src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvAddEditDialog.html

branch
eric7
changeset 10479
856476537696
parent 10194
2c26b4fe25db
child 10784
521fd465b048
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.VirtualEnv.VirtualenvAddEditDialog</h1> 9 <h1>eric7.VirtualEnv.VirtualenvAddEditDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to enter the data of a virtual environment. 11 Module implementing a dialog to enter the data of a virtual environment.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#VirtualenvAddEditDialog">VirtualenvAddEditDialog</a></td> 22 <td><a href="#VirtualenvAddEditDialog">VirtualenvAddEditDialog</a></td>
25 <td>Class implementing a dialog to enter the data of a virtual environment.</td> 23 <td>Class implementing a dialog to enter the data of a virtual environment.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="VirtualenvAddEditDialog" ID="VirtualenvAddEditDialog"></a> 34 <a NAME="VirtualenvAddEditDialog" ID="VirtualenvAddEditDialog"></a>
36 <h2>VirtualenvAddEditDialog</h2> 35 <h2>VirtualenvAddEditDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to enter the data of a virtual environment. 37 Class implementing a dialog to enter the data of a virtual environment.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_VirtualenvAddEditDialog 41 QDialog, Ui_VirtualenvAddEditDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#VirtualenvAddEditDialog.__init__">VirtualenvAddEditDialog</a></td> 55 <td><a href="#VirtualenvAddEditDialog.__init__">VirtualenvAddEditDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
93 <tr> 90 <tr>
94 <td><a href="#VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td> 91 <td><a href="#VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td>
95 <td>Private slot to handle changes of the virtual environment directory.</td> 92 <td>Private slot to handle changes of the virtual environment directory.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a> 102 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a>
105 <h4>VirtualenvAddEditDialog (Constructor)</h4> 103 <h4>VirtualenvAddEditDialog (Constructor)</h4>
106 <b>VirtualenvAddEditDialog</b>(<i>manager, metadata=None, baseDir="", parent=None, </i>) 104 <b>VirtualenvAddEditDialog</b>(<i>manager, metadata=None, baseDir="", parent=None, </i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>manager</i> (VirtualenvManager)</dt> 111 <dt><i>manager</i> (VirtualenvManager)</dt>
114 <dd> 112 <dd>
115 reference to the virtual environment manager 113 reference to the virtual environment manager
129 </dd> 127 </dd>
130 </dl> 128 </dl>
131 <a NAME="VirtualenvAddEditDialog.__detectPythonInterpreter" ID="VirtualenvAddEditDialog.__detectPythonInterpreter"></a> 129 <a NAME="VirtualenvAddEditDialog.__detectPythonInterpreter" ID="VirtualenvAddEditDialog.__detectPythonInterpreter"></a>
132 <h4>VirtualenvAddEditDialog.__detectPythonInterpreter</h4> 130 <h4>VirtualenvAddEditDialog.__detectPythonInterpreter</h4>
133 <b>__detectPythonInterpreter</b>(<i>venvDirectory</i>) 131 <b>__detectPythonInterpreter</b>(<i>venvDirectory</i>)
134
135 <p> 132 <p>
136 Private method to search for a suitable Python interpreter inside an 133 Private method to search for a suitable Python interpreter inside an
137 environment. 134 environment.
138 </p> 135 </p>
136
139 <dl> 137 <dl>
140 138
141 <dt><i>venvDirectory</i> (str)</dt> 139 <dt><i>venvDirectory</i> (str)</dt>
142 <dd> 140 <dd>
143 directory for the virtual environment 141 directory for the virtual environment
156 </dd> 154 </dd>
157 </dl> 155 </dl>
158 <a NAME="VirtualenvAddEditDialog.__updateOk" ID="VirtualenvAddEditDialog.__updateOk"></a> 156 <a NAME="VirtualenvAddEditDialog.__updateOk" ID="VirtualenvAddEditDialog.__updateOk"></a>
159 <h4>VirtualenvAddEditDialog.__updateOk</h4> 157 <h4>VirtualenvAddEditDialog.__updateOk</h4>
160 <b>__updateOk</b>(<i></i>) 158 <b>__updateOk</b>(<i></i>)
161
162 <p> 159 <p>
163 Private slot to update the state of the OK button. 160 Private slot to update the state of the OK button.
164 </p> 161 </p>
162
165 <a NAME="VirtualenvAddEditDialog.getMetaData" ID="VirtualenvAddEditDialog.getMetaData"></a> 163 <a NAME="VirtualenvAddEditDialog.getMetaData" ID="VirtualenvAddEditDialog.getMetaData"></a>
166 <h4>VirtualenvAddEditDialog.getMetaData</h4> 164 <h4>VirtualenvAddEditDialog.getMetaData</h4>
167 <b>getMetaData</b>(<i></i>) 165 <b>getMetaData</b>(<i></i>)
168
169 <p> 166 <p>
170 Public method to retrieve the entered metadata. 167 Public method to retrieve the entered metadata.
171 </p> 168 </p>
169
172 <dl> 170 <dl>
173 <dt>Return:</dt> 171 <dt>Return:</dt>
174 <dd> 172 <dd>
175 metadata for the virtual environment 173 metadata for the virtual environment
176 </dd> 174 </dd>
182 </dd> 180 </dd>
183 </dl> 181 </dl>
184 <a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a> 182 <a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a>
185 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4> 183 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4>
186 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>) 184 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>)
187
188 <p> 185 <p>
189 Private slot handling a user click on this check box. 186 Private slot handling a user click on this check box.
190 </p> 187 </p>
188
191 <dl> 189 <dl>
192 190
193 <dt><i>checked</i> (bool)</dt> 191 <dt><i>checked</i> (bool)</dt>
194 <dd> 192 <dd>
195 state of the check box 193 state of the check box
196 </dd> 194 </dd>
197 </dl> 195 </dl>
198 <a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a> 196 <a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a>
199 <h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4> 197 <h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4>
200 <b>on_globalCheckBox_toggled</b>(<i>checked</i>) 198 <b>on_globalCheckBox_toggled</b>(<i>checked</i>)
201
202 <p> 199 <p>
203 Private slot handling a change of the global check box state. 200 Private slot handling a change of the global check box state.
204 </p> 201 </p>
202
205 <dl> 203 <dl>
206 204
207 <dt><i>checked</i> (bool)</dt> 205 <dt><i>checked</i> (bool)</dt>
208 <dd> 206 <dd>
209 state of the check box 207 state of the check box
210 </dd> 208 </dd>
211 </dl> 209 </dl>
212 <a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a> 210 <a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a>
213 <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4> 211 <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4>
214 <b>on_nameEdit_textChanged</b>(<i>txt</i>) 212 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
215
216 <p> 213 <p>
217 Private slot to handle changes of the logical name. 214 Private slot to handle changes of the logical name.
218 </p> 215 </p>
216
219 <dl> 217 <dl>
220 218
221 <dt><i>txt</i> (str)</dt> 219 <dt><i>txt</i> (str)</dt>
222 <dd> 220 <dd>
223 current logical name 221 current logical name
224 </dd> 222 </dd>
225 </dl> 223 </dl>
226 <a NAME="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ID="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged"></a> 224 <a NAME="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ID="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged"></a>
227 <h4>VirtualenvAddEditDialog.on_pythonExecPicker_textChanged</h4> 225 <h4>VirtualenvAddEditDialog.on_pythonExecPicker_textChanged</h4>
228 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>) 226 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
229
230 <p> 227 <p>
231 Private slot to handle changes of the virtual environment interpreter. 228 Private slot to handle changes of the virtual environment interpreter.
232 </p> 229 </p>
230
233 <dl> 231 <dl>
234 232
235 <dt><i>txt</i> (str)</dt> 233 <dt><i>txt</i> (str)</dt>
236 <dd> 234 <dd>
237 virtual environment interpreter 235 virtual environment interpreter
238 </dd> 236 </dd>
239 </dl> 237 </dl>
240 <a NAME="VirtualenvAddEditDialog.on_remoteCheckBox_toggled" ID="VirtualenvAddEditDialog.on_remoteCheckBox_toggled"></a> 238 <a NAME="VirtualenvAddEditDialog.on_remoteCheckBox_toggled" ID="VirtualenvAddEditDialog.on_remoteCheckBox_toggled"></a>
241 <h4>VirtualenvAddEditDialog.on_remoteCheckBox_toggled</h4> 239 <h4>VirtualenvAddEditDialog.on_remoteCheckBox_toggled</h4>
242 <b>on_remoteCheckBox_toggled</b>(<i>checked</i>) 240 <b>on_remoteCheckBox_toggled</b>(<i>checked</i>)
243
244 <p> 241 <p>
245 Private slot handling a change of the remote check box state. 242 Private slot handling a change of the remote check box state.
246 </p> 243 </p>
244
247 <dl> 245 <dl>
248 246
249 <dt><i>checked</i> (bool)</dt> 247 <dt><i>checked</i> (bool)</dt>
250 <dd> 248 <dd>
251 state of the check box 249 state of the check box
252 </dd> 250 </dd>
253 </dl> 251 </dl>
254 <a NAME="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged"></a> 252 <a NAME="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged"></a>
255 <h4>VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged</h4> 253 <h4>VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged</h4>
256 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>) 254 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>)
257
258 <p> 255 <p>
259 Private slot to handle changes of the virtual environment directory. 256 Private slot to handle changes of the virtual environment directory.
260 </p> 257 </p>
258
261 <dl> 259 <dl>
262 260
263 <dt><i>txt</i> (str)</dt> 261 <dt><i>txt</i> (str)</dt>
264 <dd> 262 <dd>
265 virtual environment directory 263 virtual environment directory

eric ide

mercurial