Documentation/Source/eric6.E5Gui.E5ToolBarManager.html

changeset 3673
e26d7d0c1088
child 4113
feac3108a780
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5ToolBarManager</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.E5ToolBarManager</h1>
23 <p>
24 Module implementing a toolbar manager 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="#E5ToolBarManager">E5ToolBarManager</a></td>
34 <td>Class implementing a toolbar manager.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="E5ToolBarManager" ID="E5ToolBarManager"></a>
43 <h2>E5ToolBarManager</h2>
44 <p>
45 Class implementing a toolbar manager.
46 </p>
47 <h3>Derived from</h3>
48 QObject
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>CustomToolBarMarker</td></tr><tr><td>ToolBarMarker</td></tr><tr><td>VersionMarker</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#E5ToolBarManager.__init__">E5ToolBarManager</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#E5ToolBarManager.__findAction">__findAction</a></td>
64 <td>Private method to find an action by name.</td>
65 </tr><tr>
66 <td><a href="#E5ToolBarManager.__findDefaultToolBar">__findDefaultToolBar</a></td>
67 <td>Private method to find a default toolbar by name.</td>
68 </tr><tr>
69 <td><a href="#E5ToolBarManager.__toolBarByName">__toolBarByName</a></td>
70 <td>Private slot to get a toolbar by its object name.</td>
71 </tr><tr>
72 <td><a href="#E5ToolBarManager.actionById">actionById</a></td>
73 <td>Public method to get an action given its id.</td>
74 </tr><tr>
75 <td><a href="#E5ToolBarManager.addAction">addAction</a></td>
76 <td>Public method to add an action to be managed.</td>
77 </tr><tr>
78 <td><a href="#E5ToolBarManager.addToolBar">addToolBar</a></td>
79 <td>Public method to add a toolbar to be managed.</td>
80 </tr><tr>
81 <td><a href="#E5ToolBarManager.categories">categories</a></td>
82 <td>Public method to get the list of categories.</td>
83 </tr><tr>
84 <td><a href="#E5ToolBarManager.categoryActions">categoryActions</a></td>
85 <td>Public method to get the actions belonging to a category.</td>
86 </tr><tr>
87 <td><a href="#E5ToolBarManager.createToolBar">createToolBar</a></td>
88 <td>Public method to create a custom toolbar.</td>
89 </tr><tr>
90 <td><a href="#E5ToolBarManager.defaultToolBarActions">defaultToolBarActions</a></td>
91 <td>Public method to get a default toolbar's actions given its id.</td>
92 </tr><tr>
93 <td><a href="#E5ToolBarManager.defaultToolBars">defaultToolBars</a></td>
94 <td>Public method to get all toolbars added with addToolBar().</td>
95 </tr><tr>
96 <td><a href="#E5ToolBarManager.deleteToolBar">deleteToolBar</a></td>
97 <td>Public method to remove a custom toolbar created with createToolBar().</td>
98 </tr><tr>
99 <td><a href="#E5ToolBarManager.isDefaultToolBar">isDefaultToolBar</a></td>
100 <td>Public method to check, if a toolbar was added with addToolBar().</td>
101 </tr><tr>
102 <td><a href="#E5ToolBarManager.isWidgetAction">isWidgetAction</a></td>
103 <td>Public method to check, if action is a widget action.</td>
104 </tr><tr>
105 <td><a href="#E5ToolBarManager.mainWindow">mainWindow</a></td>
106 <td>Public method to get the reference to the main window.</td>
107 </tr><tr>
108 <td><a href="#E5ToolBarManager.removeAction">removeAction</a></td>
109 <td>Public method to remove an action from the manager.</td>
110 </tr><tr>
111 <td><a href="#E5ToolBarManager.removeToolBar">removeToolBar</a></td>
112 <td>Public method to remove a toolbar added with addToolBar().</td>
113 </tr><tr>
114 <td><a href="#E5ToolBarManager.removeWidgetActions">removeWidgetActions</a></td>
115 <td>Public method to remove widget actions.</td>
116 </tr><tr>
117 <td><a href="#E5ToolBarManager.renameToolBar">renameToolBar</a></td>
118 <td>Public method to give a toolbar a new title.</td>
119 </tr><tr>
120 <td><a href="#E5ToolBarManager.resetAllToolBars">resetAllToolBars</a></td>
121 <td>Public method to reset all toolbars to their default state.</td>
122 </tr><tr>
123 <td><a href="#E5ToolBarManager.resetToolBar">resetToolBar</a></td>
124 <td>Public method to reset a toolbar to its default state.</td>
125 </tr><tr>
126 <td><a href="#E5ToolBarManager.restoreState">restoreState</a></td>
127 <td>Public method to restore the state of the toolbar manager.</td>
128 </tr><tr>
129 <td><a href="#E5ToolBarManager.saveState">saveState</a></td>
130 <td>Public method to save the state of the toolbar manager.</td>
131 </tr><tr>
132 <td><a href="#E5ToolBarManager.setMainWindow">setMainWindow</a></td>
133 <td>Public method to set the reference to the main window.</td>
134 </tr><tr>
135 <td><a href="#E5ToolBarManager.setToolBar">setToolBar</a></td>
136 <td>Public method to set the actions of a toolbar.</td>
137 </tr><tr>
138 <td><a href="#E5ToolBarManager.setToolBars">setToolBars</a></td>
139 <td>Public method to set the actions of several toolbars.</td>
140 </tr><tr>
141 <td><a href="#E5ToolBarManager.toolBarActions">toolBarActions</a></td>
142 <td>Public method to get a toolbar's actions given its id.</td>
143 </tr><tr>
144 <td><a href="#E5ToolBarManager.toolBarById">toolBarById</a></td>
145 <td>Public method to get a toolbar given its id.</td>
146 </tr><tr>
147 <td><a href="#E5ToolBarManager.toolBarWidgetAction">toolBarWidgetAction</a></td>
148 <td>Public method to get the toolbar for a widget action.</td>
149 </tr><tr>
150 <td><a href="#E5ToolBarManager.toolBars">toolBars</a></td>
151 <td>Public method to get all toolbars.</td>
152 </tr><tr>
153 <td><a href="#E5ToolBarManager.toolBarsActions">toolBarsActions</a></td>
154 <td>Public method to get all toolbars and their actions.</td>
155 </tr>
156 </table>
157 <h3>Static Methods</h3>
158 <table>
159 <tr><td>None</td></tr>
160 </table>
161 <a NAME="E5ToolBarManager.__init__" ID="E5ToolBarManager.__init__"></a>
162 <h4>E5ToolBarManager (Constructor)</h4>
163 <b>E5ToolBarManager</b>(<i>ui=None, parent=None</i>)
164 <p>
165 Constructor
166 </p><dl>
167 <dt><i>ui</i></dt>
168 <dd>
169 reference to the user interface object (UI.UserInterface)
170 </dd><dt><i>parent</i></dt>
171 <dd>
172 reference to the parent object (QObject)
173 </dd>
174 </dl><a NAME="E5ToolBarManager.__findAction" ID="E5ToolBarManager.__findAction"></a>
175 <h4>E5ToolBarManager.__findAction</h4>
176 <b>__findAction</b>(<i>name</i>)
177 <p>
178 Private method to find an action by name.
179 </p><dl>
180 <dt><i>name</i></dt>
181 <dd>
182 name of the action to search for (string)
183 </dd>
184 </dl><dl>
185 <dt>Returns:</dt>
186 <dd>
187 reference to the action (QAction)
188 </dd>
189 </dl><a NAME="E5ToolBarManager.__findDefaultToolBar" ID="E5ToolBarManager.__findDefaultToolBar"></a>
190 <h4>E5ToolBarManager.__findDefaultToolBar</h4>
191 <b>__findDefaultToolBar</b>(<i>name</i>)
192 <p>
193 Private method to find a default toolbar by name.
194 </p><dl>
195 <dt><i>name</i></dt>
196 <dd>
197 name of the default toolbar to search for (string)
198 </dd>
199 </dl><dl>
200 <dt>Returns:</dt>
201 <dd>
202 reference to the default toolbar (QToolBar)
203 </dd>
204 </dl><a NAME="E5ToolBarManager.__toolBarByName" ID="E5ToolBarManager.__toolBarByName"></a>
205 <h4>E5ToolBarManager.__toolBarByName</h4>
206 <b>__toolBarByName</b>(<i>name</i>)
207 <p>
208 Private slot to get a toolbar by its object name.
209 </p><dl>
210 <dt><i>name</i></dt>
211 <dd>
212 object name of the toolbar (string)
213 </dd>
214 </dl><dl>
215 <dt>Returns:</dt>
216 <dd>
217 reference to the toolbar (QToolBar)
218 </dd>
219 </dl><a NAME="E5ToolBarManager.actionById" ID="E5ToolBarManager.actionById"></a>
220 <h4>E5ToolBarManager.actionById</h4>
221 <b>actionById</b>(<i>aID</i>)
222 <p>
223 Public method to get an action given its id.
224 </p><dl>
225 <dt><i>aID</i></dt>
226 <dd>
227 id of the action object (integer)
228 </dd>
229 </dl><dl>
230 <dt>Returns:</dt>
231 <dd>
232 reference to the action (QAction)
233 </dd>
234 </dl><a NAME="E5ToolBarManager.addAction" ID="E5ToolBarManager.addAction"></a>
235 <h4>E5ToolBarManager.addAction</h4>
236 <b>addAction</b>(<i>action, category</i>)
237 <p>
238 Public method to add an action to be managed.
239 </p><dl>
240 <dt><i>action</i></dt>
241 <dd>
242 reference to the action to be managed (QAction)
243 </dd><dt><i>category</i></dt>
244 <dd>
245 category for the toolbar (string)
246 </dd>
247 </dl><a NAME="E5ToolBarManager.addToolBar" ID="E5ToolBarManager.addToolBar"></a>
248 <h4>E5ToolBarManager.addToolBar</h4>
249 <b>addToolBar</b>(<i>toolBar, category</i>)
250 <p>
251 Public method to add a toolbar to be managed.
252 </p><dl>
253 <dt><i>toolBar</i></dt>
254 <dd>
255 reference to the toolbar to be managed (QToolBar)
256 </dd><dt><i>category</i></dt>
257 <dd>
258 category for the toolbar (string)
259 </dd>
260 </dl><a NAME="E5ToolBarManager.categories" ID="E5ToolBarManager.categories"></a>
261 <h4>E5ToolBarManager.categories</h4>
262 <b>categories</b>(<i></i>)
263 <p>
264 Public method to get the list of categories.
265 </p><dl>
266 <dt>Returns:</dt>
267 <dd>
268 list of categories (list of string)
269 </dd>
270 </dl><a NAME="E5ToolBarManager.categoryActions" ID="E5ToolBarManager.categoryActions"></a>
271 <h4>E5ToolBarManager.categoryActions</h4>
272 <b>categoryActions</b>(<i>category</i>)
273 <p>
274 Public method to get the actions belonging to a category.
275 </p><dl>
276 <dt><i>category</i></dt>
277 <dd>
278 category for the toolbar (string)
279 </dd>
280 </dl><dl>
281 <dt>Returns:</dt>
282 <dd>
283 list of actions (list of QAction)
284 </dd>
285 </dl><a NAME="E5ToolBarManager.createToolBar" ID="E5ToolBarManager.createToolBar"></a>
286 <h4>E5ToolBarManager.createToolBar</h4>
287 <b>createToolBar</b>(<i>title, name=""</i>)
288 <p>
289 Public method to create a custom toolbar.
290 </p><dl>
291 <dt><i>title</i></dt>
292 <dd>
293 title to be used for the toolbar (string)
294 </dd><dt><i>name</i></dt>
295 <dd>
296 optional name for the new toolbar (string)
297 </dd>
298 </dl><dl>
299 <dt>Returns:</dt>
300 <dd>
301 reference to the created toolbar (QToolBar)
302 </dd>
303 </dl><a NAME="E5ToolBarManager.defaultToolBarActions" ID="E5ToolBarManager.defaultToolBarActions"></a>
304 <h4>E5ToolBarManager.defaultToolBarActions</h4>
305 <b>defaultToolBarActions</b>(<i>tbID</i>)
306 <p>
307 Public method to get a default toolbar's actions given its id.
308 </p><dl>
309 <dt><i>tbID</i></dt>
310 <dd>
311 id of the default toolbar object (integer)
312 </dd>
313 </dl><dl>
314 <dt>Returns:</dt>
315 <dd>
316 list of actions (list of QAction)
317 </dd>
318 </dl><a NAME="E5ToolBarManager.defaultToolBars" ID="E5ToolBarManager.defaultToolBars"></a>
319 <h4>E5ToolBarManager.defaultToolBars</h4>
320 <b>defaultToolBars</b>(<i></i>)
321 <p>
322 Public method to get all toolbars added with addToolBar().
323 </p><dl>
324 <dt>Returns:</dt>
325 <dd>
326 list of all default toolbars (list of QToolBar)
327 </dd>
328 </dl><a NAME="E5ToolBarManager.deleteToolBar" ID="E5ToolBarManager.deleteToolBar"></a>
329 <h4>E5ToolBarManager.deleteToolBar</h4>
330 <b>deleteToolBar</b>(<i>toolBar</i>)
331 <p>
332 Public method to remove a custom toolbar created with createToolBar().
333 </p><dl>
334 <dt><i>toolBar</i></dt>
335 <dd>
336 reference to the toolbar to be managed (QToolBar)
337 </dd>
338 </dl><a NAME="E5ToolBarManager.isDefaultToolBar" ID="E5ToolBarManager.isDefaultToolBar"></a>
339 <h4>E5ToolBarManager.isDefaultToolBar</h4>
340 <b>isDefaultToolBar</b>(<i>toolBar</i>)
341 <p>
342 Public method to check, if a toolbar was added with addToolBar().
343 </p><dl>
344 <dt><i>toolBar</i></dt>
345 <dd>
346 reference to the toolbar to be checked (QToolBar)
347 </dd>
348 </dl><dl>
349 <dt>Returns:</dt>
350 <dd>
351 flag indicating an added toolbar (boolean)
352 </dd>
353 </dl><a NAME="E5ToolBarManager.isWidgetAction" ID="E5ToolBarManager.isWidgetAction"></a>
354 <h4>E5ToolBarManager.isWidgetAction</h4>
355 <b>isWidgetAction</b>(<i>action</i>)
356 <p>
357 Public method to check, if action is a widget action.
358 </p><dl>
359 <dt><i>action</i></dt>
360 <dd>
361 reference to the action to be checked (QAction)
362 </dd>
363 </dl><dl>
364 <dt>Returns:</dt>
365 <dd>
366 flag indicating a widget action (boolean)
367 </dd>
368 </dl><a NAME="E5ToolBarManager.mainWindow" ID="E5ToolBarManager.mainWindow"></a>
369 <h4>E5ToolBarManager.mainWindow</h4>
370 <b>mainWindow</b>(<i></i>)
371 <p>
372 Public method to get the reference to the main window.
373 </p><dl>
374 <dt>Returns:</dt>
375 <dd>
376 reference to the main window (QMainWindow)
377 </dd>
378 </dl><a NAME="E5ToolBarManager.removeAction" ID="E5ToolBarManager.removeAction"></a>
379 <h4>E5ToolBarManager.removeAction</h4>
380 <b>removeAction</b>(<i>action</i>)
381 <p>
382 Public method to remove an action from the manager.
383 </p><dl>
384 <dt><i>action</i></dt>
385 <dd>
386 reference to the action to be removed (QAction)
387 </dd>
388 </dl><a NAME="E5ToolBarManager.removeToolBar" ID="E5ToolBarManager.removeToolBar"></a>
389 <h4>E5ToolBarManager.removeToolBar</h4>
390 <b>removeToolBar</b>(<i>toolBar</i>)
391 <p>
392 Public method to remove a toolbar added with addToolBar().
393 </p><dl>
394 <dt><i>toolBar</i></dt>
395 <dd>
396 reference to the toolbar to be removed (QToolBar)
397 </dd>
398 </dl><a NAME="E5ToolBarManager.removeWidgetActions" ID="E5ToolBarManager.removeWidgetActions"></a>
399 <h4>E5ToolBarManager.removeWidgetActions</h4>
400 <b>removeWidgetActions</b>(<i>actions</i>)
401 <p>
402 Public method to remove widget actions.
403 </p><dl>
404 <dt><i>actions</i></dt>
405 <dd>
406 dictionary with toolbar id as key and
407 a list of widget actions as value
408 </dd>
409 </dl><a NAME="E5ToolBarManager.renameToolBar" ID="E5ToolBarManager.renameToolBar"></a>
410 <h4>E5ToolBarManager.renameToolBar</h4>
411 <b>renameToolBar</b>(<i>toolBar, title</i>)
412 <p>
413 Public method to give a toolbar a new title.
414 </p><dl>
415 <dt><i>toolBar</i></dt>
416 <dd>
417 reference to the toolbar to be managed (QToolBar)
418 </dd><dt><i>title</i></dt>
419 <dd>
420 title to be used for the toolbar (string)
421 </dd>
422 </dl><a NAME="E5ToolBarManager.resetAllToolBars" ID="E5ToolBarManager.resetAllToolBars"></a>
423 <h4>E5ToolBarManager.resetAllToolBars</h4>
424 <b>resetAllToolBars</b>(<i></i>)
425 <p>
426 Public method to reset all toolbars to their default state.
427 </p><a NAME="E5ToolBarManager.resetToolBar" ID="E5ToolBarManager.resetToolBar"></a>
428 <h4>E5ToolBarManager.resetToolBar</h4>
429 <b>resetToolBar</b>(<i>toolBar</i>)
430 <p>
431 Public method to reset a toolbar to its default state.
432 </p><dl>
433 <dt><i>toolBar</i></dt>
434 <dd>
435 reference to the toolbar to configure (QToolBar)
436 </dd>
437 </dl><a NAME="E5ToolBarManager.restoreState" ID="E5ToolBarManager.restoreState"></a>
438 <h4>E5ToolBarManager.restoreState</h4>
439 <b>restoreState</b>(<i>state, version=0</i>)
440 <p>
441 Public method to restore the state of the toolbar manager.
442 </p><dl>
443 <dt><i>state</i></dt>
444 <dd>
445 byte array containing the saved state (QByteArray)
446 </dd><dt><i>version</i></dt>
447 <dd>
448 version number stored with the data (integer)
449 </dd>
450 </dl><dl>
451 <dt>Returns:</dt>
452 <dd>
453 flag indicating success (boolean)
454 </dd>
455 </dl><a NAME="E5ToolBarManager.saveState" ID="E5ToolBarManager.saveState"></a>
456 <h4>E5ToolBarManager.saveState</h4>
457 <b>saveState</b>(<i>version=0</i>)
458 <p>
459 Public method to save the state of the toolbar manager.
460 </p><dl>
461 <dt><i>version</i></dt>
462 <dd>
463 version number stored with the data (integer)
464 </dd>
465 </dl><dl>
466 <dt>Returns:</dt>
467 <dd>
468 saved state as a byte array (QByteArray)
469 </dd>
470 </dl><a NAME="E5ToolBarManager.setMainWindow" ID="E5ToolBarManager.setMainWindow"></a>
471 <h4>E5ToolBarManager.setMainWindow</h4>
472 <b>setMainWindow</b>(<i>mainWindow</i>)
473 <p>
474 Public method to set the reference to the main window.
475 </p><dl>
476 <dt><i>mainWindow</i></dt>
477 <dd>
478 reference to the main window (QMainWindow)
479 </dd>
480 </dl><a NAME="E5ToolBarManager.setToolBar" ID="E5ToolBarManager.setToolBar"></a>
481 <h4>E5ToolBarManager.setToolBar</h4>
482 <b>setToolBar</b>(<i>toolBar, actions</i>)
483 <p>
484 Public method to set the actions of a toolbar.
485 </p><dl>
486 <dt><i>toolBar</i></dt>
487 <dd>
488 reference to the toolbar to configure (QToolBar)
489 </dd><dt><i>actions</i></dt>
490 <dd>
491 list of actions to be set (list of QAction)
492 </dd>
493 </dl><a NAME="E5ToolBarManager.setToolBars" ID="E5ToolBarManager.setToolBars"></a>
494 <h4>E5ToolBarManager.setToolBars</h4>
495 <b>setToolBars</b>(<i>toolBars</i>)
496 <p>
497 Public method to set the actions of several toolbars.
498 </p><dl>
499 <dt><i>toolBars</i></dt>
500 <dd>
501 dictionary with toolbar id as key and
502 a list of actions as value
503 </dd>
504 </dl><a NAME="E5ToolBarManager.toolBarActions" ID="E5ToolBarManager.toolBarActions"></a>
505 <h4>E5ToolBarManager.toolBarActions</h4>
506 <b>toolBarActions</b>(<i>tbID</i>)
507 <p>
508 Public method to get a toolbar's actions given its id.
509 </p><dl>
510 <dt><i>tbID</i></dt>
511 <dd>
512 id of the toolbar object (integer)
513 </dd>
514 </dl><dl>
515 <dt>Returns:</dt>
516 <dd>
517 list of actions (list of QAction)
518 </dd>
519 </dl><a NAME="E5ToolBarManager.toolBarById" ID="E5ToolBarManager.toolBarById"></a>
520 <h4>E5ToolBarManager.toolBarById</h4>
521 <b>toolBarById</b>(<i>tbID</i>)
522 <p>
523 Public method to get a toolbar given its id.
524 </p><dl>
525 <dt><i>tbID</i></dt>
526 <dd>
527 id of the toolbar object (integer)
528 </dd>
529 </dl><dl>
530 <dt>Returns:</dt>
531 <dd>
532 reference to the toolbar (QToolBar)
533 </dd>
534 </dl><a NAME="E5ToolBarManager.toolBarWidgetAction" ID="E5ToolBarManager.toolBarWidgetAction"></a>
535 <h4>E5ToolBarManager.toolBarWidgetAction</h4>
536 <b>toolBarWidgetAction</b>(<i>action</i>)
537 <p>
538 Public method to get the toolbar for a widget action.
539 </p><dl>
540 <dt><i>action</i></dt>
541 <dd>
542 widget action to check for (QAction)
543 </dd>
544 </dl><dl>
545 <dt>Returns:</dt>
546 <dd>
547 reference to the toolbar containing action (QToolBar)
548 </dd>
549 </dl><a NAME="E5ToolBarManager.toolBars" ID="E5ToolBarManager.toolBars"></a>
550 <h4>E5ToolBarManager.toolBars</h4>
551 <b>toolBars</b>(<i></i>)
552 <p>
553 Public method to get all toolbars.
554 </p><dl>
555 <dt>Returns:</dt>
556 <dd>
557 list of all toolbars (list of QToolBar)
558 </dd>
559 </dl><a NAME="E5ToolBarManager.toolBarsActions" ID="E5ToolBarManager.toolBarsActions"></a>
560 <h4>E5ToolBarManager.toolBarsActions</h4>
561 <b>toolBarsActions</b>(<i></i>)
562 <p>
563 Public method to get all toolbars and their actions.
564 </p><dl>
565 <dt>Returns:</dt>
566 <dd>
567 reference to dictionary of toolbar IDs as key and list
568 of actions as values
569 </dd>
570 </dl>
571 <div align="right"><a href="#top">Up</a></div>
572 <hr />
573 </body></html>

eric ide

mercurial