tip/src/eric7/Documentation/Source/eric7.CondaInterface.CondaEnvironmentConfigurationDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.CondaInterface.CondaEnvironmentConfigurationDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.CondaInterface.CondaEnvironmentConfigurationDialog</h1>
<p>
Module implementing a dialog to enter the parameters for the conda virtual environment.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#CondaEnvironmentConfigurationDialog">CondaEnvironmentConfigurationDialog</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="CondaEnvironmentConfigurationDialog" ID="CondaEnvironmentConfigurationDialog"></a>
<h2>CondaEnvironmentConfigurationDialog</h2>
<p>
    Class implementing a dialog to enter the parameters for the virtual environment.
</p>

<h3>Derived from</h3>
QDialog, Ui_CondaEnvironmentConfigurationDialog
<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="#CondaEnvironmentConfigurationDialog.__init__">CondaEnvironmentConfigurationDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CondaEnvironmentConfigurationDialog.__generateArguments">__generateArguments</a></td>
<td>Private method to generate the process arguments.</td>
</tr>
<tr>
<td><a href="#CondaEnvironmentConfigurationDialog.__updateOK">__updateOK</a></td>
<td>Private method to update the enabled status of the OK button.</td>
</tr>
<tr>
<td><a href="#CondaEnvironmentConfigurationDialog.__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="#CondaEnvironmentConfigurationDialog.getData">getData</a></td>
<td>Public method to retrieve the dialog data.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="CondaEnvironmentConfigurationDialog.__init__" ID="CondaEnvironmentConfigurationDialog.__init__"></a>
<h4>CondaEnvironmentConfigurationDialog (Constructor)</h4>
<b>CondaEnvironmentConfigurationDialog</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="CondaEnvironmentConfigurationDialog.__generateArguments" ID="CondaEnvironmentConfigurationDialog.__generateArguments"></a>
<h4>CondaEnvironmentConfigurationDialog.__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="CondaEnvironmentConfigurationDialog.__updateOK" ID="CondaEnvironmentConfigurationDialog.__updateOK"></a>
<h4>CondaEnvironmentConfigurationDialog.__updateOK</h4>
<b>__updateOK</b>(<i></i>)
<p>
        Private method to update the enabled status of the OK button.
</p>

<a NAME="CondaEnvironmentConfigurationDialog.__updateUi" ID="CondaEnvironmentConfigurationDialog.__updateUi"></a>
<h4>CondaEnvironmentConfigurationDialog.__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="CondaEnvironmentConfigurationDialog.getData" ID="CondaEnvironmentConfigurationDialog.getData"></a>
<h4>CondaEnvironmentConfigurationDialog.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 environment creation. The
            key 'logicalName' contains the environment name to be used with the
            virtual environment manager and 'arguments' contains the generated
            command line arguments for the 'conda create' command.
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>