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