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