--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.RunServerDialog.html Sun Nov 22 14:12:44 2020 +0100 @@ -0,0 +1,258 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Flask.ProjectFlask.RunServerDialog</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.RunServerDialog</h1> + +<p> +Module implementing a dialog to run the Flask server. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#RunServerDialog">RunServerDialog</a></td> +<td>Class implementing a dialog to run the Flask server.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="RunServerDialog" ID="RunServerDialog"></a> +<h2>RunServerDialog</h2> + +<p> + Class implementing a dialog to run the Flask server. +</p> +<h3>Derived from</h3> +QDialog, Ui_RunServerDialog +<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="#RunServerDialog.__init__">RunServerDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__initActionsMenu">__initActionsMenu</a></td> +<td>Private method to populate the actions button menu.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__processFinished">__processFinished</a></td> +<td>Private slot handling the finishing of the server process.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__readStdOut">__readStdOut</a></td> +<td>Private slot to add the server process output to the output pane.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__restartServer">__restartServer</a></td> +<td>Private slot to restart the server process.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__restartServerDifferentMode">__restartServerDifferentMode</a></td> +<td>Private slot to restart the server process with the opposite mode.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__restartServerWithOptions">__restartServerWithOptions</a></td> +<td>Private slot to restart the server asking for start options.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.__showActionsMenu">__showActionsMenu</a></td> +<td>Private slot handling the actions menu about to be shown.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.closeEvent">closeEvent</a></td> +<td>Protected method handling a close event.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.on_startBrowserButton_clicked">on_startBrowserButton_clicked</a></td> +<td>Private slot to start a web browser with the server URL.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.on_stopServerButton_clicked">on_stopServerButton_clicked</a></td> +<td>Private slot to stop the running server.</td> +</tr> +<tr> +<td><a href="#RunServerDialog.startServer">startServer</a></td> +<td>Public method to start the Flask server process.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="RunServerDialog.__init__" ID="RunServerDialog.__init__"></a> +<h4>RunServerDialog (Constructor)</h4> +<b>RunServerDialog</b>(<i>plugin, project, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>plugin</i> (PluginProjectFlask)</dt> +<dd> +reference to the plug-in object +</dd> +<dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd> +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="RunServerDialog.__initActionsMenu" ID="RunServerDialog.__initActionsMenu"></a> +<h4>RunServerDialog.__initActionsMenu</h4> +<b>__initActionsMenu</b>(<i></i>) + +<p> + Private method to populate the actions button menu. +</p> +<a NAME="RunServerDialog.__processFinished" ID="RunServerDialog.__processFinished"></a> +<h4>RunServerDialog.__processFinished</h4> +<b>__processFinished</b>(<i></i>) + +<p> + Private slot handling the finishing of the server process. +</p> +<a NAME="RunServerDialog.__readStdOut" ID="RunServerDialog.__readStdOut"></a> +<h4>RunServerDialog.__readStdOut</h4> +<b>__readStdOut</b>(<i></i>) + +<p> + Private slot to add the server process output to the output pane. +</p> +<a NAME="RunServerDialog.__restartServer" ID="RunServerDialog.__restartServer"></a> +<h4>RunServerDialog.__restartServer</h4> +<b>__restartServer</b>(<i></i>) + +<p> + Private slot to restart the server process. +</p> +<a NAME="RunServerDialog.__restartServerDifferentMode" ID="RunServerDialog.__restartServerDifferentMode"></a> +<h4>RunServerDialog.__restartServerDifferentMode</h4> +<b>__restartServerDifferentMode</b>(<i></i>) + +<p> + Private slot to restart the server process with the opposite mode. +</p> +<a NAME="RunServerDialog.__restartServerWithOptions" ID="RunServerDialog.__restartServerWithOptions"></a> +<h4>RunServerDialog.__restartServerWithOptions</h4> +<b>__restartServerWithOptions</b>(<i></i>) + +<p> + Private slot to restart the server asking for start options. +</p> +<a NAME="RunServerDialog.__showActionsMenu" ID="RunServerDialog.__showActionsMenu"></a> +<h4>RunServerDialog.__showActionsMenu</h4> +<b>__showActionsMenu</b>(<i></i>) + +<p> + Private slot handling the actions menu about to be shown. +</p> +<a NAME="RunServerDialog.closeEvent" ID="RunServerDialog.closeEvent"></a> +<h4>RunServerDialog.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected method handling a close event. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> +<a NAME="RunServerDialog.on_startBrowserButton_clicked" ID="RunServerDialog.on_startBrowserButton_clicked"></a> +<h4>RunServerDialog.on_startBrowserButton_clicked</h4> +<b>on_startBrowserButton_clicked</b>(<i></i>) + +<p> + Private slot to start a web browser with the server URL. +</p> +<a NAME="RunServerDialog.on_stopServerButton_clicked" ID="RunServerDialog.on_stopServerButton_clicked"></a> +<h4>RunServerDialog.on_stopServerButton_clicked</h4> +<b>on_stopServerButton_clicked</b>(<i></i>) + +<p> + Private slot to stop the running server. +</p> +<a NAME="RunServerDialog.startServer" ID="RunServerDialog.startServer"></a> +<h4>RunServerDialog.startServer</h4> +<b>startServer</b>(<i>development=False, askForOptions=False</i>) + +<p> + Public method to start the Flask server process. +</p> +<dl> + +<dt><i>development</i> (bool)</dt> +<dd> +flag indicating development mode +</dd> +<dt><i>askForOptions</i> (bool)</dt> +<dd> +flag indicating to ask for server start options + first +</dd> +</dl> +<dl> +<dt>Returns:</dt> +<dd> +flag indicating success +</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