diff -r 7d955b1995d5 -r eb28b4b6f7f5 ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html --- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html Sat May 29 15:05:16 2021 +0200 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html Tue Jun 01 19:37:46 2021 +0200 @@ -353,7 +353,13 @@ <dl> <dt>Return:</dt> <dd> -list of projects (list of string) +list of projects +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a> @@ -365,16 +371,22 @@ </p> <dl> -<dt><i>language</i></dt> +<dt><i>language</i> (str)</dt> <dd> Python variant to get the debugger environment - for (string, one of '' or 'Python3') + for (one of '' or 'Python3') </dd> </dl> <dl> <dt>Return:</dt> <dd> -path of the debugger environment (string) +path of the debugger environment +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a> @@ -387,9 +399,9 @@ </p> <dl> -<dt><i>file</i></dt> +<dt><i>file</i> (str)</dt> <dd> -filename of the executable (string) +filename of the executable </dd> </dl> <dl> @@ -400,6 +412,12 @@ variable, or an empty list otherwise. </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> <a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a> <h4>Project.__getInitDbCommand</h4> <b>__getInitDbCommand</b>(<i></i>) @@ -410,7 +428,13 @@ <dl> <dt>Return:</dt> <dd> -path to the initialization script (string) +path to the initialization script +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.__getLocale" ID="Project.__getLocale"></a> @@ -422,15 +446,21 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -name of the file used for extraction (string) +name of the file used for extraction </dd> </dl> <dl> <dt>Return:</dt> <dd> -extracted locale (string) or None +extracted locale or None +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> @@ -442,16 +472,22 @@ </p> <dl> -<dt><i>language</i></dt> +<dt><i>language</i> (str)</dt> <dd> Python variant to get the virtual environment - for (string, one of '' or 'Python3') + for (one of '' or 'Python3') </dd> </dl> <dl> <dt>Return:</dt> <dd> -path of the virtual environment (string) +path of the virtual environment +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> @@ -501,15 +537,21 @@ </p> <dl> -<dt><i>filenames</i></dt> +<dt><i>filenames</i> (list of str)</dt> <dd> -list of file names to normalize (list of string) +list of file names to normalize </dd> </dl> <dl> <dt>Return:</dt> <dd> -normalized file names (list of string) +normalized file names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Project.__project" ID="Project.__project"></a> @@ -522,7 +564,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> <dl> @@ -542,15 +590,21 @@ </p> <dl> -<dt><i>filenames</i></dt> +<dt><i>filenames</i> (list of str)</dt> <dd> -list of file names to be filtered (list of string) +list of file names to be filtered </dd> </dl> <dl> <dt>Return:</dt> <dd> -file names belonging to the current site (list of string) +file names belonging to the current site +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> @@ -562,9 +616,9 @@ </p> <dl> -<dt><i>code</i></dt> +<dt><i>code</i> (str)</dt> <dd> -language code of the new language (string) +language code of the new language </dd> </dl> <a NAME="Project.__projectPath" ID="Project.__projectPath"></a> @@ -577,7 +631,13 @@ <dl> <dt>Return:</dt> <dd> -path of the project (string) +path of the project +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <dl> @@ -625,9 +685,9 @@ </p> <dl> -<dt><i>logging</i></dt> +<dt><i>logging</i> (bool)</dt> <dd> -flag indicating to enable logging (boolean) +flag indicating to enable logging </dd> </dl> <a NAME="Project.__selectProject" ID="Project.__selectProject"></a> @@ -653,9 +713,9 @@ </p> <dl> -<dt><i>project</i></dt> +<dt><i>project</i> (str)</dt> <dd> -name of the project (string) +name of the project </dd> </dl> <a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a> @@ -703,7 +763,7 @@ </p> <dl> -<dt><i>filenames</i></dt> +<dt><i>filenames</i> (list of str)</dt> <dd> list of filenames (not used) </dd> @@ -717,9 +777,9 @@ </p> <dl> -<dt><i>filenames</i></dt> +<dt><i>filenames</i> (list of str)</dt> <dd> -list of file names (list of string) +list of file names </dd> </dl> <a NAME="Project.extractMessages" ID="Project.extractMessages"></a> @@ -738,16 +798,22 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the menu (string) +name of the menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the menu (QMenu) or None, if no - menu with the given name exists +reference to the menu or None, if no menu with the given + name exists +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a> @@ -760,7 +826,13 @@ <dl> <dt>Return:</dt> <dd> -menu names (list of string) +menu names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> @@ -772,20 +844,26 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (str)</dt> <dd> -command (string) +command </dd> -<dt><i>language</i></dt> +<dt><i>language</i> (str)</dt> <dd> Python variant to get the virtual environment - for (string, one of '' or 'Python3') + for (one of '' or 'Python3') </dd> </dl> <dl> <dt>Return:</dt> <dd> -full pyramid command (string) +full pyramid command +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a> @@ -836,7 +914,13 @@ <dl> <dt>Return:</dt> <dd> -python command (string) +python command +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.initActions" ID="Project.initActions"></a> @@ -856,7 +940,13 @@ <dl> <dt>Return:</dt> <dd> -the menu generated (QMenu) +the menu generated +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> @@ -868,9 +958,9 @@ </p> <dl> -<dt><i>consoleCmd</i></dt> +<dt><i>consoleCmd</i> (str)</dt> <dd> -console command (string) +console command </dd> </dl> <dl> @@ -878,7 +968,12 @@ <dd> tuple of two entries giving an indication, if the console is spawning (boolean) and the (possibly) cleaned console command - (string) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Project.newForm" ID="Project.newForm"></a> @@ -890,9 +985,9 @@ </p> <dl> -<dt><i>path</i></dt> +<dt><i>path</i> (str)</dt> <dd> -full directory path for the new form file (string) +full directory path for the new form file </dd> </dl> <a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a> @@ -904,9 +999,9 @@ </p> <dl> -<dt><i>poFile</i></dt> +<dt><i>poFile</i> (str)</dt> <dd> -name of the .po file (string) +name of the .po file </dd> </dl> <a NAME="Project.projectClosed" ID="Project.projectClosed"></a> @@ -948,7 +1043,13 @@ <dl> <dt>Return:</dt> <dd> -list of supported Python variants (list of strings) +list of supported Python variants +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> @@ -960,7 +1061,7 @@ </p> <dl> -<dt><i>filenames</i></dt> +<dt><i>filenames</i> (list of str)</dt> <dd> list of filenames (not used) </dd> @@ -974,7 +1075,7 @@ </p> <dl> -<dt><i>filenames</i></dt> +<dt><i>filenames</i> (list of str)</dt> <dd> list of filenames </dd> @@ -1053,7 +1154,7 @@ <a NAME="QProcess.start" ID="QProcess.start"></a> <h4>QProcess.start</h4> -<b>start</b>(<i>cmd, args=None, mode=QProcessPyQt.ReadWrite</i>) +<b>start</b>(<i>cmd, args=None, mode=QIODeviceBase.OpenModeFlag.ReadWrite</i>) <p> Public method to start the given program (cmd) in a new process, if @@ -1061,17 +1162,17 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (str)</dt> <dd> -start the given program cmd (string) +start the given program cmd </dd> -<dt><i>args=</i></dt> +<dt><i>args</i> (list of str)</dt> <dd> -list of parameters (list of strings) +list of parameters </dd> -<dt><i>mode=</i></dt> +<dt><i>mode</i> (QIODeviceBase.OpenMode)</dt> <dd> -access mode (QIODevice.OpenMode) +access mode </dd> </dl> <a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a> @@ -1084,23 +1185,29 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (str)</dt> <dd> -start the given program cmd (string) +start the given program cmd </dd> -<dt><i>args=</i></dt> +<dt><i>args</i> (list of str)</dt> <dd> -list of parameters (list of strings) +list of parameters </dd> -<dt><i>path=</i></dt> +<dt><i>path</i> (str)</dt> <dd> -new working directory (string) +new working directory </dd> </dl> <dl> <dt>Return:</dt> <dd> -tuple of successful start and process id (boolean, integer) +tuple of successful start and process id +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, int) </dd> </dl> <div align="right"><a href="#top">Up</a></div>