Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricToolButton.html

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

branch
eric7
changeset 10479
856476537696
parent 9643
10839ab864e0
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricWidgets.EricToolButton</h1> 9 <h1>eric7.EricWidgets.EricToolButton</h1>
10
11 <p> 10 <p>
12 Module implementing a specialized tool button subclass. 11 Module implementing a specialized tool button subclass.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EricToolButton">EricToolButton</a></td> 22 <td><a href="#EricToolButton">EricToolButton</a></td>
25 <td>Class implementing a specialized tool button subclass.</td> 23 <td>Class implementing a specialized tool button subclass.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#EricToolButtonOptions">EricToolButtonOptions</a></td> 26 <td><a href="#EricToolButtonOptions">EricToolButtonOptions</a></td>
29 <td>Class defining the tool button options.</td> 27 <td>Class defining the tool button options.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="EricToolButton" ID="EricToolButton"></a> 38 <a NAME="EricToolButton" ID="EricToolButton"></a>
40 <h2>EricToolButton</h2> 39 <h2>EricToolButton</h2>
41
42 <p> 40 <p>
43 Class implementing a specialized tool button subclass. 41 Class implementing a specialized tool button subclass.
44 </p> 42 </p>
43
45 <h3>Signals</h3> 44 <h3>Signals</h3>
46 <dl> 45 <dl>
47 46
48 <dt>aboutToHideMenu()</dt> 47 <dt>aboutToHideMenu()</dt>
49 <dd> 48 <dd>
69 </dd> 68 </dd>
70 </dl> 69 </dl>
71 <h3>Derived from</h3> 70 <h3>Derived from</h3>
72 QToolButton 71 QToolButton
73 <h3>Class Attributes</h3> 72 <h3>Class Attributes</h3>
74 73 <table>
75 <table> 74 <tr><td>None</td></tr>
76 <tr><td>None</td></tr> 75 </table>
77 </table> 76
78 <h3>Class Methods</h3> 77 <h3>Class Methods</h3>
79 78 <table>
80 <table> 79 <tr><td>None</td></tr>
81 <tr><td>None</td></tr> 80 </table>
82 </table> 81
83 <h3>Methods</h3> 82 <h3>Methods</h3>
84 83 <table>
85 <table>
86
87 <tr> 84 <tr>
88 <td><a href="#EricToolButton.__init__">EricToolButton</a></td> 85 <td><a href="#EricToolButton.__init__">EricToolButton</a></td>
89 <td>Constructor</td> 86 <td>Constructor</td>
90 </tr> 87 </tr>
91 <tr> 88 <tr>
139 <tr> 136 <tr>
140 <td><a href="#EricToolButton.toolbarButtonLook">toolbarButtonLook</a></td> 137 <td><a href="#EricToolButton.toolbarButtonLook">toolbarButtonLook</a></td>
141 <td>Public method to check, if the button has the toolbar look.</td> 138 <td>Public method to check, if the button has the toolbar look.</td>
142 </tr> 139 </tr>
143 </table> 140 </table>
141
144 <h3>Static Methods</h3> 142 <h3>Static Methods</h3>
145 143 <table>
146 <table> 144 <tr><td>None</td></tr>
147 <tr><td>None</td></tr> 145 </table>
148 </table> 146
149 147
150 <a NAME="EricToolButton.__init__" ID="EricToolButton.__init__"></a> 148 <a NAME="EricToolButton.__init__" ID="EricToolButton.__init__"></a>
151 <h4>EricToolButton (Constructor)</h4> 149 <h4>EricToolButton (Constructor)</h4>
152 <b>EricToolButton</b>(<i>parent=None</i>) 150 <b>EricToolButton</b>(<i>parent=None</i>)
153
154 <p> 151 <p>
155 Constructor 152 Constructor
156 </p> 153 </p>
154
157 <dl> 155 <dl>
158 156
159 <dt><i>parent</i> (QWidget)</dt> 157 <dt><i>parent</i> (QWidget)</dt>
160 <dd> 158 <dd>
161 reference to the parent widget 159 reference to the parent widget
162 </dd> 160 </dd>
163 </dl> 161 </dl>
164 <a NAME="EricToolButton.__menuAboutToHide" ID="EricToolButton.__menuAboutToHide"></a> 162 <a NAME="EricToolButton.__menuAboutToHide" ID="EricToolButton.__menuAboutToHide"></a>
165 <h4>EricToolButton.__menuAboutToHide</h4> 163 <h4>EricToolButton.__menuAboutToHide</h4>
166 <b>__menuAboutToHide</b>(<i></i>) 164 <b>__menuAboutToHide</b>(<i></i>)
167
168 <p> 165 <p>
169 Private slot to handle the tool button menu about to be hidden. 166 Private slot to handle the tool button menu about to be hidden.
170 </p> 167 </p>
168
171 <a NAME="EricToolButton.__showMenu" ID="EricToolButton.__showMenu"></a> 169 <a NAME="EricToolButton.__showMenu" ID="EricToolButton.__showMenu"></a>
172 <h4>EricToolButton.__showMenu</h4> 170 <h4>EricToolButton.__showMenu</h4>
173 <b>__showMenu</b>(<i></i>) 171 <b>__showMenu</b>(<i></i>)
174
175 <p> 172 <p>
176 Private slot to show the tool button menu. 173 Private slot to show the tool button menu.
177 </p> 174 </p>
175
178 <a NAME="EricToolButton.badgeText" ID="EricToolButton.badgeText"></a> 176 <a NAME="EricToolButton.badgeText" ID="EricToolButton.badgeText"></a>
179 <h4>EricToolButton.badgeText</h4> 177 <h4>EricToolButton.badgeText</h4>
180 <b>badgeText</b>(<i></i>) 178 <b>badgeText</b>(<i></i>)
181
182 <p> 179 <p>
183 Public method to get the badge text. 180 Public method to get the badge text.
184 </p> 181 </p>
182
185 <dl> 183 <dl>
186 <dt>Return:</dt> 184 <dt>Return:</dt>
187 <dd> 185 <dd>
188 badge text 186 badge text
189 </dd> 187 </dd>
195 </dd> 193 </dd>
196 </dl> 194 </dl>
197 <a NAME="EricToolButton.menu" ID="EricToolButton.menu"></a> 195 <a NAME="EricToolButton.menu" ID="EricToolButton.menu"></a>
198 <h4>EricToolButton.menu</h4> 196 <h4>EricToolButton.menu</h4>
199 <b>menu</b>(<i></i>) 197 <b>menu</b>(<i></i>)
200
201 <p> 198 <p>
202 Public method to get a reference to the tool button menu. 199 Public method to get a reference to the tool button menu.
203 </p> 200 </p>
201
204 <dl> 202 <dl>
205 <dt>Return:</dt> 203 <dt>Return:</dt>
206 <dd> 204 <dd>
207 reference to the tool button menu 205 reference to the tool button menu
208 </dd> 206 </dd>
214 </dd> 212 </dd>
215 </dl> 213 </dl>
216 <a NAME="EricToolButton.mouseDoubleClickEvent" ID="EricToolButton.mouseDoubleClickEvent"></a> 214 <a NAME="EricToolButton.mouseDoubleClickEvent" ID="EricToolButton.mouseDoubleClickEvent"></a>
217 <h4>EricToolButton.mouseDoubleClickEvent</h4> 215 <h4>EricToolButton.mouseDoubleClickEvent</h4>
218 <b>mouseDoubleClickEvent</b>(<i>evt</i>) 216 <b>mouseDoubleClickEvent</b>(<i>evt</i>)
219
220 <p> 217 <p>
221 Protected method to handle mouse double click events. 218 Protected method to handle mouse double click events.
222 </p> 219 </p>
220
223 <dl> 221 <dl>
224 222
225 <dt><i>evt</i> (QMouseEvent)</dt> 223 <dt><i>evt</i> (QMouseEvent)</dt>
226 <dd> 224 <dd>
227 reference to the mouse event 225 reference to the mouse event
228 </dd> 226 </dd>
229 </dl> 227 </dl>
230 <a NAME="EricToolButton.mousePressEvent" ID="EricToolButton.mousePressEvent"></a> 228 <a NAME="EricToolButton.mousePressEvent" ID="EricToolButton.mousePressEvent"></a>
231 <h4>EricToolButton.mousePressEvent</h4> 229 <h4>EricToolButton.mousePressEvent</h4>
232 <b>mousePressEvent</b>(<i>evt</i>) 230 <b>mousePressEvent</b>(<i>evt</i>)
233
234 <p> 231 <p>
235 Protected method to handle mouse press events. 232 Protected method to handle mouse press events.
236 </p> 233 </p>
234
237 <dl> 235 <dl>
238 236
239 <dt><i>evt</i> (QMouseEvent)</dt> 237 <dt><i>evt</i> (QMouseEvent)</dt>
240 <dd> 238 <dd>
241 reference to the mouse event 239 reference to the mouse event
242 </dd> 240 </dd>
243 </dl> 241 </dl>
244 <a NAME="EricToolButton.mouseReleaseEvent" ID="EricToolButton.mouseReleaseEvent"></a> 242 <a NAME="EricToolButton.mouseReleaseEvent" ID="EricToolButton.mouseReleaseEvent"></a>
245 <h4>EricToolButton.mouseReleaseEvent</h4> 243 <h4>EricToolButton.mouseReleaseEvent</h4>
246 <b>mouseReleaseEvent</b>(<i>evt</i>) 244 <b>mouseReleaseEvent</b>(<i>evt</i>)
247
248 <p> 245 <p>
249 Protected method to handle mouse release events. 246 Protected method to handle mouse release events.
250 </p> 247 </p>
248
251 <dl> 249 <dl>
252 250
253 <dt><i>evt</i> (QMouseEvent)</dt> 251 <dt><i>evt</i> (QMouseEvent)</dt>
254 <dd> 252 <dd>
255 reference to the mouse event 253 reference to the mouse event
256 </dd> 254 </dd>
257 </dl> 255 </dl>
258 <a NAME="EricToolButton.setBadgeText" ID="EricToolButton.setBadgeText"></a> 256 <a NAME="EricToolButton.setBadgeText" ID="EricToolButton.setBadgeText"></a>
259 <h4>EricToolButton.setBadgeText</h4> 257 <h4>EricToolButton.setBadgeText</h4>
260 <b>setBadgeText</b>(<i>text</i>) 258 <b>setBadgeText</b>(<i>text</i>)
261
262 <p> 259 <p>
263 Public method to set the badge text. 260 Public method to set the badge text.
264 </p> 261 </p>
262
265 <dl> 263 <dl>
266 264
267 <dt><i>text</i> (str)</dt> 265 <dt><i>text</i> (str)</dt>
268 <dd> 266 <dd>
269 badge text to be set 267 badge text to be set
270 </dd> 268 </dd>
271 </dl> 269 </dl>
272 <a NAME="EricToolButton.setMenu" ID="EricToolButton.setMenu"></a> 270 <a NAME="EricToolButton.setMenu" ID="EricToolButton.setMenu"></a>
273 <h4>EricToolButton.setMenu</h4> 271 <h4>EricToolButton.setMenu</h4>
274 <b>setMenu</b>(<i>menu</i>) 272 <b>setMenu</b>(<i>menu</i>)
275
276 <p> 273 <p>
277 Public method to set the tool button menu. 274 Public method to set the tool button menu.
278 </p> 275 </p>
276
279 <dl> 277 <dl>
280 278
281 <dt><i>menu</i> (QMenu)</dt> 279 <dt><i>menu</i> (QMenu)</dt>
282 <dd> 280 <dd>
283 reference to the tool button menu 281 reference to the tool button menu
284 </dd> 282 </dd>
285 </dl> 283 </dl>
286 <a NAME="EricToolButton.setShowMenuInside" ID="EricToolButton.setShowMenuInside"></a> 284 <a NAME="EricToolButton.setShowMenuInside" ID="EricToolButton.setShowMenuInside"></a>
287 <h4>EricToolButton.setShowMenuInside</h4> 285 <h4>EricToolButton.setShowMenuInside</h4>
288 <b>setShowMenuInside</b>(<i>enable</i>) 286 <b>setShowMenuInside</b>(<i>enable</i>)
289
290 <p> 287 <p>
291 Public method to set a flag to show the menu edge aligned with 288 Public method to set a flag to show the menu edge aligned with
292 the button. 289 the button.
293 </p> 290 </p>
291
294 <dl> 292 <dl>
295 293
296 <dt><i>enable</i> (bool)</dt> 294 <dt><i>enable</i> (bool)</dt>
297 <dd> 295 <dd>
298 flag indicating to align the menu edge to the button 296 flag indicating to align the menu edge to the button
299 </dd> 297 </dd>
300 </dl> 298 </dl>
301 <a NAME="EricToolButton.setToolbarButtonLook" ID="EricToolButton.setToolbarButtonLook"></a> 299 <a NAME="EricToolButton.setToolbarButtonLook" ID="EricToolButton.setToolbarButtonLook"></a>
302 <h4>EricToolButton.setToolbarButtonLook</h4> 300 <h4>EricToolButton.setToolbarButtonLook</h4>
303 <b>setToolbarButtonLook</b>(<i>enable</i>) 301 <b>setToolbarButtonLook</b>(<i>enable</i>)
304
305 <p> 302 <p>
306 Public method to set the toolbar look state. 303 Public method to set the toolbar look state.
307 </p> 304 </p>
305
308 <dl> 306 <dl>
309 307
310 <dt><i>enable</i> (bool)</dt> 308 <dt><i>enable</i> (bool)</dt>
311 <dd> 309 <dd>
312 flag indicating toolbar look 310 flag indicating toolbar look
313 </dd> 311 </dd>
314 </dl> 312 </dl>
315 <a NAME="EricToolButton.showMenuInside" ID="EricToolButton.showMenuInside"></a> 313 <a NAME="EricToolButton.showMenuInside" ID="EricToolButton.showMenuInside"></a>
316 <h4>EricToolButton.showMenuInside</h4> 314 <h4>EricToolButton.showMenuInside</h4>
317 <b>showMenuInside</b>(<i></i>) 315 <b>showMenuInside</b>(<i></i>)
318
319 <p> 316 <p>
320 Public method to check, if the menu edge shall be aligned with 317 Public method to check, if the menu edge shall be aligned with
321 the button. 318 the button.
322 </p> 319 </p>
320
323 <dl> 321 <dl>
324 <dt>Return:</dt> 322 <dt>Return:</dt>
325 <dd> 323 <dd>
326 flag indicating that the menu edge shall be aligned 324 flag indicating that the menu edge shall be aligned
327 </dd> 325 </dd>
333 </dd> 331 </dd>
334 </dl> 332 </dl>
335 <a NAME="EricToolButton.toolbarButtonLook" ID="EricToolButton.toolbarButtonLook"></a> 333 <a NAME="EricToolButton.toolbarButtonLook" ID="EricToolButton.toolbarButtonLook"></a>
336 <h4>EricToolButton.toolbarButtonLook</h4> 334 <h4>EricToolButton.toolbarButtonLook</h4>
337 <b>toolbarButtonLook</b>(<i></i>) 335 <b>toolbarButtonLook</b>(<i></i>)
338
339 <p> 336 <p>
340 Public method to check, if the button has the toolbar look. 337 Public method to check, if the button has the toolbar look.
341 </p> 338 </p>
339
342 <dl> 340 <dl>
343 <dt>Return:</dt> 341 <dt>Return:</dt>
344 <dd> 342 <dd>
345 flag indicating toolbar look 343 flag indicating toolbar look
346 </dd> 344 </dd>
354 <div align="right"><a href="#top">Up</a></div> 352 <div align="right"><a href="#top">Up</a></div>
355 <hr /> 353 <hr />
356 <hr /> 354 <hr />
357 <a NAME="EricToolButtonOptions" ID="EricToolButtonOptions"></a> 355 <a NAME="EricToolButtonOptions" ID="EricToolButtonOptions"></a>
358 <h2>EricToolButtonOptions</h2> 356 <h2>EricToolButtonOptions</h2>
359
360 <p> 357 <p>
361 Class defining the tool button options. 358 Class defining the tool button options.
362 </p> 359 </p>
360
363 <h3>Derived from</h3> 361 <h3>Derived from</h3>
364 enum.IntEnum 362 enum.IntEnum
365 <h3>Class Attributes</h3> 363 <h3>Class Attributes</h3>
366 364 <table>
367 <table> 365 <tr><td>DEFAULT</td></tr>
368 <tr><td>DEFAULT</td></tr><tr><td>SHOW_MENU_INSIDE</td></tr><tr><td>TOOLBAR_LOOKUP</td></tr> 366 <tr><td>SHOW_MENU_INSIDE</td></tr>
369 </table> 367 <tr><td>TOOLBAR_LOOKUP</td></tr>
368 </table>
369
370 <h3>Class Methods</h3> 370 <h3>Class Methods</h3>
371 371 <table>
372 <table> 372 <tr><td>None</td></tr>
373 <tr><td>None</td></tr> 373 </table>
374 </table> 374
375 <h3>Methods</h3> 375 <h3>Methods</h3>
376 376 <table>
377 <table> 377 <tr><td>None</td></tr>
378 <tr><td>None</td></tr> 378 </table>
379 </table> 379
380 <h3>Static Methods</h3> 380 <h3>Static Methods</h3>
381 381 <table>
382 <table> 382 <tr><td>None</td></tr>
383 <tr><td>None</td></tr> 383 </table>
384 </table> 384
385 385
386 <div align="right"><a href="#top">Up</a></div> 386 <div align="right"><a href="#top">Up</a></div>
387 <hr /> 387 <hr />
388 </body></html> 388 </body></html>

Mercurial Repository: eric

eric ide

mercurial