ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskVirtualenvConfigurationDialog.html

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

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

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

<table>

<tr>
<td><a href="#FlaskVirtualenvConfigurationDialog">FlaskVirtualenvConfigurationDialog</a></td>
<td>Class implementing a dialog to configure a project specific virtual environment.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to configure a project specific virtual
    environment.
</p>
<p>
    Note: This dialog is a simplified variant of the one found in the eric
    package.
</p>
<h3>Derived from</h3>
QDialog, Ui_FlaskVirtualenvConfigurationDialog
<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="#FlaskVirtualenvConfigurationDialog.__init__">FlaskVirtualenvConfigurationDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#FlaskVirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td>
<td>Private method to generate a valid target directory path.</td>
</tr>
<tr>
<td><a href="#FlaskVirtualenvConfigurationDialog.__updateOK">__updateOK</a></td>
<td>Private method to update the enabled status of the OK button.</td>
</tr>
<tr>
<td><a href="#FlaskVirtualenvConfigurationDialog.getData">getData</a></td>
<td>Public method to retrieve the dialog data.</td>
</tr>
<tr>
<td><a href="#FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
<td>Private slot handling a change of the virtual environment name.</td>
</tr>
<tr>
<td><a href="#FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td>
<td>Private slot handling a change of the target directory.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="FlaskVirtualenvConfigurationDialog.__init__" ID="FlaskVirtualenvConfigurationDialog.__init__"></a>
<h4>FlaskVirtualenvConfigurationDialog (Constructor)</h4>
<b>FlaskVirtualenvConfigurationDialog</b>(<i>projectPath, projectName, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>projectPath</i> (str)</dt>
<dd>
directory path of the project
</dd>
<dt><i>projectName</i> (str)</dt>
<dd>
name of the project
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="FlaskVirtualenvConfigurationDialog.__generateTargetDir" ID="FlaskVirtualenvConfigurationDialog.__generateTargetDir"></a>
<h4>FlaskVirtualenvConfigurationDialog.__generateTargetDir</h4>
<b>__generateTargetDir</b>(<i></i>)

<p>
        Private method to generate a valid target directory path.
</p>
<dl>
<dt>Return:</dt>
<dd>
target directory path
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="FlaskVirtualenvConfigurationDialog.__updateOK" ID="FlaskVirtualenvConfigurationDialog.__updateOK"></a>
<h4>FlaskVirtualenvConfigurationDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)

<p>
        Private method to update the enabled status of the OK button.
</p>
<a NAME="FlaskVirtualenvConfigurationDialog.getData" ID="FlaskVirtualenvConfigurationDialog.getData"></a>
<h4>FlaskVirtualenvConfigurationDialog.getData</h4>
<b>getData</b>(<i></i>)

<p>
        Public method to retrieve the dialog data.
</p>
<p>
        Note: This method returns a data structure compatible with the one
        returned by the eric virtual environment configuration dialog.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing the data for the environment to be
            created. The keys for both variants are 'arguments' containing the
            command line arguments, 'logicalName' containing the environment
            name to be used with the virtual environment manager and 'envType'
            containing the environment type (always pyvenv). The pyvenv
            specific keys are 'openTarget' containg a flag to open the target
            directory after creation (always False), 'createLog' containing a
            flag to write a log file (always False), 'createScript' containing
            a flag to write a script (always False), 'targetDirectory'
            containing the target directory and 'pythonExe' containing the
            Python interpreter to be used.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged" ID="FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged"></a>
<h4>FlaskVirtualenvConfigurationDialog.on_nameEdit_textChanged</h4>
<b>on_nameEdit_textChanged</b>(<i>txt</i>)

<p>
        Private slot handling a change of the virtual environment name.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
name of the virtual environment
</dd>
</dl>
<a NAME="FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged" ID="FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged"></a>
<h4>FlaskVirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged</h4>
<b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>)

<p>
        Private slot handling a change of the target directory.
</p>
<dl>

<dt><i>txt</i> (str)</dt>
<dd>
target directory
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>