ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskConfigDialog.html

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

<p>
Module implementing a dialog to configure project specific flask settings.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#FlaskConfigDialog">FlaskConfigDialog</a></td>
<td>Class implementing a dialog to configure project specific flask settings.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to configure project specific flask settings.
</p>
<h3>Derived from</h3>
QDialog, Ui_FlaskConfigDialog
<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="#FlaskConfigDialog.__init__">FlaskConfigDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#FlaskConfigDialog.__installFlask">__installFlask</a></td>
<td>Private method to install flask into the newly created environment.</td>
</tr>
<tr>
<td><a href="#FlaskConfigDialog.getConfiguration">getConfiguration</a></td>
<td>Public method to get the entered configuration data.</td>
</tr>
<tr>
<td><a href="#FlaskConfigDialog.on_newEnvironmentButton_clicked">on_newEnvironmentButton_clicked</a></td>
<td>Private slot to open a dialog for adding a new virtual environment.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="FlaskConfigDialog.__init__" ID="FlaskConfigDialog.__init__"></a>
<h4>FlaskConfigDialog (Constructor)</h4>
<b>FlaskConfigDialog</b>(<i>configuration, project, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>configuration</i> (dict)</dt>
<dd>
current project specific configuration
</dd>
<dt><i>project</i> (Project)</dt>
<dd>
reference to the flask project object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="FlaskConfigDialog.__installFlask" ID="FlaskConfigDialog.__installFlask"></a>
<h4>FlaskConfigDialog.__installFlask</h4>
<b>__installFlask</b>(<i>venvDir</i>)

<p>
        Private method to install flask into the newly created environment.
</p>
<dl>

<dt><i>venvDir</i> (str)</dt>
<dd>
directory containing the virtual environment
</dd>
</dl>
<a NAME="FlaskConfigDialog.getConfiguration" ID="FlaskConfigDialog.getConfiguration"></a>
<h4>FlaskConfigDialog.getConfiguration</h4>
<b>getConfiguration</b>(<i></i>)

<p>
        Public method to get the entered configuration data.
</p>
<dl>
<dt>Return:</dt>
<dd>
project specific configuration
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="FlaskConfigDialog.on_newEnvironmentButton_clicked" ID="FlaskConfigDialog.on_newEnvironmentButton_clicked"></a>
<h4>FlaskConfigDialog.on_newEnvironmentButton_clicked</h4>
<b>on_newEnvironmentButton_clicked</b>(<i></i>)

<p>
        Private slot to open a dialog for adding a new virtual environment.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>