Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html
src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9971
- 773ad1f1ed22
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.MultiProject.MultiProject</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.MultiProject.MultiProject</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the multi project management functionality. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#MultiProject">MultiProject</a></td> | |
| 25 <td>Class implementing the project management functionality.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="MultiProject" ID="MultiProject"></a> | |
| 36 <h2>MultiProject</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the project management functionality. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>dirty(bool)</dt> | |
| 45 <dd> | |
| 46 emitted when the dirty state changes | |
| 47 </dd> | |
| 48 <dt>multiProjectClosed()</dt> | |
| 49 <dd> | |
| 50 emitted after a multi project was closed | |
| 51 </dd> | |
| 52 <dt>multiProjectOpened()</dt> | |
| 53 <dd> | |
| 54 emitted after a multi project file was read | |
| 55 </dd> | |
| 56 <dt>multiProjectPropertiesChanged()</dt> | |
| 57 <dd> | |
| 58 emitted after the multi project | |
| 59 properties were changed | |
| 60 </dd> | |
| 61 <dt>newMultiProject()</dt> | |
| 62 <dd> | |
| 63 emitted after a new multi project was generated | |
| 64 </dd> | |
| 65 <dt>projectAdded(project data dict)</dt> | |
| 66 <dd> | |
| 67 emitted after a project entry | |
| 68 has been added | |
| 69 </dd> | |
| 70 <dt>projectDataChanged(project data dict)</dt> | |
| 71 <dd> | |
| 72 emitted after a project entry | |
| 73 has been changed | |
| 74 </dd> | |
| 75 <dt>projectOpened(filename)</dt> | |
| 76 <dd> | |
| 77 emitted after the project has been opened | |
| 78 </dd> | |
| 79 <dt>projectRemoved(project data dict)</dt> | |
| 80 <dd> | |
| 81 emitted after a project entry | |
| 82 has been removed | |
| 83 </dd> | |
| 84 <dt>showMenu(string, QMenu)</dt> | |
| 85 <dd> | |
| 86 emitted when a menu is about to be shown. | |
| 87 The name of the menu and a reference to the menu are given. | |
| 88 </dd> | |
| 89 </dl> | |
| 90 <h3>Derived from</h3> | |
| 91 QObject | |
| 92 <h3>Class Attributes</h3> | |
| 93 | |
| 94 <table> | |
| 95 <tr><td>None</td></tr> | |
| 96 </table> | |
| 97 <h3>Class Methods</h3> | |
| 98 | |
| 99 <table> | |
| 100 <tr><td>None</td></tr> | |
| 101 </table> | |
| 102 <h3>Methods</h3> | |
| 103 | |
| 104 <table> | |
| 105 | |
| 106 <tr> | |
| 107 <td><a href="#MultiProject.__init__">MultiProject</a></td> | |
| 108 <td>Constructor</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#MultiProject.__checkFilesExist">__checkFilesExist</a></td> | |
| 112 <td>Private method to check, if the files in a list exist.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#MultiProject.__extractCategories">__extractCategories</a></td> | |
| 116 <td>Private slot to extract the categories used in the project definitions.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#MultiProject.__initData">__initData</a></td> | |
| 120 <td>Private method to initialize the multi project data part.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#MultiProject.__loadRecent">__loadRecent</a></td> | |
| 124 <td>Private method to load the recently opened multi project filenames.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#MultiProject.__newMultiProject">__newMultiProject</a></td> | |
| 128 <td>Private slot to build a new multi project.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#MultiProject.__openMasterProject">__openMasterProject</a></td> | |
| 132 <td>Private slot to open the master project.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#MultiProject.__openRecent">__openRecent</a></td> | |
| 136 <td>Private method to open a multi project from the list of rencently opened multi projects.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#MultiProject.__readMultiProject">__readMultiProject</a></td> | |
| 140 <td>Private method to read in a multi project (.emj, .e4m, .e5m) file.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#MultiProject.__saveRecent">__saveRecent</a></td> | |
| 144 <td>Private method to save the list of recently opened filenames.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#MultiProject.__showContextMenuRecent">__showContextMenuRecent</a></td> | |
| 148 <td>Private method to set up the recent multi projects menu.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#MultiProject.__showMenu">__showMenu</a></td> | |
| 152 <td>Private method to set up the multi project menu.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#MultiProject.__showProperties">__showProperties</a></td> | |
| 156 <td>Private slot to display the properties dialog.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#MultiProject.__syncRecent">__syncRecent</a></td> | |
| 160 <td>Private method to synchronize the list of recently opened multi projects with the central store.</td> | |
| 161 </tr> | |
| 162 <tr> | |
| 163 <td><a href="#MultiProject.__writeMultiProject">__writeMultiProject</a></td> | |
| 164 <td>Private method to save the multi project infos to a multi project file.</td> | |
| 165 </tr> | |
| 166 <tr> | |
| 167 <td><a href="#MultiProject.addEricActions">addEricActions</a></td> | |
| 168 <td>Public method to add actions to the list of actions.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#MultiProject.addNewProject">addNewProject</a></td> | |
| 172 <td>Public slot used to add a new project to the multi-project.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#MultiProject.addProject">addProject</a></td> | |
| 176 <td>Public method to add a project to the multi-project.</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#MultiProject.changeProjectProperties">changeProjectProperties</a></td> | |
| 180 <td>Public method to change the data of a project entry.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#MultiProject.checkDirty">checkDirty</a></td> | |
| 184 <td>Public method to check the dirty status and open a message window.</td> | |
| 185 </tr> | |
| 186 <tr> | |
| 187 <td><a href="#MultiProject.clearRecent">clearRecent</a></td> | |
| 188 <td>Public method to clear the recent multi projects menu.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td> | |
| 192 <td>Public slot to close the current multi project.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#MultiProject.copyProject">copyProject</a></td> | |
| 196 <td>Public method to copy the project with given UID on disk.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#MultiProject.deleteProject">deleteProject</a></td> | |
| 200 <td>Public slot to delete project(s) from the multi project and disk.</td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#MultiProject.getActions">getActions</a></td> | |
| 204 <td>Public method to get a list of all actions.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#MultiProject.getCategories">getCategories</a></td> | |
| 208 <td>Public method to get the list of defined categories.</td> | |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#MultiProject.getDependantProjectFiles">getDependantProjectFiles</a></td> | |
| 212 <td>Public method to get the filenames of the dependent projects.</td> | |
| 213 </tr> | |
| 214 <tr> | |
| 215 <td><a href="#MultiProject.getMasterProjectFile">getMasterProjectFile</a></td> | |
| 216 <td>Public method to get the filename of the master project.</td> | |
| 217 </tr> | |
| 218 <tr> | |
| 219 <td><a href="#MultiProject.getMenu">getMenu</a></td> | |
| 220 <td>Public method to get a reference to the main menu or a submenu.</td> | |
| 221 </tr> | |
| 222 <tr> | |
| 223 <td><a href="#MultiProject.getMostRecent">getMostRecent</a></td> | |
| 224 <td>Public method to get the most recently opened multiproject.</td> | |
| 225 </tr> | |
| 226 <tr> | |
| 227 <td><a href="#MultiProject.getMultiProjectFile">getMultiProjectFile</a></td> | |
| 228 <td>Public method to get the path of the multi project file.</td> | |
| 229 </tr> | |
| 230 <tr> | |
| 231 <td><a href="#MultiProject.getMultiProjectPath">getMultiProjectPath</a></td> | |
| 232 <td>Public method to get the multi project path.</td> | |
| 233 </tr> | |
| 234 <tr> | |
| 235 <td><a href="#MultiProject.getProject">getProject</a></td> | |
| 236 <td>Public method to get a reference to a project entry.</td> | |
| 237 </tr> | |
| 238 <tr> | |
| 239 <td><a href="#MultiProject.getProjects">getProjects</a></td> | |
| 240 <td>Public method to get all project entries.</td> | |
| 241 </tr> | |
| 242 <tr> | |
| 243 <td><a href="#MultiProject.initActions">initActions</a></td> | |
| 244 <td>Public slot to initialize the multi project related actions.</td> | |
| 245 </tr> | |
| 246 <tr> | |
| 247 <td><a href="#MultiProject.initMenu">initMenu</a></td> | |
| 248 <td>Public slot to initialize the multi project menu.</td> | |
| 249 </tr> | |
| 250 <tr> | |
| 251 <td><a href="#MultiProject.initToolbar">initToolbar</a></td> | |
| 252 <td>Public slot to initialize the multi project toolbar.</td> | |
| 253 </tr> | |
| 254 <tr> | |
| 255 <td><a href="#MultiProject.isDirty">isDirty</a></td> | |
| 256 <td>Public method to return the dirty state.</td> | |
| 257 </tr> | |
| 258 <tr> | |
| 259 <td><a href="#MultiProject.isOpen">isOpen</a></td> | |
| 260 <td>Public method to return the opened state.</td> | |
| 261 </tr> | |
| 262 <tr> | |
| 263 <td><a href="#MultiProject.openMultiProject">openMultiProject</a></td> | |
| 264 <td>Public slot to open a multi project.</td> | |
| 265 </tr> | |
| 266 <tr> | |
| 267 <td><a href="#MultiProject.openProject">openProject</a></td> | |
| 268 <td>Public slot to open a project.</td> | |
| 269 </tr> | |
| 270 <tr> | |
| 271 <td><a href="#MultiProject.removeEricActions">removeEricActions</a></td> | |
| 272 <td>Public method to remove actions from the list of actions.</td> | |
| 273 </tr> | |
| 274 <tr> | |
| 275 <td><a href="#MultiProject.removeProject">removeProject</a></td> | |
| 276 <td>Public slot to remove a project from the multi project.</td> | |
| 277 </tr> | |
| 278 <tr> | |
| 279 <td><a href="#MultiProject.saveMultiProject">saveMultiProject</a></td> | |
| 280 <td>Public slot to save the current multi project.</td> | |
| 281 </tr> | |
| 282 <tr> | |
| 283 <td><a href="#MultiProject.saveMultiProjectAs">saveMultiProjectAs</a></td> | |
| 284 <td>Public slot to save the current multi project to a different file.</td> | |
| 285 </tr> | |
| 286 <tr> | |
| 287 <td><a href="#MultiProject.setDirty">setDirty</a></td> | |
| 288 <td>Public method to set the dirty state.</td> | |
| 289 </tr> | |
| 290 </table> | |
| 291 <h3>Static Methods</h3> | |
| 292 | |
| 293 <table> | |
| 294 <tr><td>None</td></tr> | |
| 295 </table> | |
| 296 | |
| 297 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a> | |
| 298 <h4>MultiProject (Constructor)</h4> | |
| 299 <b>MultiProject</b>(<i>project, parent=None, filename=None</i>) | |
| 300 | |
| 301 <p> | |
| 302 Constructor | |
| 303 </p> | |
| 304 <dl> | |
| 305 | |
| 306 <dt><i>project</i></dt> | |
| 307 <dd> | |
| 308 reference to the project object (Project.Project) | |
| 309 </dd> | |
| 310 <dt><i>parent</i></dt> | |
| 311 <dd> | |
| 312 parent widget (usually the ui object) (QWidget) | |
| 313 </dd> | |
| 314 <dt><i>filename</i></dt> | |
| 315 <dd> | |
| 316 optional filename of a multi project file to open | |
| 317 (string) | |
| 318 </dd> | |
| 319 </dl> | |
| 320 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a> | |
| 321 <h4>MultiProject.__checkFilesExist</h4> | |
| 322 <b>__checkFilesExist</b>(<i></i>) | |
| 323 | |
| 324 <p> | |
| 325 Private method to check, if the files in a list exist. | |
| 326 </p> | |
| 327 <p> | |
| 328 The project files are checked for existance in the | |
| 329 filesystem. Non existant projects are removed from the list and the | |
| 330 dirty state of the multi project is changed accordingly. | |
| 331 </p> | |
| 332 <a NAME="MultiProject.__extractCategories" ID="MultiProject.__extractCategories"></a> | |
| 333 <h4>MultiProject.__extractCategories</h4> | |
| 334 <b>__extractCategories</b>(<i></i>) | |
| 335 | |
| 336 <p> | |
| 337 Private slot to extract the categories used in the project definitions. | |
| 338 </p> | |
| 339 <a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a> | |
| 340 <h4>MultiProject.__initData</h4> | |
| 341 <b>__initData</b>(<i></i>) | |
| 342 | |
| 343 <p> | |
| 344 Private method to initialize the multi project data part. | |
| 345 </p> | |
| 346 <a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a> | |
| 347 <h4>MultiProject.__loadRecent</h4> | |
| 348 <b>__loadRecent</b>(<i></i>) | |
| 349 | |
| 350 <p> | |
| 351 Private method to load the recently opened multi project filenames. | |
| 352 </p> | |
| 353 <a NAME="MultiProject.__newMultiProject" ID="MultiProject.__newMultiProject"></a> | |
| 354 <h4>MultiProject.__newMultiProject</h4> | |
| 355 <b>__newMultiProject</b>(<i></i>) | |
| 356 | |
| 357 <p> | |
| 358 Private slot to build a new multi project. | |
| 359 </p> | |
| 360 <p> | |
| 361 This method displays the new multi project dialog and initializes | |
| 362 the multi project object with the data entered. | |
| 363 </p> | |
| 364 <a NAME="MultiProject.__openMasterProject" ID="MultiProject.__openMasterProject"></a> | |
| 365 <h4>MultiProject.__openMasterProject</h4> | |
| 366 <b>__openMasterProject</b>(<i>reopen=True</i>) | |
| 367 | |
| 368 <p> | |
| 369 Private slot to open the master project. | |
| 370 </p> | |
| 371 <dl> | |
| 372 | |
| 373 <dt><i>reopen</i></dt> | |
| 374 <dd> | |
| 375 flag indicating, that the master project should be | |
| 376 reopened, if it has been opened already (boolean) | |
| 377 </dd> | |
| 378 </dl> | |
| 379 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a> | |
| 380 <h4>MultiProject.__openRecent</h4> | |
| 381 <b>__openRecent</b>(<i>act</i>) | |
| 382 | |
| 383 <p> | |
| 384 Private method to open a multi project from the list of rencently | |
| 385 opened multi projects. | |
| 386 </p> | |
| 387 <dl> | |
| 388 | |
| 389 <dt><i>act</i></dt> | |
| 390 <dd> | |
| 391 reference to the action that triggered (QAction) | |
| 392 </dd> | |
| 393 </dl> | |
| 394 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a> | |
| 395 <h4>MultiProject.__readMultiProject</h4> | |
| 396 <b>__readMultiProject</b>(<i>fn</i>) | |
| 397 | |
| 398 <p> | |
| 399 Private method to read in a multi project (.emj, .e4m, .e5m) file. | |
| 400 </p> | |
| 401 <dl> | |
| 402 | |
| 403 <dt><i>fn</i></dt> | |
| 404 <dd> | |
| 405 filename of the multi project file to be read (string) | |
| 406 </dd> | |
| 407 </dl> | |
| 408 <dl> | |
| 409 <dt>Return:</dt> | |
| 410 <dd> | |
| 411 flag indicating success | |
| 412 </dd> | |
| 413 </dl> | |
| 414 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> | |
| 415 <h4>MultiProject.__saveRecent</h4> | |
| 416 <b>__saveRecent</b>(<i></i>) | |
| 417 | |
| 418 <p> | |
| 419 Private method to save the list of recently opened filenames. | |
| 420 </p> | |
| 421 <a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a> | |
| 422 <h4>MultiProject.__showContextMenuRecent</h4> | |
| 423 <b>__showContextMenuRecent</b>(<i></i>) | |
| 424 | |
| 425 <p> | |
| 426 Private method to set up the recent multi projects menu. | |
| 427 </p> | |
| 428 <a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a> | |
| 429 <h4>MultiProject.__showMenu</h4> | |
| 430 <b>__showMenu</b>(<i></i>) | |
| 431 | |
| 432 <p> | |
| 433 Private method to set up the multi project menu. | |
| 434 </p> | |
| 435 <a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a> | |
| 436 <h4>MultiProject.__showProperties</h4> | |
| 437 <b>__showProperties</b>(<i></i>) | |
| 438 | |
| 439 <p> | |
| 440 Private slot to display the properties dialog. | |
| 441 </p> | |
| 442 <a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a> | |
| 443 <h4>MultiProject.__syncRecent</h4> | |
| 444 <b>__syncRecent</b>(<i></i>) | |
| 445 | |
| 446 <p> | |
| 447 Private method to synchronize the list of recently opened multi | |
| 448 projects with the central store. | |
| 449 </p> | |
| 450 <a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a> | |
| 451 <h4>MultiProject.__writeMultiProject</h4> | |
| 452 <b>__writeMultiProject</b>(<i>fn=None</i>) | |
| 453 | |
| 454 <p> | |
| 455 Private method to save the multi project infos to a multi project file. | |
| 456 </p> | |
| 457 <dl> | |
| 458 | |
| 459 <dt><i>fn</i></dt> | |
| 460 <dd> | |
| 461 optional filename of the multi project file to be written. | |
| 462 If fn is None, the filename stored in the multi project object | |
| 463 is used. This is the 'save' action. If fn is given, this filename | |
| 464 is used instead of the one in the multi project object. This is the | |
| 465 'save as' action. | |
| 466 </dd> | |
| 467 </dl> | |
| 468 <dl> | |
| 469 <dt>Return:</dt> | |
| 470 <dd> | |
| 471 flag indicating success | |
| 472 </dd> | |
| 473 </dl> | |
| 474 <a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a> | |
| 475 <h4>MultiProject.addEricActions</h4> | |
| 476 <b>addEricActions</b>(<i>actions</i>) | |
| 477 | |
| 478 <p> | |
| 479 Public method to add actions to the list of actions. | |
| 480 </p> | |
| 481 <dl> | |
| 482 | |
| 483 <dt><i>actions</i></dt> | |
| 484 <dd> | |
| 485 list of actions (list of EricAction) | |
| 486 </dd> | |
| 487 </dl> | |
| 488 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a> | |
| 489 <h4>MultiProject.addNewProject</h4> | |
| 490 <b>addNewProject</b>(<i>startdir="", category=""</i>) | |
| 491 | |
| 492 <p> | |
| 493 Public slot used to add a new project to the multi-project. | |
| 494 </p> | |
| 495 <dl> | |
| 496 | |
| 497 <dt><i>startdir</i> (str)</dt> | |
| 498 <dd> | |
| 499 start directory for the selection dialog | |
| 500 </dd> | |
| 501 <dt><i>category</i> (str)</dt> | |
| 502 <dd> | |
| 503 category to be preset | |
| 504 </dd> | |
| 505 </dl> | |
| 506 <a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a> | |
| 507 <h4>MultiProject.addProject</h4> | |
| 508 <b>addProject</b>(<i>project</i>) | |
| 509 | |
| 510 <p> | |
| 511 Public method to add a project to the multi-project. | |
| 512 </p> | |
| 513 <dl> | |
| 514 | |
| 515 <dt><i>project</i> (dict)</dt> | |
| 516 <dd> | |
| 517 dictionary containing the project data to be added | |
| 518 </dd> | |
| 519 </dl> | |
| 520 <a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a> | |
| 521 <h4>MultiProject.changeProjectProperties</h4> | |
| 522 <b>changeProjectProperties</b>(<i>pro</i>) | |
| 523 | |
| 524 <p> | |
| 525 Public method to change the data of a project entry. | |
| 526 </p> | |
| 527 <dl> | |
| 528 | |
| 529 <dt><i>pro</i></dt> | |
| 530 <dd> | |
| 531 dictionary with the project data (string) | |
| 532 </dd> | |
| 533 </dl> | |
| 534 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a> | |
| 535 <h4>MultiProject.checkDirty</h4> | |
| 536 <b>checkDirty</b>(<i></i>) | |
| 537 | |
| 538 <p> | |
| 539 Public method to check the dirty status and open a message window. | |
| 540 </p> | |
| 541 <dl> | |
| 542 <dt>Return:</dt> | |
| 543 <dd> | |
| 544 flag indicating whether this operation was successful (boolean) | |
| 545 </dd> | |
| 546 </dl> | |
| 547 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> | |
| 548 <h4>MultiProject.clearRecent</h4> | |
| 549 <b>clearRecent</b>(<i></i>) | |
| 550 | |
| 551 <p> | |
| 552 Public method to clear the recent multi projects menu. | |
| 553 </p> | |
| 554 <a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a> | |
| 555 <h4>MultiProject.closeMultiProject</h4> | |
| 556 <b>closeMultiProject</b>(<i></i>) | |
| 557 | |
| 558 <p> | |
| 559 Public slot to close the current multi project. | |
| 560 </p> | |
| 561 <dl> | |
| 562 <dt>Return:</dt> | |
| 563 <dd> | |
| 564 flag indicating success (boolean) | |
| 565 </dd> | |
| 566 </dl> | |
| 567 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> | |
| 568 <h4>MultiProject.copyProject</h4> | |
| 569 <b>copyProject</b>(<i>uid</i>) | |
| 570 | |
| 571 <p> | |
| 572 Public method to copy the project with given UID on disk. | |
| 573 </p> | |
| 574 <dl> | |
| 575 | |
| 576 <dt><i>uid</i> (str)</dt> | |
| 577 <dd> | |
| 578 UID of the project to copy | |
| 579 </dd> | |
| 580 </dl> | |
| 581 <a NAME="MultiProject.deleteProject" ID="MultiProject.deleteProject"></a> | |
| 582 <h4>MultiProject.deleteProject</h4> | |
| 583 <b>deleteProject</b>(<i>uid</i>) | |
| 584 | |
| 585 <p> | |
| 586 Public slot to delete project(s) from the multi project and disk. | |
| 587 </p> | |
| 588 <dl> | |
| 589 | |
| 590 <dt><i>uid</i> (str)</dt> | |
| 591 <dd> | |
| 592 UID of the project to be removed from the multi | |
| 593 project | |
| 594 </dd> | |
| 595 </dl> | |
| 596 <a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a> | |
| 597 <h4>MultiProject.getActions</h4> | |
| 598 <b>getActions</b>(<i></i>) | |
| 599 | |
| 600 <p> | |
| 601 Public method to get a list of all actions. | |
| 602 </p> | |
| 603 <dl> | |
| 604 <dt>Return:</dt> | |
| 605 <dd> | |
| 606 list of all actions (list of EricAction) | |
| 607 </dd> | |
| 608 </dl> | |
| 609 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> | |
| 610 <h4>MultiProject.getCategories</h4> | |
| 611 <b>getCategories</b>(<i></i>) | |
| 612 | |
| 613 <p> | |
| 614 Public method to get the list of defined categories. | |
| 615 </p> | |
| 616 <dl> | |
| 617 <dt>Return:</dt> | |
| 618 <dd> | |
| 619 list of categories (list of string) | |
| 620 </dd> | |
| 621 </dl> | |
| 622 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> | |
| 623 <h4>MultiProject.getDependantProjectFiles</h4> | |
| 624 <b>getDependantProjectFiles</b>(<i></i>) | |
| 625 | |
| 626 <p> | |
| 627 Public method to get the filenames of the dependent projects. | |
| 628 </p> | |
| 629 <dl> | |
| 630 <dt>Return:</dt> | |
| 631 <dd> | |
| 632 names of the dependent project files (list of strings) | |
| 633 </dd> | |
| 634 </dl> | |
| 635 <a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a> | |
| 636 <h4>MultiProject.getMasterProjectFile</h4> | |
| 637 <b>getMasterProjectFile</b>(<i></i>) | |
| 638 | |
| 639 <p> | |
| 640 Public method to get the filename of the master project. | |
| 641 </p> | |
| 642 <dl> | |
| 643 <dt>Return:</dt> | |
| 644 <dd> | |
| 645 name of the master project file (string) | |
| 646 </dd> | |
| 647 </dl> | |
| 648 <a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a> | |
| 649 <h4>MultiProject.getMenu</h4> | |
| 650 <b>getMenu</b>(<i>menuName</i>) | |
| 651 | |
| 652 <p> | |
| 653 Public method to get a reference to the main menu or a submenu. | |
| 654 </p> | |
| 655 <dl> | |
| 656 | |
| 657 <dt><i>menuName</i></dt> | |
| 658 <dd> | |
| 659 name of the menu (string) | |
| 660 </dd> | |
| 661 </dl> | |
| 662 <dl> | |
| 663 <dt>Return:</dt> | |
| 664 <dd> | |
| 665 reference to the requested menu (QMenu) or None | |
| 666 </dd> | |
| 667 </dl> | |
| 668 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> | |
| 669 <h4>MultiProject.getMostRecent</h4> | |
| 670 <b>getMostRecent</b>(<i></i>) | |
| 671 | |
| 672 <p> | |
| 673 Public method to get the most recently opened multiproject. | |
| 674 </p> | |
| 675 <dl> | |
| 676 <dt>Return:</dt> | |
| 677 <dd> | |
| 678 path of the most recently opened multiproject (string) | |
| 679 </dd> | |
| 680 </dl> | |
| 681 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> | |
| 682 <h4>MultiProject.getMultiProjectFile</h4> | |
| 683 <b>getMultiProjectFile</b>(<i></i>) | |
| 684 | |
| 685 <p> | |
| 686 Public method to get the path of the multi project file. | |
| 687 </p> | |
| 688 <dl> | |
| 689 <dt>Return:</dt> | |
| 690 <dd> | |
| 691 path of the multi project file (string) | |
| 692 </dd> | |
| 693 </dl> | |
| 694 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> | |
| 695 <h4>MultiProject.getMultiProjectPath</h4> | |
| 696 <b>getMultiProjectPath</b>(<i></i>) | |
| 697 | |
| 698 <p> | |
| 699 Public method to get the multi project path. | |
| 700 </p> | |
| 701 <dl> | |
| 702 <dt>Return:</dt> | |
| 703 <dd> | |
| 704 multi project path (string) | |
| 705 </dd> | |
| 706 </dl> | |
| 707 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> | |
| 708 <h4>MultiProject.getProject</h4> | |
| 709 <b>getProject</b>(<i>uid</i>) | |
| 710 | |
| 711 <p> | |
| 712 Public method to get a reference to a project entry. | |
| 713 </p> | |
| 714 <dl> | |
| 715 | |
| 716 <dt><i>uid</i> (str)</dt> | |
| 717 <dd> | |
| 718 UID of the project to get | |
| 719 </dd> | |
| 720 </dl> | |
| 721 <dl> | |
| 722 <dt>Return:</dt> | |
| 723 <dd> | |
| 724 dictionary containing the project data | |
| 725 </dd> | |
| 726 </dl> | |
| 727 <dl> | |
| 728 <dt>Return Type:</dt> | |
| 729 <dd> | |
| 730 dict | |
| 731 </dd> | |
| 732 </dl> | |
| 733 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a> | |
| 734 <h4>MultiProject.getProjects</h4> | |
| 735 <b>getProjects</b>(<i></i>) | |
| 736 | |
| 737 <p> | |
| 738 Public method to get all project entries. | |
| 739 </p> | |
| 740 <dl> | |
| 741 <dt>Return:</dt> | |
| 742 <dd> | |
| 743 list of all project entries (list of dictionaries) | |
| 744 </dd> | |
| 745 </dl> | |
| 746 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> | |
| 747 <h4>MultiProject.initActions</h4> | |
| 748 <b>initActions</b>(<i></i>) | |
| 749 | |
| 750 <p> | |
| 751 Public slot to initialize the multi project related actions. | |
| 752 </p> | |
| 753 <a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a> | |
| 754 <h4>MultiProject.initMenu</h4> | |
| 755 <b>initMenu</b>(<i></i>) | |
| 756 | |
| 757 <p> | |
| 758 Public slot to initialize the multi project menu. | |
| 759 </p> | |
| 760 <dl> | |
| 761 <dt>Return:</dt> | |
| 762 <dd> | |
| 763 the menu generated (QMenu) | |
| 764 </dd> | |
| 765 </dl> | |
| 766 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> | |
| 767 <h4>MultiProject.initToolbar</h4> | |
| 768 <b>initToolbar</b>(<i>toolbarManager</i>) | |
| 769 | |
| 770 <p> | |
| 771 Public slot to initialize the multi project toolbar. | |
| 772 </p> | |
| 773 <dl> | |
| 774 | |
| 775 <dt><i>toolbarManager</i></dt> | |
| 776 <dd> | |
| 777 reference to a toolbar manager object | |
| 778 (EricToolBarManager) | |
| 779 </dd> | |
| 780 </dl> | |
| 781 <dl> | |
| 782 <dt>Return:</dt> | |
| 783 <dd> | |
| 784 the toolbar generated (QToolBar) | |
| 785 </dd> | |
| 786 </dl> | |
| 787 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> | |
| 788 <h4>MultiProject.isDirty</h4> | |
| 789 <b>isDirty</b>(<i></i>) | |
| 790 | |
| 791 <p> | |
| 792 Public method to return the dirty state. | |
| 793 </p> | |
| 794 <dl> | |
| 795 <dt>Return:</dt> | |
| 796 <dd> | |
| 797 dirty state (boolean) | |
| 798 </dd> | |
| 799 </dl> | |
| 800 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> | |
| 801 <h4>MultiProject.isOpen</h4> | |
| 802 <b>isOpen</b>(<i></i>) | |
| 803 | |
| 804 <p> | |
| 805 Public method to return the opened state. | |
| 806 </p> | |
| 807 <dl> | |
| 808 <dt>Return:</dt> | |
| 809 <dd> | |
| 810 open state (boolean) | |
| 811 </dd> | |
| 812 </dl> | |
| 813 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> | |
| 814 <h4>MultiProject.openMultiProject</h4> | |
| 815 <b>openMultiProject</b>(<i>fn=None, openMaster=True</i>) | |
| 816 | |
| 817 <p> | |
| 818 Public slot to open a multi project. | |
| 819 </p> | |
| 820 <dl> | |
| 821 | |
| 822 <dt><i>fn</i> (str)</dt> | |
| 823 <dd> | |
| 824 optional filename of the multi project file to be | |
| 825 read | |
| 826 </dd> | |
| 827 <dt><i>openMaster</i> (bool)</dt> | |
| 828 <dd> | |
| 829 flag indicating, that the master project | |
| 830 should be opened depending on the configuration | |
| 831 </dd> | |
| 832 </dl> | |
| 833 <a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a> | |
| 834 <h4>MultiProject.openProject</h4> | |
| 835 <b>openProject</b>(<i>filename</i>) | |
| 836 | |
| 837 <p> | |
| 838 Public slot to open a project. | |
| 839 </p> | |
| 840 <dl> | |
| 841 | |
| 842 <dt><i>filename</i></dt> | |
| 843 <dd> | |
| 844 filename of the project file (string) | |
| 845 </dd> | |
| 846 </dl> | |
| 847 <a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a> | |
| 848 <h4>MultiProject.removeEricActions</h4> | |
| 849 <b>removeEricActions</b>(<i>actions</i>) | |
| 850 | |
| 851 <p> | |
| 852 Public method to remove actions from the list of actions. | |
| 853 </p> | |
| 854 <dl> | |
| 855 | |
| 856 <dt><i>actions</i></dt> | |
| 857 <dd> | |
| 858 list of actions (list of EricAction) | |
| 859 </dd> | |
| 860 </dl> | |
| 861 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a> | |
| 862 <h4>MultiProject.removeProject</h4> | |
| 863 <b>removeProject</b>(<i>uid</i>) | |
| 864 | |
| 865 <p> | |
| 866 Public slot to remove a project from the multi project. | |
| 867 </p> | |
| 868 <dl> | |
| 869 | |
| 870 <dt><i>uid</i> (str)</dt> | |
| 871 <dd> | |
| 872 UID of the project to be removed from the multi | |
| 873 project | |
| 874 </dd> | |
| 875 </dl> | |
| 876 <a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a> | |
| 877 <h4>MultiProject.saveMultiProject</h4> | |
| 878 <b>saveMultiProject</b>(<i></i>) | |
| 879 | |
| 880 <p> | |
| 881 Public slot to save the current multi project. | |
| 882 </p> | |
| 883 <dl> | |
| 884 <dt>Return:</dt> | |
| 885 <dd> | |
| 886 flag indicating success | |
| 887 </dd> | |
| 888 </dl> | |
| 889 <dl> | |
| 890 <dt>Return Type:</dt> | |
| 891 <dd> | |
| 892 bool | |
| 893 </dd> | |
| 894 </dl> | |
| 895 <a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a> | |
| 896 <h4>MultiProject.saveMultiProjectAs</h4> | |
| 897 <b>saveMultiProjectAs</b>(<i></i>) | |
| 898 | |
| 899 <p> | |
| 900 Public slot to save the current multi project to a different file. | |
| 901 </p> | |
| 902 <dl> | |
| 903 <dt>Return:</dt> | |
| 904 <dd> | |
| 905 flag indicating success | |
| 906 </dd> | |
| 907 </dl> | |
| 908 <dl> | |
| 909 <dt>Return Type:</dt> | |
| 910 <dd> | |
| 911 bool | |
| 912 </dd> | |
| 913 </dl> | |
| 914 <a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a> | |
| 915 <h4>MultiProject.setDirty</h4> | |
| 916 <b>setDirty</b>(<i>b</i>) | |
| 917 | |
| 918 <p> | |
| 919 Public method to set the dirty state. | |
| 920 </p> | |
| 921 <p> | |
| 922 It emits the signal dirty(int). | |
| 923 </p> | |
| 924 <dl> | |
| 925 | |
| 926 <dt><i>b</i></dt> | |
| 927 <dd> | |
| 928 dirty state (boolean) | |
| 929 </dd> | |
| 930 </dl> | |
| 931 <div align="right"><a href="#top">Up</a></div> | |
| 932 <hr /> | |
| 933 </body></html> |
