Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.VirtualEnv.VirtualenvConfigurationDialog.html
Documentation/Source/eric6.VirtualEnv.VirtualenvConfigurationDialog.html
- changeset 6339
- d765c3204c71
- child 6770
- 4782d2b8e1bd
equal
deleted
inserted
replaced
| 6338:104ee21d765d | 6339:d765c3204c71 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.VirtualEnv.VirtualenvConfigurationDialog</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.VirtualenvConfigurationDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter the parameters for the | |
| 25 virtual environment. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#VirtualenvConfigurationDialog">VirtualenvConfigurationDialog</a></td> | |
| 35 <td>Class implementing a dialog to enter the parameters for the virtual environment.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="VirtualenvConfigurationDialog" ID="VirtualenvConfigurationDialog"></a> | |
| 44 <h2>VirtualenvConfigurationDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to enter the parameters for the | |
| 47 virtual environment. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QDialog, Ui_VirtualenvConfigurationDialog | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#VirtualenvConfigurationDialog.__init__">VirtualenvConfigurationDialog</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#VirtualenvConfigurationDialog.__generateArguments">__generateArguments</a></td> | |
| 66 <td>Private method to generate the process arguments.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#VirtualenvConfigurationDialog.__generateTargetDir">__generateTargetDir</a></td> | |
| 69 <td>Private method to generate a valid target directory path.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#VirtualenvConfigurationDialog.__setPyvenvVersion">__setPyvenvVersion</a></td> | |
| 72 <td>Private method to determine the pyvenv version and set the respective label.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#VirtualenvConfigurationDialog.__setVirtualenvVersion">__setVirtualenvVersion</a></td> | |
| 75 <td>Private method to determine the virtualenv version and set the respective label.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#VirtualenvConfigurationDialog.__updateOK">__updateOK</a></td> | |
| 78 <td>Private method to update the enabled status of the OK button.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#VirtualenvConfigurationDialog.__updateUi">__updateUi</a></td> | |
| 81 <td>Private method to update the UI depending on the selected virtual environment creator (virtualenv or pyvenv).</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#VirtualenvConfigurationDialog.getData">getData</a></td> | |
| 84 <td>Public method to retrieve the dialog data.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged">on_pythonExecPicker_textChanged</a></td> | |
| 87 <td>Private slot to react to a change of the Python executable.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#VirtualenvConfigurationDialog.on_pyvenvButton_toggled">on_pyvenvButton_toggled</a></td> | |
| 90 <td>Private slot to react to the selection of 'pyvenv'.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged">on_targetDirectoryPicker_textChanged</a></td> | |
| 93 <td>Private slot handling a change of the target directory.</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#VirtualenvConfigurationDialog.on_virtualenvButton_toggled">on_virtualenvButton_toggled</a></td> | |
| 96 <td>Private slot to react to the selection of 'virtualenv'.</td> | |
| 97 </tr> | |
| 98 </table> | |
| 99 <h3>Static Methods</h3> | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 <a NAME="VirtualenvConfigurationDialog.__init__" ID="VirtualenvConfigurationDialog.__init__"></a> | |
| 104 <h4>VirtualenvConfigurationDialog (Constructor)</h4> | |
| 105 <b>VirtualenvConfigurationDialog</b>(<i>parent=None</i>) | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p><dl> | |
| 109 <dt><i>parent</i> (QWidget)</dt> | |
| 110 <dd> | |
| 111 reference to the parent widget | |
| 112 </dd> | |
| 113 </dl><a NAME="VirtualenvConfigurationDialog.__generateArguments" ID="VirtualenvConfigurationDialog.__generateArguments"></a> | |
| 114 <h4>VirtualenvConfigurationDialog.__generateArguments</h4> | |
| 115 <b>__generateArguments</b>(<i></i>) | |
| 116 <p> | |
| 117 Private method to generate the process arguments. | |
| 118 </p><dl> | |
| 119 <dt>Returns:</dt> | |
| 120 <dd> | |
| 121 process arguments | |
| 122 </dd> | |
| 123 </dl><dl> | |
| 124 <dt>Return Type:</dt> | |
| 125 <dd> | |
| 126 list of str | |
| 127 </dd> | |
| 128 </dl><a NAME="VirtualenvConfigurationDialog.__generateTargetDir" ID="VirtualenvConfigurationDialog.__generateTargetDir"></a> | |
| 129 <h4>VirtualenvConfigurationDialog.__generateTargetDir</h4> | |
| 130 <b>__generateTargetDir</b>(<i></i>) | |
| 131 <p> | |
| 132 Private method to generate a valid target directory path. | |
| 133 </p><dl> | |
| 134 <dt>Returns:</dt> | |
| 135 <dd> | |
| 136 target directory path | |
| 137 </dd> | |
| 138 </dl><dl> | |
| 139 <dt>Return Type:</dt> | |
| 140 <dd> | |
| 141 str | |
| 142 </dd> | |
| 143 </dl><a NAME="VirtualenvConfigurationDialog.__setPyvenvVersion" ID="VirtualenvConfigurationDialog.__setPyvenvVersion"></a> | |
| 144 <h4>VirtualenvConfigurationDialog.__setPyvenvVersion</h4> | |
| 145 <b>__setPyvenvVersion</b>(<i></i>) | |
| 146 <p> | |
| 147 Private method to determine the pyvenv version and set the respective | |
| 148 label. | |
| 149 </p><a NAME="VirtualenvConfigurationDialog.__setVirtualenvVersion" ID="VirtualenvConfigurationDialog.__setVirtualenvVersion"></a> | |
| 150 <h4>VirtualenvConfigurationDialog.__setVirtualenvVersion</h4> | |
| 151 <b>__setVirtualenvVersion</b>(<i></i>) | |
| 152 <p> | |
| 153 Private method to determine the virtualenv version and set the | |
| 154 respective label. | |
| 155 </p><a NAME="VirtualenvConfigurationDialog.__updateOK" ID="VirtualenvConfigurationDialog.__updateOK"></a> | |
| 156 <h4>VirtualenvConfigurationDialog.__updateOK</h4> | |
| 157 <b>__updateOK</b>(<i></i>) | |
| 158 <p> | |
| 159 Private method to update the enabled status of the OK button. | |
| 160 </p><a NAME="VirtualenvConfigurationDialog.__updateUi" ID="VirtualenvConfigurationDialog.__updateUi"></a> | |
| 161 <h4>VirtualenvConfigurationDialog.__updateUi</h4> | |
| 162 <b>__updateUi</b>(<i></i>) | |
| 163 <p> | |
| 164 Private method to update the UI depending on the selected | |
| 165 virtual environment creator (virtualenv or pyvenv). | |
| 166 </p><a NAME="VirtualenvConfigurationDialog.getData" ID="VirtualenvConfigurationDialog.getData"></a> | |
| 167 <h4>VirtualenvConfigurationDialog.getData</h4> | |
| 168 <b>getData</b>(<i></i>) | |
| 169 <p> | |
| 170 Public method to retrieve the dialog data. | |
| 171 </p><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 174 tuple containing a flag indicating the pyvenv selection, the | |
| 175 process arguments, a name for the virtual environment, a flag | |
| 176 indicating to open the target directory after creation, a flag | |
| 177 indicating to write a log file, a flag indicating to write a | |
| 178 script, the name of the target directory and the name of the | |
| 179 Python interpreter to use | |
| 180 </dd> | |
| 181 </dl><dl> | |
| 182 <dt>Return Type:</dt> | |
| 183 <dd> | |
| 184 tuple of (bool, list of str, str, bool, bool, bool, str, str) | |
| 185 </dd> | |
| 186 </dl><a NAME="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged" ID="VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged"></a> | |
| 187 <h4>VirtualenvConfigurationDialog.on_pythonExecPicker_textChanged</h4> | |
| 188 <b>on_pythonExecPicker_textChanged</b>(<i>txt</i>) | |
| 189 <p> | |
| 190 Private slot to react to a change of the Python executable. | |
| 191 </p><dl> | |
| 192 <dt><i>txt</i> (str)</dt> | |
| 193 <dd> | |
| 194 contents of the picker's line edit | |
| 195 </dd> | |
| 196 </dl><a NAME="VirtualenvConfigurationDialog.on_pyvenvButton_toggled" ID="VirtualenvConfigurationDialog.on_pyvenvButton_toggled"></a> | |
| 197 <h4>VirtualenvConfigurationDialog.on_pyvenvButton_toggled</h4> | |
| 198 <b>on_pyvenvButton_toggled</b>(<i>checked</i>) | |
| 199 <p> | |
| 200 Private slot to react to the selection of 'pyvenv'. | |
| 201 </p><dl> | |
| 202 <dt><i>checked</i> (bool)</dt> | |
| 203 <dd> | |
| 204 state of the checkbox | |
| 205 </dd> | |
| 206 </dl><a NAME="VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged" ID="VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged"></a> | |
| 207 <h4>VirtualenvConfigurationDialog.on_targetDirectoryPicker_textChanged</h4> | |
| 208 <b>on_targetDirectoryPicker_textChanged</b>(<i>txt</i>) | |
| 209 <p> | |
| 210 Private slot handling a change of the target directory. | |
| 211 </p><dl> | |
| 212 <dt><i>txt</i> (str)</dt> | |
| 213 <dd> | |
| 214 target directory | |
| 215 </dd> | |
| 216 </dl><a NAME="VirtualenvConfigurationDialog.on_virtualenvButton_toggled" ID="VirtualenvConfigurationDialog.on_virtualenvButton_toggled"></a> | |
| 217 <h4>VirtualenvConfigurationDialog.on_virtualenvButton_toggled</h4> | |
| 218 <b>on_virtualenvButton_toggled</b>(<i>checked</i>) | |
| 219 <p> | |
| 220 Private slot to react to the selection of 'virtualenv'. | |
| 221 </p><dl> | |
| 222 <dt><i>checked</i> (bool)</dt> | |
| 223 <dd> | |
| 224 state of the checkbox | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <div align="right"><a href="#top">Up</a></div> | |
| 228 <hr /> | |
| 229 </body></html> |
