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 10411
- f9dedceca6c9
- parent 9971
- 773ad1f1ed22
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10410:da82156f44e9 | 10411:f9dedceca6c9 |
|---|---|
| 60 </dd> | 60 </dd> |
| 61 <dt>newMultiProject()</dt> | 61 <dt>newMultiProject()</dt> |
| 62 <dd> | 62 <dd> |
| 63 emitted after a new multi project was generated | 63 emitted after a new multi project was generated |
| 64 </dd> | 64 </dd> |
| 65 <dt>projectAdded(project data dict)</dt> | 65 <dt>projectAdded(project metadata)</dt> |
| 66 <dd> | 66 <dd> |
| 67 emitted after a project entry | 67 emitted after a project entry |
| 68 has been added | 68 has been added |
| 69 </dd> | 69 </dd> |
| 70 <dt>projectDataChanged(project data dict)</dt> | 70 <dt>projectDataChanged(project metadata)</dt> |
| 71 <dd> | 71 <dd> |
| 72 emitted after a project entry | 72 emitted after a project entry |
| 73 has been changed | 73 has been changed |
| 74 </dd> | 74 </dd> |
| 75 <dt>projectOpened(filename)</dt> | 75 <dt>projectOpened(filename)</dt> |
| 76 <dd> | 76 <dd> |
| 77 emitted after the project has been opened | 77 emitted after the project has been opened |
| 78 </dd> | 78 </dd> |
| 79 <dt>projectRemoved(project data dict)</dt> | 79 <dt>projectRemoved(project metadata)</dt> |
| 80 <dd> | 80 <dd> |
| 81 emitted after a project entry | 81 emitted after a project entry |
| 82 has been removed | 82 has been removed |
| 83 </dd> | 83 </dd> |
| 84 <dt>showMenu(string, QMenu)</dt> | 84 <dt>showMenu(string, QMenu)</dt> |
| 186 <tr> | 186 <tr> |
| 187 <td><a href="#MultiProject.clearRecent">clearRecent</a></td> | 187 <td><a href="#MultiProject.clearRecent">clearRecent</a></td> |
| 188 <td>Public method to clear the recent multi projects menu.</td> | 188 <td>Public method to clear the recent multi projects menu.</td> |
| 189 </tr> | 189 </tr> |
| 190 <tr> | 190 <tr> |
| 191 <td><a href="#MultiProject.clearRemovedProjects">clearRemovedProjects</a></td> | |
| 192 <td>Public slot to clear out all projects marked as removed.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 191 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td> | 195 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td> |
| 192 <td>Public slot to close the current multi project.</td> | 196 <td>Public slot to close the current multi project.</td> |
| 193 </tr> | 197 </tr> |
| 194 <tr> | 198 <tr> |
| 195 <td><a href="#MultiProject.copyProject">copyProject</a></td> | 199 <td><a href="#MultiProject.copyProject">copyProject</a></td> |
| 236 <td>Public method to get a reference to a project entry.</td> | 240 <td>Public method to get a reference to a project entry.</td> |
| 237 </tr> | 241 </tr> |
| 238 <tr> | 242 <tr> |
| 239 <td><a href="#MultiProject.getProjects">getProjects</a></td> | 243 <td><a href="#MultiProject.getProjects">getProjects</a></td> |
| 240 <td>Public method to get all project entries.</td> | 244 <td>Public method to get all project entries.</td> |
| 245 </tr> | |
| 246 <tr> | |
| 247 <td><a href="#MultiProject.hasRemovedProjects">hasRemovedProjects</a></td> | |
| 248 <td>Public method to check for removed projects.</td> | |
| 241 </tr> | 249 </tr> |
| 242 <tr> | 250 <tr> |
| 243 <td><a href="#MultiProject.initActions">initActions</a></td> | 251 <td><a href="#MultiProject.initActions">initActions</a></td> |
| 244 <td>Public slot to initialize the multi project related actions.</td> | 252 <td>Public slot to initialize the multi project related actions.</td> |
| 245 </tr> | 253 </tr> |
| 301 <p> | 309 <p> |
| 302 Constructor | 310 Constructor |
| 303 </p> | 311 </p> |
| 304 <dl> | 312 <dl> |
| 305 | 313 |
| 306 <dt><i>project</i></dt> | 314 <dt><i>project</i> (Project.Project)</dt> |
| 307 <dd> | 315 <dd> |
| 308 reference to the project object (Project.Project) | 316 reference to the project object |
| 309 </dd> | 317 </dd> |
| 310 <dt><i>parent</i></dt> | 318 <dt><i>parent</i> (QWidget)</dt> |
| 311 <dd> | 319 <dd> |
| 312 parent widget (usually the ui object) (QWidget) | 320 parent widget (usually the ui object) |
| 313 </dd> | 321 </dd> |
| 314 <dt><i>filename</i></dt> | 322 <dt><i>filename</i> (str)</dt> |
| 315 <dd> | 323 <dd> |
| 316 optional filename of a multi project file to open | 324 optional filename of a multi project file to open |
| 317 (string) | |
| 318 </dd> | 325 </dd> |
| 319 </dl> | 326 </dl> |
| 320 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a> | 327 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a> |
| 321 <h4>MultiProject.__checkFilesExist</h4> | 328 <h4>MultiProject.__checkFilesExist</h4> |
| 322 <b>__checkFilesExist</b>(<i></i>) | 329 <b>__checkFilesExist</b>(<i></i>) |
| 368 <p> | 375 <p> |
| 369 Private slot to open the main project. | 376 Private slot to open the main project. |
| 370 </p> | 377 </p> |
| 371 <dl> | 378 <dl> |
| 372 | 379 |
| 373 <dt><i>reopen</i></dt> | 380 <dt><i>reopen</i> (bool)</dt> |
| 374 <dd> | 381 <dd> |
| 375 flag indicating, that the main project should be | 382 flag indicating, that the main project should be |
| 376 reopened, if it has been opened already (boolean) | 383 reopened, if it has been opened already |
| 377 </dd> | 384 </dd> |
| 378 </dl> | 385 </dl> |
| 379 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a> | 386 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a> |
| 380 <h4>MultiProject.__openRecent</h4> | 387 <h4>MultiProject.__openRecent</h4> |
| 381 <b>__openRecent</b>(<i>act</i>) | 388 <b>__openRecent</b>(<i>act</i>) |
| 384 Private method to open a multi project from the list of rencently | 391 Private method to open a multi project from the list of rencently |
| 385 opened multi projects. | 392 opened multi projects. |
| 386 </p> | 393 </p> |
| 387 <dl> | 394 <dl> |
| 388 | 395 |
| 389 <dt><i>act</i></dt> | 396 <dt><i>act</i> (QAction)</dt> |
| 390 <dd> | 397 <dd> |
| 391 reference to the action that triggered (QAction) | 398 reference to the action that triggered |
| 392 </dd> | 399 </dd> |
| 393 </dl> | 400 </dl> |
| 394 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a> | 401 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a> |
| 395 <h4>MultiProject.__readMultiProject</h4> | 402 <h4>MultiProject.__readMultiProject</h4> |
| 396 <b>__readMultiProject</b>(<i>fn</i>) | 403 <b>__readMultiProject</b>(<i>fn</i>) |
| 398 <p> | 405 <p> |
| 399 Private method to read in a multi project (.emj, .e4m, .e5m) file. | 406 Private method to read in a multi project (.emj, .e4m, .e5m) file. |
| 400 </p> | 407 </p> |
| 401 <dl> | 408 <dl> |
| 402 | 409 |
| 403 <dt><i>fn</i></dt> | 410 <dt><i>fn</i> (str)</dt> |
| 404 <dd> | 411 <dd> |
| 405 filename of the multi project file to be read (string) | 412 filename of the multi project file to be read |
| 406 </dd> | 413 </dd> |
| 407 </dl> | 414 </dl> |
| 408 <dl> | 415 <dl> |
| 409 <dt>Return:</dt> | 416 <dt>Return:</dt> |
| 410 <dd> | 417 <dd> |
| 411 flag indicating success | 418 flag indicating success |
| 419 </dd> | |
| 420 </dl> | |
| 421 <dl> | |
| 422 <dt>Return Type:</dt> | |
| 423 <dd> | |
| 424 bool | |
| 412 </dd> | 425 </dd> |
| 413 </dl> | 426 </dl> |
| 414 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> | 427 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> |
| 415 <h4>MultiProject.__saveRecent</h4> | 428 <h4>MultiProject.__saveRecent</h4> |
| 416 <b>__saveRecent</b>(<i></i>) | 429 <b>__saveRecent</b>(<i></i>) |
| 454 <p> | 467 <p> |
| 455 Private method to save the multi project infos to a multi project file. | 468 Private method to save the multi project infos to a multi project file. |
| 456 </p> | 469 </p> |
| 457 <dl> | 470 <dl> |
| 458 | 471 |
| 459 <dt><i>fn</i></dt> | 472 <dt><i>fn</i> (str)</dt> |
| 460 <dd> | 473 <dd> |
| 461 optional filename of the multi project file to be written. | 474 optional filename of the multi project file to be written. |
| 462 If fn is None, the filename stored in the multi project object | 475 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 | 476 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 | 477 is used instead of the one in the multi project object. This is the |
| 469 <dt>Return:</dt> | 482 <dt>Return:</dt> |
| 470 <dd> | 483 <dd> |
| 471 flag indicating success | 484 flag indicating success |
| 472 </dd> | 485 </dd> |
| 473 </dl> | 486 </dl> |
| 487 <dl> | |
| 488 <dt>Return Type:</dt> | |
| 489 <dd> | |
| 490 bool | |
| 491 </dd> | |
| 492 </dl> | |
| 474 <a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a> | 493 <a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a> |
| 475 <h4>MultiProject.addEricActions</h4> | 494 <h4>MultiProject.addEricActions</h4> |
| 476 <b>addEricActions</b>(<i>actions</i>) | 495 <b>addEricActions</b>(<i>actions</i>) |
| 477 | 496 |
| 478 <p> | 497 <p> |
| 479 Public method to add actions to the list of actions. | 498 Public method to add actions to the list of actions. |
| 480 </p> | 499 </p> |
| 481 <dl> | 500 <dl> |
| 482 | 501 |
| 483 <dt><i>actions</i></dt> | 502 <dt><i>actions</i> (list of EricAction)</dt> |
| 484 <dd> | 503 <dd> |
| 485 list of actions (list of EricAction) | 504 list of actions |
| 486 </dd> | 505 </dd> |
| 487 </dl> | 506 </dl> |
| 488 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a> | 507 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a> |
| 489 <h4>MultiProject.addNewProject</h4> | 508 <h4>MultiProject.addNewProject</h4> |
| 490 <b>addNewProject</b>(<i>startdir="", category=""</i>) | 509 <b>addNewProject</b>(<i>startdir="", category=""</i>) |
| 510 <p> | 529 <p> |
| 511 Public method to add a project to the multi-project. | 530 Public method to add a project to the multi-project. |
| 512 </p> | 531 </p> |
| 513 <dl> | 532 <dl> |
| 514 | 533 |
| 515 <dt><i>project</i> (dict)</dt> | 534 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
| 516 <dd> | 535 <dd> |
| 517 dictionary containing the project data to be added | 536 dictionary containing the project data to be added |
| 518 </dd> | 537 </dd> |
| 519 </dl> | 538 </dl> |
| 520 <a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a> | 539 <a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a> |
| 524 <p> | 543 <p> |
| 525 Public method to change the data of a project entry. | 544 Public method to change the data of a project entry. |
| 526 </p> | 545 </p> |
| 527 <dl> | 546 <dl> |
| 528 | 547 |
| 529 <dt><i>pro</i></dt> | 548 <dt><i>pro</i> (str)</dt> |
| 530 <dd> | 549 <dd> |
| 531 dictionary with the project data (string) | 550 dictionary with the project data |
| 532 </dd> | 551 </dd> |
| 533 </dl> | 552 </dl> |
| 534 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a> | 553 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a> |
| 535 <h4>MultiProject.checkDirty</h4> | 554 <h4>MultiProject.checkDirty</h4> |
| 536 <b>checkDirty</b>(<i></i>) | 555 <b>checkDirty</b>(<i></i>) |
| 539 Public method to check the dirty status and open a message window. | 558 Public method to check the dirty status and open a message window. |
| 540 </p> | 559 </p> |
| 541 <dl> | 560 <dl> |
| 542 <dt>Return:</dt> | 561 <dt>Return:</dt> |
| 543 <dd> | 562 <dd> |
| 544 flag indicating whether this operation was successful (boolean) | 563 flag indicating whether this operation was successful |
| 564 </dd> | |
| 565 </dl> | |
| 566 <dl> | |
| 567 <dt>Return Type:</dt> | |
| 568 <dd> | |
| 569 bool | |
| 545 </dd> | 570 </dd> |
| 546 </dl> | 571 </dl> |
| 547 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> | 572 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> |
| 548 <h4>MultiProject.clearRecent</h4> | 573 <h4>MultiProject.clearRecent</h4> |
| 549 <b>clearRecent</b>(<i></i>) | 574 <b>clearRecent</b>(<i></i>) |
| 550 | 575 |
| 551 <p> | 576 <p> |
| 552 Public method to clear the recent multi projects menu. | 577 Public method to clear the recent multi projects menu. |
| 553 </p> | 578 </p> |
| 579 <a NAME="MultiProject.clearRemovedProjects" ID="MultiProject.clearRemovedProjects"></a> | |
| 580 <h4>MultiProject.clearRemovedProjects</h4> | |
| 581 <b>clearRemovedProjects</b>(<i></i>) | |
| 582 | |
| 583 <p> | |
| 584 Public slot to clear out all projects marked as removed. | |
| 585 </p> | |
| 554 <a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a> | 586 <a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a> |
| 555 <h4>MultiProject.closeMultiProject</h4> | 587 <h4>MultiProject.closeMultiProject</h4> |
| 556 <b>closeMultiProject</b>(<i></i>) | 588 <b>closeMultiProject</b>(<i></i>) |
| 557 | 589 |
| 558 <p> | 590 <p> |
| 559 Public slot to close the current multi project. | 591 Public slot to close the current multi project. |
| 560 </p> | 592 </p> |
| 561 <dl> | 593 <dl> |
| 562 <dt>Return:</dt> | 594 <dt>Return:</dt> |
| 563 <dd> | 595 <dd> |
| 564 flag indicating success (boolean) | 596 flag indicating success |
| 597 </dd> | |
| 598 </dl> | |
| 599 <dl> | |
| 600 <dt>Return Type:</dt> | |
| 601 <dd> | |
| 602 bool | |
| 565 </dd> | 603 </dd> |
| 566 </dl> | 604 </dl> |
| 567 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> | 605 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> |
| 568 <h4>MultiProject.copyProject</h4> | 606 <h4>MultiProject.copyProject</h4> |
| 569 <b>copyProject</b>(<i>uid</i>) | 607 <b>copyProject</b>(<i>uid</i>) |
| 601 Public method to get a list of all actions. | 639 Public method to get a list of all actions. |
| 602 </p> | 640 </p> |
| 603 <dl> | 641 <dl> |
| 604 <dt>Return:</dt> | 642 <dt>Return:</dt> |
| 605 <dd> | 643 <dd> |
| 606 list of all actions (list of EricAction) | 644 list of all actions |
| 645 </dd> | |
| 646 </dl> | |
| 647 <dl> | |
| 648 <dt>Return Type:</dt> | |
| 649 <dd> | |
| 650 list of EricAction | |
| 607 </dd> | 651 </dd> |
| 608 </dl> | 652 </dl> |
| 609 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> | 653 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> |
| 610 <h4>MultiProject.getCategories</h4> | 654 <h4>MultiProject.getCategories</h4> |
| 611 <b>getCategories</b>(<i></i>) | 655 <b>getCategories</b>(<i></i>) |
| 614 Public method to get the list of defined categories. | 658 Public method to get the list of defined categories. |
| 615 </p> | 659 </p> |
| 616 <dl> | 660 <dl> |
| 617 <dt>Return:</dt> | 661 <dt>Return:</dt> |
| 618 <dd> | 662 <dd> |
| 619 list of categories (list of string) | 663 list of categories |
| 664 </dd> | |
| 665 </dl> | |
| 666 <dl> | |
| 667 <dt>Return Type:</dt> | |
| 668 <dd> | |
| 669 list of str | |
| 620 </dd> | 670 </dd> |
| 621 </dl> | 671 </dl> |
| 622 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> | 672 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> |
| 623 <h4>MultiProject.getDependantProjectFiles</h4> | 673 <h4>MultiProject.getDependantProjectFiles</h4> |
| 624 <b>getDependantProjectFiles</b>(<i></i>) | 674 <b>getDependantProjectFiles</b>(<i></i>) |
| 627 Public method to get the filenames of the dependent projects. | 677 Public method to get the filenames of the dependent projects. |
| 628 </p> | 678 </p> |
| 629 <dl> | 679 <dl> |
| 630 <dt>Return:</dt> | 680 <dt>Return:</dt> |
| 631 <dd> | 681 <dd> |
| 632 names of the dependent project files (list of strings) | 682 names of the dependent project files |
| 683 </dd> | |
| 684 </dl> | |
| 685 <dl> | |
| 686 <dt>Return Type:</dt> | |
| 687 <dd> | |
| 688 list of str | |
| 633 </dd> | 689 </dd> |
| 634 </dl> | 690 </dl> |
| 635 <a NAME="MultiProject.getMainProjectFile" ID="MultiProject.getMainProjectFile"></a> | 691 <a NAME="MultiProject.getMainProjectFile" ID="MultiProject.getMainProjectFile"></a> |
| 636 <h4>MultiProject.getMainProjectFile</h4> | 692 <h4>MultiProject.getMainProjectFile</h4> |
| 637 <b>getMainProjectFile</b>(<i></i>) | 693 <b>getMainProjectFile</b>(<i></i>) |
| 658 <p> | 714 <p> |
| 659 Public method to get a reference to the main menu or a submenu. | 715 Public method to get a reference to the main menu or a submenu. |
| 660 </p> | 716 </p> |
| 661 <dl> | 717 <dl> |
| 662 | 718 |
| 663 <dt><i>menuName</i></dt> | 719 <dt><i>menuName</i> (str)</dt> |
| 664 <dd> | 720 <dd> |
| 665 name of the menu (string) | 721 name of the menu |
| 666 </dd> | 722 </dd> |
| 667 </dl> | 723 </dl> |
| 668 <dl> | 724 <dl> |
| 669 <dt>Return:</dt> | 725 <dt>Return:</dt> |
| 670 <dd> | 726 <dd> |
| 671 reference to the requested menu (QMenu) or None | 727 reference to the requested menu |
| 728 </dd> | |
| 729 </dl> | |
| 730 <dl> | |
| 731 <dt>Return Type:</dt> | |
| 732 <dd> | |
| 733 QMenu or None | |
| 672 </dd> | 734 </dd> |
| 673 </dl> | 735 </dl> |
| 674 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> | 736 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> |
| 675 <h4>MultiProject.getMostRecent</h4> | 737 <h4>MultiProject.getMostRecent</h4> |
| 676 <b>getMostRecent</b>(<i></i>) | 738 <b>getMostRecent</b>(<i></i>) |
| 679 Public method to get the most recently opened multiproject. | 741 Public method to get the most recently opened multiproject. |
| 680 </p> | 742 </p> |
| 681 <dl> | 743 <dl> |
| 682 <dt>Return:</dt> | 744 <dt>Return:</dt> |
| 683 <dd> | 745 <dd> |
| 684 path of the most recently opened multiproject (string) | 746 path of the most recently opened multiproject |
| 747 </dd> | |
| 748 </dl> | |
| 749 <dl> | |
| 750 <dt>Return Type:</dt> | |
| 751 <dd> | |
| 752 str | |
| 685 </dd> | 753 </dd> |
| 686 </dl> | 754 </dl> |
| 687 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> | 755 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> |
| 688 <h4>MultiProject.getMultiProjectFile</h4> | 756 <h4>MultiProject.getMultiProjectFile</h4> |
| 689 <b>getMultiProjectFile</b>(<i></i>) | 757 <b>getMultiProjectFile</b>(<i></i>) |
| 692 Public method to get the path of the multi project file. | 760 Public method to get the path of the multi project file. |
| 693 </p> | 761 </p> |
| 694 <dl> | 762 <dl> |
| 695 <dt>Return:</dt> | 763 <dt>Return:</dt> |
| 696 <dd> | 764 <dd> |
| 697 path of the multi project file (string) | 765 path of the multi project file |
| 766 </dd> | |
| 767 </dl> | |
| 768 <dl> | |
| 769 <dt>Return Type:</dt> | |
| 770 <dd> | |
| 771 str | |
| 698 </dd> | 772 </dd> |
| 699 </dl> | 773 </dl> |
| 700 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> | 774 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> |
| 701 <h4>MultiProject.getMultiProjectPath</h4> | 775 <h4>MultiProject.getMultiProjectPath</h4> |
| 702 <b>getMultiProjectPath</b>(<i></i>) | 776 <b>getMultiProjectPath</b>(<i></i>) |
| 705 Public method to get the multi project path. | 779 Public method to get the multi project path. |
| 706 </p> | 780 </p> |
| 707 <dl> | 781 <dl> |
| 708 <dt>Return:</dt> | 782 <dt>Return:</dt> |
| 709 <dd> | 783 <dd> |
| 710 multi project path (string) | 784 multi project path |
| 785 </dd> | |
| 786 </dl> | |
| 787 <dl> | |
| 788 <dt>Return Type:</dt> | |
| 789 <dd> | |
| 790 str | |
| 711 </dd> | 791 </dd> |
| 712 </dl> | 792 </dl> |
| 713 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> | 793 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> |
| 714 <h4>MultiProject.getProject</h4> | 794 <h4>MultiProject.getProject</h4> |
| 715 <b>getProject</b>(<i>uid</i>) | 795 <b>getProject</b>(<i>uid</i>) |
| 725 </dd> | 805 </dd> |
| 726 </dl> | 806 </dl> |
| 727 <dl> | 807 <dl> |
| 728 <dt>Return:</dt> | 808 <dt>Return:</dt> |
| 729 <dd> | 809 <dd> |
| 730 dictionary containing the project data | 810 project metadata |
| 731 </dd> | 811 </dd> |
| 732 </dl> | 812 </dl> |
| 733 <dl> | 813 <dl> |
| 734 <dt>Return Type:</dt> | 814 <dt>Return Type:</dt> |
| 735 <dd> | 815 <dd> |
| 736 dict | 816 MultiProjectProjectMeta |
| 737 </dd> | 817 </dd> |
| 738 </dl> | 818 </dl> |
| 739 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a> | 819 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a> |
| 740 <h4>MultiProject.getProjects</h4> | 820 <h4>MultiProject.getProjects</h4> |
| 741 <b>getProjects</b>(<i></i>) | 821 <b>getProjects</b>(<i></i>) |
| 744 Public method to get all project entries. | 824 Public method to get all project entries. |
| 745 </p> | 825 </p> |
| 746 <dl> | 826 <dl> |
| 747 <dt>Return:</dt> | 827 <dt>Return:</dt> |
| 748 <dd> | 828 <dd> |
| 749 list of all project entries (list of dictionaries) | 829 list of all project entries |
| 830 </dd> | |
| 831 </dl> | |
| 832 <dl> | |
| 833 <dt>Return Type:</dt> | |
| 834 <dd> | |
| 835 list of MultiProjectProjectMeta | |
| 836 </dd> | |
| 837 </dl> | |
| 838 <a NAME="MultiProject.hasRemovedProjects" ID="MultiProject.hasRemovedProjects"></a> | |
| 839 <h4>MultiProject.hasRemovedProjects</h4> | |
| 840 <b>hasRemovedProjects</b>(<i></i>) | |
| 841 | |
| 842 <p> | |
| 843 Public method to check for removed projects. | |
| 844 </p> | |
| 845 <dl> | |
| 846 <dt>Return:</dt> | |
| 847 <dd> | |
| 848 flag indicating the existence of a removed project | |
| 849 </dd> | |
| 850 </dl> | |
| 851 <dl> | |
| 852 <dt>Return Type:</dt> | |
| 853 <dd> | |
| 854 bool | |
| 750 </dd> | 855 </dd> |
| 751 </dl> | 856 </dl> |
| 752 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> | 857 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> |
| 753 <h4>MultiProject.initActions</h4> | 858 <h4>MultiProject.initActions</h4> |
| 754 <b>initActions</b>(<i></i>) | 859 <b>initActions</b>(<i></i>) |
| 764 Public slot to initialize the multi project menu. | 869 Public slot to initialize the multi project menu. |
| 765 </p> | 870 </p> |
| 766 <dl> | 871 <dl> |
| 767 <dt>Return:</dt> | 872 <dt>Return:</dt> |
| 768 <dd> | 873 <dd> |
| 769 the menu generated (QMenu) | 874 the menu generated |
| 875 </dd> | |
| 876 </dl> | |
| 877 <dl> | |
| 878 <dt>Return Type:</dt> | |
| 879 <dd> | |
| 880 QMenu | |
| 770 </dd> | 881 </dd> |
| 771 </dl> | 882 </dl> |
| 772 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> | 883 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> |
| 773 <h4>MultiProject.initToolbar</h4> | 884 <h4>MultiProject.initToolbar</h4> |
| 774 <b>initToolbar</b>(<i>toolbarManager</i>) | 885 <b>initToolbar</b>(<i>toolbarManager</i>) |
| 776 <p> | 887 <p> |
| 777 Public slot to initialize the multi project toolbar. | 888 Public slot to initialize the multi project toolbar. |
| 778 </p> | 889 </p> |
| 779 <dl> | 890 <dl> |
| 780 | 891 |
| 781 <dt><i>toolbarManager</i></dt> | 892 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> |
| 782 <dd> | 893 <dd> |
| 783 reference to a toolbar manager object | 894 reference to a toolbar manager object |
| 784 (EricToolBarManager) | 895 </dd> |
| 785 </dd> | 896 </dl> |
| 786 </dl> | 897 <dl> |
| 787 <dl> | 898 <dt>Return:</dt> |
| 788 <dt>Return:</dt> | 899 <dd> |
| 789 <dd> | 900 the toolbar generated |
| 790 the toolbar generated (QToolBar) | 901 </dd> |
| 902 </dl> | |
| 903 <dl> | |
| 904 <dt>Return Type:</dt> | |
| 905 <dd> | |
| 906 QToolBar | |
| 791 </dd> | 907 </dd> |
| 792 </dl> | 908 </dl> |
| 793 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> | 909 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> |
| 794 <h4>MultiProject.isDirty</h4> | 910 <h4>MultiProject.isDirty</h4> |
| 795 <b>isDirty</b>(<i></i>) | 911 <b>isDirty</b>(<i></i>) |
| 798 Public method to return the dirty state. | 914 Public method to return the dirty state. |
| 799 </p> | 915 </p> |
| 800 <dl> | 916 <dl> |
| 801 <dt>Return:</dt> | 917 <dt>Return:</dt> |
| 802 <dd> | 918 <dd> |
| 803 dirty state (boolean) | 919 dirty state |
| 920 </dd> | |
| 921 </dl> | |
| 922 <dl> | |
| 923 <dt>Return Type:</dt> | |
| 924 <dd> | |
| 925 bool | |
| 804 </dd> | 926 </dd> |
| 805 </dl> | 927 </dl> |
| 806 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> | 928 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> |
| 807 <h4>MultiProject.isOpen</h4> | 929 <h4>MultiProject.isOpen</h4> |
| 808 <b>isOpen</b>(<i></i>) | 930 <b>isOpen</b>(<i></i>) |
| 811 Public method to return the opened state. | 933 Public method to return the opened state. |
| 812 </p> | 934 </p> |
| 813 <dl> | 935 <dl> |
| 814 <dt>Return:</dt> | 936 <dt>Return:</dt> |
| 815 <dd> | 937 <dd> |
| 816 open state (boolean) | 938 open state |
| 939 </dd> | |
| 940 </dl> | |
| 941 <dl> | |
| 942 <dt>Return Type:</dt> | |
| 943 <dd> | |
| 944 bool | |
| 817 </dd> | 945 </dd> |
| 818 </dl> | 946 </dl> |
| 819 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> | 947 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> |
| 820 <h4>MultiProject.openMultiProject</h4> | 948 <h4>MultiProject.openMultiProject</h4> |
| 821 <b>openMultiProject</b>(<i>fn=None, openMain=True</i>) | 949 <b>openMultiProject</b>(<i>fn=None, openMain=True</i>) |
| 843 <p> | 971 <p> |
| 844 Public slot to open a project. | 972 Public slot to open a project. |
| 845 </p> | 973 </p> |
| 846 <dl> | 974 <dl> |
| 847 | 975 |
| 848 <dt><i>filename</i></dt> | 976 <dt><i>filename</i> (str)</dt> |
| 849 <dd> | 977 <dd> |
| 850 filename of the project file (string) | 978 filename of the project file |
| 851 </dd> | 979 </dd> |
| 852 </dl> | 980 </dl> |
| 853 <a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a> | 981 <a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a> |
| 854 <h4>MultiProject.removeEricActions</h4> | 982 <h4>MultiProject.removeEricActions</h4> |
| 855 <b>removeEricActions</b>(<i>actions</i>) | 983 <b>removeEricActions</b>(<i>actions</i>) |
| 857 <p> | 985 <p> |
| 858 Public method to remove actions from the list of actions. | 986 Public method to remove actions from the list of actions. |
| 859 </p> | 987 </p> |
| 860 <dl> | 988 <dl> |
| 861 | 989 |
| 862 <dt><i>actions</i></dt> | 990 <dt><i>actions</i> (list of EricAction)</dt> |
| 863 <dd> | 991 <dd> |
| 864 list of actions (list of EricAction) | 992 list of actions |
| 865 </dd> | 993 </dd> |
| 866 </dl> | 994 </dl> |
| 867 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a> | 995 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a> |
| 868 <h4>MultiProject.removeProject</h4> | 996 <h4>MultiProject.removeProject</h4> |
| 869 <b>removeProject</b>(<i>uid</i>) | 997 <b>removeProject</b>(<i>uid</i>) |
| 927 <p> | 1055 <p> |
| 928 It emits the signal dirty(int). | 1056 It emits the signal dirty(int). |
| 929 </p> | 1057 </p> |
| 930 <dl> | 1058 <dl> |
| 931 | 1059 |
| 932 <dt><i>b</i></dt> | 1060 <dt><i>b</i> (bool)</dt> |
| 933 <dd> | 1061 <dd> |
| 934 dirty state (boolean) | 1062 dirty state |
| 935 </dd> | 1063 </dd> |
| 936 </dl> | 1064 </dl> |
| 937 <div align="right"><a href="#top">Up</a></div> | 1065 <div align="right"><a href="#top">Up</a></div> |
| 938 <hr /> | 1066 <hr /> |
| 939 </body></html> | 1067 </body></html> |
