Documentation/Source/eric6.Plugins.UiExtensionPlugins.VirtualenvInterface.VirtualenvConfigurationDialog.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.UiExtensionPlugins.VirtualenvInterface.VirtualenvConfigurationDialog</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>eric6.Plugins.UiExtensionPlugins.VirtualenvInterface.VirtualenvConfigurationDialog</h1>
<p>
Module implementing a dialog to enter the parameters for the
virtual environment.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#VirtualenvConfigurationDialog">VirtualenvConfigurationDialog</a></td>
<td>Class implementing a dialog to enter the parameters for the virtual environment.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="VirtualenvConfigurationDialog" ID="VirtualenvConfigurationDialog"></a>
<h2>VirtualenvConfigurationDialog</h2>
<p>
    Class implementing a dialog to enter the parameters for the
    virtual environment.
</p>
<h3>Derived from</h3>
QDialog, Ui_VirtualenvConfigurationDialog
<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="#VirtualenvConfigurationDialog.__init__">VirtualenvConfigurationDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.__generateArguments">__generateArguments</a></td>
<td>Private method to generate the process arguments.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td>
<td>Private method to generate a valid target directory path.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.__setPyvenvVersion">__setPyvenvVersion</a></td>
<td>Private method to determine the pyvenv version and set the respective label.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.__setVirtualenvVersion">__setVirtualenvVersion</a></td>
<td>Private method to determine the virtualenv version and set the respective label.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.__updateOK">__updateOK</a></td>
<td>Private method to update the enabled status of the OK button.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td>
<td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.getData">getData</a></td>
<td>Public method to retrieve the dialog data.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_extraSearchPathButton_clicked">on_extraSearchPathButton_clicked</a></td>
<td>Private slot to select the extra search path via a directory selection dialog.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_pythonExecButton_clicked">on_pythonExecButton_clicked</a></td>
<td>Private slot to select a Python interpreter via a file selection dialog.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_pythonExecEdit_textChanged">on_pythonExecEdit_textChanged</a></td>
<td>Private slot to react to a change of the Python executable.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_pyvenvButton_toggled">on_pyvenvButton_toggled</a></td>
<td>Private slot to react to the selection of 'pyvenv'.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_targetDirectoryButton_clicked">on_targetDirectoryButton_clicked</a></td>
<td>Private slot to select the target directory via a directory selection dialog.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_targetDirectoryEdit_textChanged">on_targetDirectoryEdit_textChanged</a></td>
<td>Private slot handling a change of the target directory.</td>
</tr><tr>
<td><a href="#VirtualenvConfigurationDialog.on_virtualenvButton_toggled">on_virtualenvButton_toggled</a></td>
<td>Private slot to react to the selection of 'virtualenv'.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="VirtualenvConfigurationDialog.__init__" ID="VirtualenvConfigurationDialog.__init__"></a>
<h4>VirtualenvConfigurationDialog (Constructor)</h4>
<b>VirtualenvConfigurationDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.__generateArguments" ID="VirtualenvConfigurationDialog.__generateArguments"></a>
<h4>VirtualenvConfigurationDialog.__generateArguments</h4>
<b>__generateArguments</b>(<i></i>)
<p>
        Private method to generate the process arguments.
</p><dl>
<dt>Returns:</dt>
<dd>
process arguments (list of string)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.__generateTargetDir" ID="VirtualenvConfigurationDialog.__generateTargetDir"></a>
<h4>VirtualenvConfigurationDialog.__generateTargetDir</h4>
<b>__generateTargetDir</b>(<i></i>)
<p>
        Private method to generate a valid target directory path.
</p><dl>
<dt>Returns:</dt>
<dd>
target directory path (string)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.__setPyvenvVersion" ID="VirtualenvConfigurationDialog.__setPyvenvVersion"></a>
<h4>VirtualenvConfigurationDialog.__setPyvenvVersion</h4>
<b>__setPyvenvVersion</b>(<i></i>)
<p>
        Private method to determine the pyvenv version and set the respective
        label.
</p><a NAME="VirtualenvConfigurationDialog.__setVirtualenvVersion" ID="VirtualenvConfigurationDialog.__setVirtualenvVersion"></a>
<h4>VirtualenvConfigurationDialog.__setVirtualenvVersion</h4>
<b>__setVirtualenvVersion</b>(<i></i>)
<p>
        Private method to determine the virtualenv version and set the
        respective label.
