--- a/Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog.html Sat Feb 16 10:27:50 2019 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,224 +0,0 @@
-<!DOCTYPE html>
-<html><head>
-<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipDialog</title>
-<meta charset="UTF-8">
-<style>
-body {
- background: #EDECE6;
- margin: 0em 1em 10em 1em;
- color: black;
-}
-
-h1 { color: white; background: #85774A; }
-h2 { color: white; background: #85774A; }
-h3 { color: white; background: #9D936E; }
-h4 { color: white; background: #9D936E; }
-
-a { color: #BA6D36; }
-
-</style>
-</head>
-<body><a NAME="top" ID="top"></a>
-<h1>eric6.Plugins.UiExtensionPlugins.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>
-</tr><tr>
-<td><a href="#PipDialog.__addOutput">__addOutput</a></td>
-<td>Private method to add some text to the output pane.</td>
-</tr><tr>
-<td><a href="#PipDialog.__finish">__finish</a></td>
-<td>Private slot called when the process finished or the user pressed the button.</td>
-</tr><tr>
-<td><a href="#PipDialog.__procFinished">__procFinished</a></td>
-<td>Private slot connected to the finished signal.</td>
-</tr><tr>
-<td><a href="#PipDialog.__readStderr">__readStderr</a></td>
-<td>Private slot to handle the readyReadStandardError signal.</td>
-</tr><tr>
-<td><a href="#PipDialog.__readStdout">__readStdout</a></td>
-<td>Private slot to handle the readyReadStandardOutput signal.</td>
-</tr><tr>
-<td><a href="#PipDialog.closeEvent">closeEvent</a></td>
-<td>Protected slot implementing a close event handler.</td>
-</tr><tr>
-<td><a href="#PipDialog.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="#PipDialog.startProcess">startProcess</a></td>
-<td>Public slot used to start the process.</td>
-</tr><tr>
-<td><a href="#PipDialog.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="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>
-<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="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>
-<dd>
-text to be added
-</dd>
-</dl><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>
-<dd>
-exit code of the process
-</dd><dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
-<dd>
-exit status of the process
-</dd>
-</dl><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><p>
- 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><p>
- 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>
-<dd>
-close event
-</dd>
-</dl><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>
-<dd>
-button that was clicked
-</dd>
-</dl><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>
-<dd>
-name of the pip 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>Returns:</dt>
-<dd>
-flag indicating a successful start of the process
-</dd>
-</dl><dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl><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>
-<dd>
-list of tuples containing the command
- and arguments
-</dd>
-</dl><dl>
-<dt>Returns:</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>
\ No newline at end of file
