Documentation/Source/eric5.E5Gui.E5ToolBox.html

changeset 58
37f0444c3479
parent 55
b5c84934de9c
child 409
0ea528e80202
--- a/Documentation/Source/eric5.E5Gui.E5ToolBox.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.E5Gui.E5ToolBox.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.E5Gui.E5ToolBox</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#104;&#111;&#114;&#105;z&#111;&#110;&#116;&#97;&#108; &#97;&#110;&#100; &#97; v&#101;&#114;&#116;&#105;&#99;&#97;&#108; &#116;&#111;&#111;&#108;&#98;&#111;x &#99;&#108;&#97;&#115;&#115;.
+Module implementing a horizontal and a vertical toolbox class.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,10 +32,10 @@
 <table>
 <tr>
 <td><a href="#E5HorizontalToolBox">E5HorizontalToolBox</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; v&#101;&#114;&#116;&#105;&#99;&#97;&#108; &#81;&#84;&#111;&#111;&#108;&#66;&#111;x &#108;&#105;&#107;&#101; w&#105;&#100;&#103;&#101;&#116;.</td>
+<td>Class implementing a vertical QToolBox like widget.</td>
 </tr><tr>
 <td><a href="#E5VerticalToolBox">E5VerticalToolBox</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#84;&#111;&#111;&#108;&#66;&#111;x &#99;&#108;&#97;&#115;&#115; &#115;&#117;&#98;&#115;&#116;&#105;&#116;&#117;&#116;&#105;&#110;&#103; &#81;&#84;&#111;&#111;&#108;&#66;&#111;x &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; w&#104;&#101;&#101;&#108; &#101;v&#101;&#110;&#116;&#115;.</td>
+<td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -46,7 +46,7 @@
 <a NAME="E5HorizontalToolBox" ID="E5HorizontalToolBox"></a>
 <h2>E5HorizontalToolBox</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; v&#101;&#114;&#116;&#105;&#99;&#97;&#108; &#81;&#84;&#111;&#111;&#108;&#66;&#111;x &#108;&#105;&#107;&#101; w&#105;&#100;&#103;&#101;&#116;.
+    Class implementing a vertical QToolBox like widget.
 </p>
 <h3>Derived from</h3>
 E5TabWidget
@@ -58,101 +58,101 @@
 <table>
 <tr>
 <td><a href="#E5HorizontalToolBox.__init__">E5HorizontalToolBox</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#E5HorizontalToolBox.addItem">addItem</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#98;&#111;x.</td>
+<td>Public method to add a widget to the toolbox.</td>
 </tr><tr>
 <td><a href="#E5HorizontalToolBox.insertItem">insertItem</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#98;&#111;x.</td>
+<td>Public method to add a widget to the toolbox.</td>
 </tr><tr>
 <td><a href="#E5HorizontalToolBox.setItemEnabled">setItemEnabled</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.</td>
+<td>Public method to set the enabled state of an item.</td>
 </tr><tr>
 <td><a href="#E5HorizontalToolBox.setItemToolTip">setItemToolTip</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#116;&#105;&#112; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.</td>
