eric6/Documentation/Source/eric6.E5Gui.E5ToolBox.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7989
a21d673a8f99
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.E5Gui.E5ToolBox</h1> 23 <h1>eric6.E5Gui.E5ToolBox</h1>
24
23 <p> 25 <p>
24 Module implementing a horizontal and a vertical toolbox class. 26 Module implementing a horizontal and a vertical toolbox class.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#E5HorizontalToolBox">E5HorizontalToolBox</a></td> 38 <td><a href="#E5HorizontalToolBox">E5HorizontalToolBox</a></td>
34 <td>Class implementing a vertical QToolBox like widget.</td> 39 <td>Class implementing a vertical QToolBox like widget.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#E5VerticalToolBox">E5VerticalToolBox</a></td> 42 <td><a href="#E5VerticalToolBox">E5VerticalToolBox</a></td>
37 <td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td> 43 <td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td>
38 </tr> 44 </tr>
39 </table> 45 </table>
40 <h3>Functions</h3> 46 <h3>Functions</h3>
41 <table> 47
42 <tr><td>None</td></tr> 48 <table>
43 </table> 49 <tr><td>None</td></tr>
44 <hr /><hr /> 50 </table>
51 <hr />
52 <hr />
45 <a NAME="E5HorizontalToolBox" ID="E5HorizontalToolBox"></a> 53 <a NAME="E5HorizontalToolBox" ID="E5HorizontalToolBox"></a>
46 <h2>E5HorizontalToolBox</h2> 54 <h2>E5HorizontalToolBox</h2>
55
47 <p> 56 <p>
48 Class implementing a vertical QToolBox like widget. 57 Class implementing a vertical QToolBox like widget.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 E5TabWidget 60 E5TabWidget
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
61 <table> 72
73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#E5HorizontalToolBox.__init__">E5HorizontalToolBox</a></td> 76 <td><a href="#E5HorizontalToolBox.__init__">E5HorizontalToolBox</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#E5HorizontalToolBox.addItem">addItem</a></td> 80 <td><a href="#E5HorizontalToolBox.addItem">addItem</a></td>
67 <td>Public method to add a widget to the toolbox.</td> 81 <td>Public method to add a widget to the toolbox.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#E5HorizontalToolBox.insertItem">insertItem</a></td> 84 <td><a href="#E5HorizontalToolBox.insertItem">insertItem</a></td>
70 <td>Public method to add a widget to the toolbox.</td> 85 <td>Public method to add a widget to the toolbox.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#E5HorizontalToolBox.removeItem">removeItem</a></td> 88 <td><a href="#E5HorizontalToolBox.removeItem">removeItem</a></td>
73 <td>Public method to remove a widget from the toolbox.</td> 89 <td>Public method to remove a widget from the toolbox.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#E5HorizontalToolBox.setItemEnabled">setItemEnabled</a></td> 92 <td><a href="#E5HorizontalToolBox.setItemEnabled">setItemEnabled</a></td>
76 <td>Public method to set the enabled state of an item.</td> 93 <td>Public method to set the enabled state of an item.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#E5HorizontalToolBox.setItemToolTip">setItemToolTip</a></td> 96 <td><a href="#E5HorizontalToolBox.setItemToolTip">setItemToolTip</a></td>
79 <td>Public method to set the tooltip of an item.</td> 97 <td>Public method to set the tooltip of an item.</td>
80 </tr> 98 </tr>
81 </table> 99 </table>
82 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
83 <table> 101
84 <tr><td>None</td></tr> 102 <table>
85 </table> 103 <tr><td>None</td></tr>
104 </table>
105
86 <a NAME="E5HorizontalToolBox.__init__" ID="E5HorizontalToolBox.__init__"></a> 106 <a NAME="E5HorizontalToolBox.__init__" ID="E5HorizontalToolBox.__init__"></a>
87 <h4>E5HorizontalToolBox (Constructor)</h4> 107 <h4>E5HorizontalToolBox (Constructor)</h4>
88 <b>E5HorizontalToolBox</b>(<i>parent=None</i>) 108 <b>E5HorizontalToolBox</b>(<i>parent=None</i>)
109
89 <p> 110 <p>
90 Constructor 111 Constructor
91 </p><dl> 112 </p>
113 <dl>
114
92 <dt><i>parent</i></dt> 115 <dt><i>parent</i></dt>
93 <dd> 116 <dd>
94 reference to the parent widget (QWidget) 117 reference to the parent widget (QWidget)
95 </dd> 118 </dd>
96 </dl><a NAME="E5HorizontalToolBox.addItem" ID="E5HorizontalToolBox.addItem"></a> 119 </dl>
120 <a NAME="E5HorizontalToolBox.addItem" ID="E5HorizontalToolBox.addItem"></a>
97 <h4>E5HorizontalToolBox.addItem</h4> 121 <h4>E5HorizontalToolBox.addItem</h4>
98 <b>addItem</b>(<i>widget, icon, text</i>) 122 <b>addItem</b>(<i>widget, icon, text</i>)
123
99 <p> 124 <p>
100 Public method to add a widget to the toolbox. 125 Public method to add a widget to the toolbox.
101 </p><dl> 126 </p>
127 <dl>
128
102 <dt><i>widget</i></dt> 129 <dt><i>widget</i></dt>
103 <dd> 130 <dd>
104 reference to the widget to be added (QWidget) 131 reference to the widget to be added (QWidget)
105 </dd><dt><i>icon</i></dt> 132 </dd>
133 <dt><i>icon</i></dt>
106 <dd> 134 <dd>
107 the icon to be shown (QIcon) 135 the icon to be shown (QIcon)
108 </dd><dt><i>text</i></dt> 136 </dd>
137 <dt><i>text</i></dt>
109 <dd> 138 <dd>
110 the text to be shown (string) 139 the text to be shown (string)
111 </dd> 140 </dd>
112 </dl><dl> 141 </dl>
142 <dl>
113 <dt>Returns:</dt> 143 <dt>Returns:</dt>
114 <dd> 144 <dd>
115 index of the added widget (integer) 145 index of the added widget (integer)
116 </dd> 146 </dd>
117 </dl><a NAME="E5HorizontalToolBox.insertItem" ID="E5HorizontalToolBox.insertItem"></a> 147 </dl>
148 <a NAME="E5HorizontalToolBox.insertItem" ID="E5HorizontalToolBox.insertItem"></a>
118 <h4>E5HorizontalToolBox.insertItem</h4> 149 <h4>E5HorizontalToolBox.insertItem</h4>
119 <b>insertItem</b>(<i>index, widget, icon, text</i>) 150 <b>insertItem</b>(<i>index, widget, icon, text</i>)
151
120 <p> 152 <p>
121 Public method to add a widget to the toolbox. 153 Public method to add a widget to the toolbox.
122 </p><dl> 154 </p>
155 <dl>
156
123 <dt><i>index</i></dt> 157 <dt><i>index</i></dt>
124 <dd> 158 <dd>
125 position at which the widget should be inserted (integer) 159 position at which the widget should be inserted (integer)
126 </dd><dt><i>widget</i></dt> 160 </dd>
161 <dt><i>widget</i></dt>
127 <dd> 162 <dd>
128 reference to the widget to be added (QWidget) 163 reference to the widget to be added (QWidget)
129 </dd><dt><i>icon</i></dt> 164 </dd>
165 <dt><i>icon</i></dt>
130 <dd> 166 <dd>
131 the icon to be shown (QIcon) 167 the icon to be shown (QIcon)
132 </dd><dt><i>text</i></dt> 168 </dd>
169 <dt><i>text</i></dt>
133 <dd> 170 <dd>
134 the text to be shown (string) 171 the text to be shown (string)
135 </dd> 172 </dd>
136 </dl><dl> 173 </dl>
174 <dl>
137 <dt>Returns:</dt> 175 <dt>Returns:</dt>
138 <dd> 176 <dd>
139 index of the added widget (integer) 177 index of the added widget (integer)
140 </dd> 178 </dd>
141 </dl><a NAME="E5HorizontalToolBox.removeItem" ID="E5HorizontalToolBox.removeItem"></a> 179 </dl>
180 <a NAME="E5HorizontalToolBox.removeItem" ID="E5HorizontalToolBox.removeItem"></a>
142 <h4>E5HorizontalToolBox.removeItem</h4> 181 <h4>E5HorizontalToolBox.removeItem</h4>
143 <b>removeItem</b>(<i>index</i>) 182 <b>removeItem</b>(<i>index</i>)
183
144 <p> 184 <p>
145 Public method to remove a widget from the toolbox. 185 Public method to remove a widget from the toolbox.
146 </p><dl> 186 </p>
187 <dl>
188
147 <dt><i>index</i></dt> 189 <dt><i>index</i></dt>
148 <dd> 190 <dd>
149 index of the widget to remove (integer) 191 index of the widget to remove (integer)
150 </dd> 192 </dd>
151 </dl><a NAME="E5HorizontalToolBox.setItemEnabled" ID="E5HorizontalToolBox.setItemEnabled"></a> 193 </dl>
194 <a NAME="E5HorizontalToolBox.setItemEnabled" ID="E5HorizontalToolBox.setItemEnabled"></a>
152 <h4>E5HorizontalToolBox.setItemEnabled</h4> 195 <h4>E5HorizontalToolBox.setItemEnabled</h4>
153 <b>setItemEnabled</b>(<i>index, enabled</i>) 196 <b>setItemEnabled</b>(<i>index, enabled</i>)
197
154 <p> 198 <p>
155 Public method to set the enabled state of an item. 199 Public method to set the enabled state of an item.
156 </p><dl> 200 </p>
201 <dl>
202
157 <dt><i>index</i></dt> 203 <dt><i>index</i></dt>
158 <dd> 204 <dd>
159 index of the item (integer) 205 index of the item (integer)
160 </dd><dt><i>enabled</i></dt> 206 </dd>
207 <dt><i>enabled</i></dt>
161 <dd> 208 <dd>
162 flag indicating the enabled state (boolean) 209 flag indicating the enabled state (boolean)
163 </dd> 210 </dd>
164 </dl><a NAME="E5HorizontalToolBox.setItemToolTip" ID="E5HorizontalToolBox.setItemToolTip"></a> 211 </dl>
212 <a NAME="E5HorizontalToolBox.setItemToolTip" ID="E5HorizontalToolBox.setItemToolTip"></a>
165 <h4>E5HorizontalToolBox.setItemToolTip</h4> 213 <h4>E5HorizontalToolBox.setItemToolTip</h4>
166 <b>setItemToolTip</b>(<i>index, toolTip</i>) 214 <b>setItemToolTip</b>(<i>index, toolTip</i>)
215
167 <p> 216 <p>
168 Public method to set the tooltip of an item. 217 Public method to set the tooltip of an item.
169 </p><dl> 218 </p>
219 <dl>
220
170 <dt><i>index</i></dt> 221 <dt><i>index</i></dt>
171 <dd> 222 <dd>
172 index of the item (integer) 223 index of the item (integer)
173 </dd><dt><i>toolTip</i></dt> 224 </dd>
225 <dt><i>toolTip</i></dt>
174 <dd> 226 <dd>
175 tooltip text to be set (string) 227 tooltip text to be set (string)
176 </dd> 228 </dd>
177 </dl> 229 </dl>
178 <div align="right"><a href="#top">Up</a></div> 230 <div align="right"><a href="#top">Up</a></div>
179 <hr /><hr /> 231 <hr />
232 <hr />
180 <a NAME="E5VerticalToolBox" ID="E5VerticalToolBox"></a> 233 <a NAME="E5VerticalToolBox" ID="E5VerticalToolBox"></a>
181 <h2>E5VerticalToolBox</h2> 234 <h2>E5VerticalToolBox</h2>
235
182 <p> 236 <p>
183 Class implementing a ToolBox class substituting QToolBox to support wheel 237 Class implementing a ToolBox class substituting QToolBox to support wheel
184 events. 238 events.
185 </p> 239 </p>
186 <h3>Derived from</h3> 240 <h3>Derived from</h3>
187 QToolBox 241 QToolBox
188 <h3>Class Attributes</h3> 242 <h3>Class Attributes</h3>
243
189 <table> 244 <table>
190 <tr><td>None</td></tr> 245 <tr><td>None</td></tr>
191 </table> 246 </table>
192 <h3>Class Methods</h3> 247 <h3>Class Methods</h3>
248
193 <table> 249 <table>
194 <tr><td>None</td></tr> 250 <tr><td>None</td></tr>
195 </table> 251 </table>
196 <h3>Methods</h3> 252 <h3>Methods</h3>
197 <table> 253
254 <table>
255
198 <tr> 256 <tr>
199 <td><a href="#E5VerticalToolBox.__init__">E5VerticalToolBox</a></td> 257 <td><a href="#E5VerticalToolBox.__init__">E5VerticalToolBox</a></td>
200 <td>Constructor</td> 258 <td>Constructor</td>
201 </tr> 259 </tr>
202 </table> 260 </table>
203 <h3>Static Methods</h3> 261 <h3>Static Methods</h3>
204 <table> 262
205 <tr><td>None</td></tr> 263 <table>
206 </table> 264 <tr><td>None</td></tr>
265 </table>
266
207 <a NAME="E5VerticalToolBox.__init__" ID="E5VerticalToolBox.__init__"></a> 267 <a NAME="E5VerticalToolBox.__init__" ID="E5VerticalToolBox.__init__"></a>
208 <h4>E5VerticalToolBox (Constructor)</h4> 268 <h4>E5VerticalToolBox (Constructor)</h4>
209 <b>E5VerticalToolBox</b>(<i>parent=None</i>) 269 <b>E5VerticalToolBox</b>(<i>parent=None</i>)
270
210 <p> 271 <p>
211 Constructor 272 Constructor
212 </p><dl> 273 </p>
274 <dl>
275
213 <dt><i>parent</i></dt> 276 <dt><i>parent</i></dt>
214 <dd> 277 <dd>
215 reference to the parent widget (QWidget) 278 reference to the parent widget (QWidget)
216 </dd> 279 </dd>
217 </dl> 280 </dl>

eric ide

mercurial