Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E4Gui.E4ToolBox.html
Documentation/Source/eric5.E4Gui.E4ToolBox.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.E4Gui.E4ToolBox</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.E4Gui.E4ToolBox</h1> | |
| 12 <p> | |
| 13 Module implementing a horizontal and a vertical toolbox class. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#E4HorizontalToolBox">E4HorizontalToolBox</a></td> | |
| 23 <td>Class implementing a vertical QToolBox like widget.</td> | |
| 24 </tr><tr> | |
| 25 <td><a href="#E4VerticalToolBox">E4VerticalToolBox</a></td> | |
| 26 <td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /><hr /> | |
| 34 <a NAME="E4HorizontalToolBox" ID="E4HorizontalToolBox"></a> | |
| 35 <h2>E4HorizontalToolBox</h2> | |
| 36 <p> | |
| 37 Class implementing a vertical QToolBox like widget. | |
| 38 </p> | |
| 39 <h3>Derived from</h3> | |
| 40 E4TabWidget | |
| 41 <h3>Class Attributes</h3> | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <h3>Methods</h3> | |
| 46 <table> | |
| 47 <tr> | |
| 48 <td><a href="#E4HorizontalToolBox.__init__">E4HorizontalToolBox</a></td> | |
| 49 <td>Constructor</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#E4HorizontalToolBox.addItem">addItem</a></td> | |
| 52 <td>Public method to add a widget to the toolbox.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#E4HorizontalToolBox.insertItem">insertItem</a></td> | |
| 55 <td>Public method to add a widget to the toolbox.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#E4HorizontalToolBox.setItemEnabled">setItemEnabled</a></td> | |
| 58 <td>Public method to set the enabled state of an item.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#E4HorizontalToolBox.setItemToolTip">setItemToolTip</a></td> | |
| 61 <td>Public method to set the tooltip of an item.</td> | |
| 62 </tr> | |
| 63 </table> | |
| 64 <a NAME="E4HorizontalToolBox.__init__" ID="E4HorizontalToolBox.__init__"></a> | |
| 65 <h4>E4HorizontalToolBox (Constructor)</h4> | |
| 66 <b>E4HorizontalToolBox</b>(<i>parent = None</i>) | |
| 67 <p> | |
| 68 Constructor | |
| 69 </p><dl> | |
| 70 <dt><i>parent</i></dt> | |
| 71 <dd> | |
| 72 reference to the parent widget (QWidget) | |
| 73 </dd> | |
| 74 </dl><a NAME="E4HorizontalToolBox.addItem" ID="E4HorizontalToolBox.addItem"></a> | |
| 75 <h4>E4HorizontalToolBox.addItem</h4> | |
| 76 <b>addItem</b>(<i>widget, icon, text</i>) | |
| 77 <p> | |
| 78 Public method to add a widget to the toolbox. | |
| 79 </p><dl> | |
| 80 <dt><i>widget</i></dt> | |
| 81 <dd> | |
| 82 reference to the widget to be added (QWidget) | |
| 83 </dd><dt><i>icon</i></dt> | |
| 84 <dd> | |
| 85 the icon to be shown (QIcon) | |
| 86 </dd><dt><i>text</i></dt> | |
| 87 <dd> | |
| 88 the text to be shown (string) | |
| 89 </dd> | |
| 90 </dl><dl> | |
| 91 <dt>Returns:</dt> | |
| 92 <dd> | |
| 93 index of the added widget (integer) | |
| 94 </dd> | |
| 95 </dl><a NAME="E4HorizontalToolBox.insertItem" ID="E4HorizontalToolBox.insertItem"></a> | |
| 96 <h4>E4HorizontalToolBox.insertItem</h4> | |
| 97 <b>insertItem</b>(<i>index, widget, icon, text</i>) | |
| 98 <p> | |
| 99 Public method to add a widget to the toolbox. | |
| 100 </p><dl> | |
| 101 <dt><i>index</i></dt> | |
| 102 <dd> | |
| 103 position at which the widget should be inserted (integer) | |
| 104 </dd><dt><i>widget</i></dt> | |
| 105 <dd> | |
| 106 reference to the widget to be added (QWidget) | |
| 107 </dd><dt><i>icon</i></dt> | |
| 108 <dd> | |
| 109 the icon to be shown (QIcon) | |
| 110 </dd><dt><i>text</i></dt> | |
| 111 <dd> | |
| 112 the text to be shown (string) | |
| 113 </dd> | |
| 114 </dl><dl> | |
| 115 <dt>Returns:</dt> | |
| 116 <dd> | |
| 117 index of the added widget (integer) | |
| 118 </dd> | |
| 119 </dl><a NAME="E4HorizontalToolBox.setItemEnabled" ID="E4HorizontalToolBox.setItemEnabled"></a> | |
| 120 <h4>E4HorizontalToolBox.setItemEnabled</h4> | |
| 121 <b>setItemEnabled</b>(<i>index, enabled</i>) | |
| 122 <p> | |
| 123 Public method to set the enabled state of an item. | |
| 124 </p><dl> | |
| 125 <dt><i>index</i></dt> | |
| 126 <dd> | |
| 127 index of the item (integer) | |
| 128 </dd><dt><i>enabled</i></dt> | |
| 129 <dd> | |
| 130 flag indicating the enabled state (boolean) | |
| 131 </dd> | |
| 132 </dl><a NAME="E4HorizontalToolBox.setItemToolTip" ID="E4HorizontalToolBox.setItemToolTip"></a> | |
| 133 <h4>E4HorizontalToolBox.setItemToolTip</h4> | |
| 134 <b>setItemToolTip</b>(<i>index, toolTip</i>) | |
| 135 <p> | |
| 136 Public method to set the tooltip of an item. | |
| 137 </p><dl> | |
| 138 <dt><i>index</i></dt> | |
| 139 <dd> | |
| 140 index of the item (integer) | |
| 141 </dd><dt><i>toolTip</i></dt> | |
| 142 <dd> | |
| 143 tooltip text to be set (string) | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <div align="right"><a href="#top">Up</a></div> | |
| 147 <hr /><hr /> | |
| 148 <a NAME="E4VerticalToolBox" ID="E4VerticalToolBox"></a> | |
| 149 <h2>E4VerticalToolBox</h2> | |
| 150 <p> | |
| 151 Class implementing a ToolBox class substituting QToolBox to support wheel events. | |
| 152 </p> | |
| 153 <h3>Derived from</h3> | |
| 154 QToolBox | |
| 155 <h3>Class Attributes</h3> | |
| 156 <table> | |
| 157 <tr><td>None</td></tr> | |
| 158 </table> | |
| 159 <h3>Methods</h3> | |
| 160 <table> | |
| 161 <tr> | |
| 162 <td><a href="#E4VerticalToolBox.__init__">E4VerticalToolBox</a></td> | |
| 163 <td>Constructor</td> | |
| 164 </tr><tr> | |
| 165 <td><a href="#E4VerticalToolBox.wheelEvent">wheelEvent</a></td> | |
| 166 <td>Protected slot to support wheel events.</td> | |
| 167 </tr> | |
| 168 </table> | |
| 169 <a NAME="E4VerticalToolBox.__init__" ID="E4VerticalToolBox.__init__"></a> | |
| 170 <h4>E4VerticalToolBox (Constructor)</h4> | |
| 171 <b>E4VerticalToolBox</b>(<i>parent = None</i>) | |
| 172 <p> | |
| 173 Constructor | |
| 174 </p><dl> | |
| 175 <dt><i>parent</i></dt> | |
| 176 <dd> | |
| 177 reference to the parent widget (QWidget) | |
| 178 </dd> | |
| 179 </dl><a NAME="E4VerticalToolBox.wheelEvent" ID="E4VerticalToolBox.wheelEvent"></a> | |
| 180 <h4>E4VerticalToolBox.wheelEvent</h4> | |
| 181 <b>wheelEvent</b>(<i>event</i>) | |
| 182 <p> | |
| 183 Protected slot to support wheel events. | |
| 184 </p><dl> | |
| 185 <dt><i>reference</i></dt> | |
| 186 <dd> | |
| 187 to the wheel event (QWheelEvent) | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <div align="right"><a href="#top">Up</a></div> | |
| 191 <hr /> | |
| 192 </body></html> |
