ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog</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>Plugin_Project_Flask.ProjectFlask.FlaskCommandDialog</h1>

<p>
Module implementing a dialog to run a flask command and show its output.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#FlaskCommandDialog">FlaskCommandDialog</a></td>
<td>Class implementing a dialog to run a flask command and show its output.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to run a flask command and show its output.
</p>
<h3>Derived from</h3>
QDialog, Ui_FlaskCommandDialog
<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="#FlaskCommandDialog.__init__">FlaskCommandDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#FlaskCommandDialog.__cancelProcess">__cancelProcess</a></td>
<td>Private slot to terminate the current process.</td>
</tr>
<tr>
<td><a href="#FlaskCommandDialog.__processFinished">__processFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr>
<tr>
<td><a href="#FlaskCommandDialog.__readStdOut">__readStdOut</a></td>
<td>Private slot to add the server process output to the output pane.</td>
</tr>
<tr>
<td><a href="#FlaskCommandDialog.closeEvent">closeEvent</a></td>
<td>Protected method handling the close event of the dialog.</td>
</tr>
<tr>
<td><a href="#FlaskCommandDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot handling presses of the button box buttons.</td>
</tr>
<tr>
<td><a href="#FlaskCommandDialog.startCommand">startCommand</a></td>
<td>Public method to start a flask command and show its output.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="FlaskCommandDialog.__init__" ID="FlaskCommandDialog.__init__"></a>
<h4>FlaskCommandDialog (Constructor)</h4>
<b>FlaskCommandDialog</b>(<i>project, title="", msgSuccess="", msgError="", parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
<dt><i>title</i> (str)</dt>
<dd>
window title of the dialog
</dd>
<dt><i>msgSuccess</i> (str)</dt>
<dd>
success message to be shown
</dd>
<dt><i>msgError</i> (str)</dt>
<dd>
message to be shown on error
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="FlaskCommandDialog.__cancelProcess" ID="FlaskCommandDialog.__cancelProcess"></a>
<h4>FlaskCommandDialog.__cancelProcess</h4>
<b>__cancelProcess</b>(<i></i>)

<p>
        Private slot to terminate the current process.
</p>
<a NAME="FlaskCommandDialog.__processFinished" ID="FlaskCommandDialog.__processFinished"></a>
<h4>FlaskCommandDialog.__processFinished</h4>
<b>__processFinished</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="FlaskCommandDialog.__readStdOut" ID="FlaskCommandDialog.__readStdOut"></a>
<h4>FlaskCommandDialog.__readStdOut</h4>
<b>__readStdOut</b>(<i></i>)

<p>
        Private slot to add the server process output to the output pane.
</p>
<a NAME="FlaskCommandDialog.closeEvent" ID="FlaskCommandDialog.closeEvent"></a>
<h4>FlaskCommandDialog.closeEvent</h4>
<b>closeEvent</b>(<i>evt</i>)

<p>
        Protected method handling the close event of the dialog.
</p>
<dl>

<dt><i>evt</i> (QCloseEvent)</dt>
<dd>
reference to the close event object
</dd>
</dl>
<a NAME="FlaskCommandDialog.on_buttonBox_clicked" ID="FlaskCommandDialog.on_buttonBox_clicked"></a>
<h4>FlaskCommandDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)

<p>
        Private slot handling presses of the button box buttons.
</p>
<dl>

<dt><i>button</i> (QAbstractButton)</dt>
<dd>
reference to the button been clicked
</dd>
</dl>
<a NAME="FlaskCommandDialog.startCommand" ID="FlaskCommandDialog.startCommand"></a>
<h4>FlaskCommandDialog.startCommand</h4>
<b>startCommand</b>(<i>command, args=None</i>)

<p>
        Public method to start a flask command and show its output.
</p>
<dl>

<dt><i>command</i> (str)</dt>
<dd>
flask command to be run
</dd>
<dt><i>args</i> (list of str)</dt>
<dd>
list of command line arguments for the command
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
flag indicating a successful start
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>