|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.E5Gui.E5ToolBox</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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.E5Gui.E5ToolBox</h1> |
|
23 <p> |
|
24 Module implementing a horizontal and a vertical toolbox class. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#E5HorizontalToolBox">E5HorizontalToolBox</a></td> |
|
34 <td>Class implementing a vertical QToolBox like widget.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#E5VerticalToolBox">E5VerticalToolBox</a></td> |
|
37 <td>Class implementing a ToolBox class substituting QToolBox to support wheel events.</td> |
|
38 </tr> |
|
39 </table> |
|
40 <h3>Functions</h3> |
|
41 <table> |
|
42 <tr><td>None</td></tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="E5HorizontalToolBox" ID="E5HorizontalToolBox"></a> |
|
46 <h2>E5HorizontalToolBox</h2> |
|
47 <p> |
|
48 Class implementing a vertical QToolBox like widget. |
|
49 </p> |
|
50 <h3>Derived from</h3> |
|
51 E5TabWidget |
|
52 <h3>Class Attributes</h3> |
|
53 <table> |
|
54 <tr><td>None</td></tr> |
|
55 </table> |
|
56 <h3>Class Methods</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Methods</h3> |
|
61 <table> |
|
62 <tr> |
|
63 <td><a href="#E5HorizontalToolBox.__init__">E5HorizontalToolBox</a></td> |
|
64 <td>Constructor</td> |
|
65 </tr><tr> |
|
66 <td><a href="#E5HorizontalToolBox.addItem">addItem</a></td> |
|
67 <td>Public method to add a widget to the toolbox.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#E5HorizontalToolBox.insertItem">insertItem</a></td> |
|
70 <td>Public method to add a widget to the toolbox.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#E5HorizontalToolBox.removeItem">removeItem</a></td> |
|
73 <td>Public method to remove a widget from the toolbox.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#E5HorizontalToolBox.setItemEnabled">setItemEnabled</a></td> |
|
76 <td>Public method to set the enabled state of an item.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#E5HorizontalToolBox.setItemToolTip">setItemToolTip</a></td> |
|
79 <td>Public method to set the tooltip of an item.</td> |
|
80 </tr> |
|
81 </table> |
|
82 <h3>Static Methods</h3> |
|
83 <table> |
|
84 <tr><td>None</td></tr> |
|
85 </table> |
|
86 <a NAME="E5HorizontalToolBox.__init__" ID="E5HorizontalToolBox.__init__"></a> |
|
87 <h4>E5HorizontalToolBox (Constructor)</h4> |
|
88 <b>E5HorizontalToolBox</b>(<i>parent=None</i>) |
|
89 <p> |
|
90 Constructor |
|
91 </p><dl> |
|
92 <dt><i>parent</i></dt> |
|
93 <dd> |
|
94 reference to the parent widget (QWidget) |
|
95 </dd> |
|
96 </dl><a NAME="E5HorizontalToolBox.addItem" ID="E5HorizontalToolBox.addItem"></a> |
|
97 <h4>E5HorizontalToolBox.addItem</h4> |
|
98 <b>addItem</b>(<i>widget, icon, text</i>) |
|
99 <p> |
|
100 Public method to add a widget to the toolbox. |
|
101 </p><dl> |
|
102 <dt><i>widget</i></dt> |
|
103 <dd> |
|
104 reference to the widget to be added (QWidget) |
|
105 </dd><dt><i>icon</i></dt> |
|
106 <dd> |
|
107 the icon to be shown (QIcon) |
|
108 </dd><dt><i>text</i></dt> |
|
109 <dd> |
|
110 the text to be shown (string) |
|
111 </dd> |
|
112 </dl><dl> |
|
113 <dt>Returns:</dt> |
|
114 <dd> |
|
115 index of the added widget (integer) |
|
116 </dd> |
|
117 </dl><a NAME="E5HorizontalToolBox.insertItem" ID="E5HorizontalToolBox.insertItem"></a> |
|
118 <h4>E5HorizontalToolBox.insertItem</h4> |
|
119 <b>insertItem</b>(<i>index, widget, icon, text</i>) |
|
120 <p> |
|
121 Public method to add a widget to the toolbox. |
|
122 </p><dl> |
|
123 <dt><i>index</i></dt> |
|
124 <dd> |
|
125 position at which the widget should be inserted (integer) |
|
126 </dd><dt><i>widget</i></dt> |
|
127 <dd> |
|
128 reference to the widget to be added (QWidget) |
|
129 </dd><dt><i>icon</i></dt> |
|
130 <dd> |
|
131 the icon to be shown (QIcon) |
|
132 </dd><dt><i>text</i></dt> |
|
133 <dd> |
|
134 the text to be shown (string) |
|
135 </dd> |
|
136 </dl><dl> |
|
137 <dt>Returns:</dt> |
|
138 <dd> |
|
139 index of the added widget (integer) |
|
140 </dd> |
|
141 </dl><a NAME="E5HorizontalToolBox.removeItem" ID="E5HorizontalToolBox.removeItem"></a> |
|
142 <h4>E5HorizontalToolBox.removeItem</h4> |
|
143 <b>removeItem</b>(<i>index</i>) |
|
144 <p> |
|
145 Public method to remove a widget from the toolbox. |
|
146 </p><dl> |
|
147 <dt><i>index</i></dt> |
|
148 <dd> |
|
149 index of the widget to remove (integer) |
|
150 </dd> |
|
151 </dl><a NAME="E5HorizontalToolBox.setItemEnabled" ID="E5HorizontalToolBox.setItemEnabled"></a> |
|
152 <h4>E5HorizontalToolBox.setItemEnabled</h4> |
|
153 <b>setItemEnabled</b>(<i>index, enabled</i>) |
|
154 <p> |
|
155 Public method to set the enabled state of an item. |
|
156 </p><dl> |
|
157 <dt><i>index</i></dt> |
|
158 <dd> |
|
159 index of the item (integer) |
|
160 </dd><dt><i>enabled</i></dt> |
|
161 <dd> |
|
162 flag indicating the enabled state (boolean) |
|
163 </dd> |
|
164 </dl><a NAME="E5HorizontalToolBox.setItemToolTip" ID="E5HorizontalToolBox.setItemToolTip"></a> |
|
165 <h4>E5HorizontalToolBox.setItemToolTip</h4> |
|
166 <b>setItemToolTip</b>(<i>index, toolTip</i>) |
|
167 <p> |
|
168 Public method to set the tooltip of an item. |
|
169 </p><dl> |
|
170 <dt><i>index</i></dt> |
|
171 <dd> |
|
172 index of the item (integer) |
|
173 </dd><dt><i>toolTip</i></dt> |
|
174 <dd> |
|
175 tooltip text to be set (string) |
|
176 </dd> |
|
177 </dl> |
|
178 <div align="right"><a href="#top">Up</a></div> |
|
179 <hr /><hr /> |
|
180 <a NAME="E5VerticalToolBox" ID="E5VerticalToolBox"></a> |
|
181 <h2>E5VerticalToolBox</h2> |
|
182 <p> |
|
183 Class implementing a ToolBox class substituting QToolBox to support wheel |
|
184 events. |
|
185 </p> |
|
186 <h3>Derived from</h3> |
|
187 QToolBox |
|
188 <h3>Class Attributes</h3> |
|
189 <table> |
|
190 <tr><td>None</td></tr> |
|
191 </table> |
|
192 <h3>Class Methods</h3> |
|
193 <table> |
|
194 <tr><td>None</td></tr> |
|
195 </table> |
|
196 <h3>Methods</h3> |
|
197 <table> |
|
198 <tr> |
|
199 <td><a href="#E5VerticalToolBox.__init__">E5VerticalToolBox</a></td> |
|
200 <td>Constructor</td> |
|
201 </tr> |
|
202 </table> |
|
203 <h3>Static Methods</h3> |
|
204 <table> |
|
205 <tr><td>None</td></tr> |
|
206 </table> |
|
207 <a NAME="E5VerticalToolBox.__init__" ID="E5VerticalToolBox.__init__"></a> |
|
208 <h4>E5VerticalToolBox (Constructor)</h4> |
|
209 <b>E5VerticalToolBox</b>(<i>parent=None</i>) |
|
210 <p> |
|
211 Constructor |
|
212 </p><dl> |
|
213 <dt><i>parent</i></dt> |
|
214 <dd> |
|
215 reference to the parent widget (QWidget) |
|
216 </dd> |
|
217 </dl> |
|
218 <div align="right"><a href="#top">Up</a></div> |
|
219 <hr /> |
|
220 </body></html> |