diff -r 5ce1774b3106 -r c30f02ea1b27 src/eric7/Documentation/Source/eric7.Project.Project.html
--- a/src/eric7/Documentation/Source/eric7.Project.Project.html Thu Nov 24 16:10:58 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.Project.html Thu Nov 24 16:11:55 2022 +0100
@@ -92,6 +92,11 @@
emitted before an item of the model is
repopulated
</dd>
+<dt>processChangedProjectFiles()</dt>
+<dd>
+emitted to indicate, that changed project files
+ should be processed
+</dd>
<dt>projectAboutToBeCreated()</dt>
<dd>
emitted just before the project will be
@@ -111,44 +116,28 @@
emitted after a project file was closed but
before the projectClosed() signal is sent
</dd>
+<dt>projectFileAdded(str, str)</dt>
+<dd>
+emitted after a new file was added
+</dd>
+<dt>projectFileCompiled(str, str)</dt>
+<dd>
+emitted after a form was compiled
+</dd>
+<dt>projectFileRemoved(str, str)</dt>
+<dd>
+emitted after a file of the project was removed
+</dd>
<dt>projectFileRenamed(str, str)</dt>
<dd>
emitted after a file of the project
has been renamed
</dd>
-<dt>projectFormAdded(str)</dt>
-<dd>
-emitted after a new form was added
-</dd>
-<dt>projectFormCompiled(str)</dt>
-<dd>
-emitted after a form was compiled
-</dd>
-<dt>projectFormRemoved(str)</dt>
-<dd>
-emitted after a form was removed
-</dd>
-<dt>projectInterfaceAdded(str)</dt>
-<dd>
-emitted after a new IDL file was added
-</dd>
-<dt>projectInterfaceRemoved(str)</dt>
-<dd>
-emitted after a IDL file was removed
-</dd>
-<dt>projectLanguageAdded(str)</dt>
-<dd>
-emitted after a new language was added
-</dd>
<dt>projectLanguageAddedByCode(str)</dt>
<dd>
emitted after a new language was
added. The language code is sent by this signal.
</dd>
-<dt>projectLanguageRemoved(str)</dt>
-<dd>
-emitted after a language was removed
-</dd>
<dt>projectOpened()</dt>
<dd>
emitted after a project file was read
@@ -158,46 +147,11 @@
emitted after a project file was read but
before the projectOpened() signal is sent
</dd>
-<dt>projectOthersAdded(str)</dt>
-<dd>
-emitted after a file or directory was added
- to the OTHERS project data area
-</dd>
-<dt>projectOthersRemoved(str)</dt>
-<dd>
-emitted after a file was removed from the
- OTHERS project data area
-</dd>
<dt>projectPropertiesChanged()</dt>
<dd>
emitted after the project properties
were changed
</dd>
-<dt>projectProtocolAdded(str)</dt>
-<dd>
-emitted after a new proto file was added
-</dd>
-<dt>projectProtocolRemoved(str)</dt>
-<dd>
-emitted after a proto file was removed
-</dd>
-<dt>projectResourceAdded(str)</dt>
-<dd>
-emitted after a new resource file was
- added
-</dd>
-<dt>projectResourceRemoved(str)</dt>
-<dd>
-emitted after a resource was removed
-</dd>
-<dt>projectSourceAdded(str)</dt>
-<dd>
-emitted after a new source file was added
-</dd>
-<dt>projectSourceRemoved(str)</dt>
-<dd>
-emitted after a source was removed
-</dd>
<dt>reinitVCS()</dt>
<dd>
emitted after the VCS has been reinitialized
@@ -265,6 +219,10 @@
<td>Private method used to add all files of a single directory to the project.</td>
</tr>
<tr>
+<td><a href="#Project.__autoExecuteMake">__autoExecuteMake</a></td>
+<td>Private slot to execute a project specific make run (auto-run) (execute or question).</td>
+</tr>
+<tr>
<td><a href="#Project.__binaryTranslationFile">__binaryTranslationFile</a></td>
<td>Private method to calculate the filename of the binary translations file given the name of the raw translations file.</td>
</tr>
@@ -585,66 +543,22 @@
<td>Public method to add actions to the list of actions.</td>
</tr>
<tr>
-<td><a href="#Project.addFiles">addFiles</a></td>
-<td>Public slot used to add files to the project.</td>
+<td><a href="#Project.addFileCategory">addFileCategory</a></td>
+<td>Public method to add a file category to the categories repository.</td>
</tr>
<tr>
-<td><a href="#Project.addIdlDir">addIdlDir</a></td>
-<td>Public slot to add all IDL interfaces of a directory to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addIdlFiles">addIdlFiles</a></td>
-<td>Public slot to add IDL interfaces to the current project.</td>
+<td><a href="#Project.addFiles">addFiles</a></td>
+<td>Public slot used to add files to the project.</td>
</tr>
<tr>
<td><a href="#Project.addLanguage">addLanguage</a></td>
<td>Public slot used to add a language to the project.</td>
</tr>
<tr>
-<td><a href="#Project.addOthersDir">addOthersDir</a></td>
-<td>Public slot to add a directory to the OTHERS project data.</td>
-</tr>
-<tr>
-<td><a href="#Project.addOthersFiles">addOthersFiles</a></td>
-<td>Public slot to add files to the OTHERS project data.</td>
-</tr>
-<tr>
-<td><a href="#Project.addProtoDir">addProtoDir</a></td>
-<td>Public slot to add all protocol files of a directory to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addProtoFiles">addProtoFiles</a></td>
-<td>Public slot to add protocol files to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addResourceDir">addResourceDir</a></td>
-<td>Public slot to add all Qt resource files of a directory to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addResourceFiles">addResourceFiles</a></td>
-<td>Public slot to add Qt resources to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addSourceDir">addSourceDir</a></td>
-<td>Public slot to add all source files of a directory to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addSourceFiles">addSourceFiles</a></td>
-<td>Public slot to add source files to the current project.</td>
-</tr>
-<tr>
<td><a href="#Project.addToOthers">addToOthers</a></td>
<td>Public method to add a file/directory to the OTHERS project data.</td>
</tr>
<tr>
-<td><a href="#Project.addUiDir">addUiDir</a></td>
-<td>Public slot to add all forms of a directory to the current project.</td>
-</tr>
-<tr>
-<td><a href="#Project.addUiFiles">addUiFiles</a></td>
-<td>Public slot to add forms to the current project.</td>
-</tr>
-<tr>
<td><a href="#Project.appendFile">appendFile</a></td>
<td>Public method to append a file to the project.</td>
</tr>
@@ -705,10 +619,6 @@
<td>Public slot to delete a translation from the project directory.</td>
</tr>
<tr>
-<td><a href="#Project.executeMake">executeMake</a></td>
-<td>Public slot to execute a project specific make run (auto-run) (execute or question).</td>
-</tr>
-<tr>
<td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td>
<td>Public method to convert a project relative file path to an absolute file path.</td>
</tr>
@@ -753,6 +663,26 @@
<td>Public method to get the EOL-string to be used by the project.</td>
</tr>
<tr>
+<td><a href="#Project.getFileCategories">getFileCategories</a></td>
+<td>Public method to get the list of known file categories.</td>
+</tr>
+<tr>
+<td><a href="#Project.getFileCategoryExtension">getFileCategoryExtension</a></td>
+<td>Public method to get a list of default file extensions for the given category.</td>
+</tr>
+<tr>
+<td><a href="#Project.getFileCategoryFilterString">getFileCategoryFilterString</a></td>
+<td>Public method to get a file selection string for the given categories.</td>
+</tr>
+<tr>
+<td><a href="#Project.getFileCategoryString">getFileCategoryString</a></td>
+<td>Public method to get a user string for the given category.</td>
+</tr>
+<tr>
+<td><a href="#Project.getFileCategoryType">getFileCategoryType</a></td>
+<td>Public method to get a user type string for the given category.</td>
+</tr>
+<tr>
<td><a href="#Project.getFiles">getFiles</a></td>
<td>Public method to get all files starting with a common prefix.</td>
</tr>
@@ -797,6 +727,10 @@
<td>Public method to get the email address of the project author.</td>
</tr>
<tr>
+<td><a href="#Project.getProjectData">getProjectData</a></td>
+<td>Public method to get the data associated with the given data key.</td>
+</tr>
+<tr>
<td><a href="#Project.getProjectDescription">getProjectDescription</a></td>
<td>Public method to get the description of the project.</td>
</tr>
@@ -981,28 +915,12 @@
<td>Public method to return the opened state.</td>
</tr>
<tr>
-<td><a href="#Project.isProjectFile">isProjectFile</a></td>
-<td>Public method used to check, if the passed in filename belongs to the project.</td>
-</tr>
-<tr>
-<td><a href="#Project.isProjectForm">isProjectForm</a></td>
-<td>Public method used to check, if the passed in filename belongs to the project forms.</td>
+<td><a href="#Project.isProjectCategory">isProjectCategory</a></td>
+<td>Public method to check, if the passed in filename belongs to the given category.</td>
</tr>
<tr>
-<td><a href="#Project.isProjectInterface">isProjectInterface</a></td>
-<td>Public method used to check, if the passed in filename belongs to the project interfaces.</td>
-</tr>
-<tr>
-<td><a href="#Project.isProjectProtocol">isProjectProtocol</a></td>
-<td>Public method used to check, if the passed in filename belongs to the project protocols.</td>
-</tr>
-<tr>
-<td><a href="#Project.isProjectResource">isProjectResource</a></td>
-<td>Public method used to check, if the passed in filename belongs to the project resources.</td>
-</tr>
-<tr>
-<td><a href="#Project.isProjectSource">isProjectSource</a></td>
-<td>Public method used to check, if the passed in filename belongs to the project sources.</td>
+<td><a href="#Project.isProjectFile">isProjectFile</a></td>
+<td>Public method used to check, if the passed in filename belongs to the project.</td>
</tr>
<tr>
<td><a href="#Project.isPy3Project">isPy3Project</a></td>
@@ -1049,6 +967,10 @@
<td>Public slot to remove a file from the project.</td>
</tr>
<tr>
+<td><a href="#Project.removeFileCategory">removeFileCategory</a></td>
+<td>Public method to remove a category from the categories repository.</td>
+</tr>
+<tr>
<td><a href="#Project.removeLanguageFile">removeLanguageFile</a></td>
<td>Public slot to remove a translation from the project.</td>
</tr>
@@ -1058,7 +980,7 @@
</tr>
<tr>
<td><a href="#Project.renameFileInPdata">renameFileInPdata</a></td>
-<td>Public method to rename a file in the pdata structure.</td>
+<td>Public method to rename a file in the __pdata structure.</td>
</tr>
<tr>
<td><a href="#Project.renameMainScript">renameMainScript</a></td>
@@ -1101,6 +1023,10 @@
<td>Public method to set the dirty state.</td>
</tr>
<tr>
+<td><a href="#Project.setProjectData">setProjectData</a></td>
+<td>Public method to set data associated with the given data key in the project dictionary.</td>
+</tr>
+<tr>
<td><a href="#Project.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td>
<td>Public method to enable the auto update function.</td>
</tr>
@@ -1230,6 +1156,14 @@
flag indicating quiet operations (boolean)
</dd>
</dl>
+<a NAME="Project.__autoExecuteMake" ID="Project.__autoExecuteMake"></a>
+<h4>Project.__autoExecuteMake</h4>
+<b>__autoExecuteMake</b>(<i></i>)
+
+<p>
+ Private slot to execute a project specific make run (auto-run)
+ (execute or question).
+</p>
<a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a>
<h4>Project.__binaryTranslationFile</h4>
<b>__binaryTranslationFile</b>(<i>langFile</i>)
@@ -2159,6 +2093,34 @@
list of actions (list of EricAction)
</dd>
</dl>
+<a NAME="Project.addFileCategory" ID="Project.addFileCategory"></a>
+<h4>Project.addFileCategory</h4>
+<b>addFileCategory</b>(<i>category, categoryItem</i>)
+
+<p>
+ Public method to add a file category to the categories repository.
+</p>
+<p>
+ Note: The given category must not be contained in the repository already.
+</p>
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+file category (must be unique)
+</dd>
+<dt><i>categoryItem</i> (FileCategoryRepositoryItem)</dt>
+<dd>
+data class instance containing the category data
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>TypeError</b>:</dt>
+<dd>
+raised to signal a wrong type for the category item
+</dd>
+</dl>
<a NAME="Project.addFiles" ID="Project.addFiles"></a>
<h4>Project.addFiles</h4>
<b>addFiles</b>(<i>fileTypeFilter=None, startdir=None</i>)
@@ -2177,21 +2139,6 @@
start directory for the selection dialog
</dd>
</dl>
-<a NAME="Project.addIdlDir" ID="Project.addIdlDir"></a>
-<h4>Project.addIdlDir</h4>
-<b>addIdlDir</b>(<i></i>)
-
-<p>
- Public slot to add all IDL interfaces of a directory to the current
- project.
-</p>
-<a NAME="Project.addIdlFiles" ID="Project.addIdlFiles"></a>
-<h4>Project.addIdlFiles</h4>
-<b>addIdlFiles</b>(<i></i>)
-
-<p>
- Public slot to add IDL interfaces to the current project.
-</p>
<a NAME="Project.addLanguage" ID="Project.addLanguage"></a>
<h4>Project.addLanguage</h4>
<b>addLanguage</b>(<i></i>)
@@ -2199,65 +2146,6 @@
<p>
Public slot used to add a language to the project.
</p>
-<a NAME="Project.addOthersDir" ID="Project.addOthersDir"></a>
-<h4>Project.addOthersDir</h4>
-<b>addOthersDir</b>(<i></i>)
-
-<p>
- Public slot to add a directory to the OTHERS project data.
-</p>
-<a NAME="Project.addOthersFiles" ID="Project.addOthersFiles"></a>
-<h4>Project.addOthersFiles</h4>
-<b>addOthersFiles</b>(<i></i>)
-
-<p>
- Public slot to add files to the OTHERS project data.
-</p>
-<a NAME="Project.addProtoDir" ID="Project.addProtoDir"></a>
-<h4>Project.addProtoDir</h4>
-<b>addProtoDir</b>(<i></i>)
-
-<p>
- Public slot to add all protocol files of a directory to the current
- project.
-</p>
-<a NAME="Project.addProtoFiles" ID="Project.addProtoFiles"></a>
-<h4>Project.addProtoFiles</h4>
-<b>addProtoFiles</b>(<i></i>)
-
-<p>
- Public slot to add protocol files to the current project.
-</p>
-<a NAME="Project.addResourceDir" ID="Project.addResourceDir"></a>
-<h4>Project.addResourceDir</h4>
-<b>addResourceDir</b>(<i></i>)
-
-<p>
- Public slot to add all Qt resource files of a directory to the current
- project.
-</p>
-<a NAME="Project.addResourceFiles" ID="Project.addResourceFiles"></a>
-<h4>Project.addResourceFiles</h4>
-<b>addResourceFiles</b>(<i></i>)
-
-<p>
- Public slot to add Qt resources to the current project.
-</p>
-<a NAME="Project.addSourceDir" ID="Project.addSourceDir"></a>
-<h4>Project.addSourceDir</h4>
-<b>addSourceDir</b>(<i></i>)
-
-<p>
- Public slot to add all source files of a directory to the current
- project.
-</p>
-<a NAME="Project.addSourceFiles" ID="Project.addSourceFiles"></a>
-<h4>Project.addSourceFiles</h4>
-<b>addSourceFiles</b>(<i></i>)
-
-<p>
- Public slot to add source files to the current project.
-</p>
<a NAME="Project.addToOthers" ID="Project.addToOthers"></a>
<h4>Project.addToOthers</h4>
<b>addToOthers</b>(<i>fn</i>)
@@ -2272,20 +2160,6 @@
file name or directory name to add (string)
</dd>
</dl>
-<a NAME="Project.addUiDir" ID="Project.addUiDir"></a>
-<h4>Project.addUiDir</h4>
-<b>addUiDir</b>(<i></i>)
-
-<p>
- Public slot to add all forms of a directory to the current project.
-</p>
-<a NAME="Project.addUiFiles" ID="Project.addUiFiles"></a>
-<h4>Project.addUiFiles</h4>
-<b>addUiFiles</b>(<i></i>)
-
-<p>
- Public slot to add forms to the current project.
-</p>
<a NAME="Project.appendFile" ID="Project.appendFile"></a>
<h4>Project.appendFile</h4>
<b>appendFile</b>(<i>fn, isSourceFile=False, updateModel=True</i>)
@@ -2514,14 +2388,6 @@
the translation file to be removed (string)
</dd>
</dl>
-<a NAME="Project.executeMake" ID="Project.executeMake"></a>
-<h4>Project.executeMake</h4>
-<b>executeMake</b>(<i></i>)
-
-<p>
- Public slot to execute a project specific make run (auto-run)
- (execute or question).
-</p>
<a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
<h4>Project.getAbsolutePath</h4>
<b>getAbsolutePath</b>(<i>fn</i>)
@@ -2735,6 +2601,145 @@
eol string (string)
</dd>
</dl>
+<a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a>
+<h4>Project.getFileCategories</h4>
+<b>getFileCategories</b>(<i></i>)
+
+<p>
+ Public method to get the list of known file categories.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of known file categories
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<a NAME="Project.getFileCategoryExtension" ID="Project.getFileCategoryExtension"></a>
+<h4>Project.getFileCategoryExtension</h4>
+<b>getFileCategoryExtension</b>(<i>category, reverse=False</i>)
+
+<p>
+ Public method to get a list of default file extensions for the given category.
+</p>
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+file type category
+</dd>
+<dt><i>reverse</i> (bool)</dt>
+<dd>
+flag indicating to get all other extensions except the one of
+ the given category
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of default file extensions for the category
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<a NAME="Project.getFileCategoryFilterString" ID="Project.getFileCategoryFilterString"></a>
+<h4>Project.getFileCategoryFilterString</h4>
+<b>getFileCategoryFilterString</b>(<i>categories=None, withOthers=False, withAll=True</i>)
+
+<p>
+ Public method to get a file selection string for the given categories.
+</p>
+<dl>
+
+<dt><i>categories</i> (list of str (optional))</dt>
+<dd>
+list of file type categories (defaults to None).
+ A value of None means all categories except 'OTHERS'.
+</dd>
+<dt><i>withOthers</i> (bool (optional))</dt>
+<dd>
+flag indicating to include the 'OTHERS' category
+ (defaults to False)
+</dd>
+<dt><i>withAll</i> (bool (optional))</dt>
+<dd>
+flag indicating to include a filter for 'All Files'
+ (defaults to True)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+file selection filter string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="Project.getFileCategoryString" ID="Project.getFileCategoryString"></a>
+<h4>Project.getFileCategoryString</h4>
+<b>getFileCategoryString</b>(<i>category</i>)
+
+<p>
+ Public method to get a user string for the given category.
+</p>
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+file type category
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+user string for the category
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="Project.getFileCategoryType" ID="Project.getFileCategoryType"></a>
+<h4>Project.getFileCategoryType</h4>
+<b>getFileCategoryType</b>(<i>category</i>)
+
+<p>
+ Public method to get a user type string for the given category.
+</p>
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+file type category
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+user type string for the category
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<a NAME="Project.getFiles" ID="Project.getFiles"></a>
<h4>Project.getFiles</h4>
<b>getFiles</b>(<i>start</i>)
@@ -2767,9 +2772,8 @@
<dt><i>associationType</i> (str)</dt>
<dd>
-type of the association (one of FORMS,
- INTERFACES, OTHERS, PROTOCOLS, RESOURCES, SOURCES,
- TRANSLATIONS or __IGNORE__)
+type of the association (one of the known file categories
+ or __IGNORE__)
</dd>
</dl>
<dl>
@@ -2944,6 +2948,41 @@
str
</dd>
</dl>
+<a NAME="Project.getProjectData" ID="Project.getProjectData"></a>
+<h4>Project.getProjectData</h4>
+<b>getProjectData</b>(<i>dataKey=None, default=None</i>)
+
+<p>
+ Public method to get the data associated with the given data key.
+</p>
+<p>
+ Note: If dataKey is None, a copy of the project data structure
+ is returned.
+</p>
+<dl>
+
+<dt><i>dataKey</i> (str (optional))</dt>
+<dd>
+key of the data to get (defaults to None)
+</dd>
+<dt><i>default</i> (Any (optional))</dt>
+<dd>
+default value for non-existent keys (defaults to None)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+requested data or None if the data key doesn't exist or
+ a copy of the project data dictionary
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
<a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a>
<h4>Project.getProjectDescription</h4>
<b>getProjectDescription</b>(<i></i>)
@@ -3020,8 +3059,7 @@
<dt><i>fileType</i> (str)</dt>
<dd>
-project file type (one of SOURCES, FORMS, RESOURCES,
- INTERFACES, PROTOCOLS, OTHERS, TRANSLATIONS)
+project file type (one of the known file categories)
</dd>
<dt><i>normalized</i> (boolean)</dt>
<dd>
@@ -3758,76 +3796,13 @@
open state (boolean)
</dd>
</dl>
-<a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a>
-<h4>Project.isProjectFile</h4>
-<b>isProjectFile</b>(<i>fn</i>)
-
-<p>
- Public method used to check, if the passed in filename belongs to the
- project.
-</p>
-<dl>
-
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating membership (boolean)
-</dd>
-</dl>
-<a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a>
-<h4>Project.isProjectForm</h4>
-<b>isProjectForm</b>(<i>fn</i>)
-
-<p>
- Public method used to check, if the passed in filename belongs to the
- project forms.
-</p>
-<dl>
-
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating membership (boolean)
-</dd>
-</dl>
-<a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a>
-<h4>Project.isProjectInterface</h4>
-<b>isProjectInterface</b>(<i>fn</i>)
-
-<p>
- Public method used to check, if the passed in filename belongs to the
- project interfaces.
-</p>
-<dl>
-
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating membership (boolean)
-</dd>
-</dl>
-<a NAME="Project.isProjectProtocol" ID="Project.isProjectProtocol"></a>
-<h4>Project.isProjectProtocol</h4>
-<b>isProjectProtocol</b>(<i>fn</i>)
-
-<p>
- Public method used to check, if the passed in filename belongs to the
- project protocols.
+<a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a>
+<h4>Project.isProjectCategory</h4>
+<b>isProjectCategory</b>(<i>fn, category</i>)
+
+<p>
+ Public method to check, if the passed in filename belongs to the given
+ category.
</p>
<dl>
@@ -3835,6 +3810,10 @@
<dd>
filename to be checked
</dd>
+<dt><i>category</i> (str)</dt>
+<dd>
+file category to check against
+</dd>
</dl>
<dl>
<dt>Return:</dt>
@@ -3848,34 +3827,13 @@
bool
</dd>
</dl>
-<a NAME="Project.isProjectResource" ID="Project.isProjectResource"></a>
-<h4>Project.isProjectResource</h4>
-<b>isProjectResource</b>(<i>fn</i>)
+<a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a>
+<h4>Project.isProjectFile</h4>
+<b>isProjectFile</b>(<i>fn</i>)
<p>
Public method used to check, if the passed in filename belongs to the
- project resources.
-</p>
-<dl>
-
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating membership (boolean)
-</dd>
-</dl>
-<a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a>
-<h4>Project.isProjectSource</h4>
-<b>isProjectSource</b>(<i>fn</i>)
-
-<p>
- Public method used to check, if the passed in filename belongs to the
- project sources.
+ project.
</p>
<dl>
@@ -4098,6 +4056,24 @@
requested (boolean)
</dd>
</dl>
+<a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a>
+<h4>Project.removeFileCategory</h4>
+<b>removeFileCategory</b>(<i>category</i>)
+
+<p>
+ Public method to remove a category from the categories repository.
+</p>
+<p>
+ Note: If the category is not contained in the repository, the request to
+ remove it will be ignored silently.
+</p>
+<dl>
+
+<dt><i>category</i> (str)</dt>
+<dd>
+file category
+</dd>
+</dl>
<a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a>
<h4>Project.removeLanguageFile</h4>
<b>removeLanguageFile</b>(<i>langFile</i>)
@@ -4144,7 +4120,7 @@
<b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>)
<p>
- Public method to rename a file in the pdata structure.
+ Public method to rename a file in the __pdata structure.
</p>
<dl>
@@ -4370,6 +4346,34 @@
dirty state
</dd>
</dl>
+<a NAME="Project.setProjectData" ID="Project.setProjectData"></a>
+<h4>Project.setProjectData</h4>
+<b>setProjectData</b>(<i>data, dataKey=None, setDirty=True</i>)
+
+<p>
+ Public method to set data associated with the given data key in the project
+ dictionary.
+</p>
+<p>
+ Note: If no data key is given or is None, the data must be a dictionary used
+ to update the project data.
+</p>
+<dl>
+
+<dt><i>data</i> (Any)</dt>
+<dd>
+data to be set or a dictionary to update the project data
+</dd>
+<dt><i>dataKey</i> (str (optional))</dt>
+<dd>
+key of the data to set (defaults to None)
+</dd>
+<dt><i>setDirty</i> (bool (optional))</dt>
+<dd>
+flag indicating to set the dirty flag if the data is different
+ from the current one (defaults to True)
+</dd>
+</dl>
<a NAME="Project.setStatusMonitorAutoUpdate" ID="Project.setStatusMonitorAutoUpdate"></a>
<h4>Project.setStatusMonitorAutoUpdate</h4>
<b>setStatusMonitorAutoUpdate</b>(<i>auto</i>)
