Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManagerWidgets.html
src/eric7/Documentation/Source/eric7.VirtualEnv.VirtualenvManagerWidgets.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9144
- 135240382a3e
- child 9434
- ef86a77942f2
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.VirtualEnv.VirtualenvManagerWidgets</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.VirtualenvManagerWidgets</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to manage the list of defined virtual | |
| 13 environments. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#VirtualenvManagerDialog">VirtualenvManagerDialog</a></td> | |
| 26 <td>Class implementing the virtual environments manager dialog variant.</td> | |
| 27 </tr> | |
| 28 <tr> | |
| 29 <td><a href="#VirtualenvManagerWidget">VirtualenvManagerWidget</a></td> | |
| 30 <td>Class implementing a widget to manage the list of defined virtual environments.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#VirtualenvManagerWindow">VirtualenvManagerWindow</a></td> | |
| 34 <td>Main window class for the standalone virtual environments manager.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /> | |
| 43 <hr /> | |
| 44 <a NAME="VirtualenvManagerDialog" ID="VirtualenvManagerDialog"></a> | |
| 45 <h2>VirtualenvManagerDialog</h2> | |
| 46 | |
| 47 <p> | |
| 48 Class implementing the virtual environments manager dialog variant. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QDialog | |
| 52 <h3>Class Attributes</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 | |
| 66 <tr> | |
| 67 <td><a href="#VirtualenvManagerDialog.__init__">VirtualenvManagerDialog</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr> | |
| 70 </table> | |
| 71 <h3>Static Methods</h3> | |
| 72 | |
| 73 <table> | |
| 74 <tr><td>None</td></tr> | |
| 75 </table> | |
| 76 | |
| 77 <a NAME="VirtualenvManagerDialog.__init__" ID="VirtualenvManagerDialog.__init__"></a> | |
| 78 <h4>VirtualenvManagerDialog (Constructor)</h4> | |
| 79 <b>VirtualenvManagerDialog</b>(<i>manager, parent=None</i>) | |
| 80 | |
| 81 <p> | |
| 82 Constructor | |
| 83 </p> | |
| 84 <dl> | |
| 85 | |
| 86 <dt><i>manager</i> (VirtualenvManager)</dt> | |
| 87 <dd> | |
| 88 reference to the virtual environment manager | |
| 89 </dd> | |
| 90 <dt><i>parent</i> (QWidget)</dt> | |
| 91 <dd> | |
| 92 reference to the parent widget | |
| 93 </dd> | |
| 94 </dl> | |
| 95 <div align="right"><a href="#top">Up</a></div> | |
| 96 <hr /> | |
| 97 <hr /> | |
| 98 <a NAME="VirtualenvManagerWidget" ID="VirtualenvManagerWidget"></a> | |
| 99 <h2>VirtualenvManagerWidget</h2> | |
| 100 | |
| 101 <p> | |
| 102 Class implementing a widget to manage the list of defined virtual | |
| 103 environments. | |
| 104 </p> | |
| 105 <h3>Derived from</h3> | |
| 106 QWidget, Ui_VirtualenvManagerWidget | |
| 107 <h3>Class Attributes</h3> | |
| 108 | |
| 109 <table> | |
| 110 <tr><td>ExecPathRole</td></tr><tr><td>IsCondaRole</td></tr><tr><td>IsGlobalRole</td></tr><tr><td>IsRemoteRole</td></tr> | |
| 111 </table> | |
| 112 <h3>Class Methods</h3> | |
| 113 | |
| 114 <table> | |
| 115 <tr><td>None</td></tr> | |
| 116 </table> | |
| 117 <h3>Methods</h3> | |
| 118 | |
| 119 <table> | |
| 120 | |
| 121 <tr> | |
| 122 <td><a href="#VirtualenvManagerWidget.__init__">VirtualenvManagerWidget</a></td> | |
| 123 <td>Constructor</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#VirtualenvManagerWidget.__populateVenvList">__populateVenvList</a></td> | |
| 127 <td>Private method to populate the list of virtual environments.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#VirtualenvManagerWidget.__refresh">__refresh</a></td> | |
| 131 <td>Private slot to refresh the list of shown items.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#VirtualenvManagerWidget.__resizeSections">__resizeSections</a></td> | |
| 135 <td>Private method to resize the sections of the environment list to their contents.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#VirtualenvManagerWidget.__updateButtons">__updateButtons</a></td> | |
| 139 <td>Private method to update the enabled state of the various buttons.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#VirtualenvManagerWidget.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 143 <td>Private slot to add a new entry.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#VirtualenvManagerWidget.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td> | |
| 147 <td>Private slot to delete all entries from the list and disk.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#VirtualenvManagerWidget.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 151 <td>Private slot to delete all selected entries from the list and disk.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#VirtualenvManagerWidget.on_editButton_clicked">on_editButton_clicked</a></td> | |
| 155 <td>Private slot to edit the selected entry.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#VirtualenvManagerWidget.on_newButton_clicked">on_newButton_clicked</a></td> | |
| 159 <td>Private slot to create a new virtual environment.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#VirtualenvManagerWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 163 <td>Private slot to refresh the list of virtual environments.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#VirtualenvManagerWidget.on_removeAllButton_clicked">on_removeAllButton_clicked</a></td> | |
| 167 <td>Private slot to remove all entries from the list but keep their directories.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#VirtualenvManagerWidget.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 171 <td>Private slot to remove all selected entries from the list but keep their directories.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#VirtualenvManagerWidget.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 175 <td>Private slot to save the base directory name.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#VirtualenvManagerWidget.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td> | |
| 179 <td>Private slot to upgrade a virtual environment.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#VirtualenvManagerWidget.on_venvList_itemSelectionChanged">on_venvList_itemSelectionChanged</a></td> | |
| 183 <td>Private slot handling a change of the selected items.</td> | |
| 184 </tr> | |
| 185 </table> | |
| 186 <h3>Static Methods</h3> | |
| 187 | |
| 188 <table> | |
| 189 <tr><td>None</td></tr> | |
| 190 </table> | |
| 191 | |
| 192 <a NAME="VirtualenvManagerWidget.__init__" ID="VirtualenvManagerWidget.__init__"></a> | |
| 193 <h4>VirtualenvManagerWidget (Constructor)</h4> | |
| 194 <b>VirtualenvManagerWidget</b>(<i>manager, parent=None</i>) | |
| 195 | |
| 196 <p> | |
| 197 Constructor | |
| 198 </p> | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>manager</i> (VirtualenvManager)</dt> | |
| 202 <dd> | |
| 203 reference to the virtual environment manager | |
| 204 </dd> | |
| 205 <dt><i>parent</i> (QWidget)</dt> | |
| 206 <dd> | |
| 207 reference to the parent widget | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <a NAME="VirtualenvManagerWidget.__populateVenvList" ID="VirtualenvManagerWidget.__populateVenvList"></a> | |
| 211 <h4>VirtualenvManagerWidget.__populateVenvList</h4> | |
| 212 <b>__populateVenvList</b>(<i></i>) | |
| 213 | |
| 214 <p> | |
| 215 Private method to populate the list of virtual environments. | |
| 216 </p> | |
| 217 <a NAME="VirtualenvManagerWidget.__refresh" ID="VirtualenvManagerWidget.__refresh"></a> | |
| 218 <h4>VirtualenvManagerWidget.__refresh</h4> | |
| 219 <b>__refresh</b>(<i></i>) | |
| 220 | |
| 221 <p> | |
| 222 Private slot to refresh the list of shown items. | |
| 223 </p> | |
| 224 <a NAME="VirtualenvManagerWidget.__resizeSections" ID="VirtualenvManagerWidget.__resizeSections"></a> | |
| 225 <h4>VirtualenvManagerWidget.__resizeSections</h4> | |
| 226 <b>__resizeSections</b>(<i></i>) | |
| 227 | |
| 228 <p> | |
| 229 Private method to resize the sections of the environment list to their | |
| 230 contents. | |
| 231 </p> | |
| 232 <a NAME="VirtualenvManagerWidget.__updateButtons" ID="VirtualenvManagerWidget.__updateButtons"></a> | |
| 233 <h4>VirtualenvManagerWidget.__updateButtons</h4> | |
| 234 <b>__updateButtons</b>(<i></i>) | |
| 235 | |
| 236 <p> | |
| 237 Private method to update the enabled state of the various buttons. | |
| 238 </p> | |
| 239 <a NAME="VirtualenvManagerWidget.on_addButton_clicked" ID="VirtualenvManagerWidget.on_addButton_clicked"></a> | |
| 240 <h4>VirtualenvManagerWidget.on_addButton_clicked</h4> | |
| 241 <b>on_addButton_clicked</b>(<i></i>) | |
| 242 | |
| 243 <p> | |
| 244 Private slot to add a new entry. | |
| 245 </p> | |
| 246 <a NAME="VirtualenvManagerWidget.on_deleteAllButton_clicked" ID="VirtualenvManagerWidget.on_deleteAllButton_clicked"></a> | |
| 247 <h4>VirtualenvManagerWidget.on_deleteAllButton_clicked</h4> | |
| 248 <b>on_deleteAllButton_clicked</b>(<i></i>) | |
| 249 | |
| 250 <p> | |
| 251 Private slot to delete all entries from the list and disk. | |
| 252 </p> | |
| 253 <a NAME="VirtualenvManagerWidget.on_deleteButton_clicked" ID="VirtualenvManagerWidget.on_deleteButton_clicked"></a> | |
| 254 <h4>VirtualenvManagerWidget.on_deleteButton_clicked</h4> | |
| 255 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 256 | |
| 257 <p> | |
| 258 Private slot to delete all selected entries from the list and disk. | |
| 259 </p> | |
| 260 <a NAME="VirtualenvManagerWidget.on_editButton_clicked" ID="VirtualenvManagerWidget.on_editButton_clicked"></a> | |
| 261 <h4>VirtualenvManagerWidget.on_editButton_clicked</h4> | |
| 262 <b>on_editButton_clicked</b>(<i></i>) | |
| 263 | |
| 264 <p> | |
| 265 Private slot to edit the selected entry. | |
| 266 </p> | |
| 267 <a NAME="VirtualenvManagerWidget.on_newButton_clicked" ID="VirtualenvManagerWidget.on_newButton_clicked"></a> | |
| 268 <h4>VirtualenvManagerWidget.on_newButton_clicked</h4> | |
| 269 <b>on_newButton_clicked</b>(<i></i>) | |
| 270 | |
| 271 <p> | |
| 272 Private slot to create a new virtual environment. | |
| 273 </p> | |
| 274 <a NAME="VirtualenvManagerWidget.on_refreshButton_clicked" ID="VirtualenvManagerWidget.on_refreshButton_clicked"></a> | |
| 275 <h4>VirtualenvManagerWidget.on_refreshButton_clicked</h4> | |
| 276 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 277 | |
| 278 <p> | |
| 279 Private slot to refresh the list of virtual environments. | |
| 280 </p> | |
| 281 <a NAME="VirtualenvManagerWidget.on_removeAllButton_clicked" ID="VirtualenvManagerWidget.on_removeAllButton_clicked"></a> | |
| 282 <h4>VirtualenvManagerWidget.on_removeAllButton_clicked</h4> | |
| 283 <b>on_removeAllButton_clicked</b>(<i></i>) | |
| 284 | |
| 285 <p> | |
| 286 Private slot to remove all entries from the list but keep their | |
| 287 directories. | |
| 288 </p> | |
| 289 <a NAME="VirtualenvManagerWidget.on_removeButton_clicked" ID="VirtualenvManagerWidget.on_removeButton_clicked"></a> | |
| 290 <h4>VirtualenvManagerWidget.on_removeButton_clicked</h4> | |
| 291 <b>on_removeButton_clicked</b>(<i></i>) | |
| 292 | |
| 293 <p> | |
| 294 Private slot to remove all selected entries from the list but keep | |
| 295 their directories. | |
| 296 </p> | |
| 297 <a NAME="VirtualenvManagerWidget.on_saveButton_clicked" ID="VirtualenvManagerWidget.on_saveButton_clicked"></a> | |
| 298 <h4>VirtualenvManagerWidget.on_saveButton_clicked</h4> | |
| 299 <b>on_saveButton_clicked</b>(<i></i>) | |
| 300 | |
| 301 <p> | |
| 302 Private slot to save the base directory name. | |
| 303 </p> | |
| 304 <a NAME="VirtualenvManagerWidget.on_upgradeButton_clicked" ID="VirtualenvManagerWidget.on_upgradeButton_clicked"></a> | |
| 305 <h4>VirtualenvManagerWidget.on_upgradeButton_clicked</h4> | |
| 306 <b>on_upgradeButton_clicked</b>(<i></i>) | |
| 307 | |
| 308 <p> | |
| 309 Private slot to upgrade a virtual environment. | |
| 310 </p> | |
| 311 <a NAME="VirtualenvManagerWidget.on_venvList_itemSelectionChanged" ID="VirtualenvManagerWidget.on_venvList_itemSelectionChanged"></a> | |
| 312 <h4>VirtualenvManagerWidget.on_venvList_itemSelectionChanged</h4> | |
| 313 <b>on_venvList_itemSelectionChanged</b>(<i></i>) | |
| 314 | |
| 315 <p> | |
| 316 Private slot handling a change of the selected items. | |
| 317 </p> | |
| 318 <div align="right"><a href="#top">Up</a></div> | |
| 319 <hr /> | |
| 320 <hr /> | |
| 321 <a NAME="VirtualenvManagerWindow" ID="VirtualenvManagerWindow"></a> | |
| 322 <h2>VirtualenvManagerWindow</h2> | |
| 323 | |
| 324 <p> | |
| 325 Main window class for the standalone virtual environments manager. | |
| 326 </p> | |
| 327 <h3>Derived from</h3> | |
| 328 EricMainWindow | |
| 329 <h3>Class Attributes</h3> | |
| 330 | |
| 331 <table> | |
| 332 <tr><td>None</td></tr> | |
| 333 </table> | |
| 334 <h3>Class Methods</h3> | |
| 335 | |
| 336 <table> | |
| 337 <tr><td>None</td></tr> | |
| 338 </table> | |
| 339 <h3>Methods</h3> | |
| 340 | |
| 341 <table> | |
| 342 | |
| 343 <tr> | |
| 344 <td><a href="#VirtualenvManagerWindow.__init__">VirtualenvManagerWindow</a></td> | |
| 345 <td>Constructor</td> | |
| 346 </tr> | |
| 347 </table> | |
| 348 <h3>Static Methods</h3> | |
| 349 | |
| 350 <table> | |
| 351 <tr><td>None</td></tr> | |
| 352 </table> | |
| 353 | |
| 354 <a NAME="VirtualenvManagerWindow.__init__" ID="VirtualenvManagerWindow.__init__"></a> | |
| 355 <h4>VirtualenvManagerWindow (Constructor)</h4> | |
| 356 <b>VirtualenvManagerWindow</b>(<i>parent=None</i>) | |
| 357 | |
| 358 <p> | |
| 359 Constructor | |
| 360 </p> | |
| 361 <dl> | |
| 362 | |
| 363 <dt><i>parent</i></dt> | |
| 364 <dd> | |
| 365 reference to the parent widget (QWidget) | |
| 366 </dd> | |
| 367 </dl> | |
| 368 <div align="right"><a href="#top">Up</a></div> | |
| 369 <hr /> | |
| 370 </body></html> |
