--- a/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html Sat May 29 15:03:26 2021 +0200 +++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html Sat May 29 18:33:03 2021 +0200 @@ -149,39 +149,37 @@ </p> <dl> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text to be shown by the label (string) +text to be shown by the label </dd> -<dt><i>fixed=</i></dt> +<dt><i>fixed</i> (bool)</dt> <dd> -flag indicating a fixed font should be used (boolean) +flag indicating a fixed font should be used </dd> -<dt><i>linewrap=</i></dt> +<dt><i>linewrap</i> (bool)</dt> <dd> -flag indicating to wrap long lines (boolean) +flag indicating to wrap long lines </dd> -<dt><i>msgSuccess=</i></dt> +<dt><i>msgSuccess</i> (str)</dt> <dd> optional string to show upon successful execution - (string) </dd> -<dt><i>msgError=</i></dt> +<dt><i>msgError</i> (str)</dt> <dd> optional string to show upon unsuccessful execution - (string) </dd> -<dt><i>saveFilters=</i></dt> +<dt><i>saveFilters</i> (str)</dt> <dd> -filename filter string (string) +filename filter string </dd> -<dt><i>showInput=</i></dt> +<dt><i>showInput</i> (bool)</dt> <dd> -flag indicating to show the input widgets (bool) +flag indicating to show the input widgets </dd> -<dt><i>parent=</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget (QWidget) +parent widget </dd> </dl> <a NAME="DjangoDialog.__finish" ID="DjangoDialog.__finish"></a> @@ -201,13 +199,13 @@ </p> <dl> -<dt><i>exitCode</i></dt> +<dt><i>exitCode</i> (int)</dt> <dd> -exit code of the process (integer) +exit code of the process </dd> -<dt><i>exitStatus</i></dt> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> <dd> -exit status of the process (QProcess.ExitStatus) +exit status of the process </dd> </dl> <a NAME="DjangoDialog.__readStderr" ID="DjangoDialog.__readStderr"></a> @@ -248,9 +246,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -the key press event (QKeyEvent) +the key press event </dd> </dl> <a NAME="DjangoDialog.normalExit" ID="DjangoDialog.normalExit"></a> @@ -263,7 +261,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="DjangoDialog.normalExitWithoutErrors" ID="DjangoDialog.normalExitWithoutErrors"></a> @@ -277,7 +281,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating normal process termination (boolean) +flag indicating normal process termination +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="DjangoDialog.on_buttonBox_clicked" ID="DjangoDialog.on_buttonBox_clicked"></a> @@ -289,9 +299,9 @@ </p> <dl> -<dt><i>button</i></dt> +<dt><i>button</i> (QAbstractButton)</dt> <dd> -button that was clicked (QAbstractButton) +button that was clicked </dd> </dl> <a NAME="DjangoDialog.on_input_returnPressed" ID="DjangoDialog.on_input_returnPressed"></a> @@ -310,9 +320,9 @@ </p> <dl> -<dt><i>isOn</i></dt> +<dt><i>isOn</i> (bool)</dt> <dd> -flag indicating the status of the check box (boolean) +flag indicating the status of the check box </dd> </dl> <a NAME="DjangoDialog.on_sendButton_clicked" ID="DjangoDialog.on_sendButton_clicked"></a> @@ -331,26 +341,29 @@ </p> <dl> -<dt><i>argsLists</i></dt> +<dt><i>argsLists</i> (list of list of str)</dt> <dd> list of lists of arguments for the processes - (list of lists of strings) </dd> -<dt><i>workingDir</i></dt> +<dt><i>workingDir</i> (str)</dt> <dd> -working directory for the process (string) +working directory for the process </dd> -<dt><i>mergedOutput</i></dt> +<dt><i>mergedOutput</i> (bool)</dt> <dd> flag indicating to merge the output of the process - (boolean) </dd> </dl> <dl> <dt>Return:</dt> <dd> flag indicating a successful start of the first process - (boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="DjangoDialog.startProcess" ID="DjangoDialog.startProcess"></a> @@ -362,29 +375,33 @@ </p> <dl> -<dt><i>args</i></dt> +<dt><i>args</i> (list of str)</dt> <dd> -list of arguments for the process (list of strings) +list of arguments for the process </dd> -<dt><i>workingDir</i></dt> +<dt><i>workingDir</i> (str)</dt> <dd> -working directory for the process (string) +working directory for the process </dd> -<dt><i>showCommand</i></dt> +<dt><i>showCommand</i> (bool)</dt> <dd> flag indicating to show the command executed - (boolean) </dd> -<dt><i>mergedOutput</i></dt> +<dt><i>mergedOutput</i> (bool)</dt> <dd> flag indicating to merge the output of the process - (boolean) </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a successful start of the process (boolean) +flag indicating a successful start of the process +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <div align="right"><a href="#top">Up</a></div>