--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,54 +7,51 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PipInterface.PipDialog</h1>
-
<p>
Module implementing a dialog showing the output of a pip command.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PipDialog">PipDialog</a></td>
<td>Class implementing a dialog showing the output of a 'python -m pip' command.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PipDialog" ID="PipDialog"></a>
<h2>PipDialog</h2>
-
<p>
Class implementing a dialog showing the output of a 'python -m pip'
command.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_PipDialog
<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="#PipDialog.__init__">PipDialog</a></td>
<td>Constructor</td>
@@ -100,19 +97,20 @@
<td>Public method to issue a list of commands to be executed.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PipDialog.__init__" ID="PipDialog.__init__"></a>
<h4>PipDialog (Constructor)</h4>
<b>PipDialog</b>(<i>text, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -127,10 +125,10 @@
<a NAME="PipDialog.__addOutput" ID="PipDialog.__addOutput"></a>
<h4>PipDialog.__addOutput</h4>
<b>__addOutput</b>(<i>txt</i>)
-
<p>
Private method to add some text to the output pane.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -141,25 +139,25 @@
<a NAME="PipDialog.__cancel" ID="PipDialog.__cancel"></a>
<h4>PipDialog.__cancel</h4>
<b>__cancel</b>(<i></i>)
-
<p>
Private slot to cancel the current action.
</p>
+
<a NAME="PipDialog.__finish" ID="PipDialog.__finish"></a>
<h4>PipDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed
the button.
</p>
+
<a NAME="PipDialog.__procFinished" ID="PipDialog.__procFinished"></a>
<h4>PipDialog.__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>
@@ -174,7 +172,6 @@
<a NAME="PipDialog.__readStderr" ID="PipDialog.__readStderr"></a>
<h4>PipDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardError signal.
</p>
@@ -182,10 +179,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="PipDialog.__readStdout" ID="PipDialog.__readStdout"></a>
<h4>PipDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStandardOutput signal.
</p>
@@ -193,13 +190,14 @@
It reads the output of the process, formats it and inserts it into
the contents pane.
</p>
+
<a NAME="PipDialog.closeEvent" ID="PipDialog.closeEvent"></a>
<h4>PipDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
-
<p>
Protected slot implementing a close event handler.
</p>
+
<dl>
<dt><i>e</i> (QCloseEvent)</dt>
@@ -210,10 +208,10 @@
<a NAME="PipDialog.on_buttonBox_clicked" ID="PipDialog.on_buttonBox_clicked"></a>
<h4>PipDialog.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>
@@ -224,10 +222,10 @@
<a NAME="PipDialog.startProcess" ID="PipDialog.startProcess"></a>
<h4>PipDialog.startProcess</h4>
<b>startProcess</b>(<i>cmd, args, showArgs=True</i>)
-
<p>
Public slot used to start the process.
</p>
+
<dl>
<dt><i>cmd</i> (str)</dt>
@@ -258,10 +256,10 @@
<a NAME="PipDialog.startProcesses" ID="PipDialog.startProcesses"></a>
<h4>PipDialog.startProcesses</h4>
<b>startProcesses</b>(<i>processParams</i>)
-
<p>
Public method to issue a list of commands to be executed.
</p>
+
<dl>
<dt><i>processParams</i> (list of tuples of (str, list of str))</dt>
@@ -284,4 +282,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
