PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog.html

changeset 18
df1986d93746
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,250 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog</h1>
+<p>
+Module implementing a dialog to enter the application command line parameters and
+to execute the app.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxAppStartDialog">PipxAppStartDialog</a></td>
+<td>Class implementing a dialog to enter the application command line parameters and to execute the app.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxAppStartDialog" ID="PipxAppStartDialog"></a>
+<h2>PipxAppStartDialog</h2>
+<p>
+    Class implementing a dialog to enter the application command line parameters and
+    to execute the app.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxAppStartDialog
+<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="#PipxAppStartDialog.__init__">PipxAppStartDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__addOutput">__addOutput</a></td>
+<td>Private method to add some text to the output pane.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__cancel">__cancel</a></td>
+<td>Private slot to cancel the current action.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__populateWorkDirs">__populateWorkDirs</a></td>
+<td>Private method to populate the working directory selector.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.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="#PipxAppStartDialog.on_executeButton_clicked">on_executeButton_clicked</a></td>
+<td>Private slot to execute the selected app with the entered parameters.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxAppStartDialog.__init__" ID="PipxAppStartDialog.__init__"></a>
+<h4>PipxAppStartDialog (Constructor)</h4>
+<b>PipxAppStartDialog</b>(<i>app, plugin, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>app</i> (str)</dt>
+<dd>
+path of the application to be executed
+</dd>
+<dt><i>plugin</i> (PluginPipxInterface)</dt>
+<dd>
+reference to the plug-in object
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.__addOutput" ID="PipxAppStartDialog.__addOutput"></a>
+<h4>PipxAppStartDialog.__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="PipxAppStartDialog.__cancel" ID="PipxAppStartDialog.__cancel"></a>
+<h4>PipxAppStartDialog.__cancel</h4>
+<b>__cancel</b>(<i></i>)
+<p>
+        Private slot to cancel the current action.
+</p>
+
+<a NAME="PipxAppStartDialog.__finish" ID="PipxAppStartDialog.__finish"></a>
+<h4>PipxAppStartDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+        Private slot called when the process finished or the user pressed
+        the button.
+</p>
+
+<a NAME="PipxAppStartDialog.__populateWorkDirs" ID="PipxAppStartDialog.__populateWorkDirs"></a>
+<h4>PipxAppStartDialog.__populateWorkDirs</h4>
+<b>__populateWorkDirs</b>(<i>mostRecent=None</i>)
+<p>
+        Private method to populate the working directory selector.
+</p>
+
+<dl>
+
+<dt><i>mostRecent</i> (str)</dt>
+<dd>
+most recently used working directory
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.__procFinished" ID="PipxAppStartDialog.__procFinished"></a>
+<h4>PipxAppStartDialog.__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="PipxAppStartDialog.__readStderr" ID="PipxAppStartDialog.__readStderr"></a>
+<h4>PipxAppStartDialog.__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="PipxAppStartDialog.__readStdout" ID="PipxAppStartDialog.__readStdout"></a>
+<h4>PipxAppStartDialog.__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="PipxAppStartDialog.closeEvent" ID="PipxAppStartDialog.closeEvent"></a>
+<h4>PipxAppStartDialog.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="PipxAppStartDialog.on_buttonBox_clicked" ID="PipxAppStartDialog.on_buttonBox_clicked"></a>
+<h4>PipxAppStartDialog.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="PipxAppStartDialog.on_executeButton_clicked" ID="PipxAppStartDialog.on_executeButton_clicked"></a>
+<h4>PipxAppStartDialog.on_executeButton_clicked</h4>
+<b>on_executeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to execute the selected app with the entered parameters.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial