Documentation/Source/eric4.E4Gui.E4ToolBox.html

changeset 3
0d9daebf5b8c
diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.E4Gui.E4ToolBox.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.E4Gui.E4ToolBox.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,204 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.E4Gui.E4ToolBox</title>
+<style>
+body {
+    background:white;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+    
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.E4Gui.E4ToolBox</h1>
+<p>
+Module implementing a horizontal and a vertical toolbox class.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#E4HorizontalToolBox">E4HorizontalToolBox</a></td>
+<td>Class implementing a vertical QToolBox like widget.</td>
+</tr><tr>
+<td><a href="#E4VerticalToolBox">E4VerticalToolBox</a></td>
+<td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="E4HorizontalToolBox" ID="E4HorizontalToolBox"></a>
+<h2>E4HorizontalToolBox</h2>
+<p>
+    Class implementing a vertical QToolBox like widget.
+</p>
+<h3>Derived from</h3>
+E4TabWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#E4HorizontalToolBox.__init__">E4HorizontalToolBox</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E4HorizontalToolBox.addItem">addItem</a></td>
+<td>Public method to add a widget to the toolbox.</td>
+</tr><tr>
+<td><a href="#E4HorizontalToolBox.insertItem">insertItem</a></td>
+<td>Public method to add a widget to the toolbox.</td>
+</tr><tr>
+<td><a href="#E4HorizontalToolBox.setItemEnabled">setItemEnabled</a></td>
+<td>Public method to set the enabled state of an item.</td>
+</tr><tr>
+<td><a href="#E4HorizontalToolBox.setItemToolTip">setItemToolTip</a></td>
+<td>Public method to set the tooltip of an item.</td>
+</tr>
+</table>
+<a NAME="E4HorizontalToolBox.__init__" ID="E4HorizontalToolBox.__init__"></a>
+<h4>E4HorizontalToolBox (Constructor)</h4>
+<b>E4HorizontalToolBox</b>(<i>parent = None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="E4HorizontalToolBox.addItem" ID="E4HorizontalToolBox.addItem"></a>
+<h4>E4HorizontalToolBox.addItem</h4>
+<b>addItem</b>(<i>widget, icon, text</i>)
+<p>
+        Public method to add a widget to the toolbox.
+</p><dl>
+<dt><i>widget</i></dt>
+<dd>
+reference to the widget to be added (QWidget)
+</dd><dt><i>icon</i></dt>
+<dd>
+the icon to be shown (QIcon)
+</dd><dt><i>text</i></dt>
+<dd>
+the text to be shown (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+index of the added widget (integer)
+</dd>
+</dl><a NAME="E4HorizontalToolBox.insertItem" ID="E4HorizontalToolBox.insertItem"></a>
+<h4>E4HorizontalToolBox.insertItem</h4>
+<b>insertItem</b>(<i>index, widget, icon, text</i>)
+<p>
+        Public method to add a widget to the toolbox.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+position at which the widget should be inserted (integer)
+</dd><dt><i>widget</i></dt>
+<dd>
+reference to the widget to be added (QWidget)
+</dd><dt><i>icon</i></dt>
+<dd>
+the icon to be shown (QIcon)
+</dd><dt><i>text</i></dt>
+<dd>
+the text to be shown (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+index of the added widget (integer)
+</dd>
+</dl><a NAME="E4HorizontalToolBox.setItemEnabled" ID="E4HorizontalToolBox.setItemEnabled"></a>
+<h4>E4HorizontalToolBox.setItemEnabled</h4>
+<b>setItemEnabled</b>(<i>index, enabled</i>)
+<p>
+        Public method to set the enabled state of an item.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the item (integer)
+</dd><dt><i>enabled</i></dt>
+<dd>
+flag indicating the enabled state (boolean)
+</dd>
+</dl><a NAME="E4HorizontalToolBox.setItemToolTip" ID="E4HorizontalToolBox.setItemToolTip"></a>
+<h4>E4HorizontalToolBox.setItemToolTip</h4>
+<b>setItemToolTip</b>(<i>index, toolTip</i>)
+<p>
+        Public method to set the tooltip of an item.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the item (integer)
+</dd><dt><i>toolTip</i></dt>
+<dd>
+tooltip text to be set (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="E4VerticalToolBox" ID="E4VerticalToolBox"></a>
+<h2>E4VerticalToolBox</h2>
+<p>
+    Class implementing a ToolBox class substituting QToolBox to support wheel events.
+</p>
+<h3>Derived from</h3>
+QToolBox
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#E4VerticalToolBox.__init__">E4VerticalToolBox</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E4VerticalToolBox.wheelEvent">wheelEvent</a></td>
+<td>Protected slot to support wheel events.</td>
+</tr>
+</table>
+<a NAME="E4VerticalToolBox.__init__" ID="E4VerticalToolBox.__init__"></a>
+<h4>E4VerticalToolBox (Constructor)</h4>
+<b>E4VerticalToolBox</b>(<i>parent = None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="E4VerticalToolBox.wheelEvent" ID="E4VerticalToolBox.wheelEvent"></a>
+<h4>E4VerticalToolBox.wheelEvent</h4>
+<b>wheelEvent</b>(<i>event</i>)
+<p>
+        Protected slot to support wheel events.
+</p><dl>
+<dt><i>reference</i></dt>
+<dd>
+to the wheel event (QWheelEvent)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial