65 <tr> |
65 <tr> |
66 <td><a href="#VirtualenvAddEditDialog.__updateOk">__updateOk</a></td> |
66 <td><a href="#VirtualenvAddEditDialog.__updateOk">__updateOk</a></td> |
67 <td>Private slot to update the state of the OK button.</td> |
67 <td>Private slot to update the state of the OK button.</td> |
68 </tr> |
68 </tr> |
69 <tr> |
69 <tr> |
70 <td><a href="#VirtualenvAddEditDialog.getData">getData</a></td> |
70 <td><a href="#VirtualenvAddEditDialog.getMetaData">getMetaData</a></td> |
71 <td>Public method to retrieve the entered data.</td> |
71 <td>Public method to retrieve the entered metadata.</td> |
72 </tr> |
72 </tr> |
73 <tr> |
73 <tr> |
74 <td><a href="#VirtualenvAddEditDialog.on_anacondaCheckBox_clicked">on_anacondaCheckBox_clicked</a></td> |
74 <td><a href="#VirtualenvAddEditDialog.on_anacondaCheckBox_clicked">on_anacondaCheckBox_clicked</a></td> |
75 <td>Private slot handling a user click on this check box.</td> |
75 <td>Private slot handling a user click on this check box.</td> |
76 </tr> |
76 </tr> |
101 <tr><td>None</td></tr> |
101 <tr><td>None</td></tr> |
102 </table> |
102 </table> |
103 |
103 |
104 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a> |
104 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a> |
105 <h4>VirtualenvAddEditDialog (Constructor)</h4> |
105 <h4>VirtualenvAddEditDialog (Constructor)</h4> |
106 <b>VirtualenvAddEditDialog</b>(<i>manager, venvName="", venvDirectory="", venvInterpreter="", isGlobal=False, isConda=False, isRemote=False, execPath="", description="", baseDir="", parent=None, </i>) |
106 <b>VirtualenvAddEditDialog</b>(<i>manager, metadata=None, baseDir="", parent=None, </i>) |
107 |
107 |
108 <p> |
108 <p> |
109 Constructor |
109 Constructor |
110 </p> |
110 </p> |
111 <dl> |
111 <dl> |
112 |
112 |
113 <dt><i>manager</i> (VirtualenvManager)</dt> |
113 <dt><i>manager</i> (VirtualenvManager)</dt> |
114 <dd> |
114 <dd> |
115 reference to the virtual environment manager |
115 reference to the virtual environment manager |
116 </dd> |
116 </dd> |
117 <dt><i>venvName</i> (str)</dt> |
117 <dt><i>metadata</i> (VirtualenvMetaData (optional))</dt> |
118 <dd> |
118 <dd> |
119 logical name of a virtual environment for editing |
119 object containing the metadata of the virtual environment |
120 </dd> |
120 (defaults to None) |
121 <dt><i>venvDirectory</i> (str)</dt> |
121 </dd> |
122 <dd> |
122 <dt><i>baseDir</i> (str (optional))</dt> |
123 directory of the virtual environment |
123 <dd> |
124 </dd> |
124 base directory for the virtual environments (defaults to "") |
125 <dt><i>venvInterpreter</i> (str)</dt> |
125 </dd> |
126 <dd> |
126 <dt><i>parent</i> (QWidget (optional))</dt> |
127 Python interpreter of the virtual environment |
127 <dd> |
128 </dd> |
128 reference to the parent widget (defaults to None) |
129 <dt><i>isGlobal</i> (bool)</dt> |
|
130 <dd> |
|
131 flag indicating a global environment |
|
132 </dd> |
|
133 <dt><i>isConda</i> (bool)</dt> |
|
134 <dd> |
|
135 flag indicating an Anaconda virtual environment |
|
136 </dd> |
|
137 <dt><i>isRemote</i> (bool)</dt> |
|
138 <dd> |
|
139 flag indicating a remotely accessed environment |
|
140 </dd> |
|
141 <dt><i>execPath</i> (str)</dt> |
|
142 <dd> |
|
143 search path string to be prepended to the PATH |
|
144 environment variable |
|
145 </dd> |
|
146 <dt><i>description</i> (str)</dt> |
|
147 <dd> |
|
148 descriptive text for the environment |
|
149 </dd> |
|
150 <dt><i>baseDir</i> (str)</dt> |
|
151 <dd> |
|
152 base directory for the virtual environments |
|
153 </dd> |
|
154 <dt><i>parent</i> (QWidget)</dt> |
|
155 <dd> |
|
156 reference to the parent widget |
|
157 </dd> |
129 </dd> |
158 </dl> |
130 </dl> |
159 <a NAME="VirtualenvAddEditDialog.__detectPythonInterpreter" ID="VirtualenvAddEditDialog.__detectPythonInterpreter"></a> |
131 <a NAME="VirtualenvAddEditDialog.__detectPythonInterpreter" ID="VirtualenvAddEditDialog.__detectPythonInterpreter"></a> |
160 <h4>VirtualenvAddEditDialog.__detectPythonInterpreter</h4> |
132 <h4>VirtualenvAddEditDialog.__detectPythonInterpreter</h4> |
161 <b>__detectPythonInterpreter</b>(<i>venvDirectory</i>) |
133 <b>__detectPythonInterpreter</b>(<i>venvDirectory</i>) |
188 <b>__updateOk</b>(<i></i>) |
160 <b>__updateOk</b>(<i></i>) |
189 |
161 |
190 <p> |
162 <p> |
191 Private slot to update the state of the OK button. |
163 Private slot to update the state of the OK button. |
192 </p> |
164 </p> |
193 <a NAME="VirtualenvAddEditDialog.getData" ID="VirtualenvAddEditDialog.getData"></a> |
165 <a NAME="VirtualenvAddEditDialog.getMetaData" ID="VirtualenvAddEditDialog.getMetaData"></a> |
194 <h4>VirtualenvAddEditDialog.getData</h4> |
166 <h4>VirtualenvAddEditDialog.getMetaData</h4> |
195 <b>getData</b>(<i></i>) |
167 <b>getMetaData</b>(<i></i>) |
196 |
168 |
197 <p> |
169 <p> |
198 Public method to retrieve the entered data. |
170 Public method to retrieve the entered metadata. |
199 </p> |
171 </p> |
200 <dl> |
172 <dl> |
201 <dt>Return:</dt> |
173 <dt>Return:</dt> |
202 <dd> |
174 <dd> |
203 tuple containing the logical name, the directory, the interpreter of the |
175 metadata for the virtual environment |
204 virtual environment, a flag indicating a global environment, a flag |
|
205 indicating an Anaconda environment, a flag indicating a remotely accessed |
|
206 environment, a string to be prepended to the PATH environment variable and |
|
207 a descriptive text |
|
208 </dd> |
176 </dd> |
209 </dl> |
177 </dl> |
210 <dl> |
178 <dl> |
211 <dt>Return Type:</dt> |
179 <dt>Return Type:</dt> |
212 <dd> |
180 <dd> |
213 tuple of (str, str, str, bool, bool, bool, str, str) |
181 VirtualenvMetaData |
214 </dd> |
182 </dd> |
215 </dl> |
183 </dl> |
216 <a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a> |
184 <a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a> |
217 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4> |
185 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4> |
218 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>) |
186 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>) |