+<td>Public method to set the tooltip of an item.</td>
 </tr>
 </table>
 <a NAME="E5HorizontalToolBox.__init__" ID="E5HorizontalToolBox.__init__"></a>
 <h4>E5HorizontalToolBox (Constructor)</h4>
 <b>E5HorizontalToolBox</b>(<i>parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent widget (QWidget)
 </dd>
 </dl><a NAME="E5HorizontalToolBox.addItem" ID="E5HorizontalToolBox.addItem"></a>
 <h4>E5HorizontalToolBox.addItem</h4>
 <b>addItem</b>(<i>widget, icon, text</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#98;&#111;x.
+        Public method to add a widget to the toolbox.
 </p><dl>
 <dt><i>widget</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#98;&#101; &#97;&#100;&#100;&#101;&#100; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the widget to be added (QWidget)
 </dd><dt><i>icon</i></dt>
 <dd>
-&#116;&#104;&#101; &#105;&#99;&#111;&#110; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#81;&#73;&#99;&#111;&#110;)
+the icon to be shown (QIcon)
 </dd><dt><i>text</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;&#101;x&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the text to be shown (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#116;&#104;&#101; &#97;&#100;&#100;&#101;&#100; w&#105;&#100;&#103;&#101;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+index of the added widget (integer)
 </dd>
 </dl><a NAME="E5HorizontalToolBox.insertItem" ID="E5HorizontalToolBox.insertItem"></a>
 <h4>E5HorizontalToolBox.insertItem</h4>
 <b>insertItem</b>(<i>index, widget, icon, text</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#98;&#111;x.
+        Public method to add a widget to the toolbox.
 </p><dl>
 <dt><i>index</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#97;&#116; w&#104;&#105;&#99;&#104; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#105;&#110;&#115;&#101;&#114;&#116;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position at which the widget should be inserted (integer)
 </dd><dt><i>widget</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; w&#105;&#100;&#103;&#101;&#116; &#116;&#111; &#98;&#101; &#97;&#100;&#100;&#101;&#100; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the widget to be added (QWidget)
 </dd><dt><i>icon</i></dt>
 <dd>
-&#116;&#104;&#101; &#105;&#99;&#111;&#110; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#81;&#73;&#99;&#111;&#110;)
+the icon to be shown (QIcon)
 </dd><dt><i>text</i></dt>
 <dd>
-&#116;&#104;&#101; &#116;&#101;x&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+the text to be shown (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#116;&#104;&#101; &#97;&#100;&#100;&#101;&#100; w&#105;&#100;&#103;&#101;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+index of the added widget (integer)
 </dd>
 </dl><a NAME="E5HorizontalToolBox.setItemEnabled" ID="E5HorizontalToolBox.setItemEnabled"></a>
 <h4>E5HorizontalToolBox.setItemEnabled</h4>
 <b>setItemEnabled</b>(<i>index, enabled</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.
+        Public method to set the enabled state of an item.
 </p><dl>
 <dt><i>index</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#116;&#104;&#101; &#105;&#116;&#101;&#109; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+index of the item (integer)
 </dd><dt><i>enabled</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the enabled state (boolean)
 </dd>
 </dl><a NAME="E5HorizontalToolBox.setItemToolTip" ID="E5HorizontalToolBox.setItemToolTip"></a>
 <h4>E5HorizontalToolBox.setItemToolTip</h4>
 <b>setItemToolTip</b>(<i>index, toolTip</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#116;&#105;&#112; &#111;&#102; &#97;&#110; &#105;&#116;&#101;&#109;.
+        Public method to set the tooltip of an item.
 </p><dl>
 <dt><i>index</i></dt>
 <dd>
-&#105;&#110;&#100;&#101;x &#111;&#102; &#116;&#104;&#101; &#105;&#116;&#101;&#109; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+index of the item (integer)
 </dd><dt><i>toolTip</i></dt>
 <dd>
-&#116;&#111;&#111;&#108;&#116;&#105;&#112; &#116;&#101;x&#116; &#116;&#111; &#98;&#101; &#115;&#101;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+tooltip text to be set (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -160,7 +160,7 @@
 <a NAME="E5VerticalToolBox" ID="E5VerticalToolBox"></a>
 <h2>E5VerticalToolBox</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#84;&#111;&#111;&#108;&#66;&#111;x &#99;&#108;&#97;&#115;&#115; &#115;&#117;&#98;&#115;&#116;&#105;&#116;&#117;&#116;&#105;&#110;&#103; &#81;&#84;&#111;&#111;&#108;&#66;&#111;x &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; w&#104;&#101;&#101;&#108; &#101;v&#101;&#110;&#116;&#115;.
+    Class implementing a ToolBox class substituting QToolBox to support wheel events.
 </p>
 <h3>Derived from</h3>
 QToolBox
@@ -172,31 +172,31 @@
 <table>
 <tr>
 <td><a href="#E5VerticalToolBox.__init__">E5VerticalToolBox</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#E5VerticalToolBox.wheelEvent">wheelEvent</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; w&#104;&#101;&#101;&#108; &#101;v&#101;&#110;&#116;&#115;.</td>
+<td>Protected slot to support wheel events.</td>
 </tr>
 </table>
 <a NAME="E5VerticalToolBox.__init__" ID="E5VerticalToolBox.__init__"></a>
 <h4>E5VerticalToolBox (Constructor)</h4>
 <b>E5VerticalToolBox</b>(<i>parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+reference to the parent widget (QWidget)
 </dd>
 </dl><a NAME="E5VerticalToolBox.wheelEvent" ID="E5VerticalToolBox.wheelEvent"></a>
 <h4>E5VerticalToolBox.wheelEvent</h4>
 <b>wheelEvent</b>(<i>event</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; w&#104;&#101;&#101;&#108; &#101;v&#101;&#110;&#116;&#115;.
+        Protected slot to support wheel events.
 </p><dl>
 <dt><i>reference</i></dt>
 <dd>
-&#116;&#111; &#116;&#104;&#101; w&#104;&#101;&#101;&#108; &#101;v&#101;&#110;&#116; (&#81;&#87;&#104;&#101;&#101;&#108;&#69;v&#101;&#110;&#116;)
+to the wheel event (QWheelEvent)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial