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