Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvAddEditDialog.html

eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvAddEditDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7635
0cdead130a81
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.VirtualEnv.VirtualenvAddEditDialog</h1> 23 <h1>eric6.VirtualEnv.VirtualenvAddEditDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to enter the data of a virtual environment. 26 Module implementing a dialog to enter the data of a virtual environment.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#VirtualenvAddEditDialog">VirtualenvAddEditDialog</a></td> 38 <td><a href="#VirtualenvAddEditDialog">VirtualenvAddEditDialog</a></td>
34 <td>Class implementing a dialog to enter the data of a virtual environment.</td> 39 <td>Class implementing a dialog to enter the data of a virtual environment.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="VirtualenvAddEditDialog" ID="VirtualenvAddEditDialog"></a> 49 <a NAME="VirtualenvAddEditDialog" ID="VirtualenvAddEditDialog"></a>
43 <h2>VirtualenvAddEditDialog</h2> 50 <h2>VirtualenvAddEditDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to enter the data of a virtual environment. 53 Class implementing a dialog to enter the data of a virtual environment.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_VirtualenvAddEditDialog 56 QDialog, Ui_VirtualenvAddEditDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#VirtualenvAddEditDialog.__init__">VirtualenvAddEditDialog</a></td> 72 <td><a href="#VirtualenvAddEditDialog.__init__">VirtualenvAddEditDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#VirtualenvAddEditDialog.__updateOk">__updateOk</a></td> 76 <td><a href="#VirtualenvAddEditDialog.__updateOk">__updateOk</a></td>
64 <td>Private slot to update the state of the OK button.</td> 77 <td>Private slot to update the state of the OK button.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#VirtualenvAddEditDialog.getData">getData</a></td> 80 <td><a href="#VirtualenvAddEditDialog.getData">getData</a></td>
67 <td>Public method to retrieve the entered data.</td> 81 <td>Public method to retrieve the entered data.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#VirtualenvAddEditDialog.on_anacondaCheckBox_clicked">on_anacondaCheckBox_clicked</a></td> 84 <td><a href="#VirtualenvAddEditDialog.on_anacondaCheckBox_clicked">on_anacondaCheckBox_clicked</a></td>
70 <td>Private slot handling a user click on this check box.</td> 85 <td>Private slot handling a user click on this check box.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#VirtualenvAddEditDialog.on_globalCheckBox_toggled">on_globalCheckBox_toggled</a></td> 88 <td><a href="#VirtualenvAddEditDialog.on_globalCheckBox_toggled">on_globalCheckBox_toggled</a></td>
73 <td>Private slot handling a change of the global check box state.</td> 89 <td>Private slot handling a change of the global check box state.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#VirtualenvAddEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> 92 <td><a href="#VirtualenvAddEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
76 <td>Private slot to handle changes of the logical name.</td> 93 <td>Private slot to handle changes of the logical name.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#VirtualenvAddEditDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td> 96 <td><a href="#VirtualenvAddEditDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td>
79 <td>Private slot to handle changes of the virtual environment interpreter.</td> 97 <td>Private slot to handle changes of the virtual environment interpreter.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#VirtualenvAddEditDialog.on_remoteCheckBox_toggled">on_remoteCheckBox_toggled</a></td> 100 <td><a href="#VirtualenvAddEditDialog.on_remoteCheckBox_toggled">on_remoteCheckBox_toggled</a></td>
82 <td>Private slot handling a change of the remote check box state.</td> 101 <td>Private slot handling a change of the remote check box state.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td> 104 <td><a href="#VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td>
85 <td>Private slot to handle changes of the virtual environment directory.</td> 105 <td>Private slot to handle changes of the virtual environment directory.</td>
86 </tr> 106 </tr>
87 </table> 107 </table>
88 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
89 <table> 109
90 <tr><td>None</td></tr> 110 <table>
91 </table> 111 <tr><td>None</td></tr>
112 </table>
113
92 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a> 114 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a>
93 <h4>VirtualenvAddEditDialog (Constructor)</h4> 115 <h4>VirtualenvAddEditDialog (Constructor)</h4>
94 <b>VirtualenvAddEditDialog</b>(<i>manager, venvName="", venvDirectory="", venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath="", parent=None</i>) 116 <b>VirtualenvAddEditDialog</b>(<i>manager, venvName="", venvDirectory="", venvInterpreter="", venvVariant=3, isGlobal=False, isConda=False, isRemote=False, execPath="", parent=None</i>)
117
95 <p> 118 <p>
96 Constructor 119 Constructor
97 </p><dl> 120 </p>
121 <dl>
122
98 <dt><i>manager</i> (VirtualenvManager)</dt> 123 <dt><i>manager</i> (VirtualenvManager)</dt>
99 <dd> 124 <dd>
100 reference to the virtual environment manager 125 reference to the virtual environment manager
101 </dd><dt><i>venvName</i> (str)</dt> 126 </dd>
127 <dt><i>venvName</i> (str)</dt>
102 <dd> 128 <dd>
103 logical name of a virtual environment for editing 129 logical name of a virtual environment for editing
104 </dd><dt><i>venvDirectory</i> (str)</dt> 130 </dd>
131 <dt><i>venvDirectory</i> (str)</dt>
105 <dd> 132 <dd>
106 directory of the virtual environment 133 directory of the virtual environment
107 </dd><dt><i>venvInterpreter</i> (str)</dt> 134 </dd>
135 <dt><i>venvInterpreter</i> (str)</dt>
108 <dd> 136 <dd>
109 Python interpreter of the virtual environment 137 Python interpreter of the virtual environment
110 </dd><dt><i>venvVariant</i> (int)</dt> 138 </dd>
139 <dt><i>venvVariant</i> (int)</dt>
111 <dd> 140 <dd>
112 Python variant of the virtual environment 141 Python variant of the virtual environment
113 </dd><dt><i>isGlobal</i> (bool)</dt> 142 </dd>
143 <dt><i>isGlobal</i> (bool)</dt>
114 <dd> 144 <dd>
115 flag indicating a global environment 145 flag indicating a global environment
116 </dd><dt><i>isConda</i> (bool)</dt> 146 </dd>
147 <dt><i>isConda</i> (bool)</dt>
117 <dd> 148 <dd>
118 flag indicating an Anaconda virtual environment 149 flag indicating an Anaconda virtual environment
119 </dd><dt><i>isRemote</i> (bool)</dt> 150 </dd>
151 <dt><i>isRemote</i> (bool)</dt>
120 <dd> 152 <dd>
121 flag indicating a remotely accessed environment 153 flag indicating a remotely accessed environment
122 </dd><dt><i>execPath</i> (str)</dt> 154 </dd>
155 <dt><i>execPath</i> (str)</dt>
123 <dd> 156 <dd>
124 search path string to be prepended to the PATH 157 search path string to be prepended to the PATH
125 environment variable 158 environment variable
126 </dd><dt><i>parent</i> (QWidget)</dt> 159 </dd>
160 <dt><i>parent</i> (QWidget)</dt>
127 <dd> 161 <dd>
128 reference to the parent widget 162 reference to the parent widget
129 </dd> 163 </dd>
130 </dl><a NAME="VirtualenvAddEditDialog.__updateOk" ID="VirtualenvAddEditDialog.__updateOk"></a> 164 </dl>
165 <a NAME="VirtualenvAddEditDialog.__updateOk" ID="VirtualenvAddEditDialog.__updateOk"></a>
131 <h4>VirtualenvAddEditDialog.__updateOk</h4> 166 <h4>VirtualenvAddEditDialog.__updateOk</h4>
132 <b>__updateOk</b>(<i></i>) 167 <b>__updateOk</b>(<i></i>)
168
133 <p> 169 <p>
134 Private slot to update the state of the OK button. 170 Private slot to update the state of the OK button.
135 </p><a NAME="VirtualenvAddEditDialog.getData" ID="VirtualenvAddEditDialog.getData"></a> 171 </p>
172 <a NAME="VirtualenvAddEditDialog.getData" ID="VirtualenvAddEditDialog.getData"></a>
136 <h4>VirtualenvAddEditDialog.getData</h4> 173 <h4>VirtualenvAddEditDialog.getData</h4>
137 <b>getData</b>(<i></i>) 174 <b>getData</b>(<i></i>)
175
138 <p> 176 <p>
139 Public method to retrieve the entered data. 177 Public method to retrieve the entered data.
140 </p><dl> 178 </p>
179 <dl>
141 <dt>Returns:</dt> 180 <dt>Returns:</dt>
142 <dd> 181 <dd>
143 tuple containing the logical name, the directory, the 182 tuple containing the logical name, the directory, the
144 interpreter of the virtual environment, the Python variant, 183 interpreter of the virtual environment, the Python variant,
145 a flag indicating a global environment, a flag indicating an 184 a flag indicating a global environment, a flag indicating an
146 Anaconda environment, aflag indicating a remotely accessed 185 Anaconda environment, aflag indicating a remotely accessed
147 environment and a string to be prepended to the PATH environment 186 environment and a string to be prepended to the PATH environment
148 variable 187 variable
149 </dd> 188 </dd>
150 </dl><dl> 189 </dl>
190 <dl>
151 <dt>Return Type:</dt> 191 <dt>Return Type:</dt>
152 <dd> 192 <dd>
153 tuple of (str, str, str, int, bool, bool, bool, str) 193 tuple of (str, str, str, int, bool, bool, bool, str)
154 </dd> 194 </dd>
155 </dl><a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a> 195 </dl>
196 <a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a>
156 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4> 197 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4>
157 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>) 198 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>)
199
158 <p> 200 <p>
159 Private slot handling a user click on this check box. 201 Private slot handling a user click on this check box.
160 </p><dl> 202 </p>
203 <dl>
204
161 <dt><i>checked</i> (bool)</dt> 205 <dt><i>checked</i> (bool)</dt>
162 <dd> 206 <dd>
163 state of the check box 207 state of the check box
164 </dd> 208 </dd>
165 </dl><a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a> 209 </dl>
210 <a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a>
166 <h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4> 211 <h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4>
167 <b>on_globalCheckBox_toggled</b>(<i>checked</i>) 212 <b>on_globalCheckBox_toggled</b>(<i>checked</i>)
213
168 <p> 214 <p>
169 Private slot handling a change of the global check box state. 215 Private slot handling a change of the global check box state.
170 </p><dl> 216 </p>
217 <dl>
218
171 <dt><i>checked</i> (bool)</dt> 219 <dt><i>checked</i> (bool)</dt>
172 <dd> 220 <dd>
173 state of the check box 221 state of the check box
174 </dd> 222 </dd>
175 </dl><a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a> 223 </dl>
224 <a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a>
176 <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4> 225 <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4>
177 <b>on_nameEdit_textChanged</b>(<i>txt</i>) 226 <b>on_nameEdit_textChanged</b>(<i>txt</i>)
227
178 <p> 228 <p>
179 Private slot to handle changes of the logical name. 229 Private slot to handle changes of the logical name.
180 </p><dl> 230 </p>
231 <dl>
232
181 <dt><i>txt</i> (str)</dt> 233 <dt><i>txt</i> (str)</dt>
182 <dd> 234 <dd>
183 current logical name 235 current logical name
184 </dd> 236 </dd>
185 </dl><a NAME="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ID="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged"></a> 237 </dl>
238 <a NAME="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ID="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged"></a>
186 <h4>VirtualenvAddEditDialog.on_pythonExecPicker_textChanged</h4> 239 <h4>VirtualenvAddEditDialog.on_pythonExecPicker_textChanged</h4>
187 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>) 240 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>)
241
188 <p> 242 <p>
189 Private slot to handle changes of the virtual environment interpreter. 243 Private slot to handle changes of the virtual environment interpreter.
190 </p><dl> 244 </p>
245 <dl>
246
191 <dt><i>txt</i> (str)</dt> 247 <dt><i>txt</i> (str)</dt>
192 <dd> 248 <dd>
193 virtual environment interpreter 249 virtual environment interpreter
194 </dd> 250 </dd>
195 </dl><a NAME="VirtualenvAddEditDialog.on_remoteCheckBox_toggled" ID="VirtualenvAddEditDialog.on_remoteCheckBox_toggled"></a> 251 </dl>
252 <a NAME="VirtualenvAddEditDialog.on_remoteCheckBox_toggled" ID="VirtualenvAddEditDialog.on_remoteCheckBox_toggled"></a>
196 <h4>VirtualenvAddEditDialog.on_remoteCheckBox_toggled</h4> 253 <h4>VirtualenvAddEditDialog.on_remoteCheckBox_toggled</h4>
197 <b>on_remoteCheckBox_toggled</b>(<i>checked</i>) 254 <b>on_remoteCheckBox_toggled</b>(<i>checked</i>)
255
198 <p> 256 <p>
199 Private slot handling a change of the remote check box state. 257 Private slot handling a change of the remote check box state.
200 </p><dl> 258 </p>
259 <dl>
260
201 <dt><i>checked</i> (bool)</dt> 261 <dt><i>checked</i> (bool)</dt>
202 <dd> 262 <dd>
203 state of the check box 263 state of the check box
204 </dd> 264 </dd>
205 </dl><a NAME="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged"></a> 265 </dl>
266 <a NAME="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged"></a>
206 <h4>VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged</h4> 267 <h4>VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged</h4>
207 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>) 268 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>)
269
208 <p> 270 <p>
209 Private slot to handle changes of the virtual environment directory. 271 Private slot to handle changes of the virtual environment directory.
210 </p><dl> 272 </p>
273 <dl>
274
211 <dt><i>txt</i> (str)</dt> 275 <dt><i>txt</i> (str)</dt>
212 <dd> 276 <dd>
213 virtual environment directory 277 virtual environment directory
214 </dd> 278 </dd>
215 </dl> 279 </dl>

Mercurial Repository: eric

eric ide

mercurial