eric: src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvConfigurationDialog.html@c48c615c04a3

<!DOCTYPE html>
<html><head>
<title>eric7.VirtualEnv.VirtualenvConfigurationDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.VirtualEnv.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 slot to update the enabled status of the OK button.</td>
</tr>
<tr>
<td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td>
<td>Private slot 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_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
<td>Private slot to react to a change of the Python executable.</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>baseDir="", parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>baseDir</i> (str)</dt>
<dd>
base directory for the virtual environments
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</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>Return:</dt>
<dd>
process arguments
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</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>Return:</dt>
<dd>
target directory path
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</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 slot 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 slot 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>Return:</dt>
<dd>
dictionary containing the data for the new environment. The keys
            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 (virtualenv or
            pyvenv). Additional keys are 'openTarget' containg a flag to open the
            target directory after creation, 'createLog' containing a flag to write
            a log file, 'createScript' containing a flag to write a script,
            '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="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged"></a>
<h4>VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged</h4>
<b>on_pythonExecPicker_textChanged</b>(<i>_txt</i>)
<p>
        Private slot to react to a change of the Python executable.
</p>

<dl>

<dt><i>_txt</i> (str)</dt>
<dd>
contents of the picker's line edit (unused)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>