eric6/Documentation/Source/eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog</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.DocumentationPlugins.Ericdoc.EricdocExecDialog</h1>

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

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

<table>

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

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

<p>
    Class implementing a dialog to show the output of the ericdoc process.
</p>
<p>
    This class starts a QProcess and displays a dialog that
    shows the output of the documentation command process.
</p>
<h3>Derived from</h3>
QDialog, Ui_EricdocExecDialog
<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="#EricdocExecDialog.__init__">EricdocExecDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricdocExecDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished.</td>
</tr>
<tr>
<td><a href="#EricdocExecDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr>
<tr>
<td><a href="#EricdocExecDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr>
<tr>
<td><a href="#EricdocExecDialog.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="#EricdocExecDialog.start">start</a></td>
<td>Public slot to start the ericdoc command.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

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

<p>
        Constructor
</p>
<dl>

<dt><i>cmdname</i></dt>
<dd>
name of the documentation generator (string)
</dd>
<dt><i>parent</i></dt>
<dd>
parent widget of this dialog (QWidget)
</dd>
</dl>
<a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a>
<h4>EricdocExecDialog.__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="EricdocExecDialog.__readStderr" ID="EricdocExecDialog.__readStderr"></a>
<h4>EricdocExecDialog.__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="EricdocExecDialog.__readStdout" ID="EricdocExecDialog.__readStdout"></a>
<h4>EricdocExecDialog.__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="EricdocExecDialog.on_buttonBox_clicked" ID="EricdocExecDialog.on_buttonBox_clicked"></a>
<h4>EricdocExecDialog.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="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a>
<h4>EricdocExecDialog.start</h4>
<b>start</b>(<i>args, fn</i>)

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

<dt><i>args</i></dt>
<dd>
commandline arguments for ericdoc program (list of strings)
</dd>
<dt><i>fn</i></dt>
<dd>
filename or dirname to be processed by ericdoc 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>