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

branch
eric7
changeset 11231
c7240fb719c7
equal deleted inserted replaced
11230:8a15b05eeee3 11231:c7240fb719c7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.CondaInterface.CondaEnvironmentConfigurationDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.CondaInterface.CondaEnvironmentConfigurationDialog</h1>
10 <p>
11 Module implementing a dialog to enter the parameters for the conda virtual environment.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#CondaEnvironmentConfigurationDialog">CondaEnvironmentConfigurationDialog</a></td>
23 <td>Class implementing a dialog to enter the parameters for the virtual environment.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="CondaEnvironmentConfigurationDialog" ID="CondaEnvironmentConfigurationDialog"></a>
35 <h2>CondaEnvironmentConfigurationDialog</h2>
36 <p>
37 Class implementing a dialog to enter the parameters for the virtual environment.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_CondaEnvironmentConfigurationDialog
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>None</td></tr>
45 </table>
46
47 <h3>Class Methods</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51
52 <h3>Methods</h3>
53 <table>
54 <tr>
55 <td><a href="#CondaEnvironmentConfigurationDialog.__init__">CondaEnvironmentConfigurationDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#CondaEnvironmentConfigurationDialog.__generateArguments">__generateArguments</a></td>
60 <td>Private method to generate the process arguments.</td>
61 </tr>
62 <tr>
63 <td><a href="#CondaEnvironmentConfigurationDialog.__updateOK">__updateOK</a></td>
64 <td>Private method to update the enabled status of the OK button.</td>
65 </tr>
66 <tr>
67 <td><a href="#CondaEnvironmentConfigurationDialog.__updateUi">__updateUi</a></td>
68 <td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td>
69 </tr>
70 <tr>
71 <td><a href="#CondaEnvironmentConfigurationDialog.getData">getData</a></td>
72 <td>Public method to retrieve the dialog data.</td>
73 </tr>
74 </table>
75
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80
81
82 <a NAME="CondaEnvironmentConfigurationDialog.__init__" ID="CondaEnvironmentConfigurationDialog.__init__"></a>
83 <h4>CondaEnvironmentConfigurationDialog (Constructor)</h4>
84 <b>CondaEnvironmentConfigurationDialog</b>(<i>baseDir="", parent=None</i>)
85 <p>
86 Constructor
87 </p>
88
89 <dl>
90
91 <dt><i>baseDir</i> (str)</dt>
92 <dd>
93 base directory for the virtual environments
94 </dd>
95 <dt><i>parent</i> (QWidget)</dt>
96 <dd>
97 reference to the parent widget
98 </dd>
99 </dl>
100 <a NAME="CondaEnvironmentConfigurationDialog.__generateArguments" ID="CondaEnvironmentConfigurationDialog.__generateArguments"></a>
101 <h4>CondaEnvironmentConfigurationDialog.__generateArguments</h4>
102 <b>__generateArguments</b>(<i></i>)
103 <p>
104 Private method to generate the process arguments.
105 </p>
106
107 <dl>
108 <dt>Return:</dt>
109 <dd>
110 process arguments
111 </dd>
112 </dl>
113 <dl>
114 <dt>Return Type:</dt>
115 <dd>
116 list of str
117 </dd>
118 </dl>
119 <a NAME="CondaEnvironmentConfigurationDialog.__updateOK" ID="CondaEnvironmentConfigurationDialog.__updateOK"></a>
120 <h4>CondaEnvironmentConfigurationDialog.__updateOK</h4>
121 <b>__updateOK</b>(<i></i>)
122 <p>
123 Private method to update the enabled status of the OK button.
124 </p>
125
126 <a NAME="CondaEnvironmentConfigurationDialog.__updateUi" ID="CondaEnvironmentConfigurationDialog.__updateUi"></a>
127 <h4>CondaEnvironmentConfigurationDialog.__updateUi</h4>
128 <b>__updateUi</b>(<i></i>)
129 <p>
130 Private method to update the UI depending on the selected
131 virtual environment creator (virtualenv or pyvenv).
132 </p>
133
134 <a NAME="CondaEnvironmentConfigurationDialog.getData" ID="CondaEnvironmentConfigurationDialog.getData"></a>
135 <h4>CondaEnvironmentConfigurationDialog.getData</h4>
136 <b>getData</b>(<i></i>)
137 <p>
138 Public method to retrieve the dialog data.
139 </p>
140
141 <dl>
142 <dt>Return:</dt>
143 <dd>
144 dictionary containing the data for the environment creation. The
145 key 'logicalName' contains the environment name to be used with the
146 virtual environment manager and 'arguments' contains the generated
147 command line arguments for the 'conda create' command.
148 </dd>
149 </dl>
150 <dl>
151 <dt>Return Type:</dt>
152 <dd>
153 dict
154 </dd>
155 </dl>
156 <div align="right"><a href="#top">Up</a></div>
157 <hr />
158 </body></html>

eric ide

mercurial