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