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