diff -r 2667e16a3379 -r dd36f90e77ee ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html
--- a/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html Tue Dec 10 15:48:57 2024 +0100
+++ b/ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html Thu Dec 26 14:19:48 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Project_Django.ProjectDjango.DjangoDialog</h1>
-
<p>
Module implementing a dialog starting a process and showing its output.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#DjangoDialog">DjangoDialog</a></td>
<td>Class implementing a dialog starting a process and showing its output.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="DjangoDialog" ID="DjangoDialog"></a>
<h2>DjangoDialog</h2>
-
<p>
Class implementing a dialog starting a process and showing its output.
</p>
@@ -43,22 +41,21 @@
shows the output of the process. The dialog is modal,
which causes a synchronized execution of the process.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_DjangoDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DjangoDialog.__init__">DjangoDialog</a></td>
<td>Constructor</td>
@@ -120,19 +117,20 @@
<td>Public slot used to start the process.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DjangoDialog.__init__" ID="DjangoDialog.__init__"></a>
<h4>DjangoDialog (Constructor)</h4>
<b>DjangoDialog</b>(<i>text, fixed=False, linewrap=True, msgSuccess=None, msgError=None, saveFilters=None, showInput=False, parent=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -171,18 +169,18 @@
<a NAME="DjangoDialog.__finish" ID="DjangoDialog.__finish"></a>
<h4>DjangoDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed the
button.
</p>
+
<a NAME="DjangoDialog.__procFinished" ID="DjangoDialog.__procFinished"></a>
<h4>DjangoDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
-
<p>
Private slot connected to the finished signal.
</p>
+
<dl>
<dt><i>exitCode</i> (int)</dt>
@@ -197,7 +195,6 @@
<a NAME="DjangoDialog.__readStderr" ID="DjangoDialog.__readStderr"></a>
<h4>DjangoDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStderr signal.
</p>
@@ -205,10 +202,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="DjangoDialog.__readStdout" ID="DjangoDialog.__readStdout"></a>
<h4>DjangoDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStdout signal.
</p>
@@ -216,20 +213,21 @@
It reads the output of the process, formats it and inserts it into
the contents pane.
</p>
+
<a NAME="DjangoDialog.__saveData" ID="DjangoDialog.__saveData"></a>
<h4>DjangoDialog.__saveData</h4>
<b>__saveData</b>(<i></i>)
-
<p>
Private slot to save the output to a file.
</p>
+
<a NAME="DjangoDialog.keyPressEvent" ID="DjangoDialog.keyPressEvent"></a>
<h4>DjangoDialog.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)
-
<p>
Protected slot to handle a key press event.
</p>
+
<dl>
<dt><i>evt</i> (QKeyEvent)</dt>
@@ -240,10 +238,10 @@
<a NAME="DjangoDialog.normalExit" ID="DjangoDialog.normalExit"></a>
<h4>DjangoDialog.normalExit</h4>
<b>normalExit</b>(<i></i>)
-
<p>
Public method to check for a normal process termination.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -259,11 +257,11 @@
<a NAME="DjangoDialog.normalExitWithoutErrors" ID="DjangoDialog.normalExitWithoutErrors"></a>
<h4>DjangoDialog.normalExitWithoutErrors</h4>
<b>normalExitWithoutErrors</b>(<i></i>)
-
<p>
Public method to check for a normal process termination without
error messages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -279,10 +277,10 @@
<a NAME="DjangoDialog.on_buttonBox_clicked" ID="DjangoDialog.on_buttonBox_clicked"></a>
<h4>DjangoDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot called by a button of the button box clicked.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -293,17 +291,17 @@
<a NAME="DjangoDialog.on_input_returnPressed" ID="DjangoDialog.on_input_returnPressed"></a>
<h4>DjangoDialog.on_input_returnPressed</h4>
<b>on_input_returnPressed</b>(<i></i>)
-
<p>
Private slot to handle the press of the return key in the input field.
</p>
+
<a NAME="DjangoDialog.on_passwordCheckBox_toggled" ID="DjangoDialog.on_passwordCheckBox_toggled"></a>
<h4>DjangoDialog.on_passwordCheckBox_toggled</h4>
<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
-
<p>
Private slot to handle the password checkbox toggled.
</p>
+
<dl>
<dt><i>isOn</i> (bool)</dt>
@@ -314,17 +312,17 @@
<a NAME="DjangoDialog.on_sendButton_clicked" ID="DjangoDialog.on_sendButton_clicked"></a>
<h4>DjangoDialog.on_sendButton_clicked</h4>
<b>on_sendButton_clicked</b>(<i></i>)
-
<p>
Private slot to send the input to the manage.py process.
</p>
+
<a NAME="DjangoDialog.startBatchProcesses" ID="DjangoDialog.startBatchProcesses"></a>
<h4>DjangoDialog.startBatchProcesses</h4>
<b>startBatchProcesses</b>(<i>argsLists, workingDir=None, mergedOutput=False</i>)
-
<p>
Public slot used to start a batch of processes.
</p>
+
<dl>
<dt><i>argsLists</i> (list of list of str)</dt>
@@ -355,10 +353,10 @@
<a NAME="DjangoDialog.startProcess" ID="DjangoDialog.startProcess"></a>
<h4>DjangoDialog.startProcess</h4>
<b>startProcess</b>(<i>args, workingDir=None, showCommand=True, mergedOutput=False</i>)
-
<p>
Public slot used to start the process.
</p>
+
<dl>
<dt><i>args</i> (list of str)</dt>
@@ -392,4 +390,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
