ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog.html

changeset 19
f8e3c1676f9b
child 61
fe1e8783a95f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog.html	Sun Nov 22 14:12:44 2020 +0100
@@ -0,0 +1,271 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Project_Flask.ProjectFlask.FlaskBabelExtension.PyBabelCommandDialog</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.FlaskBabelExtension.PyBabelCommandDialog</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="#PyBabelCommandDialog">PyBabelCommandDialog</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="PyBabelCommandDialog" ID="PyBabelCommandDialog"></a>
+<h2>PyBabelCommandDialog</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="#PyBabelCommandDialog.__init__">PyBabelCommandDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.__cancelProcess">__cancelProcess</a></td>
+<td>Private slot to terminate the current process.</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.__processFinished">__processFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.__readStdOut">__readStdOut</a></td>
+<td>Private slot to add the server process output to the output pane.</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.closeEvent">closeEvent</a></td>
+<td>Protected method handling the close event of the dialog.</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot handling presses of the button box buttons.</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.startBatchCommand">startBatchCommand</a></td>
+<td>Public method to start a pybabel command repeatedly with a list of arguments and show the output.</td>
+</tr>
+<tr>
+<td><a href="#PyBabelCommandDialog.startCommand">startCommand</a></td>
+<td>Public method to start a pybabel command and show its output.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PyBabelCommandDialog.__init__" ID="PyBabelCommandDialog.__init__"></a>
+<h4>PyBabelCommandDialog (Constructor)</h4>
+<b>PyBabelCommandDialog</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="PyBabelCommandDialog.__cancelProcess" ID="PyBabelCommandDialog.__cancelProcess"></a>
+<h4>PyBabelCommandDialog.__cancelProcess</h4>
+<b>__cancelProcess</b>(<i></i>)
+
+<p>
+        Private slot to terminate the current process.
+</p>
+<a NAME="PyBabelCommandDialog.__processFinished" ID="PyBabelCommandDialog.__processFinished"></a>
+<h4>PyBabelCommandDialog.__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="PyBabelCommandDialog.__readStdOut" ID="PyBabelCommandDialog.__readStdOut"></a>
+<h4>PyBabelCommandDialog.__readStdOut</h4>
+<b>__readStdOut</b>(<i></i>)
+
+<p>
+        Private slot to add the server process output to the output pane.
+</p>
+<a NAME="PyBabelCommandDialog.closeEvent" ID="PyBabelCommandDialog.closeEvent"></a>
+<h4>PyBabelCommandDialog.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="PyBabelCommandDialog.on_buttonBox_clicked" ID="PyBabelCommandDialog.on_buttonBox_clicked"></a>
+<h4>PyBabelCommandDialog.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="PyBabelCommandDialog.startBatchCommand" ID="PyBabelCommandDialog.startBatchCommand"></a>
+<h4>PyBabelCommandDialog.startBatchCommand</h4>
+<b>startBatchCommand</b>(<i>argsLists, workdir</i>)
+
+<p>
+        Public method to start a pybabel command repeatedly with a list of
+        arguments and show the output.
+</p>
+<dl>
+
+<dt><i>argsLists</i> (list of lists of str)</dt>
+<dd>
+list of command line arguments for the batch commands
+</dd>
+<dt><i>workdir</i> (str)</dt>
+<dd>
+working directory for the command
+</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>
+<a NAME="PyBabelCommandDialog.startCommand" ID="PyBabelCommandDialog.startCommand"></a>
+<h4>PyBabelCommandDialog.startCommand</h4>
+<b>startCommand</b>(<i>command, args, workdir, clearOutput=True</i>)
+
+<p>
+        Public method to start a pybabel command and show its output.
+</p>
+<dl>
+
+<dt><i>command</i> (str)</dt>
+<dd>
+pybabel command to be run
+</dd>
+<dt><i>args</i> (list of str)</dt>
+<dd>
+list of command line arguments for the command
+</dd>
+<dt><i>workdir</i> (str)</dt>
+<dd>
+working directory for the command
+</dd>
+<dt><i>clearOutput</i> (bool)</dt>
+<dd>
+flag indicating to clear the output
+</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>
\ No newline at end of file

eric ide

mercurial