Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html
src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9031
- 8c9013b363bc
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PluginManager.PluginRepositoryDialog</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.PluginRepositoryDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog showing the available plugins. | |
| 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="#PluginRepositoryDialog">PluginRepositoryDialog</a></td> | |
| 25 <td>Class for the dialog variant.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#PluginRepositoryWidget">PluginRepositoryWidget</a></td> | |
| 29 <td>Class implementing a dialog showing the available plugins.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#PluginRepositoryWindow">PluginRepositoryWindow</a></td> | |
| 33 <td>Main window class for the standalone dialog.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <h3>Functions</h3> | |
| 37 | |
| 38 <table> | |
| 39 | |
| 40 <tr> | |
| 41 <td><a href="#PluginRepositoryDownloadCleanup">PluginRepositoryDownloadCleanup</a></td> | |
| 42 <td>Module function to clean up the plug-in downloads area.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#registerPlugin">registerPlugin</a></td> | |
| 46 <td>Method to register a plug-in's data.</td> | |
| 47 </tr> | |
| 48 </table> | |
| 49 <hr /> | |
| 50 <hr /> | |
| 51 <a NAME="PluginRepositoryDialog" ID="PluginRepositoryDialog"></a> | |
| 52 <h2>PluginRepositoryDialog</h2> | |
| 53 | |
| 54 <p> | |
| 55 Class for the dialog variant. | |
| 56 </p> | |
| 57 <h3>Derived from</h3> | |
| 58 QDialog | |
| 59 <h3>Class Attributes</h3> | |
| 60 | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 <h3>Class Methods</h3> | |
| 65 | |
| 66 <table> | |
| 67 <tr><td>None</td></tr> | |
| 68 </table> | |
| 69 <h3>Methods</h3> | |
| 70 | |
| 71 <table> | |
| 72 | |
| 73 <tr> | |
| 74 <td><a href="#PluginRepositoryDialog.__init__">PluginRepositoryDialog</a></td> | |
| 75 <td>Constructor</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PluginRepositoryDialog.__closeAndInstall">__closeAndInstall</a></td> | |
| 79 <td>Private slot to handle the closeAndInstall signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PluginRepositoryDialog.getDownloadedPlugins">getDownloadedPlugins</a></td> | |
| 83 <td>Public method to get the list of recently downloaded plugin files.</td> | |
| 84 </tr> | |
| 85 </table> | |
| 86 <h3>Static Methods</h3> | |
| 87 | |
| 88 <table> | |
| 89 <tr><td>None</td></tr> | |
| 90 </table> | |
| 91 | |
| 92 <a NAME="PluginRepositoryDialog.__init__" ID="PluginRepositoryDialog.__init__"></a> | |
| 93 <h4>PluginRepositoryDialog (Constructor)</h4> | |
| 94 <b>PluginRepositoryDialog</b>(<i>pluginManager, parent=None</i>) | |
| 95 | |
| 96 <p> | |
| 97 Constructor | |
| 98 </p> | |
| 99 <dl> | |
| 100 | |
| 101 <dt><i>pluginManager</i> (PluginManager)</dt> | |
| 102 <dd> | |
| 103 reference to the plugin manager object | |
| 104 </dd> | |
| 105 <dt><i>parent</i> (QWidget)</dt> | |
| 106 <dd> | |
| 107 reference to the parent widget | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <a NAME="PluginRepositoryDialog.__closeAndInstall" ID="PluginRepositoryDialog.__closeAndInstall"></a> | |
| 111 <h4>PluginRepositoryDialog.__closeAndInstall</h4> | |
| 112 <b>__closeAndInstall</b>(<i></i>) | |
| 113 | |
| 114 <p> | |
| 115 Private slot to handle the closeAndInstall signal. | |
| 116 </p> | |
| 117 <a NAME="PluginRepositoryDialog.getDownloadedPlugins" ID="PluginRepositoryDialog.getDownloadedPlugins"></a> | |
| 118 <h4>PluginRepositoryDialog.getDownloadedPlugins</h4> | |
| 119 <b>getDownloadedPlugins</b>(<i></i>) | |
| 120 | |
| 121 <p> | |
| 122 Public method to get the list of recently downloaded plugin files. | |
| 123 </p> | |
| 124 <dl> | |
| 125 <dt>Return:</dt> | |
| 126 <dd> | |
| 127 list of plugin filenames (list of strings) | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <div align="right"><a href="#top">Up</a></div> | |
| 131 <hr /> | |
| 132 <hr /> | |
| 133 <a NAME="PluginRepositoryWidget" ID="PluginRepositoryWidget"></a> | |
| 134 <h2>PluginRepositoryWidget</h2> | |
| 135 | |
| 136 <p> | |
| 137 Class implementing a dialog showing the available plugins. | |
| 138 </p> | |
| 139 <h3>Signals</h3> | |
| 140 <dl> | |
| 141 | |
| 142 <dt>closeAndInstall()</dt> | |
| 143 <dd> | |
| 144 emitted when the Close & Install button is | |
| 145 pressed | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <h3>Derived from</h3> | |
| 149 QWidget, Ui_PluginRepositoryDialog | |
| 150 <h3>Class Attributes</h3> | |
| 151 | |
| 152 <table> | |
| 153 <tr><td>AuthorRole</td></tr><tr><td>DescrRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>PluginStatusError</td></tr><tr><td>PluginStatusLocalUpdate</td></tr><tr><td>PluginStatusNew</td></tr><tr><td>PluginStatusRemoteUpdate</td></tr><tr><td>PluginStatusUpToDate</td></tr><tr><td>UrlRole</td></tr> | |
| 154 </table> | |
| 155 <h3>Class Methods</h3> | |
| 156 | |
| 157 <table> | |
| 158 <tr><td>None</td></tr> | |
| 159 </table> | |
| 160 <h3>Methods</h3> | |
| 161 | |
| 162 <table> | |
| 163 | |
| 164 <tr> | |
| 165 <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td> | |
| 166 <td>Constructor</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#PluginRepositoryWidget.__changeScheme">__changeScheme</a></td> | |
| 170 <td>Private method to change the scheme of the given URL.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#PluginRepositoryWidget.__cleanupDownloads">__cleanupDownloads</a></td> | |
| 174 <td>Private slot to cleanup the plug-in downloads area.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#PluginRepositoryWidget.__closeAndInstall">__closeAndInstall</a></td> | |
| 178 <td>Private method to close the dialog and invoke the install dialog.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#PluginRepositoryWidget.__downloadButtonClicked">__downloadButtonClicked</a></td> | |
| 182 <td>Private slot to handle a click of the Download button.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td> | |
| 186 <td>Private slot to cancel the current download.</td> | |
| 187 </tr> | |
| 188 <tr> | |
| 189 <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td> | |
| 190 <td>Private slot to download the given file.</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#PluginRepositoryWidget.__downloadFileDone">__downloadFileDone</a></td> | |
| 194 <td>Private method called, after the file has been downloaded from the Internet.</td> | |
| 195 </tr> | |
| 196 <tr> | |
| 197 <td><a href="#PluginRepositoryWidget.__downloadInstallButtonClicked">__downloadInstallButtonClicked</a></td> | |
| 198 <td>Private slot to handle a click of the Download & Install button.</td> | |
| 199 </tr> | |
| 200 <tr> | |
| 201 <td><a href="#PluginRepositoryWidget.__downloadPlugin">__downloadPlugin</a></td> | |
| 202 <td>Private method to download the next plugin.</td> | |
| 203 </tr> | |
| 204 <tr> | |
| 205 <td><a href="#PluginRepositoryWidget.__downloadPluginDone">__downloadPluginDone</a></td> | |
| 206 <td>Private method called, when the download of a plugin is finished.</td> | |
| 207 </tr> | |
| 208 <tr> | |
| 209 <td><a href="#PluginRepositoryWidget.__downloadPlugins">__downloadPlugins</a></td> | |
| 210 <td>Private slot to download the selected plugins.</td> | |
| 211 </tr> | |
| 212 <tr> | |
| 213 <td><a href="#PluginRepositoryWidget.__downloadPluginsDone">__downloadPluginsDone</a></td> | |
| 214 <td>Private method called, when the download of the plugins is finished.</td> | |
| 215 </tr> | |
| 216 <tr> | |
| 217 <td><a href="#PluginRepositoryWidget.__downloadProgress">__downloadProgress</a></td> | |
| 218 <td>Private slot to show the download progress.</td> | |
| 219 </tr> | |
| 220 <tr> | |
| 221 <td><a href="#PluginRepositoryWidget.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td> | |
| 222 <td>Private method called after the repository file was downloaded.</td> | |
| 223 </tr> | |
| 224 <tr> | |
| 225 <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td> | |
| 226 <td>Private method to format the description.</td> | |
| 227 </tr> | |
| 228 <tr> | |
| 229 <td><a href="#PluginRepositoryWidget.__hasHiddenPlugins">__hasHiddenPlugins</a></td> | |
| 230 <td>Private method to check, if there are any hidden plug-ins.</td> | |
| 231 </tr> | |
| 232 <tr> | |
| 233 <td><a href="#PluginRepositoryWidget.__hidePlugin">__hidePlugin</a></td> | |
| 234 <td>Private slot to hide the current plug-in.</td> | |
| 235 </tr> | |
| 236 <tr> | |
| 237 <td><a href="#PluginRepositoryWidget.__hideSelectedPlugins">__hideSelectedPlugins</a></td> | |
| 238 <td>Private slot to hide all selected plug-ins.</td> | |
| 239 </tr> | |
| 240 <tr> | |
| 241 <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td> | |
| 242 <td>Private method to populate the list of available plugins.</td> | |
| 243 </tr> | |
| 244 <tr> | |
| 245 <td><a href="#PluginRepositoryWidget.__reachabilityChanged">__reachabilityChanged</a></td> | |
| 246 <td>Private slot handling reachability state changes.</td> | |
| 247 </tr> | |
| 248 <tr> | |
| 249 <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td> | |
| 250 <td>Private method to resort the tree.</td> | |
| 251 </tr> | |
| 252 <tr> | |
| 253 <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td> | |
| 254 <td>Private method to get all selected items without the toplevel ones.</td> | |
| 255 </tr> | |
| 256 <tr> | |
| 257 <td><a href="#PluginRepositoryWidget.__showAllPlugins">__showAllPlugins</a></td> | |
| 258 <td>Private slot to show all plug-ins.</td> | |
| 259 </tr> | |
| 260 <tr> | |
| 261 <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td> | |
| 262 <td>Private slot to handle SSL errors.</td> | |
| 263 </tr> | |
| 264 <tr> | |
| 265 <td><a href="#PluginRepositoryWidget.__updateHiddenPluginsList">__updateHiddenPluginsList</a></td> | |
| 266 <td>Private method to store the list of hidden plug-ins to the settings.</td> | |
| 267 </tr> | |
| 268 <tr> | |
| 269 <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td> | |
| 270 <td>Private slot to download a new list and display the contents.</td> | |
| 271 </tr> | |
| 272 <tr> | |
| 273 <td><a href="#PluginRepositoryWidget.__updateStatus">__updateStatus</a></td> | |
| 274 <td>Private method to check the given archive update status.</td> | |
| 275 </tr> | |
| 276 <tr> | |
| 277 <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td> | |
| 278 <td>Public method to add an entry to the list.</td> | |
| 279 </tr> | |
| 280 <tr> | |
| 281 <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td> | |
| 282 <td>Public method to get the list of recently downloaded plugin files.</td> | |
| 283 </tr> | |
| 284 <tr> | |
| 285 <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 286 <td>Private slot to handle the click of a button of the button box.</td> | |
| 287 </tr> | |
| 288 <tr> | |
| 289 <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td> | |
| 290 <td>Private slot to handle the change of the current item.</td> | |
| 291 </tr> | |
| 292 <tr> | |
| 293 <td><a href="#PluginRepositoryWidget.on_repositoryList_customContextMenuRequested">on_repositoryList_customContextMenuRequested</a></td> | |
| 294 <td>Private slot to show the context menu.</td> | |
| 295 </tr> | |
| 296 <tr> | |
| 297 <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td> | |
| 298 <td>Private slot to handle a change of the selection.</td> | |
| 299 </tr> | |
| 300 <tr> | |
| 301 <td><a href="#PluginRepositoryWidget.on_repositoryUrlEditButton_toggled">on_repositoryUrlEditButton_toggled</a></td> | |
| 302 <td>Private slot to set the read only status of the repository URL line edit.</td> | |
| 303 </tr> | |
| 304 <tr> | |
| 305 <td><a href="#PluginRepositoryWidget.reloadList">reloadList</a></td> | |
| 306 <td>Public method to reload the list of plugins.</td> | |
| 307 </tr> | |
| 308 </table> | |
| 309 <h3>Static Methods</h3> | |
| 310 | |
| 311 <table> | |
| 312 <tr><td>None</td></tr> | |
| 313 </table> | |
| 314 | |
| 315 <a NAME="PluginRepositoryWidget.__init__" ID="PluginRepositoryWidget.__init__"></a> | |
| 316 <h4>PluginRepositoryWidget (Constructor)</h4> | |
| 317 <b>PluginRepositoryWidget</b>(<i>pluginManager, integrated=False, parent=None</i>) | |
| 318 | |
| 319 <p> | |
| 320 Constructor | |
| 321 </p> | |
| 322 <dl> | |
| 323 | |
| 324 <dt><i>pluginManager</i> (PluginManager)</dt> | |
| 325 <dd> | |
| 326 reference to the plugin manager object | |
| 327 </dd> | |
| 328 <dt><i>integrated</i> (bool)</dt> | |
| 329 <dd> | |
| 330 flag indicating the integration into the sidebar | |
| 331 </dd> | |
| 332 <dt><i>parent</i> (QWidget)</dt> | |
| 333 <dd> | |
| 334 parent of this dialog | |
| 335 </dd> | |
| 336 </dl> | |
| 337 <a NAME="PluginRepositoryWidget.__changeScheme" ID="PluginRepositoryWidget.__changeScheme"></a> | |
| 338 <h4>PluginRepositoryWidget.__changeScheme</h4> | |
| 339 <b>__changeScheme</b>(<i>url, newScheme=""</i>) | |
| 340 | |
| 341 <p> | |
| 342 Private method to change the scheme of the given URL. | |
| 343 </p> | |
| 344 <dl> | |
| 345 | |
| 346 <dt><i>url</i> (str)</dt> | |
| 347 <dd> | |
| 348 URL to be modified | |
| 349 </dd> | |
| 350 <dt><i>newScheme</i></dt> | |
| 351 <dd> | |
| 352 scheme to be set for the given URL | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <dl> | |
| 356 <dt>Return:</dt> | |
| 357 <dd> | |
| 358 modified URL | |
| 359 </dd> | |
| 360 </dl> | |
| 361 <dl> | |
| 362 <dt>Return Type:</dt> | |
| 363 <dd> | |
| 364 str | |
| 365 </dd> | |
| 366 </dl> | |
| 367 <a NAME="PluginRepositoryWidget.__cleanupDownloads" ID="PluginRepositoryWidget.__cleanupDownloads"></a> | |
| 368 <h4>PluginRepositoryWidget.__cleanupDownloads</h4> | |
| 369 <b>__cleanupDownloads</b>(<i></i>) | |
| 370 | |
| 371 <p> | |
| 372 Private slot to cleanup the plug-in downloads area. | |
| 373 </p> | |
| 374 <a NAME="PluginRepositoryWidget.__closeAndInstall" ID="PluginRepositoryWidget.__closeAndInstall"></a> | |
| 375 <h4>PluginRepositoryWidget.__closeAndInstall</h4> | |
| 376 <b>__closeAndInstall</b>(<i></i>) | |
| 377 | |
| 378 <p> | |
| 379 Private method to close the dialog and invoke the install dialog. | |
| 380 </p> | |
| 381 <a NAME="PluginRepositoryWidget.__downloadButtonClicked" ID="PluginRepositoryWidget.__downloadButtonClicked"></a> | |
| 382 <h4>PluginRepositoryWidget.__downloadButtonClicked</h4> | |
| 383 <b>__downloadButtonClicked</b>(<i></i>) | |
| 384 | |
| 385 <p> | |
| 386 Private slot to handle a click of the Download button. | |
| 387 </p> | |
| 388 <a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a> | |
| 389 <h4>PluginRepositoryWidget.__downloadCancel</h4> | |
| 390 <b>__downloadCancel</b>(<i>reply=None</i>) | |
| 391 | |
| 392 <p> | |
| 393 Private slot to cancel the current download. | |
| 394 </p> | |
| 395 <dl> | |
| 396 | |
| 397 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 398 <dd> | |
| 399 reference to the network reply | |
| 400 </dd> | |
| 401 </dl> | |
| 402 <a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a> | |
| 403 <h4>PluginRepositoryWidget.__downloadFile</h4> | |
| 404 <b>__downloadFile</b>(<i>url, filename, doneMethod=None</i>) | |
| 405 | |
| 406 <p> | |
| 407 Private slot to download the given file. | |
| 408 </p> | |
| 409 <dl> | |
| 410 | |
| 411 <dt><i>url</i></dt> | |
| 412 <dd> | |
| 413 URL for the download (string) | |
| 414 </dd> | |
| 415 <dt><i>filename</i></dt> | |
| 416 <dd> | |
| 417 local name of the file (string) | |
| 418 </dd> | |
| 419 <dt><i>doneMethod</i></dt> | |
| 420 <dd> | |
| 421 method to be called when done | |
| 422 </dd> | |
| 423 </dl> | |
| 424 <a NAME="PluginRepositoryWidget.__downloadFileDone" ID="PluginRepositoryWidget.__downloadFileDone"></a> | |
| 425 <h4>PluginRepositoryWidget.__downloadFileDone</h4> | |
| 426 <b>__downloadFileDone</b>(<i>reply, fileName, doneMethod</i>) | |
| 427 | |
| 428 <p> | |
| 429 Private method called, after the file has been downloaded | |
| 430 from the Internet. | |
| 431 </p> | |
| 432 <dl> | |
| 433 | |
| 434 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 435 <dd> | |
| 436 reference to the reply object of the download | |
| 437 </dd> | |
| 438 <dt><i>fileName</i> (str)</dt> | |
| 439 <dd> | |
| 440 local name of the file | |
| 441 </dd> | |
| 442 <dt><i>doneMethod</i> (func)</dt> | |
| 443 <dd> | |
| 444 method to be called when done | |
| 445 </dd> | |
| 446 </dl> | |
| 447 <a NAME="PluginRepositoryWidget.__downloadInstallButtonClicked" ID="PluginRepositoryWidget.__downloadInstallButtonClicked"></a> | |
| 448 <h4>PluginRepositoryWidget.__downloadInstallButtonClicked</h4> | |
| 449 <b>__downloadInstallButtonClicked</b>(<i></i>) | |
| 450 | |
| 451 <p> | |
| 452 Private slot to handle a click of the Download & Install button. | |
| 453 </p> | |
| 454 <a NAME="PluginRepositoryWidget.__downloadPlugin" ID="PluginRepositoryWidget.__downloadPlugin"></a> | |
| 455 <h4>PluginRepositoryWidget.__downloadPlugin</h4> | |
| 456 <b>__downloadPlugin</b>(<i></i>) | |
| 457 | |
| 458 <p> | |
| 459 Private method to download the next plugin. | |
| 460 </p> | |
| 461 <a NAME="PluginRepositoryWidget.__downloadPluginDone" ID="PluginRepositoryWidget.__downloadPluginDone"></a> | |
| 462 <h4>PluginRepositoryWidget.__downloadPluginDone</h4> | |
| 463 <b>__downloadPluginDone</b>(<i>status, filename</i>) | |
| 464 | |
| 465 <p> | |
| 466 Private method called, when the download of a plugin is finished. | |
| 467 </p> | |
| 468 <dl> | |
| 469 | |
| 470 <dt><i>status</i></dt> | |
| 471 <dd> | |
| 472 flag indicating a successful download (boolean) | |
| 473 </dd> | |
| 474 <dt><i>filename</i></dt> | |
| 475 <dd> | |
| 476 full path of the downloaded file (string) | |
| 477 </dd> | |
| 478 </dl> | |
| 479 <a NAME="PluginRepositoryWidget.__downloadPlugins" ID="PluginRepositoryWidget.__downloadPlugins"></a> | |
| 480 <h4>PluginRepositoryWidget.__downloadPlugins</h4> | |
| 481 <b>__downloadPlugins</b>(<i></i>) | |
| 482 | |
| 483 <p> | |
| 484 Private slot to download the selected plugins. | |
| 485 </p> | |
| 486 <a NAME="PluginRepositoryWidget.__downloadPluginsDone" ID="PluginRepositoryWidget.__downloadPluginsDone"></a> | |
| 487 <h4>PluginRepositoryWidget.__downloadPluginsDone</h4> | |
| 488 <b>__downloadPluginsDone</b>(<i></i>) | |
| 489 | |
| 490 <p> | |
| 491 Private method called, when the download of the plugins is finished. | |
| 492 </p> | |
| 493 <a NAME="PluginRepositoryWidget.__downloadProgress" ID="PluginRepositoryWidget.__downloadProgress"></a> | |
| 494 <h4>PluginRepositoryWidget.__downloadProgress</h4> | |
| 495 <b>__downloadProgress</b>(<i>done, total</i>) | |
| 496 | |
| 497 <p> | |
| 498 Private slot to show the download progress. | |
| 499 </p> | |
| 500 <dl> | |
| 501 | |
| 502 <dt><i>done</i></dt> | |
| 503 <dd> | |
| 504 number of bytes downloaded so far (integer) | |
| 505 </dd> | |
| 506 <dt><i>total</i></dt> | |
| 507 <dd> | |
| 508 total bytes to be downloaded (integer) | |
| 509 </dd> | |
| 510 </dl> | |
| 511 <a NAME="PluginRepositoryWidget.__downloadRepositoryFileDone" ID="PluginRepositoryWidget.__downloadRepositoryFileDone"></a> | |
| 512 <h4>PluginRepositoryWidget.__downloadRepositoryFileDone</h4> | |
| 513 <b>__downloadRepositoryFileDone</b>(<i>status, filename</i>) | |
| 514 | |
| 515 <p> | |
| 516 Private method called after the repository file was downloaded. | |
| 517 </p> | |
| 518 <dl> | |
| 519 | |
| 520 <dt><i>status</i></dt> | |
| 521 <dd> | |
| 522 flaging indicating a successful download (boolean) | |
| 523 </dd> | |
| 524 <dt><i>filename</i></dt> | |
| 525 <dd> | |
| 526 full path of the downloaded file (string) | |
| 527 </dd> | |
| 528 </dl> | |
| 529 <a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a> | |
| 530 <h4>PluginRepositoryWidget.__formatDescription</h4> | |
| 531 <b>__formatDescription</b>(<i>lines</i>) | |
| 532 | |
| 533 <p> | |
| 534 Private method to format the description. | |
| 535 </p> | |
| 536 <dl> | |
| 537 | |
| 538 <dt><i>lines</i></dt> | |
| 539 <dd> | |
| 540 lines of the description (list of strings) | |
| 541 </dd> | |
| 542 </dl> | |
| 543 <dl> | |
| 544 <dt>Return:</dt> | |
| 545 <dd> | |
| 546 formatted description (string) | |
| 547 </dd> | |
| 548 </dl> | |
| 549 <a NAME="PluginRepositoryWidget.__hasHiddenPlugins" ID="PluginRepositoryWidget.__hasHiddenPlugins"></a> | |
| 550 <h4>PluginRepositoryWidget.__hasHiddenPlugins</h4> | |
| 551 <b>__hasHiddenPlugins</b>(<i></i>) | |
| 552 | |
| 553 <p> | |
| 554 Private method to check, if there are any hidden plug-ins. | |
| 555 </p> | |
| 556 <dl> | |
| 557 <dt>Return:</dt> | |
| 558 <dd> | |
| 559 flag indicating the presence of hidden plug-ins (boolean) | |
| 560 </dd> | |
| 561 </dl> | |
| 562 <a NAME="PluginRepositoryWidget.__hidePlugin" ID="PluginRepositoryWidget.__hidePlugin"></a> | |
| 563 <h4>PluginRepositoryWidget.__hidePlugin</h4> | |
| 564 <b>__hidePlugin</b>(<i></i>) | |
| 565 | |
| 566 <p> | |
| 567 Private slot to hide the current plug-in. | |
| 568 </p> | |
| 569 <a NAME="PluginRepositoryWidget.__hideSelectedPlugins" ID="PluginRepositoryWidget.__hideSelectedPlugins"></a> | |
| 570 <h4>PluginRepositoryWidget.__hideSelectedPlugins</h4> | |
| 571 <b>__hideSelectedPlugins</b>(<i></i>) | |
| 572 | |
| 573 <p> | |
| 574 Private slot to hide all selected plug-ins. | |
| 575 </p> | |
| 576 <a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a> | |
| 577 <h4>PluginRepositoryWidget.__populateList</h4> | |
| 578 <b>__populateList</b>(<i></i>) | |
| 579 | |
| 580 <p> | |
| 581 Private method to populate the list of available plugins. | |
| 582 </p> | |
| 583 <a NAME="PluginRepositoryWidget.__reachabilityChanged" ID="PluginRepositoryWidget.__reachabilityChanged"></a> | |
| 584 <h4>PluginRepositoryWidget.__reachabilityChanged</h4> | |
| 585 <b>__reachabilityChanged</b>(<i>reachability</i>) | |
| 586 | |
| 587 <p> | |
| 588 Private slot handling reachability state changes. | |
| 589 </p> | |
| 590 <dl> | |
| 591 | |
| 592 <dt><i>reachability</i> (QNetworkInformation.Reachability)</dt> | |
| 593 <dd> | |
| 594 new reachability state | |
| 595 </dd> | |
| 596 </dl> | |
| 597 <a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a> | |
| 598 <h4>PluginRepositoryWidget.__resortRepositoryList</h4> | |
| 599 <b>__resortRepositoryList</b>(<i></i>) | |
| 600 | |
| 601 <p> | |
| 602 Private method to resort the tree. | |
| 603 </p> | |
| 604 <a NAME="PluginRepositoryWidget.__selectedItems" ID="PluginRepositoryWidget.__selectedItems"></a> | |
| 605 <h4>PluginRepositoryWidget.__selectedItems</h4> | |
| 606 <b>__selectedItems</b>(<i></i>) | |
| 607 | |
| 608 <p> | |
| 609 Private method to get all selected items without the toplevel ones. | |
| 610 </p> | |
| 611 <dl> | |
| 612 <dt>Return:</dt> | |
| 613 <dd> | |
| 614 list of selected items (list) | |
| 615 </dd> | |
| 616 </dl> | |
| 617 <a NAME="PluginRepositoryWidget.__showAllPlugins" ID="PluginRepositoryWidget.__showAllPlugins"></a> | |
| 618 <h4>PluginRepositoryWidget.__showAllPlugins</h4> | |
| 619 <b>__showAllPlugins</b>(<i></i>) | |
| 620 | |
| 621 <p> | |
| 622 Private slot to show all plug-ins. | |
| 623 </p> | |
| 624 <a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a> | |
| 625 <h4>PluginRepositoryWidget.__sslErrors</h4> | |
| 626 <b>__sslErrors</b>(<i>reply, errors</i>) | |
| 627 | |
| 628 <p> | |
| 629 Private slot to handle SSL errors. | |
| 630 </p> | |
| 631 <dl> | |
| 632 | |
| 633 <dt><i>reply</i></dt> | |
| 634 <dd> | |
| 635 reference to the reply object (QNetworkReply) | |
| 636 </dd> | |
| 637 <dt><i>errors</i></dt> | |
| 638 <dd> | |
| 639 list of SSL errors (list of QSslError) | |
| 640 </dd> | |
| 641 </dl> | |
| 642 <a NAME="PluginRepositoryWidget.__updateHiddenPluginsList" ID="PluginRepositoryWidget.__updateHiddenPluginsList"></a> | |
| 643 <h4>PluginRepositoryWidget.__updateHiddenPluginsList</h4> | |
| 644 <b>__updateHiddenPluginsList</b>(<i>hideList</i>) | |
| 645 | |
| 646 <p> | |
| 647 Private method to store the list of hidden plug-ins to the settings. | |
| 648 </p> | |
| 649 <dl> | |
| 650 | |
| 651 <dt><i>hideList</i></dt> | |
| 652 <dd> | |
| 653 list of plug-ins to add to the list of hidden ones | |
| 654 (list of string) | |
| 655 </dd> | |
| 656 </dl> | |
| 657 <a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a> | |
| 658 <h4>PluginRepositoryWidget.__updateList</h4> | |
| 659 <b>__updateList</b>(<i></i>) | |
| 660 | |
| 661 <p> | |
| 662 Private slot to download a new list and display the contents. | |
| 663 </p> | |
| 664 <a NAME="PluginRepositoryWidget.__updateStatus" ID="PluginRepositoryWidget.__updateStatus"></a> | |
| 665 <h4>PluginRepositoryWidget.__updateStatus</h4> | |
| 666 <b>__updateStatus</b>(<i>filename, version</i>) | |
| 667 | |
| 668 <p> | |
| 669 Private method to check the given archive update status. | |
| 670 </p> | |
| 671 <dl> | |
| 672 | |
| 673 <dt><i>filename</i></dt> | |
| 674 <dd> | |
| 675 data for the filename field (string) | |
| 676 </dd> | |
| 677 <dt><i>version</i></dt> | |
| 678 <dd> | |
| 679 data for the version field (string) | |
| 680 </dd> | |
| 681 </dl> | |
| 682 <dl> | |
| 683 <dt>Return:</dt> | |
| 684 <dd> | |
| 685 plug-in update status (integer, one of PluginStatusNew, | |
| 686 PluginStatusUpToDate, PluginStatusLocalUpdate, | |
| 687 PluginStatusRemoteUpdate) | |
| 688 </dd> | |
| 689 </dl> | |
| 690 <a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a> | |
| 691 <h4>PluginRepositoryWidget.addEntry</h4> | |
| 692 <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>) | |
| 693 | |
| 694 <p> | |
| 695 Public method to add an entry to the list. | |
| 696 </p> | |
| 697 <dl> | |
| 698 | |
| 699 <dt><i>name</i></dt> | |
| 700 <dd> | |
| 701 data for the name field (string) | |
| 702 </dd> | |
| 703 <dt><i>short</i></dt> | |
| 704 <dd> | |
| 705 data for the short field (string) | |
| 706 </dd> | |
| 707 <dt><i>description</i></dt> | |
| 708 <dd> | |
| 709 data for the description field (list of strings) | |
| 710 </dd> | |
| 711 <dt><i>url</i></dt> | |
| 712 <dd> | |
| 713 data for the url field (string) | |
| 714 </dd> | |
| 715 <dt><i>author</i></dt> | |
| 716 <dd> | |
| 717 data for the author field (string) | |
| 718 </dd> | |
| 719 <dt><i>version</i></dt> | |
| 720 <dd> | |
| 721 data for the version field (string) | |
| 722 </dd> | |
| 723 <dt><i>filename</i></dt> | |
| 724 <dd> | |
| 725 data for the filename field (string) | |
| 726 </dd> | |
| 727 <dt><i>status</i></dt> | |
| 728 <dd> | |
| 729 status of the plugin (string [stable, unstable, unknown]) | |
| 730 </dd> | |
| 731 </dl> | |
| 732 <a NAME="PluginRepositoryWidget.getDownloadedPlugins" ID="PluginRepositoryWidget.getDownloadedPlugins"></a> | |
| 733 <h4>PluginRepositoryWidget.getDownloadedPlugins</h4> | |
| 734 <b>getDownloadedPlugins</b>(<i></i>) | |
| 735 | |
| 736 <p> | |
| 737 Public method to get the list of recently downloaded plugin files. | |
| 738 </p> | |
| 739 <dl> | |
| 740 <dt>Return:</dt> | |
| 741 <dd> | |
| 742 list of plugin filenames (list of strings) | |
| 743 </dd> | |
| 744 </dl> | |
| 745 <a NAME="PluginRepositoryWidget.on_buttonBox_clicked" ID="PluginRepositoryWidget.on_buttonBox_clicked"></a> | |
| 746 <h4>PluginRepositoryWidget.on_buttonBox_clicked</h4> | |
| 747 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 748 | |
| 749 <p> | |
| 750 Private slot to handle the click of a button of the button box. | |
| 751 </p> | |
| 752 <dl> | |
| 753 | |
| 754 <dt><i>button</i></dt> | |
| 755 <dd> | |
| 756 reference to the button pressed (QAbstractButton) | |
| 757 </dd> | |
| 758 </dl> | |
| 759 <a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a> | |
| 760 <h4>PluginRepositoryWidget.on_repositoryList_currentItemChanged</h4> | |
| 761 <b>on_repositoryList_currentItemChanged</b>(<i>current, previous</i>) | |
| 762 | |
| 763 <p> | |
| 764 Private slot to handle the change of the current item. | |
| 765 </p> | |
| 766 <dl> | |
| 767 | |
| 768 <dt><i>current</i></dt> | |
| 769 <dd> | |
| 770 reference to the new current item (QTreeWidgetItem) | |
| 771 </dd> | |
| 772 <dt><i>previous</i></dt> | |
| 773 <dd> | |
| 774 reference to the old current item (QTreeWidgetItem) | |
| 775 </dd> | |
| 776 </dl> | |
| 777 <a NAME="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested" ID="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested"></a> | |
| 778 <h4>PluginRepositoryWidget.on_repositoryList_customContextMenuRequested</h4> | |
| 779 <b>on_repositoryList_customContextMenuRequested</b>(<i>pos</i>) | |
| 780 | |
| 781 <p> | |
| 782 Private slot to show the context menu. | |
| 783 </p> | |
| 784 <dl> | |
| 785 | |
| 786 <dt><i>pos</i></dt> | |
| 787 <dd> | |
| 788 position to show the menu (QPoint) | |
| 789 </dd> | |
| 790 </dl> | |
| 791 <a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a> | |
| 792 <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4> | |
| 793 <b>on_repositoryList_itemSelectionChanged</b>(<i></i>) | |
| 794 | |
| 795 <p> | |
| 796 Private slot to handle a change of the selection. | |
| 797 </p> | |
| 798 <a NAME="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled" ID="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled"></a> | |
| 799 <h4>PluginRepositoryWidget.on_repositoryUrlEditButton_toggled</h4> | |
| 800 <b>on_repositoryUrlEditButton_toggled</b>(<i>checked</i>) | |
| 801 | |
| 802 <p> | |
| 803 Private slot to set the read only status of the repository URL line | |
| 804 edit. | |
| 805 </p> | |
| 806 <dl> | |
| 807 | |
| 808 <dt><i>checked</i></dt> | |
| 809 <dd> | |
| 810 state of the push button (boolean) | |
| 811 </dd> | |
| 812 </dl> | |
| 813 <a NAME="PluginRepositoryWidget.reloadList" ID="PluginRepositoryWidget.reloadList"></a> | |
| 814 <h4>PluginRepositoryWidget.reloadList</h4> | |
| 815 <b>reloadList</b>(<i></i>) | |
| 816 | |
| 817 <p> | |
| 818 Public method to reload the list of plugins. | |
| 819 </p> | |
| 820 <div align="right"><a href="#top">Up</a></div> | |
| 821 <hr /> | |
| 822 <hr /> | |
| 823 <a NAME="PluginRepositoryWindow" ID="PluginRepositoryWindow"></a> | |
| 824 <h2>PluginRepositoryWindow</h2> | |
| 825 | |
| 826 <p> | |
| 827 Main window class for the standalone dialog. | |
| 828 </p> | |
| 829 <h3>Derived from</h3> | |
| 830 EricMainWindow | |
| 831 <h3>Class Attributes</h3> | |
| 832 | |
| 833 <table> | |
| 834 <tr><td>None</td></tr> | |
| 835 </table> | |
| 836 <h3>Class Methods</h3> | |
| 837 | |
| 838 <table> | |
| 839 <tr><td>None</td></tr> | |
| 840 </table> | |
| 841 <h3>Methods</h3> | |
| 842 | |
| 843 <table> | |
| 844 | |
| 845 <tr> | |
| 846 <td><a href="#PluginRepositoryWindow.__init__">PluginRepositoryWindow</a></td> | |
| 847 <td>Constructor</td> | |
| 848 </tr> | |
| 849 <tr> | |
| 850 <td><a href="#PluginRepositoryWindow.__startPluginInstall">__startPluginInstall</a></td> | |
| 851 <td>Private slot to start the eric plugin installation dialog.</td> | |
| 852 </tr> | |
| 853 </table> | |
| 854 <h3>Static Methods</h3> | |
| 855 | |
| 856 <table> | |
| 857 <tr><td>None</td></tr> | |
| 858 </table> | |
| 859 | |
| 860 <a NAME="PluginRepositoryWindow.__init__" ID="PluginRepositoryWindow.__init__"></a> | |
| 861 <h4>PluginRepositoryWindow (Constructor)</h4> | |
| 862 <b>PluginRepositoryWindow</b>(<i>parent=None</i>) | |
| 863 | |
| 864 <p> | |
| 865 Constructor | |
| 866 </p> | |
| 867 <dl> | |
| 868 | |
| 869 <dt><i>parent</i></dt> | |
| 870 <dd> | |
| 871 reference to the parent widget (QWidget) | |
| 872 </dd> | |
| 873 </dl> | |
| 874 <a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a> | |
| 875 <h4>PluginRepositoryWindow.__startPluginInstall</h4> | |
| 876 <b>__startPluginInstall</b>(<i></i>) | |
| 877 | |
| 878 <p> | |
| 879 Private slot to start the eric plugin installation dialog. | |
| 880 </p> | |
| 881 <div align="right"><a href="#top">Up</a></div> | |
| 882 <hr /> | |
| 883 <hr /> | |
| 884 <a NAME="PluginRepositoryDownloadCleanup" ID="PluginRepositoryDownloadCleanup"></a> | |
| 885 <h2>PluginRepositoryDownloadCleanup</h2> | |
| 886 <b>PluginRepositoryDownloadCleanup</b>(<i>quiet=False</i>) | |
| 887 | |
| 888 <p> | |
| 889 Module function to clean up the plug-in downloads area. | |
| 890 </p> | |
| 891 <dl> | |
| 892 | |
| 893 <dt><i>quiet</i> (bool)</dt> | |
| 894 <dd> | |
| 895 flag indicating quiet operations | |
| 896 </dd> | |
| 897 </dl> | |
| 898 <div align="right"><a href="#top">Up</a></div> | |
| 899 <hr /> | |
| 900 <hr /> | |
| 901 <a NAME="registerPlugin" ID="registerPlugin"></a> | |
| 902 <h2>registerPlugin</h2> | |
| 903 <b>registerPlugin</b>(<i>name, short, description, url, author, version, filename, status</i>) | |
| 904 | |
| 905 <p> | |
| 906 Method to register a plug-in's data. | |
| 907 </p> | |
| 908 <dl> | |
| 909 | |
| 910 <dt><i>name</i></dt> | |
| 911 <dd> | |
| 912 data for the name field (string) | |
| 913 </dd> | |
| 914 <dt><i>short</i></dt> | |
| 915 <dd> | |
| 916 data for the short field (string) | |
| 917 </dd> | |
| 918 <dt><i>description</i></dt> | |
| 919 <dd> | |
| 920 data for the description field (list of strings) | |
| 921 </dd> | |
| 922 <dt><i>url</i></dt> | |
| 923 <dd> | |
| 924 data for the url field (string) | |
| 925 </dd> | |
| 926 <dt><i>author</i></dt> | |
| 927 <dd> | |
| 928 data for the author field (string) | |
| 929 </dd> | |
| 930 <dt><i>version</i></dt> | |
| 931 <dd> | |
| 932 data for the version field (string) | |
| 933 </dd> | |
| 934 <dt><i>filename</i></dt> | |
| 935 <dd> | |
| 936 data for the filename field (string) | |
| 937 </dd> | |
| 938 <dt><i>status</i></dt> | |
| 939 <dd> | |
| 940 status of the plugin (string [stable, unstable, unknown]) | |
| 941 </dd> | |
| 942 </dl> | |
| 943 <div align="right"><a href="#top">Up</a></div> | |
| 944 <hr /> | |
| 945 </body></html> |
