Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvAddEditDialog.html
src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvAddEditDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9001
- a00cd6b55728
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.VirtualEnv.VirtualenvAddEditDialog</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.VirtualEnv.VirtualenvAddEditDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to enter the data of a virtual environment. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#VirtualenvAddEditDialog">VirtualenvAddEditDialog</a></td> | |
| 25 <td>Class implementing a dialog to enter the data of a virtual environment.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="VirtualenvAddEditDialog" ID="VirtualenvAddEditDialog"></a> | |
| 36 <h2>VirtualenvAddEditDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to enter the data of a virtual environment. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QDialog, Ui_VirtualenvAddEditDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#VirtualenvAddEditDialog.__init__">VirtualenvAddEditDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#VirtualenvAddEditDialog.__detectPythonInterpreter">__detectPythonInterpreter</a></td> | |
| 63 <td>Private method to search for a suitable Python interpreter inside an environment.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#VirtualenvAddEditDialog.__updateOk">__updateOk</a></td> | |
| 67 <td>Private slot to update the state of the OK button.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#VirtualenvAddEditDialog.getData">getData</a></td> | |
| 71 <td>Public method to retrieve the entered data.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 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> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#VirtualenvAddEditDialog.on_globalCheckBox_toggled">on_globalCheckBox_toggled</a></td> | |
| 79 <td>Private slot handling a change of the global check box state.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#VirtualenvAddEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> | |
| 83 <td>Private slot to handle changes of the logical name.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#VirtualenvAddEditDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td> | |
| 87 <td>Private slot to handle changes of the virtual environment interpreter.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#VirtualenvAddEditDialog.on_remoteCheckBox_toggled">on_remoteCheckBox_toggled</a></td> | |
| 91 <td>Private slot handling a change of the remote check box state.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <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> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a> | |
| 105 <h4>VirtualenvAddEditDialog (Constructor)</h4> | |
| 106 <b>VirtualenvAddEditDialog</b>(<i>manager, venvName="", venvDirectory="", venvInterpreter="", isGlobal=False, isConda=False, isRemote=False, execPath="", baseDir="", parent=None</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>manager</i> (VirtualenvManager)</dt> | |
| 114 <dd> | |
| 115 reference to the virtual environment manager | |
| 116 </dd> | |
| 117 <dt><i>venvName</i> (str)</dt> | |
| 118 <dd> | |
| 119 logical name of a virtual environment for editing | |
| 120 </dd> | |
| 121 <dt><i>venvDirectory</i> (str)</dt> | |
| 122 <dd> | |
| 123 directory of the virtual environment | |
| 124 </dd> | |
| 125 <dt><i>venvInterpreter</i> (str)</dt> | |
| 126 <dd> | |
| 127 Python interpreter of the virtual environment | |
| 128 </dd> | |
| 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>baseDir</i> (str)</dt> | |
| 147 <dd> | |
| 148 base directory for the virtual environments | |
| 149 </dd> | |
| 150 <dt><i>parent</i> (QWidget)</dt> | |
| 151 <dd> | |
| 152 reference to the parent widget | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <a NAME="VirtualenvAddEditDialog.__detectPythonInterpreter" ID="VirtualenvAddEditDialog.__detectPythonInterpreter"></a> | |
| 156 <h4>VirtualenvAddEditDialog.__detectPythonInterpreter</h4> | |
| 157 <b>__detectPythonInterpreter</b>(<i>venvDirectory</i>) | |
| 158 | |
| 159 <p> | |
| 160 Private method to search for a suitable Python interpreter inside an | |
| 161 environment. | |
| 162 </p> | |
| 163 <dl> | |
| 164 | |
| 165 <dt><i>venvDirectory</i> (str)</dt> | |
| 166 <dd> | |
| 167 directory for the virtual environment | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <dl> | |
| 171 <dt>Return:</dt> | |
| 172 <dd> | |
| 173 detected Python interpreter or empty string | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <dl> | |
| 177 <dt>Return Type:</dt> | |
| 178 <dd> | |
| 179 str | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="VirtualenvAddEditDialog.__updateOk" ID="VirtualenvAddEditDialog.__updateOk"></a> | |
| 183 <h4>VirtualenvAddEditDialog.__updateOk</h4> | |
| 184 <b>__updateOk</b>(<i></i>) | |
| 185 | |
| 186 <p> | |
| 187 Private slot to update the state of the OK button. | |
| 188 </p> | |
| 189 <a NAME="VirtualenvAddEditDialog.getData" ID="VirtualenvAddEditDialog.getData"></a> | |
| 190 <h4>VirtualenvAddEditDialog.getData</h4> | |
| 191 <b>getData</b>(<i></i>) | |
| 192 | |
| 193 <p> | |
| 194 Public method to retrieve the entered data. | |
| 195 </p> | |
| 196 <dl> | |
| 197 <dt>Return:</dt> | |
| 198 <dd> | |
| 199 tuple containing the logical name, the directory, the | |
| 200 interpreter of the virtual environment, a flag indicating a | |
| 201 global environment, a flag indicating an Anaconda environment, | |
| 202 a flag indicating a remotely accessed environment and a string | |
| 203 to be prepended to the PATH environment variable | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <dl> | |
| 207 <dt>Return Type:</dt> | |
| 208 <dd> | |
| 209 tuple of (str, str, str, bool, bool, bool, str) | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a> | |
| 213 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4> | |
| 214 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>) | |
| 215 | |
| 216 <p> | |
| 217 Private slot handling a user click on this check box. | |
| 218 </p> | |
| 219 <dl> | |
| 220 | |
| 221 <dt><i>checked</i> (bool)</dt> | |
| 222 <dd> | |
| 223 state of the check box | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a> | |
| 227 <h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4> | |
| 228 <b>on_globalCheckBox_toggled</b>(<i>checked</i>) | |
| 229 | |
| 230 <p> | |
| 231 Private slot handling a change of the global check box state. | |
| 232 </p> | |
| 233 <dl> | |
| 234 | |
| 235 <dt><i>checked</i> (bool)</dt> | |
| 236 <dd> | |
| 237 state of the check box | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a> | |
| 241 <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4> | |
| 242 <b>on_nameEdit_textChanged</b>(<i>txt</i>) | |
| 243 | |
| 244 <p> | |
| 245 Private slot to handle changes of the logical name. | |
| 246 </p> | |
| 247 <dl> | |
| 248 | |
| 249 <dt><i>txt</i> (str)</dt> | |
| 250 <dd> | |
| 251 current logical name | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <a NAME="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ID="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged"></a> | |
| 255 <h4>VirtualenvAddEditDialog.on_pythonExecPicker_textChanged</h4> | |
| 256 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>) | |
| 257 | |
| 258 <p> | |
| 259 Private slot to handle changes of the virtual environment interpreter. | |
| 260 </p> | |
| 261 <dl> | |
| 262 | |
| 263 <dt><i>txt</i> (str)</dt> | |
| 264 <dd> | |
| 265 virtual environment interpreter | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <a NAME="VirtualenvAddEditDialog.on_remoteCheckBox_toggled" ID="VirtualenvAddEditDialog.on_remoteCheckBox_toggled"></a> | |
| 269 <h4>VirtualenvAddEditDialog.on_remoteCheckBox_toggled</h4> | |
| 270 <b>on_remoteCheckBox_toggled</b>(<i>checked</i>) | |
| 271 | |
| 272 <p> | |
| 273 Private slot handling a change of the remote check box state. | |
| 274 </p> | |
| 275 <dl> | |
| 276 | |
| 277 <dt><i>checked</i> (bool)</dt> | |
| 278 <dd> | |
| 279 state of the check box | |
| 280 </dd> | |
| 281 </dl> | |
| 282 <a NAME="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged"></a> | |
| 283 <h4>VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged</h4> | |
| 284 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>) | |
| 285 | |
| 286 <p> | |
| 287 Private slot to handle changes of the virtual environment directory. | |
| 288 </p> | |
| 289 <dl> | |
| 290 | |
| 291 <dt><i>txt</i> (str)</dt> | |
| 292 <dd> | |
| 293 virtual environment directory | |
| 294 </dd> | |
| 295 </dl> | |
| 296 <div align="right"><a href="#top">Up</a></div> | |
| 297 <hr /> | |
| 298 </body></html> |
