src/eric7/Documentation/Source/eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.DocumentationPlugins.Ericapi.EricapiExecDialog</h1>

<p>
Module implementing a dialog to show the output of the ericapi process.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EricapiExecDialog">EricapiExecDialog</a></td>
<td>Class implementing a dialog to show the output of the ericapi process.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EricapiExecDialog" ID="EricapiExecDialog"></a>
<h2>EricapiExecDialog</h2>

<p>
    Class implementing a dialog to show the output of the ericapi process.
</p>
<p>
    This class starts a QProcess and displays a dialog that
    shows the output of the documentation command process.
</p>
<h3>Signals</h3>
<dl>

<dt>processFinished()</dt>
<dd>
emitted to indicate the eric7_doc process finished
</dd>
</dl>
<h3>Derived from</h3>
QDialog, Ui_EricapiExecDialog
<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="#EricapiExecDialog.__init__">EricapiExecDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricapiExecDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished.</td>
</tr>
<tr>
<td><a href="#EricapiExecDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr>
<tr>
<td><a href="#EricapiExecDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr>
<tr>
<td><a href="#EricapiExecDialog.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="#EricapiExecDialog.start">start</a></td>
<td>Public slot to start the ericapi command.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricapiExecDialog.__init__" ID="EricapiExecDialog.__init__"></a>
<h4>EricapiExecDialog (Constructor)</h4>
<b>EricapiExecDialog</b>(<i>cmdname, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>cmdname</i></dt>
<dd>
name of the ericapi generator (string)
</dd>
<dt><i>parent</i></dt>
<dd>
parent widget of this dialog (QWidget)
</dd>
</dl>
<a NAME="EricapiExecDialog.__finish" ID="EricapiExecDialog.__finish"></a>
<h4>EricapiExecDialog.__finish</h4>
<b>__finish</b>(<i></i>)

<p>
        Private slot called when the process finished.
</p>
<p>
        It is called when the process finished or
        the user pressed the button.
</p>
<a NAME="EricapiExecDialog.__readStderr" ID="EricapiExecDialog.__readStderr"></a>
<h4>EricapiExecDialog.__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="EricapiExecDialog.__readStdout" ID="EricapiExecDialog.__readStdout"></a>
<h4>EricapiExecDialog.__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="EricapiExecDialog.on_buttonBox_clicked" ID="EricapiExecDialog.on_buttonBox_clicked"></a>
<h4>EricapiExecDialog.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></dt>
<dd>
button that was clicked (QAbstractButton)
</dd>
</dl>
<a NAME="EricapiExecDialog.start" ID="EricapiExecDialog.start"></a>
<h4>EricapiExecDialog.start</h4>
<b>start</b>(<i>args, fn</i>)

<p>
        Public slot to start the ericapi command.
</p>
<dl>

<dt><i>args</i></dt>
<dd>
commandline arguments for ericapi program (list of strings)
</dd>
<dt><i>fn</i></dt>
<dd>
filename or dirname to be processed by ericapi program
            (string)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating the successful start of the process (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>