Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Project.Project.html
eric7/Documentation/Source/eric7.Project.Project.html
- branch
- eric7
- changeset 9097
- 213951c41dcd
- parent 8623
- fced5aa98d41
- child 9117
- c6afba2049cf
equal
deleted
inserted
replaced
| 9096:f6f7d8f364c3 | 9097:213951c41dcd |
|---|---|
| 739 <tr> | 739 <tr> |
| 740 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> | 740 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> |
| 741 <td>Public method to get the names of the project specific dictionaries.</td> | 741 <td>Public method to get the names of the project specific dictionaries.</td> |
| 742 </tr> | 742 </tr> |
| 743 <tr> | 743 <tr> |
| 744 <td><a href="#Project.getProjectExecPath">getProjectExecPath</a></td> | |
| 745 <td>Public method to get the executable search path prefix of the project.</td> | |
| 746 </tr> | |
| 747 <tr> | |
| 744 <td><a href="#Project.getProjectFile">getProjectFile</a></td> | 748 <td><a href="#Project.getProjectFile">getProjectFile</a></td> |
| 745 <td>Public method to get the path of the project file.</td> | 749 <td>Public method to get the path of the project file.</td> |
| 746 </tr> | 750 </tr> |
| 747 <tr> | 751 <tr> |
| 748 <td><a href="#Project.getProjectFiles">getProjectFiles</a></td> | 752 <td><a href="#Project.getProjectFiles">getProjectFiles</a></td> |
| 749 <td>Public method to get the file entries of the given type.</td> | 753 <td>Public method to get the file entries of the given type.</td> |
| 750 </tr> | 754 </tr> |
| 751 <tr> | 755 <tr> |
| 756 <td><a href="#Project.getProjectInterpreter">getProjectInterpreter</a></td> | |
| 757 <td>Public method to get the path of the interpreter used by the project.</td> | |
| 758 </tr> | |
| 759 <tr> | |
| 752 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td> | 760 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td> |
| 753 <td>Public method to get the project's programming language.</td> | 761 <td>Public method to get the project's programming language.</td> |
| 754 </tr> | 762 </tr> |
| 755 <tr> | 763 <tr> |
| 756 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td> | 764 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td> |
| 767 <tr> | 775 <tr> |
| 768 <td><a href="#Project.getProjectSpellLanguage">getProjectSpellLanguage</a></td> | 776 <td><a href="#Project.getProjectSpellLanguage">getProjectSpellLanguage</a></td> |
| 769 <td>Public method to get the project's programming language.</td> | 777 <td>Public method to get the project's programming language.</td> |
| 770 </tr> | 778 </tr> |
| 771 <tr> | 779 <tr> |
| 780 <td><a href="#Project.getProjectTestingFramework">getProjectTestingFramework</a></td> | |
| 781 <td>Public method to get the testing framework name of the project.</td> | |
| 782 </tr> | |
| 783 <tr> | |
| 772 <td><a href="#Project.getProjectType">getProjectType</a></td> | 784 <td><a href="#Project.getProjectType">getProjectType</a></td> |
| 773 <td>Public method to get the type of the project.</td> | 785 <td>Public method to get the type of the project.</td> |
| 774 </tr> | 786 </tr> |
| 775 <tr> | 787 <tr> |
| 776 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> | 788 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> |
| 777 <td>Public method to get the list of supported project types.</td> | 789 <td>Public method to get the list of supported project types.</td> |
| 790 </tr> | |
| 791 <tr> | |
| 792 <td><a href="#Project.getProjectVenv">getProjectVenv</a></td> | |
| 793 <td>Public method to get the name of the virtual environment used by the project.</td> | |
| 778 </tr> | 794 </tr> |
| 779 <tr> | 795 <tr> |
| 780 <td><a href="#Project.getProjectVersion">getProjectVersion</a></td> | 796 <td><a href="#Project.getProjectVersion">getProjectVersion</a></td> |
| 781 <td>Public mehod to get the version number of the project.</td> | 797 <td>Public mehod to get the version number of the project.</td> |
| 782 </tr> | 798 </tr> |
| 2555 <b>getMainScript</b>(<i>normalized=False</i>) | 2571 <b>getMainScript</b>(<i>normalized=False</i>) |
| 2556 | 2572 |
| 2557 <p> | 2573 <p> |
| 2558 Public method to return the main script filename. | 2574 Public method to return the main script filename. |
| 2559 </p> | 2575 </p> |
| 2560 <dl> | 2576 <p> |
| 2561 | 2577 The normalized name is the name of the main script prepended with |
| 2562 <dt><i>normalized</i></dt> | 2578 the project path. |
| 2579 </p> | |
| 2580 <dl> | |
| 2581 | |
| 2582 <dt><i>normalized</i> (bool)</dt> | |
| 2563 <dd> | 2583 <dd> |
| 2564 flag indicating a normalized filename is wanted | 2584 flag indicating a normalized filename is wanted |
| 2565 (boolean) | 2585 </dd> |
| 2566 </dd> | 2586 </dl> |
| 2567 </dl> | 2587 <dl> |
| 2568 <dl> | 2588 <dt>Return:</dt> |
| 2569 <dt>Return:</dt> | 2589 <dd> |
| 2570 <dd> | 2590 filename of the projects main script |
| 2571 filename of the projects main script (string) | 2591 </dd> |
| 2592 </dl> | |
| 2593 <dl> | |
| 2594 <dt>Return Type:</dt> | |
| 2595 <dd> | |
| 2596 str | |
| 2572 </dd> | 2597 </dd> |
| 2573 </dl> | 2598 </dl> |
| 2574 <a NAME="Project.getMenu" ID="Project.getMenu"></a> | 2599 <a NAME="Project.getMenu" ID="Project.getMenu"></a> |
| 2575 <h4>Project.getMenu</h4> | 2600 <h4>Project.getMenu</h4> |
| 2576 <b>getMenu</b>(<i>menuName</i>) | 2601 <b>getMenu</b>(<i>menuName</i>) |
| 2699 <dd> | 2724 <dd> |
| 2700 tuple of two strings giving the absolute path names of the | 2725 tuple of two strings giving the absolute path names of the |
| 2701 project specific word and exclude list | 2726 project specific word and exclude list |
| 2702 </dd> | 2727 </dd> |
| 2703 </dl> | 2728 </dl> |
| 2729 <a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a> | |
| 2730 <h4>Project.getProjectExecPath</h4> | |
| 2731 <b>getProjectExecPath</b>(<i></i>) | |
| 2732 | |
| 2733 <p> | |
| 2734 Public method to get the executable search path prefix of the project. | |
| 2735 </p> | |
| 2736 <dl> | |
| 2737 <dt>Return:</dt> | |
| 2738 <dd> | |
| 2739 executable search path prefix | |
| 2740 </dd> | |
| 2741 </dl> | |
| 2742 <dl> | |
| 2743 <dt>Return Type:</dt> | |
| 2744 <dd> | |
| 2745 str | |
| 2746 </dd> | |
| 2747 </dl> | |
| 2704 <a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a> | 2748 <a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a> |
| 2705 <h4>Project.getProjectFile</h4> | 2749 <h4>Project.getProjectFile</h4> |
| 2706 <b>getProjectFile</b>(<i></i>) | 2750 <b>getProjectFile</b>(<i></i>) |
| 2707 | 2751 |
| 2708 <p> | 2752 <p> |
| 2750 <dt>Raises <b>ValueError</b>:</dt> | 2794 <dt>Raises <b>ValueError</b>:</dt> |
| 2751 <dd> | 2795 <dd> |
| 2752 raised when an unsupported file type is given | 2796 raised when an unsupported file type is given |
| 2753 </dd> | 2797 </dd> |
| 2754 </dl> | 2798 </dl> |
| 2799 <a NAME="Project.getProjectInterpreter" ID="Project.getProjectInterpreter"></a> | |
| 2800 <h4>Project.getProjectInterpreter</h4> | |
| 2801 <b>getProjectInterpreter</b>(<i>resolveGlobal=True</i>) | |
| 2802 | |
| 2803 <p> | |
| 2804 Public method to get the path of the interpreter used by the project. | |
| 2805 </p> | |
| 2806 <dl> | |
| 2807 | |
| 2808 <dt><i>resolveGlobal</i> (bool)</dt> | |
| 2809 <dd> | |
| 2810 flag indicating to resolve the interpreter using | |
| 2811 the global interpreter if no project of debugger specific | |
| 2812 environment was configured | |
| 2813 </dd> | |
| 2814 </dl> | |
| 2815 <dl> | |
| 2816 <dt>Return:</dt> | |
| 2817 <dd> | |
| 2818 path of the project's interpreter | |
| 2819 </dd> | |
| 2820 </dl> | |
| 2821 <dl> | |
| 2822 <dt>Return Type:</dt> | |
| 2823 <dd> | |
| 2824 str | |
| 2825 </dd> | |
| 2826 </dl> | |
| 2755 <a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> | 2827 <a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> |
| 2756 <h4>Project.getProjectLanguage</h4> | 2828 <h4>Project.getProjectLanguage</h4> |
| 2757 <b>getProjectLanguage</b>(<i></i>) | 2829 <b>getProjectLanguage</b>(<i></i>) |
| 2758 | 2830 |
| 2759 <p> | 2831 <p> |
| 2818 <dt>Return:</dt> | 2890 <dt>Return:</dt> |
| 2819 <dd> | 2891 <dd> |
| 2820 programming language (string) | 2892 programming language (string) |
| 2821 </dd> | 2893 </dd> |
| 2822 </dl> | 2894 </dl> |
| 2895 <a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a> | |
| 2896 <h4>Project.getProjectTestingFramework</h4> | |
| 2897 <b>getProjectTestingFramework</b>(<i></i>) | |
| 2898 | |
| 2899 <p> | |
| 2900 Public method to get the testing framework name of the project. | |
| 2901 </p> | |
| 2902 <dl> | |
| 2903 <dt>Return:</dt> | |
| 2904 <dd> | |
| 2905 testing framework name of the project | |
| 2906 </dd> | |
| 2907 </dl> | |
| 2908 <dl> | |
| 2909 <dt>Return Type:</dt> | |
| 2910 <dd> | |
| 2911 str | |
| 2912 </dd> | |
| 2913 </dl> | |
| 2823 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a> | 2914 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a> |
| 2824 <h4>Project.getProjectType</h4> | 2915 <h4>Project.getProjectType</h4> |
| 2825 <b>getProjectType</b>(<i></i>) | 2916 <b>getProjectType</b>(<i></i>) |
| 2826 | 2917 |
| 2827 <p> | 2918 <p> |
| 2852 <dt>Return:</dt> | 2943 <dt>Return:</dt> |
| 2853 <dd> | 2944 <dd> |
| 2854 reference to the dictionary of project types. | 2945 reference to the dictionary of project types. |
| 2855 </dd> | 2946 </dd> |
| 2856 </dl> | 2947 </dl> |
| 2948 <a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a> | |
| 2949 <h4>Project.getProjectVenv</h4> | |
| 2950 <b>getProjectVenv</b>(<i>resolveDebugger=True</i>) | |
| 2951 | |
| 2952 <p> | |
| 2953 Public method to get the name of the virtual environment used by the | |
| 2954 project. | |
| 2955 </p> | |
| 2956 <dl> | |
| 2957 | |
| 2958 <dt><i>resolveDebugger</i> (bool)</dt> | |
| 2959 <dd> | |
| 2960 flag indicating to resolve the virtual | |
| 2961 environment name via the debugger settings if none was configured | |
| 2962 </dd> | |
| 2963 </dl> | |
| 2964 <dl> | |
| 2965 <dt>Return:</dt> | |
| 2966 <dd> | |
| 2967 name of the project's virtual environment | |
| 2968 </dd> | |
| 2969 </dl> | |
| 2970 <dl> | |
| 2971 <dt>Return Type:</dt> | |
| 2972 <dd> | |
| 2973 str | |
| 2974 </dd> | |
| 2975 </dl> | |
| 2857 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> | 2976 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> |
| 2858 <h4>Project.getProjectVersion</h4> | 2977 <h4>Project.getProjectVersion</h4> |
| 2859 <b>getProjectVersion</b>(<i></i>) | 2978 <b>getProjectVersion</b>(<i></i>) |
| 2860 | 2979 |
| 2861 <p> | 2980 <p> |
| 2924 <p> | 3043 <p> |
| 2925 Public method to return the source script files. | 3044 Public method to return the source script files. |
| 2926 </p> | 3045 </p> |
| 2927 <dl> | 3046 <dl> |
| 2928 | 3047 |
| 2929 <dt><i>normalized</i></dt> | 3048 <dt><i>normalized</i> (bool)</dt> |
| 2930 <dd> | 3049 <dd> |
| 2931 flag indicating a normalized filename is wanted | 3050 flag indicating a normalized filename is wanted |
| 2932 (boolean) | 3051 </dd> |
| 2933 </dd> | 3052 </dl> |
| 2934 </dl> | 3053 <dl> |
| 2935 <dl> | 3054 <dt>Return:</dt> |
| 2936 <dt>Return:</dt> | 3055 <dd> |
| 2937 <dd> | 3056 list of the projects scripts |
| 2938 list of the projects scripts (list of string) | 3057 </dd> |
| 3058 </dl> | |
| 3059 <dl> | |
| 3060 <dt>Return Type:</dt> | |
| 3061 <dd> | |
| 3062 list of str | |
| 2939 </dd> | 3063 </dd> |
| 2940 </dl> | 3064 </dl> |
| 2941 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> | 3065 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> |
| 2942 <h4>Project.getStatusMonitorAutoUpdate</h4> | 3066 <h4>Project.getStatusMonitorAutoUpdate</h4> |
| 2943 <b>getStatusMonitorAutoUpdate</b>(<i></i>) | 3067 <b>getStatusMonitorAutoUpdate</b>(<i></i>) |
