--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricProcessDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricProcessDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricProcessDialog</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="#EricProcessDialog">EricProcessDialog</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="EricProcessDialog" ID="EricProcessDialog"></a>
<h2>EricProcessDialog</h2>
-
<p>
Class implementing a dialog starting a process and showing its output.
</p>
@@ -43,22 +41,21 @@
process. The dialog is modal, which causes a synchronized execution of
the process.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_EricProcessDialog
<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="#EricProcessDialog.__init__">EricProcessDialog</a></td>
<td>Constructor</td>
@@ -112,19 +109,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="EricProcessDialog.__init__" ID="EricProcessDialog.__init__"></a>
<h4>EricProcessDialog (Constructor)</h4>
<b>EricProcessDialog</b>(<i>outputTitle="", windowTitle="", showProgress=False, showInput=True, combinedOutput=False, parent=None, </i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>outputTitle</i> (str (optional))</dt>
@@ -157,18 +155,18 @@
<a NAME="EricProcessDialog.__finish" ID="EricProcessDialog.__finish"></a>
<h4>EricProcessDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed
the button.
</p>
+
<a NAME="EricProcessDialog.__procFinished" ID="EricProcessDialog.__procFinished"></a>
<h4>EricProcessDialog.__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>
@@ -183,7 +181,6 @@
<a NAME="EricProcessDialog.__readStderr" ID="EricProcessDialog.__readStderr"></a>
<h4>EricProcessDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardError signal.
</p>
@@ -191,10 +188,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="EricProcessDialog.__readStdout" ID="EricProcessDialog.__readStdout"></a>
<h4>EricProcessDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardOutput signal.
</p>
@@ -202,13 +199,14 @@
It reads the output of the process and inserts it into the
output pane.
</p>
+
<a NAME="EricProcessDialog.keyPressEvent" ID="EricProcessDialog.keyPressEvent"></a>
<h4>EricProcessDialog.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>
@@ -219,10 +217,10 @@
<a NAME="EricProcessDialog.normalExit" ID="EricProcessDialog.normalExit"></a>
<h4>EricProcessDialog.normalExit</h4>
<b>normalExit</b>(<i></i>)
-
<p>
Public method to check for a normal process termination.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -238,11 +236,11 @@
<a NAME="EricProcessDialog.normalExitWithoutErrors" ID="EricProcessDialog.normalExitWithoutErrors"></a>
<h4>EricProcessDialog.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>
@@ -258,10 +256,10 @@
<a NAME="EricProcessDialog.on_buttonBox_clicked" ID="EricProcessDialog.on_buttonBox_clicked"></a>
<h4>EricProcessDialog.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>
@@ -272,17 +270,17 @@
<a NAME="EricProcessDialog.on_input_returnPressed" ID="EricProcessDialog.on_input_returnPressed"></a>
<h4>EricProcessDialog.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="EricProcessDialog.on_passwordCheckBox_toggled" ID="EricProcessDialog.on_passwordCheckBox_toggled"></a>
<h4>EricProcessDialog.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>
@@ -293,17 +291,17 @@
<a NAME="EricProcessDialog.on_sendButton_clicked" ID="EricProcessDialog.on_sendButton_clicked"></a>
<h4>EricProcessDialog.on_sendButton_clicked</h4>
<b>on_sendButton_clicked</b>(<i></i>)
-
<p>
Private slot to send the input to the git process.
</p>
+
<a NAME="EricProcessDialog.startProcess" ID="EricProcessDialog.startProcess"></a>
<h4>EricProcessDialog.startProcess</h4>
<b>startProcess</b>(<i>program, args, workingDir=None, showArgs=True, environment=None</i>)
-
<p>
Public slot used to start the process.
</p>
+
<dl>
<dt><i>program</i> (str)</dt>
@@ -342,4 +340,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
