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 10479
856476537696
parent 10411
f9dedceca6c9
child 10595
59579e8aff98
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MultiProject.MultiProject</h1> 9 <h1>eric7.MultiProject.MultiProject</h1>
10
11 <p> 10 <p>
12 Module implementing the multi project management functionality. 11 Module implementing the multi project management functionality.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#MultiProject">MultiProject</a></td> 22 <td><a href="#MultiProject">MultiProject</a></td>
25 <td>Class implementing the project management functionality.</td> 23 <td>Class implementing the project management functionality.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="MultiProject" ID="MultiProject"></a> 34 <a NAME="MultiProject" ID="MultiProject"></a>
36 <h2>MultiProject</h2> 35 <h2>MultiProject</h2>
37
38 <p> 36 <p>
39 Class implementing the project management functionality. 37 Class implementing the project management functionality.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>dirty(bool)</dt> 43 <dt>dirty(bool)</dt>
45 <dd> 44 <dd>
88 </dd> 87 </dd>
89 </dl> 88 </dl>
90 <h3>Derived from</h3> 89 <h3>Derived from</h3>
91 QObject 90 QObject
92 <h3>Class Attributes</h3> 91 <h3>Class Attributes</h3>
93
94 <table> 92 <table>
95 <tr><td>None</td></tr> 93 <tr><td>None</td></tr>
96 </table> 94 </table>
95
97 <h3>Class Methods</h3> 96 <h3>Class Methods</h3>
98
99 <table> 97 <table>
100 <tr><td>None</td></tr> 98 <tr><td>None</td></tr>
101 </table> 99 </table>
100
102 <h3>Methods</h3> 101 <h3>Methods</h3>
103
104 <table> 102 <table>
105
106 <tr> 103 <tr>
107 <td><a href="#MultiProject.__init__">MultiProject</a></td> 104 <td><a href="#MultiProject.__init__">MultiProject</a></td>
108 <td>Constructor</td> 105 <td>Constructor</td>
109 </tr> 106 </tr>
110 <tr> 107 <tr>
294 <tr> 291 <tr>
295 <td><a href="#MultiProject.setDirty">setDirty</a></td> 292 <td><a href="#MultiProject.setDirty">setDirty</a></td>
296 <td>Public method to set the dirty state.</td> 293 <td>Public method to set the dirty state.</td>
297 </tr> 294 </tr>
298 </table> 295 </table>
296
299 <h3>Static Methods</h3> 297 <h3>Static Methods</h3>
300
301 <table> 298 <table>
302 <tr><td>None</td></tr> 299 <tr><td>None</td></tr>
303 </table> 300 </table>
304 301
302
305 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a> 303 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a>
306 <h4>MultiProject (Constructor)</h4> 304 <h4>MultiProject (Constructor)</h4>
307 <b>MultiProject</b>(<i>project, parent=None, filename=None</i>) 305 <b>MultiProject</b>(<i>project, parent=None, filename=None</i>)
308
309 <p> 306 <p>
310 Constructor 307 Constructor
311 </p> 308 </p>
309
312 <dl> 310 <dl>
313 311
314 <dt><i>project</i> (Project.Project)</dt> 312 <dt><i>project</i> (Project.Project)</dt>
315 <dd> 313 <dd>
316 reference to the project object 314 reference to the project object
325 </dd> 323 </dd>
326 </dl> 324 </dl>
327 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a> 325 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a>
328 <h4>MultiProject.__checkFilesExist</h4> 326 <h4>MultiProject.__checkFilesExist</h4>
329 <b>__checkFilesExist</b>(<i></i>) 327 <b>__checkFilesExist</b>(<i></i>)
330
331 <p> 328 <p>
332 Private method to check, if the files in a list exist. 329 Private method to check, if the files in a list exist.
333 </p> 330 </p>
334 <p> 331 <p>
335 The project files are checked for existance in the 332 The project files are checked for existance in the
336 filesystem. Non existant projects are removed from the list and the 333 filesystem. Non existant projects are removed from the list and the
337 dirty state of the multi project is changed accordingly. 334 dirty state of the multi project is changed accordingly.
338 </p> 335 </p>
336
339 <a NAME="MultiProject.__extractCategories" ID="MultiProject.__extractCategories"></a> 337 <a NAME="MultiProject.__extractCategories" ID="MultiProject.__extractCategories"></a>
340 <h4>MultiProject.__extractCategories</h4> 338 <h4>MultiProject.__extractCategories</h4>
341 <b>__extractCategories</b>(<i></i>) 339 <b>__extractCategories</b>(<i></i>)
342
343 <p> 340 <p>
344 Private slot to extract the categories used in the project definitions. 341 Private slot to extract the categories used in the project definitions.
345 </p> 342 </p>
343
346 <a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a> 344 <a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a>
347 <h4>MultiProject.__initData</h4> 345 <h4>MultiProject.__initData</h4>
348 <b>__initData</b>(<i></i>) 346 <b>__initData</b>(<i></i>)
349
350 <p> 347 <p>
351 Private method to initialize the multi project data part. 348 Private method to initialize the multi project data part.
352 </p> 349 </p>
350
353 <a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a> 351 <a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a>
354 <h4>MultiProject.__loadRecent</h4> 352 <h4>MultiProject.__loadRecent</h4>
355 <b>__loadRecent</b>(<i></i>) 353 <b>__loadRecent</b>(<i></i>)
356
357 <p> 354 <p>
358 Private method to load the recently opened multi project filenames. 355 Private method to load the recently opened multi project filenames.
359 </p> 356 </p>
357
360 <a NAME="MultiProject.__newMultiProject" ID="MultiProject.__newMultiProject"></a> 358 <a NAME="MultiProject.__newMultiProject" ID="MultiProject.__newMultiProject"></a>
361 <h4>MultiProject.__newMultiProject</h4> 359 <h4>MultiProject.__newMultiProject</h4>
362 <b>__newMultiProject</b>(<i></i>) 360 <b>__newMultiProject</b>(<i></i>)
363
364 <p> 361 <p>
365 Private slot to build a new multi project. 362 Private slot to build a new multi project.
366 </p> 363 </p>
367 <p> 364 <p>
368 This method displays the new multi project dialog and initializes 365 This method displays the new multi project dialog and initializes
369 the multi project object with the data entered. 366 the multi project object with the data entered.
370 </p> 367 </p>
368
371 <a NAME="MultiProject.__openMainProject" ID="MultiProject.__openMainProject"></a> 369 <a NAME="MultiProject.__openMainProject" ID="MultiProject.__openMainProject"></a>
372 <h4>MultiProject.__openMainProject</h4> 370 <h4>MultiProject.__openMainProject</h4>
373 <b>__openMainProject</b>(<i>reopen=True</i>) 371 <b>__openMainProject</b>(<i>reopen=True</i>)
374
375 <p> 372 <p>
376 Private slot to open the main project. 373 Private slot to open the main project.
377 </p> 374 </p>
375
378 <dl> 376 <dl>
379 377
380 <dt><i>reopen</i> (bool)</dt> 378 <dt><i>reopen</i> (bool)</dt>
381 <dd> 379 <dd>
382 flag indicating, that the main project should be 380 flag indicating, that the main project should be
384 </dd> 382 </dd>
385 </dl> 383 </dl>
386 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a> 384 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a>
387 <h4>MultiProject.__openRecent</h4> 385 <h4>MultiProject.__openRecent</h4>
388 <b>__openRecent</b>(<i>act</i>) 386 <b>__openRecent</b>(<i>act</i>)
389
390 <p> 387 <p>
391 Private method to open a multi project from the list of rencently 388 Private method to open a multi project from the list of rencently
392 opened multi projects. 389 opened multi projects.
393 </p> 390 </p>
391
394 <dl> 392 <dl>
395 393
396 <dt><i>act</i> (QAction)</dt> 394 <dt><i>act</i> (QAction)</dt>
397 <dd> 395 <dd>
398 reference to the action that triggered 396 reference to the action that triggered
399 </dd> 397 </dd>
400 </dl> 398 </dl>
401 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a> 399 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a>
402 <h4>MultiProject.__readMultiProject</h4> 400 <h4>MultiProject.__readMultiProject</h4>
403 <b>__readMultiProject</b>(<i>fn</i>) 401 <b>__readMultiProject</b>(<i>fn</i>)
404
405 <p> 402 <p>
406 Private method to read in a multi project (.emj, .e4m, .e5m) file. 403 Private method to read in a multi project (.emj, .e4m, .e5m) file.
407 </p> 404 </p>
405
408 <dl> 406 <dl>
409 407
410 <dt><i>fn</i> (str)</dt> 408 <dt><i>fn</i> (str)</dt>
411 <dd> 409 <dd>
412 filename of the multi project file to be read 410 filename of the multi project file to be read
425 </dd> 423 </dd>
426 </dl> 424 </dl>
427 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> 425 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a>
428 <h4>MultiProject.__saveRecent</h4> 426 <h4>MultiProject.__saveRecent</h4>
429 <b>__saveRecent</b>(<i></i>) 427 <b>__saveRecent</b>(<i></i>)
430
431 <p> 428 <p>
432 Private method to save the list of recently opened filenames. 429 Private method to save the list of recently opened filenames.
433 </p> 430 </p>
431
434 <a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a> 432 <a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a>
435 <h4>MultiProject.__showContextMenuRecent</h4> 433 <h4>MultiProject.__showContextMenuRecent</h4>
436 <b>__showContextMenuRecent</b>(<i></i>) 434 <b>__showContextMenuRecent</b>(<i></i>)
437
438 <p> 435 <p>
439 Private method to set up the recent multi projects menu. 436 Private method to set up the recent multi projects menu.
440 </p> 437 </p>
438
441 <a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a> 439 <a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a>
442 <h4>MultiProject.__showMenu</h4> 440 <h4>MultiProject.__showMenu</h4>
443 <b>__showMenu</b>(<i></i>) 441 <b>__showMenu</b>(<i></i>)
444
445 <p> 442 <p>
446 Private method to set up the multi project menu. 443 Private method to set up the multi project menu.
447 </p> 444 </p>
445
448 <a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a> 446 <a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a>
449 <h4>MultiProject.__showProperties</h4> 447 <h4>MultiProject.__showProperties</h4>
450 <b>__showProperties</b>(<i></i>) 448 <b>__showProperties</b>(<i></i>)
451
452 <p> 449 <p>
453 Private slot to display the properties dialog. 450 Private slot to display the properties dialog.
454 </p> 451 </p>
452
455 <a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a> 453 <a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a>
456 <h4>MultiProject.__syncRecent</h4> 454 <h4>MultiProject.__syncRecent</h4>
457 <b>__syncRecent</b>(<i></i>) 455 <b>__syncRecent</b>(<i></i>)
458
459 <p> 456 <p>
460 Private method to synchronize the list of recently opened multi 457 Private method to synchronize the list of recently opened multi
461 projects with the central store. 458 projects with the central store.
462 </p> 459 </p>
460
463 <a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a> 461 <a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a>
464 <h4>MultiProject.__writeMultiProject</h4> 462 <h4>MultiProject.__writeMultiProject</h4>
465 <b>__writeMultiProject</b>(<i>fn=None</i>) 463 <b>__writeMultiProject</b>(<i>fn=None</i>)
466
467 <p> 464 <p>
468 Private method to save the multi project infos to a multi project file. 465 Private method to save the multi project infos to a multi project file.
469 </p> 466 </p>
467
470 <dl> 468 <dl>
471 469
472 <dt><i>fn</i> (str)</dt> 470 <dt><i>fn</i> (str)</dt>
473 <dd> 471 <dd>
474 optional filename of the multi project file to be written. 472 optional filename of the multi project file to be written.
491 </dd> 489 </dd>
492 </dl> 490 </dl>
493 <a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a> 491 <a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a>
494 <h4>MultiProject.addEricActions</h4> 492 <h4>MultiProject.addEricActions</h4>
495 <b>addEricActions</b>(<i>actions</i>) 493 <b>addEricActions</b>(<i>actions</i>)
496
497 <p> 494 <p>
498 Public method to add actions to the list of actions. 495 Public method to add actions to the list of actions.
499 </p> 496 </p>
497
500 <dl> 498 <dl>
501 499
502 <dt><i>actions</i> (list of EricAction)</dt> 500 <dt><i>actions</i> (list of EricAction)</dt>
503 <dd> 501 <dd>
504 list of actions 502 list of actions
505 </dd> 503 </dd>
506 </dl> 504 </dl>
507 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a> 505 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a>
508 <h4>MultiProject.addNewProject</h4> 506 <h4>MultiProject.addNewProject</h4>
509 <b>addNewProject</b>(<i>startdir="", category=""</i>) 507 <b>addNewProject</b>(<i>startdir="", category=""</i>)
510
511 <p> 508 <p>
512 Public slot used to add a new project to the multi-project. 509 Public slot used to add a new project to the multi-project.
513 </p> 510 </p>
511
514 <dl> 512 <dl>
515 513
516 <dt><i>startdir</i> (str)</dt> 514 <dt><i>startdir</i> (str)</dt>
517 <dd> 515 <dd>
518 start directory for the selection dialog 516 start directory for the selection dialog
523 </dd> 521 </dd>
524 </dl> 522 </dl>
525 <a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a> 523 <a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a>
526 <h4>MultiProject.addProject</h4> 524 <h4>MultiProject.addProject</h4>
527 <b>addProject</b>(<i>project</i>) 525 <b>addProject</b>(<i>project</i>)
528
529 <p> 526 <p>
530 Public method to add a project to the multi-project. 527 Public method to add a project to the multi-project.
531 </p> 528 </p>
529
532 <dl> 530 <dl>
533 531
534 <dt><i>project</i> (MultiProjectProjectMeta)</dt> 532 <dt><i>project</i> (MultiProjectProjectMeta)</dt>
535 <dd> 533 <dd>
536 dictionary containing the project data to be added 534 dictionary containing the project data to be added
537 </dd> 535 </dd>
538 </dl> 536 </dl>
539 <a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a> 537 <a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a>
540 <h4>MultiProject.changeProjectProperties</h4> 538 <h4>MultiProject.changeProjectProperties</h4>
541 <b>changeProjectProperties</b>(<i>pro</i>) 539 <b>changeProjectProperties</b>(<i>pro</i>)
542
543 <p> 540 <p>
544 Public method to change the data of a project entry. 541 Public method to change the data of a project entry.
545 </p> 542 </p>
543
546 <dl> 544 <dl>
547 545
548 <dt><i>pro</i> (str)</dt> 546 <dt><i>pro</i> (str)</dt>
549 <dd> 547 <dd>
550 dictionary with the project data 548 dictionary with the project data
551 </dd> 549 </dd>
552 </dl> 550 </dl>
553 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a> 551 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a>
554 <h4>MultiProject.checkDirty</h4> 552 <h4>MultiProject.checkDirty</h4>
555 <b>checkDirty</b>(<i></i>) 553 <b>checkDirty</b>(<i></i>)
556
557 <p> 554 <p>
558 Public method to check the dirty status and open a message window. 555 Public method to check the dirty status and open a message window.
559 </p> 556 </p>
557
560 <dl> 558 <dl>
561 <dt>Return:</dt> 559 <dt>Return:</dt>
562 <dd> 560 <dd>
563 flag indicating whether this operation was successful 561 flag indicating whether this operation was successful
564 </dd> 562 </dd>
570 </dd> 568 </dd>
571 </dl> 569 </dl>
572 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> 570 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a>
573 <h4>MultiProject.clearRecent</h4> 571 <h4>MultiProject.clearRecent</h4>
574 <b>clearRecent</b>(<i></i>) 572 <b>clearRecent</b>(<i></i>)
575
576 <p> 573 <p>
577 Public method to clear the recent multi projects menu. 574 Public method to clear the recent multi projects menu.
578 </p> 575 </p>
576
579 <a NAME="MultiProject.clearRemovedProjects" ID="MultiProject.clearRemovedProjects"></a> 577 <a NAME="MultiProject.clearRemovedProjects" ID="MultiProject.clearRemovedProjects"></a>
580 <h4>MultiProject.clearRemovedProjects</h4> 578 <h4>MultiProject.clearRemovedProjects</h4>
581 <b>clearRemovedProjects</b>(<i></i>) 579 <b>clearRemovedProjects</b>(<i></i>)
582
583 <p> 580 <p>
584 Public slot to clear out all projects marked as removed. 581 Public slot to clear out all projects marked as removed.
585 </p> 582 </p>
583
586 <a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a> 584 <a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a>
587 <h4>MultiProject.closeMultiProject</h4> 585 <h4>MultiProject.closeMultiProject</h4>
588 <b>closeMultiProject</b>(<i></i>) 586 <b>closeMultiProject</b>(<i></i>)
589
590 <p> 587 <p>
591 Public slot to close the current multi project. 588 Public slot to close the current multi project.
592 </p> 589 </p>
590
593 <dl> 591 <dl>
594 <dt>Return:</dt> 592 <dt>Return:</dt>
595 <dd> 593 <dd>
596 flag indicating success 594 flag indicating success
597 </dd> 595 </dd>
603 </dd> 601 </dd>
604 </dl> 602 </dl>
605 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> 603 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a>
606 <h4>MultiProject.copyProject</h4> 604 <h4>MultiProject.copyProject</h4>
607 <b>copyProject</b>(<i>uid</i>) 605 <b>copyProject</b>(<i>uid</i>)
608
609 <p> 606 <p>
610 Public method to copy the project with given UID on disk. 607 Public method to copy the project with given UID on disk.
611 </p> 608 </p>
609
612 <dl> 610 <dl>
613 611
614 <dt><i>uid</i> (str)</dt> 612 <dt><i>uid</i> (str)</dt>
615 <dd> 613 <dd>
616 UID of the project to copy 614 UID of the project to copy
617 </dd> 615 </dd>
618 </dl> 616 </dl>
619 <a NAME="MultiProject.deleteProject" ID="MultiProject.deleteProject"></a> 617 <a NAME="MultiProject.deleteProject" ID="MultiProject.deleteProject"></a>
620 <h4>MultiProject.deleteProject</h4> 618 <h4>MultiProject.deleteProject</h4>
621 <b>deleteProject</b>(<i>uid</i>) 619 <b>deleteProject</b>(<i>uid</i>)
622
623 <p> 620 <p>
624 Public slot to delete project(s) from the multi project and disk. 621 Public slot to delete project(s) from the multi project and disk.
625 </p> 622 </p>
623
626 <dl> 624 <dl>
627 625
628 <dt><i>uid</i> (str)</dt> 626 <dt><i>uid</i> (str)</dt>
629 <dd> 627 <dd>
630 UID of the project to be removed from the multi 628 UID of the project to be removed from the multi
632 </dd> 630 </dd>
633 </dl> 631 </dl>
634 <a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a> 632 <a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a>
635 <h4>MultiProject.getActions</h4> 633 <h4>MultiProject.getActions</h4>
636 <b>getActions</b>(<i></i>) 634 <b>getActions</b>(<i></i>)
637
638 <p> 635 <p>
639 Public method to get a list of all actions. 636 Public method to get a list of all actions.
640 </p> 637 </p>
638
641 <dl> 639 <dl>
642 <dt>Return:</dt> 640 <dt>Return:</dt>
643 <dd> 641 <dd>
644 list of all actions 642 list of all actions
645 </dd> 643 </dd>
651 </dd> 649 </dd>
652 </dl> 650 </dl>
653 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> 651 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a>
654 <h4>MultiProject.getCategories</h4> 652 <h4>MultiProject.getCategories</h4>
655 <b>getCategories</b>(<i></i>) 653 <b>getCategories</b>(<i></i>)
656
657 <p> 654 <p>
658 Public method to get the list of defined categories. 655 Public method to get the list of defined categories.
659 </p> 656 </p>
657
660 <dl> 658 <dl>
661 <dt>Return:</dt> 659 <dt>Return:</dt>
662 <dd> 660 <dd>
663 list of categories 661 list of categories
664 </dd> 662 </dd>
670 </dd> 668 </dd>
671 </dl> 669 </dl>
672 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> 670 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a>
673 <h4>MultiProject.getDependantProjectFiles</h4> 671 <h4>MultiProject.getDependantProjectFiles</h4>
674 <b>getDependantProjectFiles</b>(<i></i>) 672 <b>getDependantProjectFiles</b>(<i></i>)
675
676 <p> 673 <p>
677 Public method to get the filenames of the dependent projects. 674 Public method to get the filenames of the dependent projects.
678 </p> 675 </p>
676
679 <dl> 677 <dl>
680 <dt>Return:</dt> 678 <dt>Return:</dt>
681 <dd> 679 <dd>
682 names of the dependent project files 680 names of the dependent project files
683 </dd> 681 </dd>
689 </dd> 687 </dd>
690 </dl> 688 </dl>
691 <a NAME="MultiProject.getMainProjectFile" ID="MultiProject.getMainProjectFile"></a> 689 <a NAME="MultiProject.getMainProjectFile" ID="MultiProject.getMainProjectFile"></a>
692 <h4>MultiProject.getMainProjectFile</h4> 690 <h4>MultiProject.getMainProjectFile</h4>
693 <b>getMainProjectFile</b>(<i></i>) 691 <b>getMainProjectFile</b>(<i></i>)
694
695 <p> 692 <p>
696 Public method to get the filename of the main project. 693 Public method to get the filename of the main project.
697 </p> 694 </p>
695
698 <dl> 696 <dl>
699 <dt>Return:</dt> 697 <dt>Return:</dt>
700 <dd> 698 <dd>
701 name of the main project file 699 name of the main project file
702 </dd> 700 </dd>
708 </dd> 706 </dd>
709 </dl> 707 </dl>
710 <a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a> 708 <a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a>
711 <h4>MultiProject.getMenu</h4> 709 <h4>MultiProject.getMenu</h4>
712 <b>getMenu</b>(<i>menuName</i>) 710 <b>getMenu</b>(<i>menuName</i>)
713
714 <p> 711 <p>
715 Public method to get a reference to the main menu or a submenu. 712 Public method to get a reference to the main menu or a submenu.
716 </p> 713 </p>
714
717 <dl> 715 <dl>
718 716
719 <dt><i>menuName</i> (str)</dt> 717 <dt><i>menuName</i> (str)</dt>
720 <dd> 718 <dd>
721 name of the menu 719 name of the menu
734 </dd> 732 </dd>
735 </dl> 733 </dl>
736 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> 734 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a>
737 <h4>MultiProject.getMostRecent</h4> 735 <h4>MultiProject.getMostRecent</h4>
738 <b>getMostRecent</b>(<i></i>) 736 <b>getMostRecent</b>(<i></i>)
739
740 <p> 737 <p>
741 Public method to get the most recently opened multiproject. 738 Public method to get the most recently opened multiproject.
742 </p> 739 </p>
740
743 <dl> 741 <dl>
744 <dt>Return:</dt> 742 <dt>Return:</dt>
745 <dd> 743 <dd>
746 path of the most recently opened multiproject 744 path of the most recently opened multiproject
747 </dd> 745 </dd>
753 </dd> 751 </dd>
754 </dl> 752 </dl>
755 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> 753 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a>
756 <h4>MultiProject.getMultiProjectFile</h4> 754 <h4>MultiProject.getMultiProjectFile</h4>
757 <b>getMultiProjectFile</b>(<i></i>) 755 <b>getMultiProjectFile</b>(<i></i>)
758
759 <p> 756 <p>
760 Public method to get the path of the multi project file. 757 Public method to get the path of the multi project file.
761 </p> 758 </p>
759
762 <dl> 760 <dl>
763 <dt>Return:</dt> 761 <dt>Return:</dt>
764 <dd> 762 <dd>
765 path of the multi project file 763 path of the multi project file
766 </dd> 764 </dd>
772 </dd> 770 </dd>
773 </dl> 771 </dl>
774 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> 772 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a>
775 <h4>MultiProject.getMultiProjectPath</h4> 773 <h4>MultiProject.getMultiProjectPath</h4>
776 <b>getMultiProjectPath</b>(<i></i>) 774 <b>getMultiProjectPath</b>(<i></i>)
777
778 <p> 775 <p>
779 Public method to get the multi project path. 776 Public method to get the multi project path.
780 </p> 777 </p>
778
781 <dl> 779 <dl>
782 <dt>Return:</dt> 780 <dt>Return:</dt>
783 <dd> 781 <dd>
784 multi project path 782 multi project path
785 </dd> 783 </dd>
791 </dd> 789 </dd>
792 </dl> 790 </dl>
793 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> 791 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a>
794 <h4>MultiProject.getProject</h4> 792 <h4>MultiProject.getProject</h4>
795 <b>getProject</b>(<i>uid</i>) 793 <b>getProject</b>(<i>uid</i>)
796
797 <p> 794 <p>
798 Public method to get a reference to a project entry. 795 Public method to get a reference to a project entry.
799 </p> 796 </p>
797
800 <dl> 798 <dl>
801 799
802 <dt><i>uid</i> (str)</dt> 800 <dt><i>uid</i> (str)</dt>
803 <dd> 801 <dd>
804 UID of the project to get 802 UID of the project to get
817 </dd> 815 </dd>
818 </dl> 816 </dl>
819 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a> 817 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a>
820 <h4>MultiProject.getProjects</h4> 818 <h4>MultiProject.getProjects</h4>
821 <b>getProjects</b>(<i></i>) 819 <b>getProjects</b>(<i></i>)
822
823 <p> 820 <p>
824 Public method to get all project entries. 821 Public method to get all project entries.
825 </p> 822 </p>
823
826 <dl> 824 <dl>
827 <dt>Return:</dt> 825 <dt>Return:</dt>
828 <dd> 826 <dd>
829 list of all project entries 827 list of all project entries
830 </dd> 828 </dd>
836 </dd> 834 </dd>
837 </dl> 835 </dl>
838 <a NAME="MultiProject.hasRemovedProjects" ID="MultiProject.hasRemovedProjects"></a> 836 <a NAME="MultiProject.hasRemovedProjects" ID="MultiProject.hasRemovedProjects"></a>
839 <h4>MultiProject.hasRemovedProjects</h4> 837 <h4>MultiProject.hasRemovedProjects</h4>
840 <b>hasRemovedProjects</b>(<i></i>) 838 <b>hasRemovedProjects</b>(<i></i>)
841
842 <p> 839 <p>
843 Public method to check for removed projects. 840 Public method to check for removed projects.
844 </p> 841 </p>
842
845 <dl> 843 <dl>
846 <dt>Return:</dt> 844 <dt>Return:</dt>
847 <dd> 845 <dd>
848 flag indicating the existence of a removed project 846 flag indicating the existence of a removed project
849 </dd> 847 </dd>
855 </dd> 853 </dd>
856 </dl> 854 </dl>
857 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> 855 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a>
858 <h4>MultiProject.initActions</h4> 856 <h4>MultiProject.initActions</h4>
859 <b>initActions</b>(<i></i>) 857 <b>initActions</b>(<i></i>)
860
861 <p> 858 <p>
862 Public slot to initialize the multi project related actions. 859 Public slot to initialize the multi project related actions.
863 </p> 860 </p>
861
864 <a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a> 862 <a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a>
865 <h4>MultiProject.initMenu</h4> 863 <h4>MultiProject.initMenu</h4>
866 <b>initMenu</b>(<i></i>) 864 <b>initMenu</b>(<i></i>)
867
868 <p> 865 <p>
869 Public slot to initialize the multi project menu. 866 Public slot to initialize the multi project menu.
870 </p> 867 </p>
868
871 <dl> 869 <dl>
872 <dt>Return:</dt> 870 <dt>Return:</dt>
873 <dd> 871 <dd>
874 the menu generated 872 the menu generated
875 </dd> 873 </dd>
881 </dd> 879 </dd>
882 </dl> 880 </dl>
883 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> 881 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a>
884 <h4>MultiProject.initToolbar</h4> 882 <h4>MultiProject.initToolbar</h4>
885 <b>initToolbar</b>(<i>toolbarManager</i>) 883 <b>initToolbar</b>(<i>toolbarManager</i>)
886
887 <p> 884 <p>
888 Public slot to initialize the multi project toolbar. 885 Public slot to initialize the multi project toolbar.
889 </p> 886 </p>
887
890 <dl> 888 <dl>
891 889
892 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> 890 <dt><i>toolbarManager</i> (EricToolBarManager)</dt>
893 <dd> 891 <dd>
894 reference to a toolbar manager object 892 reference to a toolbar manager object
907 </dd> 905 </dd>
908 </dl> 906 </dl>
909 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> 907 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a>
910 <h4>MultiProject.isDirty</h4> 908 <h4>MultiProject.isDirty</h4>
911 <b>isDirty</b>(<i></i>) 909 <b>isDirty</b>(<i></i>)
912
913 <p> 910 <p>
914 Public method to return the dirty state. 911 Public method to return the dirty state.
915 </p> 912 </p>
913
916 <dl> 914 <dl>
917 <dt>Return:</dt> 915 <dt>Return:</dt>
918 <dd> 916 <dd>
919 dirty state 917 dirty state
920 </dd> 918 </dd>
926 </dd> 924 </dd>
927 </dl> 925 </dl>
928 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> 926 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a>
929 <h4>MultiProject.isOpen</h4> 927 <h4>MultiProject.isOpen</h4>
930 <b>isOpen</b>(<i></i>) 928 <b>isOpen</b>(<i></i>)
931
932 <p> 929 <p>
933 Public method to return the opened state. 930 Public method to return the opened state.
934 </p> 931 </p>
932
935 <dl> 933 <dl>
936 <dt>Return:</dt> 934 <dt>Return:</dt>
937 <dd> 935 <dd>
938 open state 936 open state
939 </dd> 937 </dd>
945 </dd> 943 </dd>
946 </dl> 944 </dl>
947 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> 945 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a>
948 <h4>MultiProject.openMultiProject</h4> 946 <h4>MultiProject.openMultiProject</h4>
949 <b>openMultiProject</b>(<i>fn=None, openMain=True</i>) 947 <b>openMultiProject</b>(<i>fn=None, openMain=True</i>)
950
951 <p> 948 <p>
952 Public slot to open a multi project. 949 Public slot to open a multi project.
953 </p> 950 </p>
951
954 <dl> 952 <dl>
955 953
956 <dt><i>fn</i> (str)</dt> 954 <dt><i>fn</i> (str)</dt>
957 <dd> 955 <dd>
958 optional filename of the multi project file to be 956 optional filename of the multi project file to be
965 </dd> 963 </dd>
966 </dl> 964 </dl>
967 <a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a> 965 <a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a>
968 <h4>MultiProject.openProject</h4> 966 <h4>MultiProject.openProject</h4>
969 <b>openProject</b>(<i>filename</i>) 967 <b>openProject</b>(<i>filename</i>)
970
971 <p> 968 <p>
972 Public slot to open a project. 969 Public slot to open a project.
973 </p> 970 </p>
971
974 <dl> 972 <dl>
975 973
976 <dt><i>filename</i> (str)</dt> 974 <dt><i>filename</i> (str)</dt>
977 <dd> 975 <dd>
978 filename of the project file 976 filename of the project file
979 </dd> 977 </dd>
980 </dl> 978 </dl>
981 <a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a> 979 <a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a>
982 <h4>MultiProject.removeEricActions</h4> 980 <h4>MultiProject.removeEricActions</h4>
983 <b>removeEricActions</b>(<i>actions</i>) 981 <b>removeEricActions</b>(<i>actions</i>)
984
985 <p> 982 <p>
986 Public method to remove actions from the list of actions. 983 Public method to remove actions from the list of actions.
987 </p> 984 </p>
985
988 <dl> 986 <dl>
989 987
990 <dt><i>actions</i> (list of EricAction)</dt> 988 <dt><i>actions</i> (list of EricAction)</dt>
991 <dd> 989 <dd>
992 list of actions 990 list of actions
993 </dd> 991 </dd>
994 </dl> 992 </dl>
995 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a> 993 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a>
996 <h4>MultiProject.removeProject</h4> 994 <h4>MultiProject.removeProject</h4>
997 <b>removeProject</b>(<i>uid</i>) 995 <b>removeProject</b>(<i>uid</i>)
998
999 <p> 996 <p>
1000 Public slot to remove a project from the multi project. 997 Public slot to remove a project from the multi project.
1001 </p> 998 </p>
999
1002 <dl> 1000 <dl>
1003 1001
1004 <dt><i>uid</i> (str)</dt> 1002 <dt><i>uid</i> (str)</dt>
1005 <dd> 1003 <dd>
1006 UID of the project to be removed from the multi 1004 UID of the project to be removed from the multi
1008 </dd> 1006 </dd>
1009 </dl> 1007 </dl>
1010 <a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a> 1008 <a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a>
1011 <h4>MultiProject.saveMultiProject</h4> 1009 <h4>MultiProject.saveMultiProject</h4>
1012 <b>saveMultiProject</b>(<i></i>) 1010 <b>saveMultiProject</b>(<i></i>)
1013
1014 <p> 1011 <p>
1015 Public slot to save the current multi project. 1012 Public slot to save the current multi project.
1016 </p> 1013 </p>
1014
1017 <dl> 1015 <dl>
1018 <dt>Return:</dt> 1016 <dt>Return:</dt>
1019 <dd> 1017 <dd>
1020 flag indicating success 1018 flag indicating success
1021 </dd> 1019 </dd>
1027 </dd> 1025 </dd>
1028 </dl> 1026 </dl>
1029 <a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a> 1027 <a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a>
1030 <h4>MultiProject.saveMultiProjectAs</h4> 1028 <h4>MultiProject.saveMultiProjectAs</h4>
1031 <b>saveMultiProjectAs</b>(<i></i>) 1029 <b>saveMultiProjectAs</b>(<i></i>)
1032
1033 <p> 1030 <p>
1034 Public slot to save the current multi project to a different file. 1031 Public slot to save the current multi project to a different file.
1035 </p> 1032 </p>
1033
1036 <dl> 1034 <dl>
1037 <dt>Return:</dt> 1035 <dt>Return:</dt>
1038 <dd> 1036 <dd>
1039 flag indicating success 1037 flag indicating success
1040 </dd> 1038 </dd>
1046 </dd> 1044 </dd>
1047 </dl> 1045 </dl>
1048 <a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a> 1046 <a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a>
1049 <h4>MultiProject.setDirty</h4> 1047 <h4>MultiProject.setDirty</h4>
1050 <b>setDirty</b>(<i>b</i>) 1048 <b>setDirty</b>(<i>b</i>)
1051
1052 <p> 1049 <p>
1053 Public method to set the dirty state. 1050 Public method to set the dirty state.
1054 </p> 1051 </p>
1055 <p> 1052 <p>
1056 It emits the signal dirty(int). 1053 It emits the signal dirty(int).
1057 </p> 1054 </p>
1055
1058 <dl> 1056 <dl>
1059 1057
1060 <dt><i>b</i> (bool)</dt> 1058 <dt><i>b</i> (bool)</dt>
1061 <dd> 1059 <dd>
1062 dirty state 1060 dirty state

Mercurial Repository: eric

eric ide

mercurial