Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Project.Project.html

src/eric7/Documentation/Source/eric7.Project.Project.html

branch
eric7
changeset 9530
c30f02ea1b27
parent 9454
f3cf935c0c66
child 9606
ccf055891890
equal deleted inserted replaced
9529:5ce1774b3106 9530:c30f02ea1b27
90 <dt>prepareRepopulateItem(str)</dt> 90 <dt>prepareRepopulateItem(str)</dt>
91 <dd> 91 <dd>
92 emitted before an item of the model is 92 emitted before an item of the model is
93 repopulated 93 repopulated
94 </dd> 94 </dd>
95 <dt>processChangedProjectFiles()</dt>
96 <dd>
97 emitted to indicate, that changed project files
98 should be processed
99 </dd>
95 <dt>projectAboutToBeCreated()</dt> 100 <dt>projectAboutToBeCreated()</dt>
96 <dd> 101 <dd>
97 emitted just before the project will be 102 emitted just before the project will be
98 created 103 created
99 </dd> 104 </dd>
109 <dt>projectClosedHooks()</dt> 114 <dt>projectClosedHooks()</dt>
110 <dd> 115 <dd>
111 emitted after a project file was closed but 116 emitted after a project file was closed but
112 before the projectClosed() signal is sent 117 before the projectClosed() signal is sent
113 </dd> 118 </dd>
119 <dt>projectFileAdded(str, str)</dt>
120 <dd>
121 emitted after a new file was added
122 </dd>
123 <dt>projectFileCompiled(str, str)</dt>
124 <dd>
125 emitted after a form was compiled
126 </dd>
127 <dt>projectFileRemoved(str, str)</dt>
128 <dd>
129 emitted after a file of the project was removed
130 </dd>
114 <dt>projectFileRenamed(str, str)</dt> 131 <dt>projectFileRenamed(str, str)</dt>
115 <dd> 132 <dd>
116 emitted after a file of the project 133 emitted after a file of the project
117 has been renamed 134 has been renamed
118 </dd> 135 </dd>
119 <dt>projectFormAdded(str)</dt>
120 <dd>
121 emitted after a new form was added
122 </dd>
123 <dt>projectFormCompiled(str)</dt>
124 <dd>
125 emitted after a form was compiled
126 </dd>
127 <dt>projectFormRemoved(str)</dt>
128 <dd>
129 emitted after a form was removed
130 </dd>
131 <dt>projectInterfaceAdded(str)</dt>
132 <dd>
133 emitted after a new IDL file was added
134 </dd>
135 <dt>projectInterfaceRemoved(str)</dt>
136 <dd>
137 emitted after a IDL file was removed
138 </dd>
139 <dt>projectLanguageAdded(str)</dt>
140 <dd>
141 emitted after a new language was added
142 </dd>
143 <dt>projectLanguageAddedByCode(str)</dt> 136 <dt>projectLanguageAddedByCode(str)</dt>
144 <dd> 137 <dd>
145 emitted after a new language was 138 emitted after a new language was
146 added. The language code is sent by this signal. 139 added. The language code is sent by this signal.
147 </dd> 140 </dd>
148 <dt>projectLanguageRemoved(str)</dt>
149 <dd>
150 emitted after a language was removed
151 </dd>
152 <dt>projectOpened()</dt> 141 <dt>projectOpened()</dt>
153 <dd> 142 <dd>
154 emitted after a project file was read 143 emitted after a project file was read
155 </dd> 144 </dd>
156 <dt>projectOpenedHooks()</dt> 145 <dt>projectOpenedHooks()</dt>
157 <dd> 146 <dd>
158 emitted after a project file was read but 147 emitted after a project file was read but
159 before the projectOpened() signal is sent 148 before the projectOpened() signal is sent
160 </dd> 149 </dd>
161 <dt>projectOthersAdded(str)</dt>
162 <dd>
163 emitted after a file or directory was added
164 to the OTHERS project data area
165 </dd>
166 <dt>projectOthersRemoved(str)</dt>
167 <dd>
168 emitted after a file was removed from the
169 OTHERS project data area
170 </dd>
171 <dt>projectPropertiesChanged()</dt> 150 <dt>projectPropertiesChanged()</dt>
172 <dd> 151 <dd>
173 emitted after the project properties 152 emitted after the project properties
174 were changed 153 were changed
175 </dd>
176 <dt>projectProtocolAdded(str)</dt>
177 <dd>
178 emitted after a new proto file was added
179 </dd>
180 <dt>projectProtocolRemoved(str)</dt>
181 <dd>
182 emitted after a proto file was removed
183 </dd>
184 <dt>projectResourceAdded(str)</dt>
185 <dd>
186 emitted after a new resource file was
187 added
188 </dd>
189 <dt>projectResourceRemoved(str)</dt>
190 <dd>
191 emitted after a resource was removed
192 </dd>
193 <dt>projectSourceAdded(str)</dt>
194 <dd>
195 emitted after a new source file was added
196 </dd>
197 <dt>projectSourceRemoved(str)</dt>
198 <dd>
199 emitted after a source was removed
200 </dd> 154 </dd>
201 <dt>reinitVCS()</dt> 155 <dt>reinitVCS()</dt>
202 <dd> 156 <dd>
203 emitted after the VCS has been reinitialized 157 emitted after the VCS has been reinitialized
204 </dd> 158 </dd>
263 <tr> 217 <tr>
264 <td><a href="#Project.__addSingleDirectory">__addSingleDirectory</a></td> 218 <td><a href="#Project.__addSingleDirectory">__addSingleDirectory</a></td>
265 <td>Private method used to add all files of a single directory to the project.</td> 219 <td>Private method used to add all files of a single directory to the project.</td>
266 </tr> 220 </tr>
267 <tr> 221 <tr>
222 <td><a href="#Project.__autoExecuteMake">__autoExecuteMake</a></td>
223 <td>Private slot to execute a project specific make run (auto-run) (execute or question).</td>
224 </tr>
225 <tr>
268 <td><a href="#Project.__binaryTranslationFile">__binaryTranslationFile</a></td> 226 <td><a href="#Project.__binaryTranslationFile">__binaryTranslationFile</a></td>
269 <td>Private method to calculate the filename of the binary translations file given the name of the raw translations file.</td> 227 <td>Private method to calculate the filename of the binary translations file given the name of the raw translations file.</td>
270 </tr> 228 </tr>
271 <tr> 229 <tr>
272 <td><a href="#Project.__checkFilesExist">__checkFilesExist</a></td> 230 <td><a href="#Project.__checkFilesExist">__checkFilesExist</a></td>
583 <tr> 541 <tr>
584 <td><a href="#Project.addEricActions">addEricActions</a></td> 542 <td><a href="#Project.addEricActions">addEricActions</a></td>
585 <td>Public method to add actions to the list of actions.</td> 543 <td>Public method to add actions to the list of actions.</td>
586 </tr> 544 </tr>
587 <tr> 545 <tr>
546 <td><a href="#Project.addFileCategory">addFileCategory</a></td>
547 <td>Public method to add a file category to the categories repository.</td>
548 </tr>
549 <tr>
588 <td><a href="#Project.addFiles">addFiles</a></td> 550 <td><a href="#Project.addFiles">addFiles</a></td>
589 <td>Public slot used to add files to the project.</td> 551 <td>Public slot used to add files to the project.</td>
590 </tr> 552 </tr>
591 <tr> 553 <tr>
592 <td><a href="#Project.addIdlDir">addIdlDir</a></td>
593 <td>Public slot to add all IDL interfaces of a directory to the current project.</td>
594 </tr>
595 <tr>
596 <td><a href="#Project.addIdlFiles">addIdlFiles</a></td>
597 <td>Public slot to add IDL interfaces to the current project.</td>
598 </tr>
599 <tr>
600 <td><a href="#Project.addLanguage">addLanguage</a></td> 554 <td><a href="#Project.addLanguage">addLanguage</a></td>
601 <td>Public slot used to add a language to the project.</td> 555 <td>Public slot used to add a language to the project.</td>
602 </tr> 556 </tr>
603 <tr> 557 <tr>
604 <td><a href="#Project.addOthersDir">addOthersDir</a></td>
605 <td>Public slot to add a directory to the OTHERS project data.</td>
606 </tr>
607 <tr>
608 <td><a href="#Project.addOthersFiles">addOthersFiles</a></td>
609 <td>Public slot to add files to the OTHERS project data.</td>
610 </tr>
611 <tr>
612 <td><a href="#Project.addProtoDir">addProtoDir</a></td>
613 <td>Public slot to add all protocol files of a directory to the current project.</td>
614 </tr>
615 <tr>
616 <td><a href="#Project.addProtoFiles">addProtoFiles</a></td>
617 <td>Public slot to add protocol files to the current project.</td>
618 </tr>
619 <tr>
620 <td><a href="#Project.addResourceDir">addResourceDir</a></td>
621 <td>Public slot to add all Qt resource files of a directory to the current project.</td>
622 </tr>
623 <tr>
624 <td><a href="#Project.addResourceFiles">addResourceFiles</a></td>
625 <td>Public slot to add Qt resources to the current project.</td>
626 </tr>
627 <tr>
628 <td><a href="#Project.addSourceDir">addSourceDir</a></td>
629 <td>Public slot to add all source files of a directory to the current project.</td>
630 </tr>
631 <tr>
632 <td><a href="#Project.addSourceFiles">addSourceFiles</a></td>
633 <td>Public slot to add source files to the current project.</td>
634 </tr>
635 <tr>
636 <td><a href="#Project.addToOthers">addToOthers</a></td> 558 <td><a href="#Project.addToOthers">addToOthers</a></td>
637 <td>Public method to add a file/directory to the OTHERS project data.</td> 559 <td>Public method to add a file/directory to the OTHERS project data.</td>
638 </tr> 560 </tr>
639 <tr> 561 <tr>
640 <td><a href="#Project.addUiDir">addUiDir</a></td>
641 <td>Public slot to add all forms of a directory to the current project.</td>
642 </tr>
643 <tr>
644 <td><a href="#Project.addUiFiles">addUiFiles</a></td>
645 <td>Public slot to add forms to the current project.</td>
646 </tr>
647 <tr>
648 <td><a href="#Project.appendFile">appendFile</a></td> 562 <td><a href="#Project.appendFile">appendFile</a></td>
649 <td>Public method to append a file to the project.</td> 563 <td>Public method to append a file to the project.</td>
650 </tr> 564 </tr>
651 <tr> 565 <tr>
652 <td><a href="#Project.checkAllScriptsDirty">checkAllScriptsDirty</a></td> 566 <td><a href="#Project.checkAllScriptsDirty">checkAllScriptsDirty</a></td>
703 <tr> 617 <tr>
704 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td> 618 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td>
705 <td>Public slot to delete a translation from the project directory.</td> 619 <td>Public slot to delete a translation from the project directory.</td>
706 </tr> 620 </tr>
707 <tr> 621 <tr>
708 <td><a href="#Project.executeMake">executeMake</a></td>
709 <td>Public slot to execute a project specific make run (auto-run) (execute or question).</td>
710 </tr>
711 <tr>
712 <td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td> 622 <td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td>
713 <td>Public method to convert a project relative file path to an absolute file path.</td> 623 <td>Public method to convert a project relative file path to an absolute file path.</td>
714 </tr> 624 </tr>
715 <tr> 625 <tr>
716 <td><a href="#Project.getAbsoluteUniversalPath">getAbsoluteUniversalPath</a></td> 626 <td><a href="#Project.getAbsoluteUniversalPath">getAbsoluteUniversalPath</a></td>
751 <tr> 661 <tr>
752 <td><a href="#Project.getEolString">getEolString</a></td> 662 <td><a href="#Project.getEolString">getEolString</a></td>
753 <td>Public method to get the EOL-string to be used by the project.</td> 663 <td>Public method to get the EOL-string to be used by the project.</td>
754 </tr> 664 </tr>
755 <tr> 665 <tr>
666 <td><a href="#Project.getFileCategories">getFileCategories</a></td>
667 <td>Public method to get the list of known file categories.</td>
668 </tr>
669 <tr>
670 <td><a href="#Project.getFileCategoryExtension">getFileCategoryExtension</a></td>
671 <td>Public method to get a list of default file extensions for the given category.</td>
672 </tr>
673 <tr>
674 <td><a href="#Project.getFileCategoryFilterString">getFileCategoryFilterString</a></td>
675 <td>Public method to get a file selection string for the given categories.</td>
676 </tr>
677 <tr>
678 <td><a href="#Project.getFileCategoryString">getFileCategoryString</a></td>
679 <td>Public method to get a user string for the given category.</td>
680 </tr>
681 <tr>
682 <td><a href="#Project.getFileCategoryType">getFileCategoryType</a></td>
683 <td>Public method to get a user type string for the given category.</td>
684 </tr>
685 <tr>
756 <td><a href="#Project.getFiles">getFiles</a></td> 686 <td><a href="#Project.getFiles">getFiles</a></td>
757 <td>Public method to get all files starting with a common prefix.</td> 687 <td>Public method to get all files starting with a common prefix.</td>
758 </tr> 688 </tr>
759 <tr> 689 <tr>
760 <td><a href="#Project.getFiletypeAssociations">getFiletypeAssociations</a></td> 690 <td><a href="#Project.getFiletypeAssociations">getFiletypeAssociations</a></td>
795 <tr> 725 <tr>
796 <td><a href="#Project.getProjectAuthorEmail">getProjectAuthorEmail</a></td> 726 <td><a href="#Project.getProjectAuthorEmail">getProjectAuthorEmail</a></td>
797 <td>Public method to get the email address of the project author.</td> 727 <td>Public method to get the email address of the project author.</td>
798 </tr> 728 </tr>
799 <tr> 729 <tr>
730 <td><a href="#Project.getProjectData">getProjectData</a></td>
731 <td>Public method to get the data associated with the given data key.</td>
732 </tr>
733 <tr>
800 <td><a href="#Project.getProjectDescription">getProjectDescription</a></td> 734 <td><a href="#Project.getProjectDescription">getProjectDescription</a></td>
801 <td>Public method to get the description of the project.</td> 735 <td>Public method to get the description of the project.</td>
802 </tr> 736 </tr>
803 <tr> 737 <tr>
804 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> 738 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td>
979 <tr> 913 <tr>
980 <td><a href="#Project.isOpen">isOpen</a></td> 914 <td><a href="#Project.isOpen">isOpen</a></td>
981 <td>Public method to return the opened state.</td> 915 <td>Public method to return the opened state.</td>
982 </tr> 916 </tr>
983 <tr> 917 <tr>
918 <td><a href="#Project.isProjectCategory">isProjectCategory</a></td>
919 <td>Public method to check, if the passed in filename belongs to the given category.</td>
920 </tr>
921 <tr>
984 <td><a href="#Project.isProjectFile">isProjectFile</a></td> 922 <td><a href="#Project.isProjectFile">isProjectFile</a></td>
985 <td>Public method used to check, if the passed in filename belongs to the project.</td> 923 <td>Public method used to check, if the passed in filename belongs to the project.</td>
986 </tr> 924 </tr>
987 <tr> 925 <tr>
988 <td><a href="#Project.isProjectForm">isProjectForm</a></td>
989 <td>Public method used to check, if the passed in filename belongs to the project forms.</td>
990 </tr>
991 <tr>
992 <td><a href="#Project.isProjectInterface">isProjectInterface</a></td>
993 <td>Public method used to check, if the passed in filename belongs to the project interfaces.</td>
994 </tr>
995 <tr>
996 <td><a href="#Project.isProjectProtocol">isProjectProtocol</a></td>
997 <td>Public method used to check, if the passed in filename belongs to the project protocols.</td>
998 </tr>
999 <tr>
1000 <td><a href="#Project.isProjectResource">isProjectResource</a></td>
1001 <td>Public method used to check, if the passed in filename belongs to the project resources.</td>
1002 </tr>
1003 <tr>
1004 <td><a href="#Project.isProjectSource">isProjectSource</a></td>
1005 <td>Public method used to check, if the passed in filename belongs to the project sources.</td>
1006 </tr>
1007 <tr>
1008 <td><a href="#Project.isPy3Project">isPy3Project</a></td> 926 <td><a href="#Project.isPy3Project">isPy3Project</a></td>
1009 <td>Public method to check, if this project is a Python3 project.</td> 927 <td>Public method to check, if this project is a Python3 project.</td>
1010 </tr> 928 </tr>
1011 <tr> 929 <tr>
1012 <td><a href="#Project.isPythonProject">isPythonProject</a></td> 930 <td><a href="#Project.isPythonProject">isPythonProject</a></td>
1047 <tr> 965 <tr>
1048 <td><a href="#Project.removeFile">removeFile</a></td> 966 <td><a href="#Project.removeFile">removeFile</a></td>
1049 <td>Public slot to remove a file from the project.</td> 967 <td>Public slot to remove a file from the project.</td>
1050 </tr> 968 </tr>
1051 <tr> 969 <tr>
970 <td><a href="#Project.removeFileCategory">removeFileCategory</a></td>
971 <td>Public method to remove a category from the categories repository.</td>
972 </tr>
973 <tr>
1052 <td><a href="#Project.removeLanguageFile">removeLanguageFile</a></td> 974 <td><a href="#Project.removeLanguageFile">removeLanguageFile</a></td>
1053 <td>Public slot to remove a translation from the project.</td> 975 <td>Public slot to remove a translation from the project.</td>
1054 </tr> 976 </tr>
1055 <tr> 977 <tr>
1056 <td><a href="#Project.renameFile">renameFile</a></td> 978 <td><a href="#Project.renameFile">renameFile</a></td>
1057 <td>Public slot to rename a file of the project.</td> 979 <td>Public slot to rename a file of the project.</td>
1058 </tr> 980 </tr>
1059 <tr> 981 <tr>
1060 <td><a href="#Project.renameFileInPdata">renameFileInPdata</a></td> 982 <td><a href="#Project.renameFileInPdata">renameFileInPdata</a></td>
1061 <td>Public method to rename a file in the pdata structure.</td> 983 <td>Public method to rename a file in the __pdata structure.</td>
1062 </tr> 984 </tr>
1063 <tr> 985 <tr>
1064 <td><a href="#Project.renameMainScript">renameMainScript</a></td> 986 <td><a href="#Project.renameMainScript">renameMainScript</a></td>
1065 <td>Public method to rename the main script.</td> 987 <td>Public method to rename the main script.</td>
1066 </tr> 988 </tr>
1097 <td>Public method to set the debugging information.</td> 1019 <td>Public method to set the debugging information.</td>
1098 </tr> 1020 </tr>
1099 <tr> 1021 <tr>
1100 <td><a href="#Project.setDirty">setDirty</a></td> 1022 <td><a href="#Project.setDirty">setDirty</a></td>
1101 <td>Public method to set the dirty state.</td> 1023 <td>Public method to set the dirty state.</td>
1024 </tr>
1025 <tr>
1026 <td><a href="#Project.setProjectData">setProjectData</a></td>
1027 <td>Public method to set data associated with the given data key in the project dictionary.</td>
1102 </tr> 1028 </tr>
1103 <tr> 1029 <tr>
1104 <td><a href="#Project.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td> 1030 <td><a href="#Project.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td>
1105 <td>Public method to enable the auto update function.</td> 1031 <td>Public method to enable the auto update function.</td>
1106 </tr> 1032 </tr>
1228 <dt><i>quiet</i></dt> 1154 <dt><i>quiet</i></dt>
1229 <dd> 1155 <dd>
1230 flag indicating quiet operations (boolean) 1156 flag indicating quiet operations (boolean)
1231 </dd> 1157 </dd>
1232 </dl> 1158 </dl>
1159 <a NAME="Project.__autoExecuteMake" ID="Project.__autoExecuteMake"></a>
1160 <h4>Project.__autoExecuteMake</h4>
1161 <b>__autoExecuteMake</b>(<i></i>)
1162
1163 <p>
1164 Private slot to execute a project specific make run (auto-run)
1165 (execute or question).
1166 </p>
1233 <a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a> 1167 <a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a>
1234 <h4>Project.__binaryTranslationFile</h4> 1168 <h4>Project.__binaryTranslationFile</h4>
1235 <b>__binaryTranslationFile</b>(<i>langFile</i>) 1169 <b>__binaryTranslationFile</b>(<i>langFile</i>)
1236 1170
1237 <p> 1171 <p>
2157 <dt><i>actions</i></dt> 2091 <dt><i>actions</i></dt>
2158 <dd> 2092 <dd>
2159 list of actions (list of EricAction) 2093 list of actions (list of EricAction)
2160 </dd> 2094 </dd>
2161 </dl> 2095 </dl>
2096 <a NAME="Project.addFileCategory" ID="Project.addFileCategory"></a>
2097 <h4>Project.addFileCategory</h4>
2098 <b>addFileCategory</b>(<i>category, categoryItem</i>)
2099
2100 <p>
2101 Public method to add a file category to the categories repository.
2102 </p>
2103 <p>
2104 Note: The given category must not be contained in the repository already.
2105 </p>
2106 <dl>
2107
2108 <dt><i>category</i> (str)</dt>
2109 <dd>
2110 file category (must be unique)
2111 </dd>
2112 <dt><i>categoryItem</i> (FileCategoryRepositoryItem)</dt>
2113 <dd>
2114 data class instance containing the category data
2115 </dd>
2116 </dl>
2117 <dl>
2118
2119 <dt>Raises <b>TypeError</b>:</dt>
2120 <dd>
2121 raised to signal a wrong type for the category item
2122 </dd>
2123 </dl>
2162 <a NAME="Project.addFiles" ID="Project.addFiles"></a> 2124 <a NAME="Project.addFiles" ID="Project.addFiles"></a>
2163 <h4>Project.addFiles</h4> 2125 <h4>Project.addFiles</h4>
2164 <b>addFiles</b>(<i>fileTypeFilter=None, startdir=None</i>) 2126 <b>addFiles</b>(<i>fileTypeFilter=None, startdir=None</i>)
2165 2127
2166 <p> 2128 <p>
2175 <dt><i>startdir</i> (str)</dt> 2137 <dt><i>startdir</i> (str)</dt>
2176 <dd> 2138 <dd>
2177 start directory for the selection dialog 2139 start directory for the selection dialog
2178 </dd> 2140 </dd>
2179 </dl> 2141 </dl>
2180 <a NAME="Project.addIdlDir" ID="Project.addIdlDir"></a>
2181 <h4>Project.addIdlDir</h4>
2182 <b>addIdlDir</b>(<i></i>)
2183
2184 <p>
2185 Public slot to add all IDL interfaces of a directory to the current
2186 project.
2187 </p>
2188 <a NAME="Project.addIdlFiles" ID="Project.addIdlFiles"></a>
2189 <h4>Project.addIdlFiles</h4>
2190 <b>addIdlFiles</b>(<i></i>)
2191
2192 <p>
2193 Public slot to add IDL interfaces to the current project.
2194 </p>
2195 <a NAME="Project.addLanguage" ID="Project.addLanguage"></a> 2142 <a NAME="Project.addLanguage" ID="Project.addLanguage"></a>
2196 <h4>Project.addLanguage</h4> 2143 <h4>Project.addLanguage</h4>
2197 <b>addLanguage</b>(<i></i>) 2144 <b>addLanguage</b>(<i></i>)
2198 2145
2199 <p> 2146 <p>
2200 Public slot used to add a language to the project. 2147 Public slot used to add a language to the project.
2201 </p> 2148 </p>
2202 <a NAME="Project.addOthersDir" ID="Project.addOthersDir"></a>
2203 <h4>Project.addOthersDir</h4>
2204 <b>addOthersDir</b>(<i></i>)
2205
2206 <p>
2207 Public slot to add a directory to the OTHERS project data.
2208 </p>
2209 <a NAME="Project.addOthersFiles" ID="Project.addOthersFiles"></a>
2210 <h4>Project.addOthersFiles</h4>
2211 <b>addOthersFiles</b>(<i></i>)
2212
2213 <p>
2214 Public slot to add files to the OTHERS project data.
2215 </p>
2216 <a NAME="Project.addProtoDir" ID="Project.addProtoDir"></a>
2217 <h4>Project.addProtoDir</h4>
2218 <b>addProtoDir</b>(<i></i>)
2219
2220 <p>
2221 Public slot to add all protocol files of a directory to the current
2222 project.
2223 </p>
2224 <a NAME="Project.addProtoFiles" ID="Project.addProtoFiles"></a>
2225 <h4>Project.addProtoFiles</h4>
2226 <b>addProtoFiles</b>(<i></i>)
2227
2228 <p>
2229 Public slot to add protocol files to the current project.
2230 </p>
2231 <a NAME="Project.addResourceDir" ID="Project.addResourceDir"></a>
2232 <h4>Project.addResourceDir</h4>
2233 <b>addResourceDir</b>(<i></i>)
2234
2235 <p>
2236 Public slot to add all Qt resource files of a directory to the current
2237 project.
2238 </p>
2239 <a NAME="Project.addResourceFiles" ID="Project.addResourceFiles"></a>
2240 <h4>Project.addResourceFiles</h4>
2241 <b>addResourceFiles</b>(<i></i>)
2242
2243 <p>
2244 Public slot to add Qt resources to the current project.
2245 </p>
2246 <a NAME="Project.addSourceDir" ID="Project.addSourceDir"></a>
2247 <h4>Project.addSourceDir</h4>
2248 <b>addSourceDir</b>(<i></i>)
2249
2250 <p>
2251 Public slot to add all source files of a directory to the current
2252 project.
2253 </p>
2254 <a NAME="Project.addSourceFiles" ID="Project.addSourceFiles"></a>
2255 <h4>Project.addSourceFiles</h4>
2256 <b>addSourceFiles</b>(<i></i>)
2257
2258 <p>
2259 Public slot to add source files to the current project.
2260 </p>
2261 <a NAME="Project.addToOthers" ID="Project.addToOthers"></a> 2149 <a NAME="Project.addToOthers" ID="Project.addToOthers"></a>
2262 <h4>Project.addToOthers</h4> 2150 <h4>Project.addToOthers</h4>
2263 <b>addToOthers</b>(<i>fn</i>) 2151 <b>addToOthers</b>(<i>fn</i>)
2264 2152
2265 <p> 2153 <p>
2270 <dt><i>fn</i></dt> 2158 <dt><i>fn</i></dt>
2271 <dd> 2159 <dd>
2272 file name or directory name to add (string) 2160 file name or directory name to add (string)
2273 </dd> 2161 </dd>
2274 </dl> 2162 </dl>
2275 <a NAME="Project.addUiDir" ID="Project.addUiDir"></a>
2276 <h4>Project.addUiDir</h4>
2277 <b>addUiDir</b>(<i></i>)
2278
2279 <p>
2280 Public slot to add all forms of a directory to the current project.
2281 </p>
2282 <a NAME="Project.addUiFiles" ID="Project.addUiFiles"></a>
2283 <h4>Project.addUiFiles</h4>
2284 <b>addUiFiles</b>(<i></i>)
2285
2286 <p>
2287 Public slot to add forms to the current project.
2288 </p>
2289 <a NAME="Project.appendFile" ID="Project.appendFile"></a> 2163 <a NAME="Project.appendFile" ID="Project.appendFile"></a>
2290 <h4>Project.appendFile</h4> 2164 <h4>Project.appendFile</h4>
2291 <b>appendFile</b>(<i>fn, isSourceFile=False, updateModel=True</i>) 2165 <b>appendFile</b>(<i>fn, isSourceFile=False, updateModel=True</i>)
2292 2166
2293 <p> 2167 <p>
2512 <dt><i>langFile</i></dt> 2386 <dt><i>langFile</i></dt>
2513 <dd> 2387 <dd>
2514 the translation file to be removed (string) 2388 the translation file to be removed (string)
2515 </dd> 2389 </dd>
2516 </dl> 2390 </dl>
2517 <a NAME="Project.executeMake" ID="Project.executeMake"></a>
2518 <h4>Project.executeMake</h4>
2519 <b>executeMake</b>(<i></i>)
2520
2521 <p>
2522 Public slot to execute a project specific make run (auto-run)
2523 (execute or question).
2524 </p>
2525 <a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a> 2391 <a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
2526 <h4>Project.getAbsolutePath</h4> 2392 <h4>Project.getAbsolutePath</h4>
2527 <b>getAbsolutePath</b>(<i>fn</i>) 2393 <b>getAbsolutePath</b>(<i>fn</i>)
2528 2394
2529 <p> 2395 <p>
2733 <dt>Return:</dt> 2599 <dt>Return:</dt>
2734 <dd> 2600 <dd>
2735 eol string (string) 2601 eol string (string)
2736 </dd> 2602 </dd>
2737 </dl> 2603 </dl>
2604 <a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a>
2605 <h4>Project.getFileCategories</h4>
2606 <b>getFileCategories</b>(<i></i>)
2607
2608 <p>
2609 Public method to get the list of known file categories.
2610 </p>
2611 <dl>
2612 <dt>Return:</dt>
2613 <dd>
2614 list of known file categories
2615 </dd>
2616 </dl>
2617 <dl>
2618 <dt>Return Type:</dt>
2619 <dd>
2620 list of str
2621 </dd>
2622 </dl>
2623 <a NAME="Project.getFileCategoryExtension" ID="Project.getFileCategoryExtension"></a>
2624 <h4>Project.getFileCategoryExtension</h4>
2625 <b>getFileCategoryExtension</b>(<i>category, reverse=False</i>)
2626
2627 <p>
2628 Public method to get a list of default file extensions for the given category.
2629 </p>
2630 <dl>
2631
2632 <dt><i>category</i> (str)</dt>
2633 <dd>
2634 file type category
2635 </dd>
2636 <dt><i>reverse</i> (bool)</dt>
2637 <dd>
2638 flag indicating to get all other extensions except the one of
2639 the given category
2640 </dd>
2641 </dl>
2642 <dl>
2643 <dt>Return:</dt>
2644 <dd>
2645 list of default file extensions for the category
2646 </dd>
2647 </dl>
2648 <dl>
2649 <dt>Return Type:</dt>
2650 <dd>
2651 list of str
2652 </dd>
2653 </dl>
2654 <a NAME="Project.getFileCategoryFilterString" ID="Project.getFileCategoryFilterString"></a>
2655 <h4>Project.getFileCategoryFilterString</h4>
2656 <b>getFileCategoryFilterString</b>(<i>categories=None, withOthers=False, withAll=True</i>)
2657
2658 <p>
2659 Public method to get a file selection string for the given categories.
2660 </p>
2661 <dl>
2662
2663 <dt><i>categories</i> (list of str (optional))</dt>
2664 <dd>
2665 list of file type categories (defaults to None).
2666 A value of None means all categories except 'OTHERS'.
2667 </dd>
2668 <dt><i>withOthers</i> (bool (optional))</dt>
2669 <dd>
2670 flag indicating to include the 'OTHERS' category
2671 (defaults to False)
2672 </dd>
2673 <dt><i>withAll</i> (bool (optional))</dt>
2674 <dd>
2675 flag indicating to include a filter for 'All Files'
2676 (defaults to True)
2677 </dd>
2678 </dl>
2679 <dl>
2680 <dt>Return:</dt>
2681 <dd>
2682 file selection filter string
2683 </dd>
2684 </dl>
2685 <dl>
2686 <dt>Return Type:</dt>
2687 <dd>
2688 str
2689 </dd>
2690 </dl>
2691 <a NAME="Project.getFileCategoryString" ID="Project.getFileCategoryString"></a>
2692 <h4>Project.getFileCategoryString</h4>
2693 <b>getFileCategoryString</b>(<i>category</i>)
2694
2695 <p>
2696 Public method to get a user string for the given category.
2697 </p>
2698 <dl>
2699
2700 <dt><i>category</i> (str)</dt>
2701 <dd>
2702 file type category
2703 </dd>
2704 </dl>
2705 <dl>
2706 <dt>Return:</dt>
2707 <dd>
2708 user string for the category
2709 </dd>
2710 </dl>
2711 <dl>
2712 <dt>Return Type:</dt>
2713 <dd>
2714 str
2715 </dd>
2716 </dl>
2717 <a NAME="Project.getFileCategoryType" ID="Project.getFileCategoryType"></a>
2718 <h4>Project.getFileCategoryType</h4>
2719 <b>getFileCategoryType</b>(<i>category</i>)
2720
2721 <p>
2722 Public method to get a user type string for the given category.
2723 </p>
2724 <dl>
2725
2726 <dt><i>category</i> (str)</dt>
2727 <dd>
2728 file type category
2729 </dd>
2730 </dl>
2731 <dl>
2732 <dt>Return:</dt>
2733 <dd>
2734 user type string for the category
2735 </dd>
2736 </dl>
2737 <dl>
2738 <dt>Return Type:</dt>
2739 <dd>
2740 str
2741 </dd>
2742 </dl>
2738 <a NAME="Project.getFiles" ID="Project.getFiles"></a> 2743 <a NAME="Project.getFiles" ID="Project.getFiles"></a>
2739 <h4>Project.getFiles</h4> 2744 <h4>Project.getFiles</h4>
2740 <b>getFiles</b>(<i>start</i>) 2745 <b>getFiles</b>(<i>start</i>)
2741 2746
2742 <p> 2747 <p>
2765 </p> 2770 </p>
2766 <dl> 2771 <dl>
2767 2772
2768 <dt><i>associationType</i> (str)</dt> 2773 <dt><i>associationType</i> (str)</dt>
2769 <dd> 2774 <dd>
2770 type of the association (one of FORMS, 2775 type of the association (one of the known file categories
2771 INTERFACES, OTHERS, PROTOCOLS, RESOURCES, SOURCES, 2776 or __IGNORE__)
2772 TRANSLATIONS or __IGNORE__)
2773 </dd> 2777 </dd>
2774 </dl> 2778 </dl>
2775 <dl> 2779 <dl>
2776 <dt>Return:</dt> 2780 <dt>Return:</dt>
2777 <dd> 2781 <dd>
2942 <dt>Return Type:</dt> 2946 <dt>Return Type:</dt>
2943 <dd> 2947 <dd>
2944 str 2948 str
2945 </dd> 2949 </dd>
2946 </dl> 2950 </dl>
2951 <a NAME="Project.getProjectData" ID="Project.getProjectData"></a>
2952 <h4>Project.getProjectData</h4>
2953 <b>getProjectData</b>(<i>dataKey=None, default=None</i>)
2954
2955 <p>
2956 Public method to get the data associated with the given data key.
2957 </p>
2958 <p>
2959 Note: If dataKey is None, a copy of the project data structure
2960 is returned.
2961 </p>
2962 <dl>
2963
2964 <dt><i>dataKey</i> (str (optional))</dt>
2965 <dd>
2966 key of the data to get (defaults to None)
2967 </dd>
2968 <dt><i>default</i> (Any (optional))</dt>
2969 <dd>
2970 default value for non-existent keys (defaults to None)
2971 </dd>
2972 </dl>
2973 <dl>
2974 <dt>Return:</dt>
2975 <dd>
2976 requested data or None if the data key doesn't exist or
2977 a copy of the project data dictionary
2978 </dd>
2979 </dl>
2980 <dl>
2981 <dt>Return Type:</dt>
2982 <dd>
2983 Any
2984 </dd>
2985 </dl>
2947 <a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a> 2986 <a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a>
2948 <h4>Project.getProjectDescription</h4> 2987 <h4>Project.getProjectDescription</h4>
2949 <b>getProjectDescription</b>(<i></i>) 2988 <b>getProjectDescription</b>(<i></i>)
2950 2989
2951 <p> 2990 <p>
3018 </p> 3057 </p>
3019 <dl> 3058 <dl>
3020 3059
3021 <dt><i>fileType</i> (str)</dt> 3060 <dt><i>fileType</i> (str)</dt>
3022 <dd> 3061 <dd>
3023 project file type (one of SOURCES, FORMS, RESOURCES, 3062 project file type (one of the known file categories)
3024 INTERFACES, PROTOCOLS, OTHERS, TRANSLATIONS)
3025 </dd> 3063 </dd>
3026 <dt><i>normalized</i> (boolean)</dt> 3064 <dt><i>normalized</i> (boolean)</dt>
3027 <dd> 3065 <dd>
3028 flag indicating normalized file names are wanted 3066 flag indicating normalized file names are wanted
3029 </dd> 3067 </dd>
3756 <dt>Return:</dt> 3794 <dt>Return:</dt>
3757 <dd> 3795 <dd>
3758 open state (boolean) 3796 open state (boolean)
3759 </dd> 3797 </dd>
3760 </dl> 3798 </dl>
3799 <a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a>
3800 <h4>Project.isProjectCategory</h4>
3801 <b>isProjectCategory</b>(<i>fn, category</i>)
3802
3803 <p>
3804 Public method to check, if the passed in filename belongs to the given
3805 category.
3806 </p>
3807 <dl>
3808
3809 <dt><i>fn</i> (str)</dt>
3810 <dd>
3811 filename to be checked
3812 </dd>
3813 <dt><i>category</i> (str)</dt>
3814 <dd>
3815 file category to check against
3816 </dd>
3817 </dl>
3818 <dl>
3819 <dt>Return:</dt>
3820 <dd>
3821 flag indicating membership
3822 </dd>
3823 </dl>
3824 <dl>
3825 <dt>Return Type:</dt>
3826 <dd>
3827 bool
3828 </dd>
3829 </dl>
3761 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> 3830 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a>
3762 <h4>Project.isProjectFile</h4> 3831 <h4>Project.isProjectFile</h4>
3763 <b>isProjectFile</b>(<i>fn</i>) 3832 <b>isProjectFile</b>(<i>fn</i>)
3764 3833
3765 <p> 3834 <p>
3777 <dt>Return:</dt> 3846 <dt>Return:</dt>
3778 <dd> 3847 <dd>
3779 flag indicating membership (boolean) 3848 flag indicating membership (boolean)
3780 </dd> 3849 </dd>
3781 </dl> 3850 </dl>
3782 <a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a>
3783 <h4>Project.isProjectForm</h4>
3784 <b>isProjectForm</b>(<i>fn</i>)
3785
3786 <p>
3787 Public method used to check, if the passed in filename belongs to the
3788 project forms.
3789 </p>
3790 <dl>
3791
3792 <dt><i>fn</i></dt>
3793 <dd>
3794 filename to be checked (string)
3795 </dd>
3796 </dl>
3797 <dl>
3798 <dt>Return:</dt>
3799 <dd>
3800 flag indicating membership (boolean)
3801 </dd>
3802 </dl>
3803 <a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a>
3804 <h4>Project.isProjectInterface</h4>
3805 <b>isProjectInterface</b>(<i>fn</i>)
3806
3807 <p>
3808 Public method used to check, if the passed in filename belongs to the
3809 project interfaces.
3810 </p>
3811 <dl>
3812
3813 <dt><i>fn</i></dt>
3814 <dd>
3815 filename to be checked (string)
3816 </dd>
3817 </dl>
3818 <dl>
3819 <dt>Return:</dt>
3820 <dd>
3821 flag indicating membership (boolean)
3822 </dd>
3823 </dl>
3824 <a NAME="Project.isProjectProtocol" ID="Project.isProjectProtocol"></a>
3825 <h4>Project.isProjectProtocol</h4>
3826 <b>isProjectProtocol</b>(<i>fn</i>)
3827
3828 <p>
3829 Public method used to check, if the passed in filename belongs to the
3830 project protocols.
3831 </p>
3832 <dl>
3833
3834 <dt><i>fn</i> (str)</dt>
3835 <dd>
3836 filename to be checked
3837 </dd>
3838 </dl>
3839 <dl>
3840 <dt>Return:</dt>
3841 <dd>
3842 flag indicating membership
3843 </dd>
3844 </dl>
3845 <dl>
3846 <dt>Return Type:</dt>
3847 <dd>
3848 bool
3849 </dd>
3850 </dl>
3851 <a NAME="Project.isProjectResource" ID="Project.isProjectResource"></a>
3852 <h4>Project.isProjectResource</h4>
3853 <b>isProjectResource</b>(<i>fn</i>)
3854
3855 <p>
3856 Public method used to check, if the passed in filename belongs to the
3857 project resources.
3858 </p>
3859 <dl>
3860
3861 <dt><i>fn</i></dt>
3862 <dd>
3863 filename to be checked (string)
3864 </dd>
3865 </dl>
3866 <dl>
3867 <dt>Return:</dt>
3868 <dd>
3869 flag indicating membership (boolean)
3870 </dd>
3871 </dl>
3872 <a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a>
3873 <h4>Project.isProjectSource</h4>
3874 <b>isProjectSource</b>(<i>fn</i>)
3875
3876 <p>
3877 Public method used to check, if the passed in filename belongs to the
3878 project sources.
3879 </p>
3880 <dl>
3881
3882 <dt><i>fn</i></dt>
3883 <dd>
3884 filename to be checked (string)
3885 </dd>
3886 </dl>
3887 <dl>
3888 <dt>Return:</dt>
3889 <dd>
3890 flag indicating membership (boolean)
3891 </dd>
3892 </dl>
3893 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a> 3851 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a>
3894 <h4>Project.isPy3Project</h4> 3852 <h4>Project.isPy3Project</h4>
3895 <b>isPy3Project</b>(<i></i>) 3853 <b>isPy3Project</b>(<i></i>)
3896 3854
3897 <p> 3855 <p>
4096 <dd> 4054 <dd>
4097 flag indicating an update of the model is 4055 flag indicating an update of the model is
4098 requested (boolean) 4056 requested (boolean)
4099 </dd> 4057 </dd>
4100 </dl> 4058 </dl>
4059 <a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a>
4060 <h4>Project.removeFileCategory</h4>
4061 <b>removeFileCategory</b>(<i>category</i>)
4062
4063 <p>
4064 Public method to remove a category from the categories repository.
4065 </p>
4066 <p>
4067 Note: If the category is not contained in the repository, the request to
4068 remove it will be ignored silently.
4069 </p>
4070 <dl>
4071
4072 <dt><i>category</i> (str)</dt>
4073 <dd>
4074 file category
4075 </dd>
4076 </dl>
4101 <a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a> 4077 <a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a>
4102 <h4>Project.removeLanguageFile</h4> 4078 <h4>Project.removeLanguageFile</h4>
4103 <b>removeLanguageFile</b>(<i>langFile</i>) 4079 <b>removeLanguageFile</b>(<i>langFile</i>)
4104 4080
4105 <p> 4081 <p>
4142 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> 4118 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a>
4143 <h4>Project.renameFileInPdata</h4> 4119 <h4>Project.renameFileInPdata</h4>
4144 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>) 4120 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>)
4145 4121
4146 <p> 4122 <p>
4147 Public method to rename a file in the pdata structure. 4123 Public method to rename a file in the __pdata structure.
4148 </p> 4124 </p>
4149 <dl> 4125 <dl>
4150 4126
4151 <dt><i>oldname</i></dt> 4127 <dt><i>oldname</i></dt>
4152 <dd> 4128 <dd>
4368 <dt><i>dirty</i> (bool)</dt> 4344 <dt><i>dirty</i> (bool)</dt>
4369 <dd> 4345 <dd>
4370 dirty state 4346 dirty state
4371 </dd> 4347 </dd>
4372 </dl> 4348 </dl>
4349 <a NAME="Project.setProjectData" ID="Project.setProjectData"></a>
4350 <h4>Project.setProjectData</h4>
4351 <b>setProjectData</b>(<i>data, dataKey=None, setDirty=True</i>)
4352
4353 <p>
4354 Public method to set data associated with the given data key in the project
4355 dictionary.
4356 </p>
4357 <p>
4358 Note: If no data key is given or is None, the data must be a dictionary used
4359 to update the project data.
4360 </p>
4361 <dl>
4362
4363 <dt><i>data</i> (Any)</dt>
4364 <dd>
4365 data to be set or a dictionary to update the project data
4366 </dd>
4367 <dt><i>dataKey</i> (str (optional))</dt>
4368 <dd>
4369 key of the data to set (defaults to None)
4370 </dd>
4371 <dt><i>setDirty</i> (bool (optional))</dt>
4372 <dd>
4373 flag indicating to set the dirty flag if the data is different
4374 from the current one (defaults to True)
4375 </dd>
4376 </dl>
4373 <a NAME="Project.setStatusMonitorAutoUpdate" ID="Project.setStatusMonitorAutoUpdate"></a> 4377 <a NAME="Project.setStatusMonitorAutoUpdate" ID="Project.setStatusMonitorAutoUpdate"></a>
4374 <h4>Project.setStatusMonitorAutoUpdate</h4> 4378 <h4>Project.setStatusMonitorAutoUpdate</h4>
4375 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>) 4379 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>)
4376 4380
4377 <p> 4381 <p>

Mercurial Repository: eric

eric ide

mercurial