Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.MultiProject.MultiProject.html
eric6/Documentation/Source/eric6.MultiProject.MultiProject.html
- changeset 7989
- a21d673a8f99
- parent 7273
- 391d6b7b1eff
- child 8049
- af58c1d47e5e
equal
deleted
inserted
replaced
| 7988:c4c17121eff8 | 7989:a21d673a8f99 |
|---|---|
| 418 <dd> | 418 <dd> |
| 419 filename of the multi project file to be read (string) | 419 filename of the multi project file to be read (string) |
| 420 </dd> | 420 </dd> |
| 421 </dl> | 421 </dl> |
| 422 <dl> | 422 <dl> |
| 423 <dt>Returns:</dt> | 423 <dt>Return:</dt> |
| 424 <dd> | 424 <dd> |
| 425 flag indicating success | 425 flag indicating success |
| 426 </dd> | 426 </dd> |
| 427 </dl> | 427 </dl> |
| 428 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> | 428 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> |
| 478 is used instead of the one in the multi project object. This is the | 478 is used instead of the one in the multi project object. This is the |
| 479 'save as' action. | 479 'save as' action. |
| 480 </dd> | 480 </dd> |
| 481 </dl> | 481 </dl> |
| 482 <dl> | 482 <dl> |
| 483 <dt>Returns:</dt> | 483 <dt>Return:</dt> |
| 484 <dd> | 484 <dd> |
| 485 flag indicating success | 485 flag indicating success |
| 486 </dd> | 486 </dd> |
| 487 </dl> | 487 </dl> |
| 488 <a NAME="MultiProject.addE5Actions" ID="MultiProject.addE5Actions"></a> | 488 <a NAME="MultiProject.addE5Actions" ID="MultiProject.addE5Actions"></a> |
| 551 | 551 |
| 552 <p> | 552 <p> |
| 553 Public method to check the dirty status and open a message window. | 553 Public method to check the dirty status and open a message window. |
| 554 </p> | 554 </p> |
| 555 <dl> | 555 <dl> |
| 556 <dt>Returns:</dt> | 556 <dt>Return:</dt> |
| 557 <dd> | 557 <dd> |
| 558 flag indicating whether this operation was successful (boolean) | 558 flag indicating whether this operation was successful (boolean) |
| 559 </dd> | 559 </dd> |
| 560 </dl> | 560 </dl> |
| 561 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> | 561 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> |
| 571 | 571 |
| 572 <p> | 572 <p> |
| 573 Public slot to close the current multi project. | 573 Public slot to close the current multi project. |
| 574 </p> | 574 </p> |
| 575 <dl> | 575 <dl> |
| 576 <dt>Returns:</dt> | 576 <dt>Return:</dt> |
| 577 <dd> | 577 <dd> |
| 578 flag indicating success (boolean) | 578 flag indicating success (boolean) |
| 579 </dd> | 579 </dd> |
| 580 </dl> | 580 </dl> |
| 581 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> | 581 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> |
| 613 | 613 |
| 614 <p> | 614 <p> |
| 615 Public method to get a list of all actions. | 615 Public method to get a list of all actions. |
| 616 </p> | 616 </p> |
| 617 <dl> | 617 <dl> |
| 618 <dt>Returns:</dt> | 618 <dt>Return:</dt> |
| 619 <dd> | 619 <dd> |
| 620 list of all actions (list of E5Action) | 620 list of all actions (list of E5Action) |
| 621 </dd> | 621 </dd> |
| 622 </dl> | 622 </dl> |
| 623 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> | 623 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> |
| 626 | 626 |
| 627 <p> | 627 <p> |
| 628 Public method to get the list of defined categories. | 628 Public method to get the list of defined categories. |
| 629 </p> | 629 </p> |
| 630 <dl> | 630 <dl> |
| 631 <dt>Returns:</dt> | 631 <dt>Return:</dt> |
| 632 <dd> | 632 <dd> |
| 633 list of categories (list of string) | 633 list of categories (list of string) |
| 634 </dd> | 634 </dd> |
| 635 </dl> | 635 </dl> |
| 636 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> | 636 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> |
| 639 | 639 |
| 640 <p> | 640 <p> |
| 641 Public method to get the filenames of the dependent projects. | 641 Public method to get the filenames of the dependent projects. |
| 642 </p> | 642 </p> |
| 643 <dl> | 643 <dl> |
| 644 <dt>Returns:</dt> | 644 <dt>Return:</dt> |
| 645 <dd> | 645 <dd> |
| 646 names of the dependent project files (list of strings) | 646 names of the dependent project files (list of strings) |
| 647 </dd> | 647 </dd> |
| 648 </dl> | 648 </dl> |
| 649 <a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a> | 649 <a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a> |
| 652 | 652 |
| 653 <p> | 653 <p> |
| 654 Public method to get the filename of the master project. | 654 Public method to get the filename of the master project. |
| 655 </p> | 655 </p> |
| 656 <dl> | 656 <dl> |
| 657 <dt>Returns:</dt> | 657 <dt>Return:</dt> |
| 658 <dd> | 658 <dd> |
| 659 name of the master project file (string) | 659 name of the master project file (string) |
| 660 </dd> | 660 </dd> |
| 661 </dl> | 661 </dl> |
| 662 <a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a> | 662 <a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a> |
| 672 <dd> | 672 <dd> |
| 673 name of the menu (string) | 673 name of the menu (string) |
| 674 </dd> | 674 </dd> |
| 675 </dl> | 675 </dl> |
| 676 <dl> | 676 <dl> |
| 677 <dt>Returns:</dt> | 677 <dt>Return:</dt> |
| 678 <dd> | 678 <dd> |
| 679 reference to the requested menu (QMenu) or None | 679 reference to the requested menu (QMenu) or None |
| 680 </dd> | 680 </dd> |
| 681 </dl> | 681 </dl> |
| 682 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> | 682 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> |
| 685 | 685 |
| 686 <p> | 686 <p> |
| 687 Public method to get the most recently opened multiproject. | 687 Public method to get the most recently opened multiproject. |
| 688 </p> | 688 </p> |
| 689 <dl> | 689 <dl> |
| 690 <dt>Returns:</dt> | 690 <dt>Return:</dt> |
| 691 <dd> | 691 <dd> |
| 692 path of the most recently opened multiproject (string) | 692 path of the most recently opened multiproject (string) |
| 693 </dd> | 693 </dd> |
| 694 </dl> | 694 </dl> |
| 695 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> | 695 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> |
| 698 | 698 |
| 699 <p> | 699 <p> |
| 700 Public method to get the path of the multi project file. | 700 Public method to get the path of the multi project file. |
| 701 </p> | 701 </p> |
| 702 <dl> | 702 <dl> |
| 703 <dt>Returns:</dt> | 703 <dt>Return:</dt> |
| 704 <dd> | 704 <dd> |
| 705 path of the multi project file (string) | 705 path of the multi project file (string) |
| 706 </dd> | 706 </dd> |
| 707 </dl> | 707 </dl> |
| 708 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> | 708 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> |
| 711 | 711 |
| 712 <p> | 712 <p> |
| 713 Public method to get the multi project path. | 713 Public method to get the multi project path. |
| 714 </p> | 714 </p> |
| 715 <dl> | 715 <dl> |
| 716 <dt>Returns:</dt> | 716 <dt>Return:</dt> |
| 717 <dd> | 717 <dd> |
| 718 multi project path (string) | 718 multi project path (string) |
| 719 </dd> | 719 </dd> |
| 720 </dl> | 720 </dl> |
| 721 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> | 721 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> |
| 731 <dd> | 731 <dd> |
| 732 UID of the project to get | 732 UID of the project to get |
| 733 </dd> | 733 </dd> |
| 734 </dl> | 734 </dl> |
| 735 <dl> | 735 <dl> |
| 736 <dt>Returns:</dt> | 736 <dt>Return:</dt> |
| 737 <dd> | 737 <dd> |
| 738 dictionary containing the project data | 738 dictionary containing the project data |
| 739 </dd> | 739 </dd> |
| 740 </dl> | 740 </dl> |
| 741 <dl> | 741 <dl> |
| 750 | 750 |
| 751 <p> | 751 <p> |
| 752 Public method to get all project entries. | 752 Public method to get all project entries. |
| 753 </p> | 753 </p> |
| 754 <dl> | 754 <dl> |
| 755 <dt>Returns:</dt> | 755 <dt>Return:</dt> |
| 756 <dd> | 756 <dd> |
| 757 list of all project entries (list of dictionaries) | 757 list of all project entries (list of dictionaries) |
| 758 </dd> | 758 </dd> |
| 759 </dl> | 759 </dl> |
| 760 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> | 760 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> |
| 770 | 770 |
| 771 <p> | 771 <p> |
| 772 Public slot to initialize the multi project menu. | 772 Public slot to initialize the multi project menu. |
| 773 </p> | 773 </p> |
| 774 <dl> | 774 <dl> |
| 775 <dt>Returns:</dt> | 775 <dt>Return:</dt> |
| 776 <dd> | 776 <dd> |
| 777 the menu generated (QMenu) | 777 the menu generated (QMenu) |
| 778 </dd> | 778 </dd> |
| 779 </dl> | 779 </dl> |
| 780 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> | 780 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> |
| 791 reference to a toolbar manager object | 791 reference to a toolbar manager object |
| 792 (E5ToolBarManager) | 792 (E5ToolBarManager) |
| 793 </dd> | 793 </dd> |
| 794 </dl> | 794 </dl> |
| 795 <dl> | 795 <dl> |
| 796 <dt>Returns:</dt> | 796 <dt>Return:</dt> |
| 797 <dd> | 797 <dd> |
| 798 the toolbar generated (QToolBar) | 798 the toolbar generated (QToolBar) |
| 799 </dd> | 799 </dd> |
| 800 </dl> | 800 </dl> |
| 801 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> | 801 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> |
| 804 | 804 |
| 805 <p> | 805 <p> |
| 806 Public method to return the dirty state. | 806 Public method to return the dirty state. |
| 807 </p> | 807 </p> |
| 808 <dl> | 808 <dl> |
| 809 <dt>Returns:</dt> | 809 <dt>Return:</dt> |
| 810 <dd> | 810 <dd> |
| 811 dirty state (boolean) | 811 dirty state (boolean) |
| 812 </dd> | 812 </dd> |
| 813 </dl> | 813 </dl> |
| 814 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> | 814 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> |
| 817 | 817 |
| 818 <p> | 818 <p> |
| 819 Public method to return the opened state. | 819 Public method to return the opened state. |
| 820 </p> | 820 </p> |
| 821 <dl> | 821 <dl> |
| 822 <dt>Returns:</dt> | 822 <dt>Return:</dt> |
| 823 <dd> | 823 <dd> |
| 824 open state (boolean) | 824 open state (boolean) |
| 825 </dd> | 825 </dd> |
| 826 </dl> | 826 </dl> |
| 827 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> | 827 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> |
| 893 | 893 |
| 894 <p> | 894 <p> |
| 895 Public slot to save the current multi project. | 895 Public slot to save the current multi project. |
| 896 </p> | 896 </p> |
| 897 <dl> | 897 <dl> |
| 898 <dt>Returns:</dt> | 898 <dt>Return:</dt> |
| 899 <dd> | 899 <dd> |
| 900 flag indicating success (boolean) | 900 flag indicating success (boolean) |
| 901 </dd> | 901 </dd> |
| 902 </dl> | 902 </dl> |
| 903 <a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a> | 903 <a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a> |
| 906 | 906 |
| 907 <p> | 907 <p> |
| 908 Public slot to save the current multi project to a different file. | 908 Public slot to save the current multi project to a different file. |
| 909 </p> | 909 </p> |
| 910 <dl> | 910 <dl> |
| 911 <dt>Returns:</dt> | 911 <dt>Return:</dt> |
| 912 <dd> | 912 <dd> |
| 913 flag indicating success (boolean) | 913 flag indicating success (boolean) |
| 914 </dd> | 914 </dd> |
| 915 </dl> | 915 </dl> |
| 916 <a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a> | 916 <a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a> |
