Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.MultiProject.MultiProject.html
Documentation/Source/eric5.MultiProject.MultiProject.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.MultiProject.MultiProject</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.MultiProject.MultiProject</h1> | |
| 12 <p> | |
| 13 Module implementing the multi project management functionality. | |
| 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="#MultiProject">MultiProject</a></td> | |
| 23 <td>Class implementing the project management functionality.</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="MultiProject" ID="MultiProject"></a> | |
| 32 <h2>MultiProject</h2> | |
| 33 <p> | |
| 34 Class implementing the project management functionality. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>dirty(int)</dt> | |
| 38 <dd> | |
| 39 emitted when the dirty state changes | |
| 40 </dd><dt>multiProjectClosed()</dt> | |
| 41 <dd> | |
| 42 emitted after a multi project was closed | |
| 43 </dd><dt>multiProjectOpened()</dt> | |
| 44 <dd> | |
| 45 emitted after a multi project file was read | |
| 46 </dd><dt>multiProjectPropertiesChanged()</dt> | |
| 47 <dd> | |
| 48 emitted after the multi project | |
| 49 properties were changed | |
| 50 </dd><dt>newMultiProject()</dt> | |
| 51 <dd> | |
| 52 emitted after a new multi project was generated | |
| 53 </dd><dt>projectAdded(project data dict)</dt> | |
| 54 <dd> | |
| 55 emitted after a project entry | |
| 56 has been added | |
| 57 </dd><dt>projectDataChanged(project data dict)</dt> | |
| 58 <dd> | |
| 59 emitted after a project entry | |
| 60 has been changed | |
| 61 </dd><dt>projectOpened(filename)</dt> | |
| 62 <dd> | |
| 63 emitted after the project has been opened | |
| 64 </dd><dt>projectRemoved(project data dict)</dt> | |
| 65 <dd> | |
| 66 emitted after a project entry | |
| 67 has been removed | |
| 68 </dd><dt>showMenu(string, QMenu)</dt> | |
| 69 <dd> | |
| 70 emitted when a menu is about to be shown. | |
| 71 The name of the menu and a reference to the menu are given. | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <h3>Derived from</h3> | |
| 75 QObject | |
| 76 <h3>Class Attributes</h3> | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 <h3>Methods</h3> | |
| 81 <table> | |
| 82 <tr> | |
| 83 <td><a href="#MultiProject.__init__">MultiProject</a></td> | |
| 84 <td>Constructor</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#MultiProject.__checkFilesExist">__checkFilesExist</a></td> | |
| 87 <td>Private method to check, if the files in a list exist.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#MultiProject.__clearRecent">__clearRecent</a></td> | |
| 90 <td>Private method to clear the recent multi projects menu.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#MultiProject.__initData">__initData</a></td> | |
| 93 <td>Private method to initialize the multi project data part.</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#MultiProject.__loadRecent">__loadRecent</a></td> | |
| 96 <td>Private method to load the recently opened multi project filenames.</td> | |
| 97 </tr><tr> | |
| 98 <td><a href="#MultiProject.__openMasterProject">__openMasterProject</a></td> | |
| 99 <td>Public slot to open the master project.</td> | |
| 100 </tr><tr> | |
| 101 <td><a href="#MultiProject.__openRecent">__openRecent</a></td> | |
| 102 <td>Private method to open a multi project from the list of rencently opened multi projects.</td> | |
| 103 </tr><tr> | |
| 104 <td><a href="#MultiProject.__readMultiProject">__readMultiProject</a></td> | |
| 105 <td>Private method to read in a multi project (.e4m, .e4mz) file.</td> | |
| 106 </tr><tr> | |
| 107 <td><a href="#MultiProject.__readXMLMultiProject">__readXMLMultiProject</a></td> | |
| 108 <td>Private method to read the multi project data from an XML file.</td> | |
| 109 </tr><tr> | |
| 110 <td><a href="#MultiProject.__saveRecent">__saveRecent</a></td> | |
| 111 <td>Private method to save the list of recently opened filenames.</td> | |
| 112 </tr><tr> | |
| 113 <td><a href="#MultiProject.__showContextMenuRecent">__showContextMenuRecent</a></td> | |
| 114 <td>Private method to set up the recent multi projects menu.</td> | |
| 115 </tr><tr> | |
| 116 <td><a href="#MultiProject.__showMenu">__showMenu</a></td> | |
| 117 <td>Private method to set up the multi project menu.</td> | |
| 118 </tr><tr> | |
| 119 <td><a href="#MultiProject.__showProperties">__showProperties</a></td> | |
| 120 <td>Private slot to display the properties dialog.</td> | |
| 121 </tr><tr> | |
| 122 <td><a href="#MultiProject.__syncRecent">__syncRecent</a></td> | |
| 123 <td>Private method to synchronize the list of recently opened multi projects with the central store.</td> | |
| 124 </tr><tr> | |
| 125 <td><a href="#MultiProject.__writeMultiProject">__writeMultiProject</a></td> | |
| 126 <td>Private method to save the multi project infos to a multi project file.</td> | |
| 127 </tr><tr> | |
| 128 <td><a href="#MultiProject.__writeXMLMultiProject">__writeXMLMultiProject</a></td> | |
| 129 <td>Private method to write the multi project data to an XML file.</td> | |
| 130 </tr><tr> | |
| 131 <td><a href="#MultiProject.addE4Actions">addE4Actions</a></td> | |
| 132 <td>Public method to add actions to the list of actions.</td> | |
| 133 </tr><tr> | |
| 134 <td><a href="#MultiProject.addProject">addProject</a></td> | |
| 135 <td>Public slot used to add files to the project.</td> | |
| 136 </tr><tr> | |
| 137 <td><a href="#MultiProject.changeProjectProperties">changeProjectProperties</a></td> | |
| 138 <td>Public method to change the data of a project entry.</td> | |
| 139 </tr><tr> | |
| 140 <td><a href="#MultiProject.checkDirty">checkDirty</a></td> | |
| 141 <td>Public method to check the dirty status and open a message window.</td> | |
| 142 </tr><tr> | |
| 143 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td> | |
| 144 <td>Public slot to close the current multi project.</td> | |
| 145 </tr><tr> | |
| 146 <td><a href="#MultiProject.getActions">getActions</a></td> | |
| 147 <td>Public method to get a list of all actions.</td> | |
| 148 </tr><tr> | |
| 149 <td><a href="#MultiProject.getDependantProjectFiles">getDependantProjectFiles</a></td> | |
| 150 <td>Public method to get the filenames of the dependant projects.</td> | |
| 151 </tr><tr> | |
| 152 <td><a href="#MultiProject.getMasterProjectFile">getMasterProjectFile</a></td> | |
| 153 <td>Public method to get the filename of the master project.</td> | |
| 154 </tr><tr> | |
| 155 <td><a href="#MultiProject.getMenu">getMenu</a></td> | |
| 156 <td>Public method to get a reference to the main menu or a submenu.</td> | |
| 157 </tr><tr> | |
| 158 <td><a href="#MultiProject.getMostRecent">getMostRecent</a></td> | |
| 159 <td>Public method to get the most recently opened multiproject.</td> | |
| 160 </tr><tr> | |
| 161 <td><a href="#MultiProject.getMultiProjectFile">getMultiProjectFile</a></td> | |
| 162 <td>Public method to get the path of the multi project file.</td> | |
| 163 </tr><tr> | |
| 164 <td><a href="#MultiProject.getMultiProjectPath">getMultiProjectPath</a></td> | |
| 165 <td>Public method to get the multi project path.</td> | |
| 166 </tr><tr> | |
| 167 <td><a href="#MultiProject.getProject">getProject</a></td> | |
| 168 <td>Public method to get a reference to a project entry.</td> | |
| 169 </tr><tr> | |
| 170 <td><a href="#MultiProject.getProjects">getProjects</a></td> | |
| 171 <td>Public method to get all project entries.</td> | |
| 172 </tr><tr> | |
| 173 <td><a href="#MultiProject.initActions">initActions</a></td> | |
| 174 <td>Public slot to initialize the multi project related actions.</td> | |
| 175 </tr><tr> | |
| 176 <td><a href="#MultiProject.initMenu">initMenu</a></td> | |
| 177 <td>Public slot to initialize the multi project menu.</td> | |
| 178 </tr><tr> | |
| 179 <td><a href="#MultiProject.initToolbar">initToolbar</a></td> | |
| 180 <td>Public slot to initialize the multi project toolbar.</td> | |
| 181 </tr><tr> | |
| 182 <td><a href="#MultiProject.isDirty">isDirty</a></td> | |
| 183 <td>Public method to return the dirty state.</td> | |
| 184 </tr><tr> | |
| 185 <td><a href="#MultiProject.isOpen">isOpen</a></td> | |
| 186 <td>Public method to return the opened state.</td> | |
| 187 </tr><tr> | |
| 188 <td><a href="#MultiProject.newMultiProject">newMultiProject</a></td> | |
| 189 <td>Public slot to build a new multi project.</td> | |
| 190 </tr><tr> | |
| 191 <td><a href="#MultiProject.openMultiProject">openMultiProject</a></td> | |
| 192 <td>Public slot to open a multi project.</td> | |
| 193 </tr><tr> | |
| 194 <td><a href="#MultiProject.openProject">openProject</a></td> | |
| 195 <td>Public slot to open a project.</td> | |
| 196 </tr><tr> | |
| 197 <td><a href="#MultiProject.removeE4Actions">removeE4Actions</a></td> | |
| 198 <td>Public method to remove actions from the list of actions.</td> | |
| 199 </tr><tr> | |
| 200 <td><a href="#MultiProject.removeProject">removeProject</a></td> | |
| 201 <td>Public slot to remove a project from the multi project.</td> | |
| 202 </tr><tr> | |
| 203 <td><a href="#MultiProject.saveMultiProject">saveMultiProject</a></td> | |
| 204 <td>Public slot to save the current multi project.</td> | |
| 205 </tr><tr> | |
| 206 <td><a href="#MultiProject.saveMultiProjectAs">saveMultiProjectAs</a></td> | |
| 207 <td>Public slot to save the current multi project to a different file.</td> | |
| 208 </tr><tr> | |
| 209 <td><a href="#MultiProject.setDirty">setDirty</a></td> | |
| 210 <td>Public method to set the dirty state.</td> | |
| 211 </tr> | |
| 212 </table> | |
| 213 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a> | |
| 214 <h4>MultiProject (Constructor)</h4> | |
| 215 <b>MultiProject</b>(<i>project, parent = None, filename = None</i>) | |
| 216 <p> | |
| 217 Constructor | |
| 218 </p><dl> | |
| 219 <dt><i>project</i></dt> | |
| 220 <dd> | |
| 221 reference to the project object (Project.Project) | |
| 222 </dd><dt><i>parent</i></dt> | |
| 223 <dd> | |
| 224 parent widget (usually the ui object) (QWidget) | |
| 225 </dd><dt><i>filename</i></dt> | |
| 226 <dd> | |
| 227 optional filename of a multi project file to open (string) | |
| 228 </dd> | |
| 229 </dl><a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a> | |
| 230 <h4>MultiProject.__checkFilesExist</h4> | |
| 231 <b>__checkFilesExist</b>(<i></i>) | |
| 232 <p> | |
| 233 Private method to check, if the files in a list exist. | |
| 234 </p><p> | |
| 235 The project files are checked for existance in the | |
| 236 filesystem. Non existant projects are removed from the list and the | |
| 237 dirty state of the multi project is changed accordingly. | |
| 238 </p><a NAME="MultiProject.__clearRecent" ID="MultiProject.__clearRecent"></a> | |
| 239 <h4>MultiProject.__clearRecent</h4> | |
| 240 <b>__clearRecent</b>(<i></i>) | |
| 241 <p> | |
| 242 Private method to clear the recent multi projects menu. | |
| 243 </p><a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a> | |
| 244 <h4>MultiProject.__initData</h4> | |
| 245 <b>__initData</b>(<i></i>) | |
| 246 <p> | |
| 247 Private method to initialize the multi project data part. | |
| 248 </p><a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a> | |
| 249 <h4>MultiProject.__loadRecent</h4> | |
| 250 <b>__loadRecent</b>(<i></i>) | |
| 251 <p> | |
| 252 Private method to load the recently opened multi project filenames. | |
| 253 </p><a NAME="MultiProject.__openMasterProject" ID="MultiProject.__openMasterProject"></a> | |
| 254 <h4>MultiProject.__openMasterProject</h4> | |
| 255 <b>__openMasterProject</b>(<i>reopen = True</i>) | |
| 256 <p> | |
| 257 Public slot to open the master project. | |
| 258 </p><dl> | |
| 259 <dt><i>reopen</i></dt> | |
| 260 <dd> | |
| 261 flag indicating, that the master project should be | |
| 262 reopened, if it has been opened already (boolean) | |
| 263 </dd> | |
| 264 </dl><a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a> | |
| 265 <h4>MultiProject.__openRecent</h4> | |
| 266 <b>__openRecent</b>(<i>act</i>) | |
| 267 <p> | |
| 268 Private method to open a multi project from the list of rencently | |
| 269 opened multi projects. | |
| 270 </p><dl> | |
| 271 <dt><i>act</i></dt> | |
| 272 <dd> | |
| 273 reference to the action that triggered (QAction) | |
| 274 </dd> | |
| 275 </dl><a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a> | |
| 276 <h4>MultiProject.__readMultiProject</h4> | |
| 277 <b>__readMultiProject</b>(<i>fn</i>) | |
| 278 <p> | |
| 279 Private method to read in a multi project (.e4m, .e4mz) file. | |
| 280 </p><dl> | |
| 281 <dt><i>fn</i></dt> | |
| 282 <dd> | |
| 283 filename of the multi project file to be read (string) | |
| 284 </dd> | |
| 285 </dl><dl> | |
| 286 <dt>Returns:</dt> | |
| 287 <dd> | |
| 288 flag indicating success | |
| 289 </dd> | |
| 290 </dl><a NAME="MultiProject.__readXMLMultiProject" ID="MultiProject.__readXMLMultiProject"></a> | |
| 291 <h4>MultiProject.__readXMLMultiProject</h4> | |
| 292 <b>__readXMLMultiProject</b>(<i>fn, validating</i>) | |
| 293 <p> | |
| 294 Private method to read the multi project data from an XML file. | |
| 295 </p><dl> | |
| 296 <dt><i>fn</i></dt> | |
| 297 <dd> | |
| 298 filename of the multi project file to be read (string) | |
| 299 </dd><dt><i>validating</i></dt> | |
| 300 <dd> | |
| 301 flag indicating a validation of the XML file is | |
| 302 requested (boolean) | |
| 303 </dd> | |
| 304 </dl><dl> | |
| 305 <dt>Returns:</dt> | |
| 306 <dd> | |
| 307 flag indicating success | |
| 308 </dd> | |
| 309 </dl><a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> | |
| 310 <h4>MultiProject.__saveRecent</h4> | |
| 311 <b>__saveRecent</b>(<i></i>) | |
| 312 <p> | |
| 313 Private method to save the list of recently opened filenames. | |
| 314 </p><a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a> | |
| 315 <h4>MultiProject.__showContextMenuRecent</h4> | |
| 316 <b>__showContextMenuRecent</b>(<i></i>) | |
| 317 <p> | |
| 318 Private method to set up the recent multi projects menu. | |
| 319 </p><a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a> | |
| 320 <h4>MultiProject.__showMenu</h4> | |
| 321 <b>__showMenu</b>(<i></i>) | |
| 322 <p> | |
| 323 Private method to set up the multi project menu. | |
| 324 </p><a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a> | |
| 325 <h4>MultiProject.__showProperties</h4> | |
| 326 <b>__showProperties</b>(<i></i>) | |
| 327 <p> | |
| 328 Private slot to display the properties dialog. | |
| 329 </p><a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a> | |
| 330 <h4>MultiProject.__syncRecent</h4> | |
| 331 <b>__syncRecent</b>(<i></i>) | |
| 332 <p> | |
| 333 Private method to synchronize the list of recently opened multi projects | |
| 334 with the central store. | |
| 335 </p><a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a> | |
| 336 <h4>MultiProject.__writeMultiProject</h4> | |
| 337 <b>__writeMultiProject</b>(<i>fn = None</i>) | |
| 338 <p> | |
| 339 Private method to save the multi project infos to a multi project file. | |
| 340 </p><dl> | |
| 341 <dt><i>fn</i></dt> | |
| 342 <dd> | |
| 343 optional filename of the multi project file to be written. | |
| 344 If fn is None, the filename stored in the multi project object | |
| 345 is used. This is the 'save' action. If fn is given, this filename | |
| 346 is used instead of the one in the multi project object. This is the | |
| 347 'save as' action. | |
| 348 </dd> | |
| 349 </dl><dl> | |
| 350 <dt>Returns:</dt> | |
| 351 <dd> | |
| 352 flag indicating success | |
| 353 </dd> | |
| 354 </dl><a NAME="MultiProject.__writeXMLMultiProject" ID="MultiProject.__writeXMLMultiProject"></a> | |
| 355 <h4>MultiProject.__writeXMLMultiProject</h4> | |
| 356 <b>__writeXMLMultiProject</b>(<i>fn = None</i>) | |
| 357 <p> | |
| 358 Private method to write the multi project data to an XML file. | |
| 359 </p><dl> | |
| 360 <dt><i>fn</i></dt> | |
| 361 <dd> | |
| 362 the filename of the multi project file (string) | |
| 363 </dd> | |
| 364 </dl><a NAME="MultiProject.addE4Actions" ID="MultiProject.addE4Actions"></a> | |
| 365 <h4>MultiProject.addE4Actions</h4> | |
| 366 <b>addE4Actions</b>(<i>actions</i>) | |
| 367 <p> | |
| 368 Public method to add actions to the list of actions. | |
| 369 </p><dl> | |
| 370 <dt><i>actions</i></dt> | |
| 371 <dd> | |
| 372 list of actions (list of E4Action) | |
| 373 </dd> | |
| 374 </dl><a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a> | |
| 375 <h4>MultiProject.addProject</h4> | |
| 376 <b>addProject</b>(<i>startdir = None</i>) | |
| 377 <p> | |
| 378 Public slot used to add files to the project. | |
| 379 </p><dl> | |
| 380 <dt><i>startdir</i></dt> | |
| 381 <dd> | |
| 382 start directory for the selection dialog (string) | |
| 383 </dd> | |
| 384 </dl><a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a> | |
| 385 <h4>MultiProject.changeProjectProperties</h4> | |
| 386 <b>changeProjectProperties</b>(<i>pro</i>) | |
| 387 <p> | |
| 388 Public method to change the data of a project entry. | |
| 389 </p><dl> | |
| 390 <dt><i>pro</i></dt> | |
| 391 <dd> | |
| 392 dictionary with the project data (string) | |
| 393 </dd> | |
| 394 </dl><a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a> | |
| 395 <h4>MultiProject.checkDirty</h4> | |
| 396 <b>checkDirty</b>(<i></i>) | |
| 397 <p> | |
| 398 Public method to check the dirty status and open a message window. | |
| 399 </p><dl> | |
| 400 <dt>Returns:</dt> | |
| 401 <dd> | |
| 402 flag indicating whether this operation was successful (boolean) | |
| 403 </dd> | |
| 404 </dl><a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a> | |
| 405 <h4>MultiProject.closeMultiProject</h4> | |
| 406 <b>closeMultiProject</b>(<i></i>) | |
| 407 <p> | |
| 408 Public slot to close the current multi project. | |
| 409 </p><dl> | |
| 410 <dt>Returns:</dt> | |
| 411 <dd> | |
| 412 flag indicating success (boolean) | |
| 413 </dd> | |
| 414 </dl><a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a> | |
| 415 <h4>MultiProject.getActions</h4> | |
| 416 <b>getActions</b>(<i></i>) | |
| 417 <p> | |
| 418 Public method to get a list of all actions. | |
| 419 </p><dl> | |
| 420 <dt>Returns:</dt> | |
| 421 <dd> | |
| 422 list of all actions (list of E4Action) | |
| 423 </dd> | |
| 424 </dl><a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> | |
| 425 <h4>MultiProject.getDependantProjectFiles</h4> | |
| 426 <b>getDependantProjectFiles</b>(<i></i>) | |
| 427 <p> | |
| 428 Public method to get the filenames of the dependant projects. | |
| 429 </p><dl> | |
| 430 <dt>Returns:</dt> | |
| 431 <dd> | |
| 432 names of the dependant project files (list of strings) | |
| 433 </dd> | |
| 434 </dl><a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a> | |
| 435 <h4>MultiProject.getMasterProjectFile</h4> | |
| 436 <b>getMasterProjectFile</b>(<i></i>) | |
| 437 <p> | |
| 438 Public method to get the filename of the master project. | |
| 439 </p><dl> | |
| 440 <dt>Returns:</dt> | |
| 441 <dd> | |
| 442 name of the master project file (string) | |
| 443 </dd> | |
| 444 </dl><a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a> | |
| 445 <h4>MultiProject.getMenu</h4> | |
| 446 <b>getMenu</b>(<i>menuName</i>) | |
| 447 <p> | |
| 448 Public method to get a reference to the main menu or a submenu. | |
| 449 </p><dl> | |
| 450 <dt><i>menuName</i></dt> | |
| 451 <dd> | |
| 452 name of the menu (string) | |
| 453 </dd> | |
| 454 </dl><dl> | |
| 455 <dt>Returns:</dt> | |
| 456 <dd> | |
| 457 reference to the requested menu (QMenu) or None | |
| 458 </dd> | |
| 459 </dl><a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> | |
| 460 <h4>MultiProject.getMostRecent</h4> | |
| 461 <b>getMostRecent</b>(<i></i>) | |
| 462 <p> | |
| 463 Public method to get the most recently opened multiproject. | |
| 464 </p><dl> | |
| 465 <dt>Returns:</dt> | |
| 466 <dd> | |
| 467 path of the most recently opened multiproject (string) | |
| 468 </dd> | |
| 469 </dl><a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> | |
| 470 <h4>MultiProject.getMultiProjectFile</h4> | |
| 471 <b>getMultiProjectFile</b>(<i></i>) | |
| 472 <p> | |
| 473 Public method to get the path of the multi project file. | |
| 474 </p><dl> | |
| 475 <dt>Returns:</dt> | |
| 476 <dd> | |
| 477 path of the multi project file (string) | |
| 478 </dd> | |
| 479 </dl><a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> | |
| 480 <h4>MultiProject.getMultiProjectPath</h4> | |
| 481 <b>getMultiProjectPath</b>(<i></i>) | |
| 482 <p> | |
| 483 Public method to get the multi project path. | |
| 484 </p><dl> | |
| 485 <dt>Returns:</dt> | |
| 486 <dd> | |
| 487 multi project path (string) | |
| 488 </dd> | |
| 489 </dl><a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> | |
| 490 <h4>MultiProject.getProject</h4> | |
| 491 <b>getProject</b>(<i>fn</i>) | |
| 492 <p> | |
| 493 Public method to get a reference to a project entry. | |
| 494 </p><dl> | |
| 495 <dt><i>fn</i></dt> | |
| 496 <dd> | |
| 497 filename of the project (string) | |
| 498 </dd> | |
| 499 </dl><dl> | |
| 500 <dt>Returns:</dt> | |
| 501 <dd> | |
| 502 dictionary containing the project data | |
| 503 </dd> | |
| 504 </dl><a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a> | |
| 505 <h4>MultiProject.getProjects</h4> | |
| 506 <b>getProjects</b>(<i></i>) | |
| 507 <p> | |
| 508 Public method to get all project entries. | |
| 509 </p><dl> | |
| 510 <dt>Returns:</dt> | |
| 511 <dd> | |
| 512 list of all project entries (list of dictionaries) | |
| 513 </dd> | |
| 514 </dl><a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> | |
| 515 <h4>MultiProject.initActions</h4> | |
| 516 <b>initActions</b>(<i></i>) | |
| 517 <p> | |
| 518 Public slot to initialize the multi project related actions. | |
| 519 </p><a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a> | |
| 520 <h4>MultiProject.initMenu</h4> | |
| 521 <b>initMenu</b>(<i></i>) | |
| 522 <p> | |
| 523 Public slot to initialize the multi project menu. | |
| 524 </p><dl> | |
| 525 <dt>Returns:</dt> | |
| 526 <dd> | |
| 527 the menu generated (QMenu) | |
| 528 </dd> | |
| 529 </dl><a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> | |
| 530 <h4>MultiProject.initToolbar</h4> | |
| 531 <b>initToolbar</b>(<i>toolbarManager</i>) | |
| 532 <p> | |
| 533 Public slot to initialize the multi project toolbar. | |
| 534 </p><dl> | |
| 535 <dt><i>toolbarManager</i></dt> | |
| 536 <dd> | |
| 537 reference to a toolbar manager object (E4ToolBarManager) | |
| 538 </dd> | |
| 539 </dl><dl> | |
| 540 <dt>Returns:</dt> | |
| 541 <dd> | |
| 542 the toolbar generated (QToolBar) | |
| 543 </dd> | |
| 544 </dl><a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> | |
| 545 <h4>MultiProject.isDirty</h4> | |
| 546 <b>isDirty</b>(<i></i>) | |
| 547 <p> | |
| 548 Public method to return the dirty state. | |
| 549 </p><dl> | |
| 550 <dt>Returns:</dt> | |
| 551 <dd> | |
| 552 dirty state (boolean) | |
| 553 </dd> | |
| 554 </dl><a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> | |
| 555 <h4>MultiProject.isOpen</h4> | |
| 556 <b>isOpen</b>(<i></i>) | |
| 557 <p> | |
| 558 Public method to return the opened state. | |
| 559 </p><dl> | |
| 560 <dt>Returns:</dt> | |
| 561 <dd> | |
| 562 open state (boolean) | |
| 563 </dd> | |
| 564 </dl><a NAME="MultiProject.newMultiProject" ID="MultiProject.newMultiProject"></a> | |
| 565 <h4>MultiProject.newMultiProject</h4> | |
| 566 <b>newMultiProject</b>(<i></i>) | |
| 567 <p> | |
| 568 Public slot to build a new multi project. | |
| 569 </p><p> | |
| 570 This method displays the new multi project dialog and initializes | |
| 571 the multi project object with the data entered. | |
| 572 </p><a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> | |
| 573 <h4>MultiProject.openMultiProject</h4> | |
| 574 <b>openMultiProject</b>(<i>fn = None, openMaster = True</i>) | |
| 575 <p> | |
| 576 Public slot to open a multi project. | |
| 577 </p><dl> | |
| 578 <dt><i>fn</i></dt> | |
| 579 <dd> | |
| 580 optional filename of the multi project file to be read (string) | |
| 581 </dd><dt><i>openMaster</i></dt> | |
| 582 <dd> | |
| 583 flag indicating, that the master project | |
| 584 should be opened depending on the configuration (boolean) | |
| 585 </dd> | |
| 586 </dl><a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a> | |
| 587 <h4>MultiProject.openProject</h4> | |
| 588 <b>openProject</b>(<i>filename</i>) | |
| 589 <p> | |
| 590 Public slot to open a project. | |
| 591 </p><dl> | |
| 592 <dt><i>filename</i></dt> | |
| 593 <dd> | |
| 594 filename of the project file (string) | |
| 595 </dd> | |
| 596 </dl><a NAME="MultiProject.removeE4Actions" ID="MultiProject.removeE4Actions"></a> | |
| 597 <h4>MultiProject.removeE4Actions</h4> | |
| 598 <b>removeE4Actions</b>(<i>actions</i>) | |
| 599 <p> | |
| 600 Public method to remove actions from the list of actions. | |
| 601 </p><dl> | |
| 602 <dt><i>actions</i></dt> | |
| 603 <dd> | |
| 604 list of actions (list of E4Action) | |
| 605 </dd> | |
| 606 </dl><a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a> | |
| 607 <h4>MultiProject.removeProject</h4> | |
| 608 <b>removeProject</b>(<i>fn</i>) | |
| 609 <p> | |
| 610 Public slot to remove a project from the multi project. | |
| 611 </p><dl> | |
| 612 <dt><i>fn</i></dt> | |
| 613 <dd> | |
| 614 filename of the project to be removed from the multi project (string) | |
| 615 </dd> | |
| 616 </dl><a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a> | |
| 617 <h4>MultiProject.saveMultiProject</h4> | |
| 618 <b>saveMultiProject</b>(<i></i>) | |
| 619 <p> | |
| 620 Public slot to save the current multi project. | |
| 621 </p><dl> | |
| 622 <dt>Returns:</dt> | |
| 623 <dd> | |
| 624 flag indicating success (boolean) | |
| 625 </dd> | |
| 626 </dl><a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a> | |
| 627 <h4>MultiProject.saveMultiProjectAs</h4> | |
| 628 <b>saveMultiProjectAs</b>(<i></i>) | |
| 629 <p> | |
| 630 Public slot to save the current multi project to a different file. | |
| 631 </p><dl> | |
| 632 <dt>Returns:</dt> | |
| 633 <dd> | |
| 634 flag indicating success (boolean) | |
| 635 </dd> | |
| 636 </dl><a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a> | |
| 637 <h4>MultiProject.setDirty</h4> | |
| 638 <b>setDirty</b>(<i>b</i>) | |
| 639 <p> | |
| 640 Public method to set the dirty state. | |
| 641 </p><p> | |
| 642 It emits the signal dirty(int). | |
| 643 </p><dl> | |
| 644 <dt><i>b</i></dt> | |
| 645 <dd> | |
| 646 dirty state (boolean) | |
| 647 </dd> | |
| 648 </dl> | |
| 649 <div align="right"><a href="#top">Up</a></div> | |
| 650 <hr /> | |
| 651 </body></html> |
