--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxExecDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,285 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxExecDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxExecDialog</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="#PipxExecDialog">PipxExecDialog</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="PipxExecDialog" ID="PipxExecDialog"></a>
+<h2>PipxExecDialog</h2>
+<p>
+    Class implementing a dialog showing the output of a 'python -m pip'
+    command.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxExecDialog
+<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="#PipxExecDialog.__init__">PipxExecDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__addOutput">__addOutput</a></td>
+<td>Private method to add some text to the output pane.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__cancel">__cancel</a></td>
+<td>Private slot to cancel the current action.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.startProcess">startProcess</a></td>
+<td>Public slot used to start the process.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.startProcesses">startProcesses</a></td>
+<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="PipxExecDialog.__init__" ID="PipxExecDialog.__init__"></a>
+<h4>PipxExecDialog (Constructor)</h4>
+<b>PipxExecDialog</b>(<i>text, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>text</i> (str)</dt>
+<dd>
+text to be shown by the label
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="PipxExecDialog.__addOutput" ID="PipxExecDialog.__addOutput"></a>
+<h4>PipxExecDialog.__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>
+<dd>
+text to be added
+</dd>
+</dl>
+<a NAME="PipxExecDialog.__cancel" ID="PipxExecDialog.__cancel"></a>
+<h4>PipxExecDialog.__cancel</h4>
+<b>__cancel</b>(<i></i>)
+<p>
+        Private slot to cancel the current action.
+</p>
+
+<a NAME="PipxExecDialog.__finish" ID="PipxExecDialog.__finish"></a>
+<h4>PipxExecDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+        Private slot called when the process finished or the user pressed
+        the button.
+</p>
+
+<a NAME="PipxExecDialog.__procFinished" ID="PipxExecDialog.__procFinished"></a>
+<h4>PipxExecDialog.__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>
+<dd>
+exit code of the process (unused)
+</dd>
+<dt><i>_exitStatus</i> (QProcess.ExitStatus)</dt>
+<dd>
+exit status of the process (unused)
+</dd>
+</dl>
+<a NAME="PipxExecDialog.__readStderr" ID="PipxExecDialog.__readStderr"></a>
+<h4>PipxExecDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+<p>
+        Private slot to handle the readyReadStandardError signal.
+</p>
+<p>
+        It reads the error output of the process and inserts it into the
+        error pane.
+</p>
+
+<a NAME="PipxExecDialog.__readStdout" ID="PipxExecDialog.__readStdout"></a>
+<h4>PipxExecDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+<p>
+        Private slot to handle the readyReadStandardOutput signal.
+</p>
+<p>
+        It reads the output of the process, formats it and inserts it into
+        the contents pane.
+</p>
+
+<a NAME="PipxExecDialog.closeEvent" ID="PipxExecDialog.closeEvent"></a>
+<h4>PipxExecDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+<p>
+        Protected slot implementing a close event handler.
+</p>
+
+<dl>
+
+<dt><i>e</i> (QCloseEvent)</dt>
+<dd>
+close event
+</dd>
+</dl>
+<a NAME="PipxExecDialog.on_buttonBox_clicked" ID="PipxExecDialog.on_buttonBox_clicked"></a>
+<h4>PipxExecDialog.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>
+<dd>
+button that was clicked
+</dd>
+</dl>
+<a NAME="PipxExecDialog.startProcess" ID="PipxExecDialog.startProcess"></a>
+<h4>PipxExecDialog.startProcess</h4>
+<b>startProcess</b>(<i>pipx, args, showArgs=True</i>)
+<p>
+        Public slot used to start the process.
+</p>
+
+<dl>
+
+<dt><i>pipx</i> (str)</dt>
+<dd>
+path to the 'pipx' executable to be used
+</dd>
+<dt><i>args</i> (list of str)</dt>
+<dd>
+list of arguments for the process
+</dd>
+<dt><i>showArgs</i> (bool)</dt>
+<dd>
+flag indicating to show the arguments
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful start of the process
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PipxExecDialog.startProcesses" ID="PipxExecDialog.startProcesses"></a>
+<h4>PipxExecDialog.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>
+<dd>
+list of tuples containing the command
+            and arguments
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful start of the first process
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>