Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PluginManager.PluginInstallDialog.html
src/eric7/Documentation/Source/eric7.PluginManager.PluginInstallDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10428
- a071d4065202
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PluginManager.PluginInstallDialog</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.PluginManager.PluginInstallDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Plugin installation dialog. | |
| 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="#PluginInstallDialog">PluginInstallDialog</a></td> | |
| 25 <td>Class for the dialog variant.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#PluginInstallWidget">PluginInstallWidget</a></td> | |
| 29 <td>Class implementing the Plugin installation dialog.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#PluginInstallWindow">PluginInstallWindow</a></td> | |
| 33 <td>Main window class for the standalone dialog.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <h3>Functions</h3> | |
| 37 | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="PluginInstallDialog" ID="PluginInstallDialog"></a> | |
| 44 <h2>PluginInstallDialog</h2> | |
| 45 | |
| 46 <p> | |
| 47 Class for the dialog variant. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QDialog | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#PluginInstallDialog.__init__">PluginInstallDialog</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PluginInstallDialog.restartNeeded">restartNeeded</a></td> | |
| 71 <td>Public method to check, if a restart of the IDE is required.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="PluginInstallDialog.__init__" ID="PluginInstallDialog.__init__"></a> | |
| 81 <h4>PluginInstallDialog (Constructor)</h4> | |
| 82 <b>PluginInstallDialog</b>(<i>pluginManager, pluginFileNames, parent=None</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>pluginManager</i></dt> | |
| 90 <dd> | |
| 91 reference to the plugin manager object | |
| 92 </dd> | |
| 93 <dt><i>pluginFileNames</i></dt> | |
| 94 <dd> | |
| 95 list of plugin files suggested for | |
| 96 installation (list of strings) | |
| 97 </dd> | |
| 98 <dt><i>parent</i></dt> | |
| 99 <dd> | |
| 100 reference to the parent widget (QWidget) | |
| 101 </dd> | |
| 102 </dl> | |
| 103 <a NAME="PluginInstallDialog.restartNeeded" ID="PluginInstallDialog.restartNeeded"></a> | |
| 104 <h4>PluginInstallDialog.restartNeeded</h4> | |
| 105 <b>restartNeeded</b>(<i></i>) | |
| 106 | |
| 107 <p> | |
| 108 Public method to check, if a restart of the IDE is required. | |
| 109 </p> | |
| 110 <dl> | |
| 111 <dt>Return:</dt> | |
| 112 <dd> | |
| 113 flag indicating a restart is required (boolean) | |
| 114 </dd> | |
| 115 </dl> | |
| 116 <div align="right"><a href="#top">Up</a></div> | |
| 117 <hr /> | |
| 118 <hr /> | |
| 119 <a NAME="PluginInstallWidget" ID="PluginInstallWidget"></a> | |
| 120 <h2>PluginInstallWidget</h2> | |
| 121 | |
| 122 <p> | |
| 123 Class implementing the Plugin installation dialog. | |
| 124 </p> | |
| 125 <h3>Derived from</h3> | |
| 126 QWidget, Ui_PluginInstallDialog | |
| 127 <h3>Class Attributes</h3> | |
| 128 | |
| 129 <table> | |
| 130 <tr><td>None</td></tr> | |
| 131 </table> | |
| 132 <h3>Class Methods</h3> | |
| 133 | |
| 134 <table> | |
| 135 <tr><td>None</td></tr> | |
| 136 </table> | |
| 137 <h3>Methods</h3> | |
| 138 | |
| 139 <table> | |
| 140 | |
| 141 <tr> | |
| 142 <td><a href="#PluginInstallWidget.__init__">PluginInstallWidget</a></td> | |
| 143 <td>Constructor</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#PluginInstallWidget.__createArchivesList">__createArchivesList</a></td> | |
| 147 <td>Private method to create a list of plugin archive names.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#PluginInstallWidget.__installPlugin">__installPlugin</a></td> | |
| 151 <td>Private slot to install the selected plugin.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#PluginInstallWidget.__installPlugins">__installPlugins</a></td> | |
| 155 <td>Private method to install the selected plugin archives.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#PluginInstallWidget.__makedirs">__makedirs</a></td> | |
| 159 <td>Private method to create a directory and all intermediate ones.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#PluginInstallWidget.__rollback">__rollback</a></td> | |
| 163 <td>Private method to rollback a failed installation.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#PluginInstallWidget.__selectPage">__selectPage</a></td> | |
| 167 <td>Private method to show the right wizard page.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#PluginInstallWidget.__uninstallPackage">__uninstallPackage</a></td> | |
| 171 <td>Private method to uninstall an already installed plugin to prepare the update.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#PluginInstallWidget.on_addArchivesButton_clicked">on_addArchivesButton_clicked</a></td> | |
| 175 <td>Private slot to select plugin ZIP-archives via a file selection dialog.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#PluginInstallWidget.on_archivesList_itemSelectionChanged">on_archivesList_itemSelectionChanged</a></td> | |
| 179 <td>Private slot called, when the selection of the archives list changes.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#PluginInstallWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 183 <td>Private slot to handle the click of a button of the button box.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#PluginInstallWidget.on_removeArchivesButton_clicked">on_removeArchivesButton_clicked</a></td> | |
| 187 <td>Private slot to remove archives from the list.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#PluginInstallWidget.restartNeeded">restartNeeded</a></td> | |
| 191 <td>Public method to check, if a restart of the IDE is required.</td> | |
| 192 </tr> | |
| 193 </table> | |
| 194 <h3>Static Methods</h3> | |
| 195 | |
| 196 <table> | |
| 197 <tr><td>None</td></tr> | |
| 198 </table> | |
| 199 | |
| 200 <a NAME="PluginInstallWidget.__init__" ID="PluginInstallWidget.__init__"></a> | |
| 201 <h4>PluginInstallWidget (Constructor)</h4> | |
| 202 <b>PluginInstallWidget</b>(<i>pluginManager, pluginFileNames, parent=None</i>) | |
| 203 | |
| 204 <p> | |
| 205 Constructor | |
| 206 </p> | |
| 207 <dl> | |
| 208 | |
| 209 <dt><i>pluginManager</i></dt> | |
| 210 <dd> | |
| 211 reference to the plugin manager object | |
| 212 </dd> | |
| 213 <dt><i>pluginFileNames</i></dt> | |
| 214 <dd> | |
| 215 list of plugin files suggested for | |
| 216 installation (list of strings) | |
| 217 </dd> | |
| 218 <dt><i>parent</i></dt> | |
| 219 <dd> | |
| 220 parent of this dialog (QWidget) | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <a NAME="PluginInstallWidget.__createArchivesList" ID="PluginInstallWidget.__createArchivesList"></a> | |
| 224 <h4>PluginInstallWidget.__createArchivesList</h4> | |
| 225 <b>__createArchivesList</b>(<i></i>) | |
| 226 | |
| 227 <p> | |
| 228 Private method to create a list of plugin archive names. | |
| 229 </p> | |
| 230 <dl> | |
| 231 <dt>Return:</dt> | |
| 232 <dd> | |
| 233 list of plugin archive names (list of strings) | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <a NAME="PluginInstallWidget.__installPlugin" ID="PluginInstallWidget.__installPlugin"></a> | |
| 237 <h4>PluginInstallWidget.__installPlugin</h4> | |
| 238 <b>__installPlugin</b>(<i>archiveFilename</i>) | |
| 239 | |
| 240 <p> | |
| 241 Private slot to install the selected plugin. | |
| 242 </p> | |
| 243 <dl> | |
| 244 | |
| 245 <dt><i>archiveFilename</i></dt> | |
| 246 <dd> | |
| 247 name of the plugin archive | |
| 248 file (string) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <dl> | |
| 252 <dt>Return:</dt> | |
| 253 <dd> | |
| 254 flag indicating success (boolean), error message | |
| 255 upon failure (string) and flag indicating a restart | |
| 256 of the IDE is required (boolean) | |
| 257 </dd> | |
| 258 </dl> | |
| 259 <a NAME="PluginInstallWidget.__installPlugins" ID="PluginInstallWidget.__installPlugins"></a> | |
| 260 <h4>PluginInstallWidget.__installPlugins</h4> | |
| 261 <b>__installPlugins</b>(<i></i>) | |
| 262 | |
| 263 <p> | |
| 264 Private method to install the selected plugin archives. | |
| 265 </p> | |
| 266 <dl> | |
| 267 <dt>Return:</dt> | |
| 268 <dd> | |
| 269 flag indicating success (boolean) | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <a NAME="PluginInstallWidget.__makedirs" ID="PluginInstallWidget.__makedirs"></a> | |
| 273 <h4>PluginInstallWidget.__makedirs</h4> | |
| 274 <b>__makedirs</b>(<i>name, mode=0o777</i>) | |
| 275 | |
| 276 <p> | |
| 277 Private method to create a directory and all intermediate ones. | |
| 278 </p> | |
| 279 <p> | |
| 280 This is an extended version of the Python one in order to | |
| 281 record the created directories. | |
| 282 </p> | |
| 283 <dl> | |
| 284 | |
| 285 <dt><i>name</i></dt> | |
| 286 <dd> | |
| 287 name of the directory to create (string) | |
| 288 </dd> | |
| 289 <dt><i>mode</i></dt> | |
| 290 <dd> | |
| 291 permission to set for the new directory (integer) | |
| 292 </dd> | |
| 293 </dl> | |
| 294 <a NAME="PluginInstallWidget.__rollback" ID="PluginInstallWidget.__rollback"></a> | |
| 295 <h4>PluginInstallWidget.__rollback</h4> | |
| 296 <b>__rollback</b>(<i></i>) | |
| 297 | |
| 298 <p> | |
| 299 Private method to rollback a failed installation. | |
| 300 </p> | |
| 301 <a NAME="PluginInstallWidget.__selectPage" ID="PluginInstallWidget.__selectPage"></a> | |
| 302 <h4>PluginInstallWidget.__selectPage</h4> | |
| 303 <b>__selectPage</b>(<i></i>) | |
| 304 | |
| 305 <p> | |
| 306 Private method to show the right wizard page. | |
| 307 </p> | |
| 308 <a NAME="PluginInstallWidget.__uninstallPackage" ID="PluginInstallWidget.__uninstallPackage"></a> | |
| 309 <h4>PluginInstallWidget.__uninstallPackage</h4> | |
| 310 <b>__uninstallPackage</b>(<i>destination, pluginFileName, packageName</i>) | |
| 311 | |
| 312 <p> | |
| 313 Private method to uninstall an already installed plugin to prepare | |
| 314 the update. | |
| 315 </p> | |
| 316 <dl> | |
| 317 | |
| 318 <dt><i>destination</i></dt> | |
| 319 <dd> | |
| 320 name of the plugin directory (string) | |
| 321 </dd> | |
| 322 <dt><i>pluginFileName</i></dt> | |
| 323 <dd> | |
| 324 name of the plugin file (string) | |
| 325 </dd> | |
| 326 <dt><i>packageName</i></dt> | |
| 327 <dd> | |
| 328 name of the plugin package (string) | |
| 329 </dd> | |
| 330 </dl> | |
| 331 <a NAME="PluginInstallWidget.on_addArchivesButton_clicked" ID="PluginInstallWidget.on_addArchivesButton_clicked"></a> | |
| 332 <h4>PluginInstallWidget.on_addArchivesButton_clicked</h4> | |
| 333 <b>on_addArchivesButton_clicked</b>(<i></i>) | |
| 334 | |
| 335 <p> | |
| 336 Private slot to select plugin ZIP-archives via a file selection dialog. | |
| 337 </p> | |
| 338 <a NAME="PluginInstallWidget.on_archivesList_itemSelectionChanged" ID="PluginInstallWidget.on_archivesList_itemSelectionChanged"></a> | |
| 339 <h4>PluginInstallWidget.on_archivesList_itemSelectionChanged</h4> | |
| 340 <b>on_archivesList_itemSelectionChanged</b>(<i></i>) | |
| 341 | |
| 342 <p> | |
| 343 Private slot called, when the selection of the archives list changes. | |
| 344 </p> | |
| 345 <a NAME="PluginInstallWidget.on_buttonBox_clicked" ID="PluginInstallWidget.on_buttonBox_clicked"></a> | |
| 346 <h4>PluginInstallWidget.on_buttonBox_clicked</h4> | |
| 347 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 348 | |
| 349 <p> | |
| 350 Private slot to handle the click of a button of the button box. | |
| 351 </p> | |
| 352 <dl> | |
| 353 | |
| 354 <dt><i>button</i></dt> | |
| 355 <dd> | |
| 356 reference to the button pressed (QAbstractButton) | |
| 357 </dd> | |
| 358 </dl> | |
| 359 <a NAME="PluginInstallWidget.on_removeArchivesButton_clicked" ID="PluginInstallWidget.on_removeArchivesButton_clicked"></a> | |
| 360 <h4>PluginInstallWidget.on_removeArchivesButton_clicked</h4> | |
| 361 <b>on_removeArchivesButton_clicked</b>(<i></i>) | |
| 362 | |
| 363 <p> | |
| 364 Private slot to remove archives from the list. | |
| 365 </p> | |
| 366 <a NAME="PluginInstallWidget.restartNeeded" ID="PluginInstallWidget.restartNeeded"></a> | |
| 367 <h4>PluginInstallWidget.restartNeeded</h4> | |
| 368 <b>restartNeeded</b>(<i></i>) | |
| 369 | |
| 370 <p> | |
| 371 Public method to check, if a restart of the IDE is required. | |
| 372 </p> | |
| 373 <dl> | |
| 374 <dt>Return:</dt> | |
| 375 <dd> | |
| 376 flag indicating a restart is required (boolean) | |
| 377 </dd> | |
| 378 </dl> | |
| 379 <div align="right"><a href="#top">Up</a></div> | |
| 380 <hr /> | |
| 381 <hr /> | |
| 382 <a NAME="PluginInstallWindow" ID="PluginInstallWindow"></a> | |
| 383 <h2>PluginInstallWindow</h2> | |
| 384 | |
| 385 <p> | |
| 386 Main window class for the standalone dialog. | |
| 387 </p> | |
| 388 <h3>Derived from</h3> | |
| 389 EricMainWindow | |
| 390 <h3>Class Attributes</h3> | |
| 391 | |
| 392 <table> | |
| 393 <tr><td>None</td></tr> | |
| 394 </table> | |
| 395 <h3>Class Methods</h3> | |
| 396 | |
| 397 <table> | |
| 398 <tr><td>None</td></tr> | |
| 399 </table> | |
| 400 <h3>Methods</h3> | |
| 401 | |
| 402 <table> | |
| 403 | |
| 404 <tr> | |
| 405 <td><a href="#PluginInstallWindow.__init__">PluginInstallWindow</a></td> | |
| 406 <td>Constructor</td> | |
| 407 </tr> | |
| 408 </table> | |
| 409 <h3>Static Methods</h3> | |
| 410 | |
| 411 <table> | |
| 412 <tr><td>None</td></tr> | |
| 413 </table> | |
| 414 | |
| 415 <a NAME="PluginInstallWindow.__init__" ID="PluginInstallWindow.__init__"></a> | |
| 416 <h4>PluginInstallWindow (Constructor)</h4> | |
| 417 <b>PluginInstallWindow</b>(<i>pluginFileNames, parent=None</i>) | |
| 418 | |
| 419 <p> | |
| 420 Constructor | |
| 421 </p> | |
| 422 <dl> | |
| 423 | |
| 424 <dt><i>pluginFileNames</i></dt> | |
| 425 <dd> | |
| 426 list of plugin files suggested for | |
| 427 installation (list of strings) | |
| 428 </dd> | |
| 429 <dt><i>parent</i></dt> | |
| 430 <dd> | |
| 431 reference to the parent widget (QWidget) | |
| 432 </dd> | |
| 433 </dl> | |
| 434 <div align="right"><a href="#top">Up</a></div> | |
| 435 <hr /> | |
| 436 </body></html> |