</p><a NAME="VirtualenvConfigurationDialog.__updateOK" ID="VirtualenvConfigurationDialog.__updateOK"></a>
<h4>VirtualenvConfigurationDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)
<p>
        Private method to update the enabled status of the OK button.
</p><a NAME="VirtualenvConfigurationDialog.__updateUi" ID="VirtualenvConfigurationDialog.__updateUi"></a>
<h4>VirtualenvConfigurationDialog.__updateUi</h4>
<b>__updateUi</b>(<i></i>)
<p>
        Private method to update the UI depending on the selected
        virtual environment creator (virtualenv or pyvenv).
</p><a NAME="VirtualenvConfigurationDialog.getData" ID="VirtualenvConfigurationDialog.getData"></a>
<h4>VirtualenvConfigurationDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to retrieve the dialog data.
</p><dl>
<dt>Returns:</dt>
<dd>
tuple containing a flag indicating the pyvenv selection
            (boolean), the process arguments (list of string), a flag
            indicating to open the target directory after creation (boolean),
            a flag indicating to write a log file (boolean), a flag indicating
            to write a script (boolean), the name of the target directory
            (string) and the name of the python interpreter to use (string)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.on_extraSearchPathButton_clicked" ID="VirtualenvConfigurationDialog.on_extraSearchPathButton_clicked"></a>
<h4>VirtualenvConfigurationDialog.on_extraSearchPathButton_clicked</h4>
<b>on_extraSearchPathButton_clicked</b>(<i></i>)
<p>
        Private slot to select the extra search path via a directory
        selection dialog.
</p><a NAME="VirtualenvConfigurationDialog.on_pythonExecButton_clicked" ID="VirtualenvConfigurationDialog.on_pythonExecButton_clicked"></a>
<h4>VirtualenvConfigurationDialog.on_pythonExecButton_clicked</h4>
<b>on_pythonExecButton_clicked</b>(<i></i>)
<p>
        Private slot to select a Python interpreter via a file selection
        dialog.
</p><a NAME="VirtualenvConfigurationDialog.on_pythonExecEdit_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecEdit_textChanged"></a>
<h4>VirtualenvConfigurationDialog.on_pythonExecEdit_textChanged</h4>
<b>on_pythonExecEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot to react to a change of the Python executable.
</p><dl>
<dt><i>txt</i></dt>
<dd>
contents of the line edit (string)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.on_pyvenvButton_toggled" ID="VirtualenvConfigurationDialog.on_pyvenvButton_toggled"></a>
<h4>VirtualenvConfigurationDialog.on_pyvenvButton_toggled</h4>
<b>on_pyvenvButton_toggled</b>(<i>checked</i>)
<p>
        Private slot to react to the selection of 'pyvenv'.
</p><dl>
<dt><i>checked</i></dt>
<dd>
state of the checkbox (boolean)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.on_targetDirectoryButton_clicked" ID="VirtualenvConfigurationDialog.on_targetDirectoryButton_clicked"></a>
<h4>VirtualenvConfigurationDialog.on_targetDirectoryButton_clicked</h4>
<b>on_targetDirectoryButton_clicked</b>(<i></i>)
<p>
        Private slot to select the target directory via a directory
        selection dialog.
</p><a NAME="VirtualenvConfigurationDialog.on_targetDirectoryEdit_textChanged" ID="VirtualenvConfigurationDialog.on_targetDirectoryEdit_textChanged"></a>
<h4>VirtualenvConfigurationDialog.on_targetDirectoryEdit_textChanged</h4>
<b>on_targetDirectoryEdit_textChanged</b>(<i>txt</i>)
<p>
        Private slot handling a change of the target directory.
</p><dl>
<dt><i>txt</i></dt>
<dd>
target directory (string)
</dd>
</dl><a NAME="VirtualenvConfigurationDialog.on_virtualenvButton_toggled" ID="VirtualenvConfigurationDialog.on_virtualenvButton_toggled"></a>
<h4>VirtualenvConfigurationDialog.on_virtualenvButton_toggled</h4>
<b>on_virtualenvButton_toggled</b>(<i>checked</i>)
<p>
        Private slot to react to the selection of 'virtualenv'.
</p><dl>
<dt><i>checked</i></dt>
<dd>
state of the checkbox (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>