src/eric7/Documentation/Source/eric7.EricWidgets.EricToolBox.html

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

eric ide

mercurial