diff -r 643989a1e2bd -r e440aaf179ce src/eric7/Documentation/Source/eric7.Project.Project.html
--- a/src/eric7/Documentation/Source/eric7.Project.Project.html Wed Dec 20 15:42:44 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.Project.html Wed Dec 20 19:28:22 2023 +0100
@@ -1102,13 +1102,13 @@
</p>
<dl>
-<dt><i>parent</i></dt>
-<dd>
-parent widget (usually the ui object) (QWidget)
-</dd>
-<dt><i>filename</i></dt>
-<dd>
-optional filename of a project file to open (string)
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget (usually the ui object)
+</dd>
+<dt><i>filename</i> (str)</dt>
+<dd>
+optional filename of a project file to open
</dd>
</dl>
<a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a>
@@ -1124,17 +1124,17 @@
</p>
<dl>
-<dt><i>filetype</i></dt>
-<dd>
-type of files to add (string)
-</dd>
-<dt><i>source</i></dt>
-<dd>
-source directory (string)
-</dd>
-<dt><i>target</i></dt>
-<dd>
-target directory (string)
+<dt><i>filetype</i> (str)</dt>
+<dd>
+type of files to add
+</dd>
+<dt><i>source</i> (str)</dt>
+<dd>
+source directory
+</dd>
+<dt><i>target</i> (str)</dt>
+<dd>
+target directory
</dd>
</dl>
<a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a>
@@ -1147,21 +1147,21 @@
</p>
<dl>
-<dt><i>filetype</i></dt>
-<dd>
-type of files to add (string)
-</dd>
-<dt><i>source</i></dt>
-<dd>
-source directory (string)
-</dd>
-<dt><i>target</i></dt>
-<dd>
-target directory (string)
-</dd>
-<dt><i>quiet</i></dt>
-<dd>
-flag indicating quiet operations (boolean)
+<dt><i>filetype</i> (str)</dt>
+<dd>
+type of files to add
+</dd>
+<dt><i>source</i> (str)</dt>
+<dd>
+source directory
+</dd>
+<dt><i>target</i> (str)</dt>
+<dd>
+target directory
+</dd>
+<dt><i>quiet</i> (bool)</dt>
+<dd>
+flag indicating quiet operations
</dd>
</dl>
<a NAME="Project.__autoExecuteMake" ID="Project.__autoExecuteMake"></a>
@@ -1182,15 +1182,21 @@
</p>
<dl>
-<dt><i>langFile</i></dt>
-<dd>
-name of the raw translations file (string)
+<dt><i>langFile</i> (str)</dt>
+<dd>
+name of the raw translations file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-name of the binary translations file (string)
+name of the binary translations file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a>
@@ -1207,9 +1213,9 @@
</p>
<dl>
-<dt><i>index</i></dt>
-<dd>
-key of the list to be checked (string)
+<dt><i>index</i> (str)</dt>
+<dd>
+key of the list to be checked
</dd>
</dl>
<a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a>
@@ -1222,19 +1228,25 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
-</dd>
-<dt><i>group</i></dt>
-<dd>
-group to check (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+filename to be checked
+</dd>
+<dt><i>group</i> (str)</dt>
+<dd>
+group to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating membership (boolean)
+flag indicating membership
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a>
@@ -1320,15 +1332,21 @@
</p>
<dl>
-<dt><i>filename</i></dt>
-<dd>
-name of the plugin file to modify (string)
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the plugin file to modify
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-modified source (bytes), snapshot version string (string)
+modified source (bytes), snapshot version string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a>
@@ -1340,13 +1358,13 @@
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-name of the directory entry to create (string)
-</dd>
-<dt><i>zipFile</i></dt>
-<dd>
-open ZipFile object (zipfile.ZipFile)
+<dt><i>path</i> (str)</dt>
+<dd>
+name of the directory entry to create
+</dd>
+<dt><i>zipFile</i> (zipfile.ZipFile)</dt>
+<dd>
+open ZipFile object
</dd>
</dl>
<a NAME="Project.__deleteDebugProperties" ID="Project.__deleteDebugProperties"></a>
@@ -1379,15 +1397,15 @@
</p>
<dl>
-<dt><i>AI</i></dt>
+<dt><i>AI</i> (bool)</dt>
<dd>
flag indicating whether the automatic inclusion should
- be honoured (boolean)
-</dd>
-<dt><i>onUserDemand</i></dt>
+ be honoured
+</dd>
+<dt><i>onUserDemand</i> (bool)</dt>
<dd>
flag indicating whether this method was
- requested by the user via a menu action (boolean)
+ requested by the user via a menu action
</dd>
</dl>
<a NAME="Project.__executeMake" ID="Project.__executeMake"></a>
@@ -1558,9 +1576,9 @@
</p>
<dl>
-<dt><i>act</i></dt>
-<dd>
-reference to the action that triggered (QAction)
+<dt><i>act</i> (QAction)</dt>
+<dd>
+reference to the action that triggered
</dd>
</dl>
<a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a>
@@ -1621,9 +1639,9 @@
</p>
<dl>
-<dt><i>snapshot</i></dt>
-<dd>
-flag indicating snapshot archives (boolean)
+<dt><i>snapshot</i> (bool)</dt>
+<dd>
+flag indicating snapshot archives
</dd>
</dl>
<a NAME="Project.__pluginCreatePkgList" ID="Project.__pluginCreatePkgList"></a>
@@ -1649,15 +1667,21 @@
</p>
<dl>
-<dt><i>filename</i></dt>
-<dd>
-name of the plugin file (string)
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the plugin file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-version string (string)
+version string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.__readDebugProperties" ID="Project.__readDebugProperties"></a>
@@ -1670,7 +1694,7 @@
</p>
<dl>
-<dt><i>quiet</i></dt>
+<dt><i>quiet</i> (bool)</dt>
<dd>
flag indicating quiet operations.
If this flag is true, no errors are reported.
@@ -1685,9 +1709,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename of the project file to be read (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+filename of the project file to be read
</dd>
</dl>
<dl>
@@ -1696,6 +1720,12 @@
flag indicating success
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
<a NAME="Project.__readSession" ID="Project.__readSession"></a>
<h4>Project.__readSession</h4>
<b>__readSession</b>(<i>quiet=False, indicator=""</i>)
@@ -1705,14 +1735,14 @@
</p>
<dl>
-<dt><i>quiet</i></dt>
+<dt><i>quiet</i> (bool)</dt>
<dd>
flag indicating quiet operations.
If this flag is true, no errors are reported.
</dd>
-<dt><i>indicator</i></dt>
-<dd>
-indicator string (string)
+<dt><i>indicator</i> (str)</dt>
+<dd>
+indicator string
</dd>
</dl>
<a NAME="Project.__readTasks" ID="Project.__readTasks"></a>
@@ -1943,15 +1973,21 @@
</p>
<dl>
-<dt><i>language</i></dt>
-<dd>
-programming language (string)
+<dt><i>language</i> (str)</dt>
+<dd>
+programming language
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-source extensions (list of string)
+source extensions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Project.__syncRecent" ID="Project.__syncRecent"></a>
@@ -1985,7 +2021,7 @@
</p>
<dl>
-<dt><i>quiet</i></dt>
+<dt><i>quiet</i> (bool)</dt>
<dd>
flag indicating quiet operations.
If this flag is true, no errors are reported.
@@ -2000,7 +2036,7 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
optional filename of the project file to be written (string).
If fn is None, the filename stored in the project object
@@ -2015,6 +2051,12 @@
flag indicating success
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
<a NAME="Project.__writeSession" ID="Project.__writeSession"></a>
<h4>Project.__writeSession</h4>
<b>__writeSession</b>(<i>quiet=False, indicator=""</i>)
@@ -2024,14 +2066,14 @@
</p>
<dl>
-<dt><i>quiet</i></dt>
+<dt><i>quiet</i> (bool)</dt>
<dd>
flag indicating quiet operations.
If this flag is true, no errors are reported.
</dd>
-<dt><i>indicator</i></dt>
-<dd>
-indicator string (string)
+<dt><i>indicator</i> (str)</dt>
+<dd>
+indicator string
</dd>
</dl>
<a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a>
@@ -2068,9 +2110,9 @@
</p>
<dl>
-<dt><i>actions</i></dt>
-<dd>
-list of actions (list of EricAction)
+<dt><i>actions</i> (list of EricAction)</dt>
+<dd>
+list of actions
</dd>
</dl>
<a NAME="Project.addFileCategory" ID="Project.addFileCategory"></a>
@@ -2135,9 +2177,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-file name or directory name to add (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+file name or directory name to add
</dd>
</dl>
<a NAME="Project.appendFile" ID="Project.appendFile"></a>
@@ -2149,19 +2191,19 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename to be added to the project (string)
-</dd>
-<dt><i>isSourceFile</i></dt>
+<dt><i>fn</i> (str)</dt>
+<dd>
+filename to be added to the project
+</dd>
+<dt><i>isSourceFile</i> (bool)</dt>
<dd>
flag indicating that this is a source file
- even if it doesn't have the source extension (boolean)
-</dd>
-<dt><i>updateModel</i></dt>
+ even if it doesn't have the source extension
+</dd>
+<dt><i>updateModel</i> (bool)</dt>
<dd>
flag indicating an update of the model is
- requested (boolean)
+ requested
</dd>
</dl>
<a NAME="Project.checkAllScriptsDirty" ID="Project.checkAllScriptsDirty"></a>
@@ -2174,16 +2216,22 @@
</p>
<dl>
-<dt><i>reportSyntaxErrors</i></dt>
+<dt><i>reportSyntaxErrors</i> (bool)</dt>
<dd>
flag indicating special reporting
- for syntax errors (boolean)
+ for syntax errors
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.checkDirty" ID="Project.checkDirty"></a>
@@ -2196,7 +2244,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating whether this operation was successful (boolean)
+flag indicating whether this operation was successful
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a>
@@ -2236,9 +2290,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
-<dd>
-name of the entry to be cleared (string)
+<dt><i>name</i> (str)</dt>
+<dd>
+name of the entry to be cleared
</dd>
</dl>
<a NAME="Project.closeProject" ID="Project.closeProject"></a>
@@ -2284,13 +2338,13 @@
</p>
<dl>
-<dt><i>olddn</i></dt>
-<dd>
-original directory name (string)
-</dd>
-<dt><i>newdn</i></dt>
-<dd>
-new directory name (string)
+<dt><i>olddn</i> (str)</dt>
+<dd>
+original directory name
+</dd>
+<dt><i>newdn</i> (str)</dt>
+<dd>
+new directory name
</dd>
</dl>
<a NAME="Project.createNewProject" ID="Project.createNewProject"></a>
@@ -2357,7 +2411,7 @@
</p>
<dl>
-<dt><i>dn</i></dt>
+<dt><i>dn</i> (str)</dt>
<dd>
directory name to be removed from the project
</dd>
@@ -2365,7 +2419,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.deleteFile" ID="Project.deleteFile"></a>
@@ -2377,7 +2437,7 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
filename to be deleted from the project
</dd>
@@ -2385,7 +2445,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a>
@@ -2397,9 +2463,9 @@
</p>
<dl>
-<dt><i>langFile</i></dt>
-<dd>
-the translation file to be removed (string)
+<dt><i>langFile</i> (str)</dt>
+<dd>
+the translation file to be removed
</dd>
</dl>
<a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
@@ -2412,15 +2478,21 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-file or directory name to convert (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+file or directory name to convert
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-absolute path (string)
+absolute path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getAbsoluteUniversalPath" ID="Project.getAbsoluteUniversalPath"></a>
@@ -2433,15 +2505,21 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-file or directory name to convert (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+file or directory name to convert
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-absolute path (string)
+absolute path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getActions" ID="Project.getActions"></a>
@@ -2454,7 +2532,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of all actions (list of EricAction)
+list of all actions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of EricAction
</dd>
</dl>
<a NAME="Project.getData" ID="Project.getData"></a>
@@ -2487,6 +2571,12 @@
a copy of the requested data or None
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
<a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a>
<h4>Project.getDebugProperty</h4>
<b>getDebugProperty</b>(<i>key</i>)
@@ -2496,9 +2586,9 @@
</p>
<dl>
-<dt><i>key</i></dt>
-<dd>
-key of the property (string)
+<dt><i>key</i> (str)</dt>
+<dd>
+key of the property
</dd>
</dl>
<dl>
@@ -2507,6 +2597,12 @@
value of the property
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
<a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a>
<h4>Project.getDebuggerFilters</h4>
<b>getDebuggerFilters</b>(<i>language</i>)
@@ -2563,7 +2659,13 @@
<dl>
<dt>Return:</dt>
<dd>
-default extension (including the dot) (string)
+default extension (including the dot)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a>
@@ -2594,16 +2696,22 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
filename used to determine the associated lexer
- language (string)
+ language
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-the requested lexer language (string)
+the requested lexer language
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getEolString" ID="Project.getEolString"></a>
@@ -2616,7 +2724,13 @@
<dl>
<dt>Return:</dt>
<dd>
-eol string (string)
+eol string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a>
@@ -2804,15 +2918,21 @@
</p>
<dl>
-<dt><i>start</i></dt>
-<dd>
-prefix (string)
+<dt><i>start</i> (str)</dt>
+<dd>
+prefix
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of files starting with a common prefix (list of strings)
+list of files starting with a common prefix
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a>
@@ -2853,7 +2973,13 @@
<dl>
<dt>Return:</dt>
<dd>
-project hash as a hex string (string)
+project hash as a hex string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getIgnorePatterns" ID="Project.getIgnorePatterns"></a>
@@ -2915,15 +3041,21 @@
</p>
<dl>
-<dt><i>menuName</i></dt>
-<dd>
-name of the menu (string)
+<dt><i>menuName</i> (str)</dt>
+<dd>
+name of the menu
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the requested menu (QMenu) or None
+reference to the requested menu or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
</dd>
</dl>
<a NAME="Project.getModel" ID="Project.getModel"></a>
@@ -2936,7 +3068,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the project browser model (ProjectBrowserModel)
+reference to the project browser model
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ProjectBrowserModel
</dd>
</dl>
<a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a>
@@ -2949,7 +3087,13 @@
<dl>
<dt>Return:</dt>
<dd>
-path of the most recently opened project (string)
+path of the most recently opened project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a>
@@ -2962,7 +3106,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of supported programming languages (list of string)
+list of supported programming languages
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a>
@@ -3067,8 +3217,14 @@
<dl>
<dt>Return:</dt>
<dd>
-tuple of two strings giving the absolute path names of the
- project specific word and exclude list
+tuple containing the absolute path names of the project specific
+ word and exclude list
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
</dd>
</dl>
<a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a>
@@ -3100,7 +3256,13 @@
<dl>
<dt>Return:</dt>
<dd>
-path of the project file (string)
+path of the project file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a>
@@ -3178,7 +3340,13 @@
<dl>
<dt>Return:</dt>
<dd>
-programming language (string)
+programming language
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectLicense" ID="Project.getProjectLicense"></a>
@@ -3210,7 +3378,13 @@
<dl>
<dt>Return:</dt>
<dd>
-path of the management directory (string)
+path of the management directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectName" ID="Project.getProjectName"></a>
@@ -3226,7 +3400,13 @@
<dl>
<dt>Return:</dt>
<dd>
-name of the project (string)
+name of the project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a>
@@ -3239,7 +3419,13 @@
<dl>
<dt>Return:</dt>
<dd>
-project path (string)
+project path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a>
@@ -3252,7 +3438,13 @@
<dl>
<dt>Return:</dt>
<dd>
-programming language (string)
+programming language
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a>
@@ -3284,7 +3476,13 @@
<dl>
<dt>Return:</dt>
<dd>
-UI type of the project (string)
+UI type of the project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a>
@@ -3296,10 +3494,9 @@
</p>
<dl>
-<dt><i>progLanguage</i></dt>
+<dt><i>progLanguage</i> (str)</dt>
<dd>
programming language to get project types for
- (string)
</dd>
</dl>
<dl>
@@ -3308,6 +3505,12 @@
reference to the dictionary of project types.
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a>
<h4>Project.getProjectVenv</h4>
<b>getProjectVenv</b>(<i>resolveDebugger=True</i>)
@@ -3384,16 +3587,22 @@
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-file or directory name to convert (string)
+<dt><i>path</i> (str)</dt>
+<dd>
+file or directory name to convert
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
project relative path or unchanged path, if path doesn't
- belong to the project (string)
+ belong to the project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a>
@@ -3406,16 +3615,22 @@
</p>
<dl>
-<dt><i>path</i></dt>
-<dd>
-file or directory name to convert (string)
+<dt><i>path</i> (str)</dt>
+<dd>
+file or directory name to convert
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
project relative path or unchanged path, if path doesn't
- belong to the project (string)
+ belong to the project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getSources" ID="Project.getSources"></a>
@@ -3454,7 +3669,13 @@
<dl>
<dt>Return:</dt>
<dd>
-status of the auto update function (boolean)
+status of the auto update function
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a>
@@ -3467,7 +3688,13 @@
<dl>
<dt>Return:</dt>
<dd>
-interval in seconds (integer)
+interval in seconds
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a>
@@ -3480,7 +3707,13 @@
<dl>
<dt>Return:</dt>
<dd>
-translation pattern (string)
+translation pattern
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a>
@@ -3522,6 +3755,12 @@
reference to the VCS object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VersionControl
+</dd>
+</dl>
<a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a>
<h4>Project.handleApplicationDiagram</h4>
<b>handleApplicationDiagram</b>(<i></i>)
@@ -3625,15 +3864,21 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+filename to be checked
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, if the project contains the file (boolean)
+flag indicating, if the project contains the file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a>
@@ -3645,19 +3890,25 @@
</p>
<dl>
-<dt><i>type_</i></dt>
-<dd>
-internal type designator (string)
-</dd>
-<dt><i>progLanguage</i></dt>
-<dd>
-programming language of the project type (string)
+<dt><i>type_</i> (str)</dt>
+<dd>
+internal type designator
+</dd>
+<dt><i>progLanguage</i> (str)</dt>
+<dd>
+programming language of the project type
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating presence of the project type (boolean)
+flag indicating presence of the project type
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.initActions" ID="Project.initActions"></a>
@@ -3704,16 +3955,21 @@
</p>
<dl>
-<dt><i>toolbarManager</i></dt>
+<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
<dd>
reference to a toolbar manager object
- (EricToolBarManager)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-tuple of the generated toolbars (tuple of two QToolBar)
+tuple of the generated toolbars
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of two QToolBar
</dd>
</dl>
<a NAME="Project.initVCS" ID="Project.initVCS"></a>
@@ -3725,14 +3981,13 @@
</p>
<dl>
-<dt><i>vcsSystem</i></dt>
-<dd>
-type of VCS to be used (string)
-</dd>
-<dt><i>nooverride</i></dt>
+<dt><i>vcsSystem</i> (str)</dt>
+<dd>
+type of VCS to be used
+</dd>
+<dt><i>nooverride</i> (bool)</dt>
<dd>
flag indicating to ignore an override request
- (boolean)
</dd>
</dl>
<dl>
@@ -3741,6 +3996,12 @@
a reference to the vcs object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VersionControl
+</dd>
+</dl>
<a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a>
<h4>Project.isDebugPropertiesLoaded</h4>
<b>isDebugPropertiesLoaded</b>(<i></i>)
@@ -3751,7 +4012,13 @@
<dl>
<dt>Return:</dt>
<dd>
-load status of debug properties (boolean)
+load status of debug properties
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isDirty" ID="Project.isDirty"></a>
@@ -3764,7 +4031,13 @@
<dl>
<dt>Return:</dt>
<dd>
-dirty state (boolean)
+dirty state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a>
@@ -3777,7 +4050,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a JavaScript project (boolean)
+flag indicating a JavaScript project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a>
@@ -3847,7 +4126,13 @@
<dl>
<dt>Return:</dt>
<dd>
-open state (boolean)
+open state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a>
@@ -3891,15 +4176,21 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename to be checked (string)
+<dt><i>fn</i> (str)</dt>
+<dd>
+filename to be checked
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating membership (boolean)
+flag indicating membership
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a>
@@ -3912,7 +4203,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a Python3 project (boolean)
+flag indicating a Python3 project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a>
@@ -3926,7 +4223,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a Python project (boolean)
+flag indicating a Python project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a>
@@ -3939,7 +4242,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a Ruby project (boolean)
+flag indicating a Ruby project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.isVcsControlled" ID="Project.isVcsControlled"></a>
@@ -3970,13 +4279,13 @@
</p>
<dl>
-<dt><i>olddn</i></dt>
-<dd>
-old directory name (string)
-</dd>
-<dt><i>newdn</i></dt>
-<dd>
-new directory name (string)
+<dt><i>olddn</i> (str)</dt>
+<dd>
+old directory name
+</dd>
+<dt><i>newdn</i> (str)</dt>
+<dd>
+new directory name
</dd>
</dl>
<a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a>
@@ -3988,9 +4297,9 @@
</p>
<dl>
-<dt><i>mainscript</i></dt>
-<dd>
-name of the mainscript (string)
+<dt><i>mainscript</i> (str)</dt>
+<dd>
+name of the mainscript
</dd>
</dl>
<a NAME="Project.openProject" ID="Project.openProject"></a>
@@ -4002,18 +4311,18 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
optional filename of the project file to be read
</dd>
-<dt><i>restoreSession</i></dt>
+<dt><i>restoreSession</i> (bool)</dt>
<dd>
flag indicating to restore the project
- session (boolean)
-</dd>
-<dt><i>reopen</i></dt>
-<dd>
-flag indicating a reopening of the project (boolean)
+ session
+</dd>
+<dt><i>reopen</i> (bool)</dt>
+<dd>
+flag indicating a reopening of the project
</dd>
</dl>
<a NAME="Project.othersAdded" ID="Project.othersAdded"></a>
@@ -4026,14 +4335,13 @@
</p>
<dl>
-<dt><i>fn</i></dt>
-<dd>
-filename or directory name added (string)
-</dd>
-<dt><i>updateModel</i></dt>
+<dt><i>fn</i> (str)</dt>
+<dd>
+filename or directory name added
+</dd>
+<dt><i>updateModel</i> (bool)</dt>
<dd>
flag indicating an update of the model is requested
- (boolean)
</dd>
</dl>
<a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a>
@@ -4045,35 +4353,35 @@
</p>
<dl>
-<dt><i>type_</i></dt>
-<dd>
-internal type designator to be registered (string)
-</dd>
-<dt><i>description</i></dt>
-<dd>
-more verbose type name (display string) (string)
-</dd>
-<dt><i>fileTypeCallback</i></dt>
+<dt><i>type_</i> (str)</dt>
+<dd>
+internal type designator to be registered
+</dd>
+<dt><i>description</i> (str)</dt>
+<dd>
+more verbose type name (display string)
+</dd>
+<dt><i>fileTypeCallback</i> (function)</dt>
<dd>
reference to a method returning a dictionary
- of filetype associations.
-</dd>
-<dt><i>binaryTranslationsCallback</i></dt>
+ of filetype associations
+</dd>
+<dt><i>binaryTranslationsCallback</i> (function)</dt>
<dd>
reference to a method returning
the name of the binary translation file given the name of the raw
translation file
</dd>
-<dt><i>lexerAssociationCallback</i></dt>
+<dt><i>lexerAssociationCallback</i> (function)</dt>
<dd>
reference to a method returning the
lexer type to be used for syntax highlighting given the name of
a file
</dd>
-<dt><i>progLanguages</i></dt>
+<dt><i>progLanguages</i> (list of str)</dt>
<dd>
programming languages supported by the
- project type (list of string)
+ project type
</dd>
</dl>
<a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a>
@@ -4088,7 +4396,7 @@
</p>
<dl>
-<dt><i>dn</i></dt>
+<dt><i>dn</i> (str)</dt>
<dd>
directory name to be removed from the project
</dd>
@@ -4102,9 +4410,9 @@
</p>
<dl>
-<dt><i>actions</i></dt>
-<dd>
-list of actions (list of EricAction)
+<dt><i>actions</i> (list of EricAction)</dt>
+<dd>
+list of actions
</dd>
</dl>
<a NAME="Project.removeFile" ID="Project.removeFile"></a>
@@ -4119,14 +4427,13 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
filename to be removed from the project
</dd>
-<dt><i>updateModel</i></dt>
-<dd>
-flag indicating an update of the model is
- requested (boolean)
+<dt><i>updateModel</i> (bool)</dt>
+<dd>
+flag indicating an update of the model is requested
</dd>
</dl>
<a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a>
@@ -4159,9 +4466,9 @@
</p>
<dl>
-<dt><i>langFile</i></dt>
-<dd>
-the translation file to be removed (string)
+<dt><i>langFile</i> (str)</dt>
+<dd>
+the translation file to be removed
</dd>
</dl>
<a NAME="Project.renameFile" ID="Project.renameFile"></a>
@@ -4173,13 +4480,13 @@
</p>
<dl>
-<dt><i>oldfn</i></dt>
-<dd>
-old filename of the file (string)
-</dd>
-<dt><i>newfn</i></dt>
-<dd>
-new filename of the file (string)
+<dt><i>oldfn</i> (str)</dt>
+<dd>
+old filename of the file
+</dd>
+<dt><i>newfn</i> (str)</dt>
+<dd>
+new filename of the file
</dd>
</dl>
<dl>
@@ -4188,6 +4495,12 @@
flag indicating success
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
<a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a>
<h4>Project.renameFileInPdata</h4>
<b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>)
@@ -4197,18 +4510,18 @@
</p>
<dl>
-<dt><i>oldname</i></dt>
-<dd>
-old filename (string)
-</dd>
-<dt><i>newname</i></dt>
-<dd>
-new filename (string)
-</dd>
-<dt><i>isSourceFile</i></dt>
+<dt><i>oldname</i> (str)</dt>
+<dd>
+old filename
+</dd>
+<dt><i>newname</i> (str)</dt>
+<dd>
+new filename
+</dd>
+<dt><i>isSourceFile</i> (bool)</dt>
<dd>
flag indicating that this is a source file
- even if it doesn't have the source extension (boolean)
+ even if it doesn't have the source extension
</dd>
</dl>
<a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a>
@@ -4220,13 +4533,13 @@
</p>
<dl>
-<dt><i>oldfn</i></dt>
-<dd>
-old filename (string)
-</dd>
-<dt><i>newfn</i></dt>
-<dd>
-new filename of the main script (string)
+<dt><i>oldfn</i> (str)</dt>
+<dd>
+old filename
+</dd>
+<dt><i>newfn</i> (str)</dt>
+<dd>
+new filename of the main script
</dd>
</dl>
<a NAME="Project.reopenProject" ID="Project.reopenProject"></a>
@@ -4245,9 +4558,9 @@
</p>
<dl>
-<dt><i>fullname</i></dt>
-<dd>
-full name of the item to repopulate (string)
+<dt><i>fullname</i> (str)</dt>
+<dd>
+full name of the item to repopulate
</dd>
</dl>
<a NAME="Project.resetVCS" ID="Project.resetVCS"></a>
@@ -4266,16 +4579,22 @@
</p>
<dl>
-<dt><i>reportSyntaxErrors</i></dt>
+<dt><i>reportSyntaxErrors</i> (bool)</dt>
<dd>
flag indicating special reporting
- for syntax errors (boolean)
+ for syntax errors
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.saveProject" ID="Project.saveProject"></a>
@@ -4291,6 +4610,12 @@
flag indicating success
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
<a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a>
<h4>Project.saveProjectAs</h4>
<b>saveProjectAs</b>(<i></i>)
@@ -4301,7 +4626,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.setData" ID="Project.setData"></a>
@@ -4313,17 +4644,17 @@
</p>
<dl>
-<dt><i>category</i></dt>
-<dd>
-category of the data to get (string, one of
+<dt><i>category</i> (str)</dt>
+<dd>
+category of the data to get (one of
PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS,
DOCUMENTATIONPARMS or OTHERTOOLSPARMS)
</dd>
-<dt><i>key</i></dt>
-<dd>
-key of the data entry to get (string).
-</dd>
-<dt><i>data</i></dt>
+<dt><i>key</i> (str)</dt>
+<dd>
+key of the data entry to get
+</dd>
+<dt><i>data</i> (Any)</dt>
<dd>
data to be stored
</dd>
@@ -4331,7 +4662,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a>
@@ -4457,9 +4794,9 @@
</p>
<dl>
-<dt><i>auto</i></dt>
-<dd>
-status of the auto update function (boolean)
+<dt><i>auto</i> (bool)</dt>
+<dd>
+status of the auto update function
</dd>
</dl>
<a NAME="Project.setStatusMonitorInterval" ID="Project.setStatusMonitorInterval"></a>
@@ -4471,9 +4808,9 @@
</p>
<dl>
-<dt><i>interval</i></dt>
-<dd>
-status monitor interval in seconds (integer)
+<dt><i>interval</i> (int)</dt>
+<dd>
+status monitor interval in seconds
</dd>
</dl>
<a NAME="Project.setTranslationPattern" ID="Project.setTranslationPattern"></a>
@@ -4553,9 +4890,9 @@
</p>
<dl>
-<dt><i>type_</i></dt>
-<dd>
-internal type designator to be unregistered (string)
+<dt><i>type_</i> (str)</dt>
+<dd>
+internal type designator to be unregistered
</dd>
</dl>
<a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a>
@@ -4576,7 +4913,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the usage of system eol (boolean)
+flag indicating the usage of system eol
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.vcsSoftwareAvailable" ID="Project.vcsSoftwareAvailable"></a>
@@ -4590,7 +4933,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating availability of VCS software (boolean)
+flag indicating availability of VCS software
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Project.writeTasks" ID="Project.writeTasks"></a>
