Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvAddEditDialog.html
eric6/Documentation/Source/eric6.VirtualEnv.VirtualenvAddEditDialog.html
- changeset 6942
- 2602857055c5
- parent 6716
- 1c9d3b369ea8
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.VirtualEnv.VirtualenvAddEditDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter the data of a virtual environment. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#VirtualenvAddEditDialog">VirtualenvAddEditDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter the data of a virtual environment.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="VirtualenvAddEditDialog" ID="VirtualenvAddEditDialog"></a> | |
| 43 <h2>VirtualenvAddEditDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter the data of a virtual environment. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_VirtualenvAddEditDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#VirtualenvAddEditDialog.__init__">VirtualenvAddEditDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#VirtualenvAddEditDialog.__updateOk">__updateOk</a></td> | |
| 64 <td>Private slot to update the state of the OK button.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#VirtualenvAddEditDialog.getData">getData</a></td> | |
| 67 <td>Public method to retrieve the entered data.</td> | |
| 68 </tr><tr> | |
| 69 <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> | |
| 71 </tr><tr> | |
| 72 <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> | |
| 74 </tr><tr> | |
| 75 <td><a href="#VirtualenvAddEditDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> | |
| 76 <td>Private slot to handle changes of the logical name.</td> | |
| 77 </tr><tr> | |
| 78 <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> | |
| 80 </tr><tr> | |
| 81 <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> | |
| 83 </tr><tr> | |
| 84 <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> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <h3>Static Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <a NAME="VirtualenvAddEditDialog.__init__" ID="VirtualenvAddEditDialog.__init__"></a> | |
| 93 <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>) | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p><dl> | |
| 98 <dt><i>manager</i> (VirtualenvManager)</dt> | |
| 99 <dd> | |
| 100 reference to the virtual environment manager | |
| 101 </dd><dt><i>venvName</i> (str)</dt> | |
| 102 <dd> | |
| 103 logical name of a virtual environment for editing | |
| 104 </dd><dt><i>venvDirectory</i> (str)</dt> | |
| 105 <dd> | |
| 106 directory of the virtual environment | |
| 107 </dd><dt><i>venvInterpreter</i> (str)</dt> | |
| 108 <dd> | |
| 109 Python interpreter of the virtual environment | |
| 110 </dd><dt><i>venvVariant</i> (int)</dt> | |
| 111 <dd> | |
| 112 Python variant of the virtual environment | |
| 113 </dd><dt><i>isGlobal</i> (bool)</dt> | |
| 114 <dd> | |
| 115 flag indicating a global environment | |
| 116 </dd><dt><i>isConda</i> (bool)</dt> | |
| 117 <dd> | |
| 118 flag indicating an Anaconda virtual environment | |
| 119 </dd><dt><i>isRemote</i> (bool)</dt> | |
| 120 <dd> | |
| 121 flag indicating a remotely accessed environment | |
| 122 </dd><dt><i>execPath</i> (str)</dt> | |
| 123 <dd> | |
| 124 search path string to be prepended to the PATH | |
| 125 environment variable | |
| 126 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 127 <dd> | |
| 128 reference to the parent widget | |
| 129 </dd> | |
| 130 </dl><a NAME="VirtualenvAddEditDialog.__updateOk" ID="VirtualenvAddEditDialog.__updateOk"></a> | |
| 131 <h4>VirtualenvAddEditDialog.__updateOk</h4> | |
| 132 <b>__updateOk</b>(<i></i>) | |
| 133 <p> | |
| 134 Private slot to update the state of the OK button. | |
| 135 </p><a NAME="VirtualenvAddEditDialog.getData" ID="VirtualenvAddEditDialog.getData"></a> | |
| 136 <h4>VirtualenvAddEditDialog.getData</h4> | |
| 137 <b>getData</b>(<i></i>) | |
| 138 <p> | |
| 139 Public method to retrieve the entered data. | |
| 140 </p><dl> | |
| 141 <dt>Returns:</dt> | |
| 142 <dd> | |
| 143 tuple containing the logical name, the directory, the | |
| 144 interpreter of the virtual environment, the Python variant, | |
| 145 a flag indicating a global environment, a flag indicating an | |
| 146 Anaconda environment, aflag indicating a remotely accessed | |
| 147 environment and a string to be prepended to the PATH environment | |
| 148 variable | |
| 149 </dd> | |
| 150 </dl><dl> | |
| 151 <dt>Return Type:</dt> | |
| 152 <dd> | |
| 153 tuple of (str, str, str, int, bool, bool, bool, str) | |
| 154 </dd> | |
| 155 </dl><a NAME="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked" ID="VirtualenvAddEditDialog.on_anacondaCheckBox_clicked"></a> | |
| 156 <h4>VirtualenvAddEditDialog.on_anacondaCheckBox_clicked</h4> | |
| 157 <b>on_anacondaCheckBox_clicked</b>(<i>checked</i>) | |
| 158 <p> | |
| 159 Private slot handling a user click on this check box. | |
| 160 </p><dl> | |
| 161 <dt><i>checked</i> (bool)</dt> | |
| 162 <dd> | |
| 163 state of the check box | |
| 164 </dd> | |
| 165 </dl><a NAME="VirtualenvAddEditDialog.on_globalCheckBox_toggled" ID="VirtualenvAddEditDialog.on_globalCheckBox_toggled"></a> | |
| 166 <h4>VirtualenvAddEditDialog.on_globalCheckBox_toggled</h4> | |
| 167 <b>on_globalCheckBox_toggled</b>(<i>checked</i>) | |
| 168 <p> | |
| 169 Private slot handling a change of the global check box state. | |
| 170 </p><dl> | |
| 171 <dt><i>checked</i> (bool)</dt> | |
| 172 <dd> | |
| 173 state of the check box | |
| 174 </dd> | |
| 175 </dl><a NAME="VirtualenvAddEditDialog.on_nameEdit_textChanged" ID="VirtualenvAddEditDialog.on_nameEdit_textChanged"></a> | |
| 176 <h4>VirtualenvAddEditDialog.on_nameEdit_textChanged</h4> | |
| 177 <b>on_nameEdit_textChanged</b>(<i>txt</i>) | |
| 178 <p> | |
| 179 Private slot to handle changes of the logical name. | |
| 180 </p><dl> | |
| 181 <dt><i>txt</i> (str)</dt> | |
| 182 <dd> | |
| 183 current logical name | |
| 184 </dd> | |
| 185 </dl><a NAME="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged" ID="VirtualenvAddEditDialog.on_pythonExecPicker_textChanged"></a> | |
| 186 <h4>VirtualenvAddEditDialog.on_pythonExecPicker_textChanged</h4> | |
| 187 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>) | |
| 188 <p> | |
| 189 Private slot to handle changes of the virtual environment interpreter. | |
| 190 </p><dl> | |
| 191 <dt><i>txt</i> (str)</dt> | |
| 192 <dd> | |
| 193 virtual environment interpreter | |
| 194 </dd> | |
| 195 </dl><a NAME="VirtualenvAddEditDialog.on_remoteCheckBox_toggled" ID="VirtualenvAddEditDialog.on_remoteCheckBox_toggled"></a> | |
| 196 <h4>VirtualenvAddEditDialog.on_remoteCheckBox_toggled</h4> | |
| 197 <b>on_remoteCheckBox_toggled</b>(<i>checked</i>) | |
| 198 <p> | |
| 199 Private slot handling a change of the remote check box state. | |
| 200 </p><dl> | |
| 201 <dt><i>checked</i> (bool)</dt> | |
| 202 <dd> | |
| 203 state of the check box | |
| 204 </dd> | |
| 205 </dl><a NAME="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged"></a> | |
| 206 <h4>VirtualenvAddEditDialog.on_targetDirectoryPicker_textChanged</h4> | |
| 207 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>) | |
| 208 <p> | |
| 209 Private slot to handle changes of the virtual environment directory. | |
| 210 </p><dl> | |
| 211 <dt><i>txt</i> (str)</dt> | |
| 212 <dd> | |
| 213 virtual environment directory | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <div align="right"><a href="#top">Up</a></div> | |
| 217 <hr /> | |
| 218 </body></html> |
