Mercurial Repositories > eric / file revision
Documentation/Source/eric5.PluginManager.PluginRepositoryDialog.html@b88a0e6268bd
Documentation/Source/eric5.PluginManager.PluginRepositoryDialog.html
Wed, 06 Jan 2010 18:14:15 +0000
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Wed, 06 Jan 2010 18:14:15 +0000
- changeset 21
- b88a0e6268bd
- parent 17
- edde1fe80b3e
- child 58
- 37f0444c3479
- permissions
- -rw-r--r--
Fixed a bug in eric5-doc.py and regenerated docu.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.PluginManager.PluginRepositoryDialog</title> <style> body { background:white; margin: 0em 1em 10em 1em; color: black; } h1 { color: white; background: #4FA4FF; } h2 { color: white; background: #4FA4FF; } h3 { color: white; background: #00557F; } h4 { color: white; background: #00557F; } a { color: #AA5500; } </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.PluginManager.PluginRepositoryDialog</h1> <p> Module implementing a dialog showing the available plugins. </p> <h3>Global Attributes</h3> <table> <tr><td>authorRole</td></tr><tr><td>descrRole</td></tr><tr><td>filenameRole</td></tr><tr><td>urlRole</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#PluginRepositoryDialog">PluginRepositoryDialog</a></td> <td>Class for the dialog variant.</td> </tr><tr> <td><a href="#PluginRepositoryWidget">PluginRepositoryWidget</a></td> <td>Class implementing a dialog showing the available plugins.</td> </tr><tr> <td><a href="#PluginRepositoryWindow">PluginRepositoryWindow</a></td> <td>Main window class for the standalone dialog.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="PluginRepositoryDialog" ID="PluginRepositoryDialog"></a> <h2>PluginRepositoryDialog</h2> <p> Class for the dialog variant. </p> <h3>Derived from</h3> QDialog <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#PluginRepositoryDialog.__init__">PluginRepositoryDialog</a></td> <td>Constructor</td> </tr><tr> <td><a href="#PluginRepositoryDialog.__closeAndInstall">__closeAndInstall</a></td> <td>Private slot to handle the closeAndInstall signal.</td> </tr><tr> <td><a href="#PluginRepositoryDialog.getDownloadedPlugins">getDownloadedPlugins</a></td> <td>Public method to get the list of recently downloaded plugin files.</td> </tr> </table> <a NAME="PluginRepositoryDialog.__init__" ID="PluginRepositoryDialog.__init__"></a> <h4>PluginRepositoryDialog (Constructor)</h4> <b>PluginRepositoryDialog</b>(<i>parent = None</i>) <p> Constructor </p><dl> <dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> </dl><a NAME="PluginRepositoryDialog.__closeAndInstall" ID="PluginRepositoryDialog.__closeAndInstall"></a> <h4>PluginRepositoryDialog.__closeAndInstall</h4> <b>__closeAndInstall</b>(<i></i>) <p> Private slot to handle the closeAndInstall signal. </p><a NAME="PluginRepositoryDialog.getDownloadedPlugins" ID="PluginRepositoryDialog.getDownloadedPlugins"></a> <h4>PluginRepositoryDialog.getDownloadedPlugins</h4> <b>getDownloadedPlugins</b>(<i></i>) <p> Public method to get the list of recently downloaded plugin files. </p><dl> <dt>Returns:</dt> <dd> list of plugin filenames (list of strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="PluginRepositoryWidget" ID="PluginRepositoryWidget"></a> <h2>PluginRepositoryWidget</h2> <p> Class implementing a dialog showing the available plugins. </p><h4>Signals</h4> <dl> <dt>closeAndInstall</dt> <dd> emitted when the Close & Install button is pressed </dd> </dl> <h3>Derived from</h3> QWidget, Ui_PluginRepositoryDialog <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td> <td>Constructor</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__dataReadProgress">__dataReadProgress</a></td> <td>Private slot to show the download progress.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadCancel">__downloadCancel</a></td> <td>Private slot to cancel the current download.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadFile">__downloadFile</a></td> <td>Private slot to download the given file.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadFileDone">__downloadFileDone</a></td> <td>Private method called, after the file has been downloaded from the internet.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadPlugin">__downloadPlugin</a></td> <td>Private method to download the next plugin.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadPluginDone">__downloadPluginDone</a></td> <td>Private method called, when the download of a plugin is finished.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadPlugins">__downloadPlugins</a></td> <td>Private slot to download the selected plugins.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadPluginsDone">__downloadPluginsDone</a></td> <td>Private method called, when the download of the plugins is finished.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td> <td>Private method called after the repository file was downloaded.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__formatDescription">__formatDescription</a></td> <td>Private method to format the description.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__isUpToDate">__isUpToDate</a></td> <td>Private method to check, if the given archive is up-to-date.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td> <td>Private method to populate the list of available plugins.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__proxyAuthenticationRequired">__proxyAuthenticationRequired</a></td> <td>Private slot to handle a proxy authentication request.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__resortRepositoryList">__resortRepositoryList</a></td> <td>Private method to resort the tree.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td> <td>Private method to get all selected items without the toplevel ones.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__sslErrors">__sslErrors</a></td> <td>Private slot to handle SSL errors.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.__updateList">__updateList</a></td> <td>Private slot to download a new list and display the contents.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.addEntry">addEntry</a></td> <td>Public method to add an entry to the list.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.getDownloadedPlugins">getDownloadedPlugins</a></td> <td>Public method to get the list of recently downloaded plugin files.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot to handle the click of a button of the button box.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.on_repositoryList_currentItemChanged">on_repositoryList_currentItemChanged</a></td> <td>Private slot to handle the change of the current item.</td> </tr><tr> <td><a href="#PluginRepositoryWidget.on_repositoryList_itemSelectionChanged">on_repositoryList_itemSelectionChanged</a></td> <td>Private slot to handle a change of the selection.</td> </tr> </table> <a NAME="PluginRepositoryWidget.__init__" ID="PluginRepositoryWidget.__init__"></a> <h4>PluginRepositoryWidget (Constructor)</h4> <b>PluginRepositoryWidget</b>(<i>parent = None</i>) <p> Constructor </p><dl> <dt><i>parent</i></dt> <dd> parent of this dialog (QWidget) </dd> </dl><a NAME="PluginRepositoryWidget.__dataReadProgress" ID="PluginRepositoryWidget.__dataReadProgress"></a> <h4>PluginRepositoryWidget.__dataReadProgress</h4> <b>__dataReadProgress</b>(<i>done, total</i>) <p> Private slot to show the download progress. </p><dl> <dt><i>done</i></dt> <dd> number of bytes downloaded so far (integer) </dd><dt><i>total</i></dt> <dd> total bytes to be downloaded (integer) </dd> </dl><a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a> <h4>PluginRepositoryWidget.__downloadCancel</h4> <b>__downloadCancel</b>(<i></i>) <p> Private slot to cancel the current download. </p><a NAME="PluginRepositoryWidget.__downloadFile" ID="PluginRepositoryWidget.__downloadFile"></a> <h4>PluginRepositoryWidget.__downloadFile</h4> <b>__downloadFile</b>(<i>url, filename, doneMethod = None</i>) <p> Private slot to download the given file. </p><dl> <dt><i>url</i></dt> <dd> URL for the download (string) </dd><dt><i>filename</i></dt> <dd> local name of the file (string) </dd><dt><i>doneMethod</i></dt> <dd> method to be called when done </dd> </dl><a NAME="PluginRepositoryWidget.__downloadFileDone" ID="PluginRepositoryWidget.__downloadFileDone"></a> <h4>PluginRepositoryWidget.__downloadFileDone</h4> <b>__downloadFileDone</b>(<i>error</i>) <p> Private method called, after the file has been downloaded from the internet. </p><dl> <dt><i>error</i></dt> <dd> flag indicating an error condition (boolean) </dd> </dl><a NAME="PluginRepositoryWidget.__downloadPlugin" ID="PluginRepositoryWidget.__downloadPlugin"></a> <h4>PluginRepositoryWidget.__downloadPlugin</h4> <b>__downloadPlugin</b>(<i></i>) <p> Private method to download the next plugin. </p><a NAME="PluginRepositoryWidget.__downloadPluginDone" ID="PluginRepositoryWidget.__downloadPluginDone"></a> <h4>PluginRepositoryWidget.__downloadPluginDone</h4> <b>__downloadPluginDone</b>(<i>status, filename</i>) <p> Private method called, when the download of a plugin is finished. </p><dl> <dt><i>status</i></dt> <dd> flaging indicating a successful download (boolean) </dd><dt><i>filename</i></dt> <dd> full path of the downloaded file (string) </dd> </dl><a NAME="PluginRepositoryWidget.__downloadPlugins" ID="PluginRepositoryWidget.__downloadPlugins"></a> <h4>PluginRepositoryWidget.__downloadPlugins</h4> <b>__downloadPlugins</b>(<i></i>) <p> Private slot to download the selected plugins. </p><a NAME="PluginRepositoryWidget.__downloadPluginsDone" ID="PluginRepositoryWidget.__downloadPluginsDone"></a> <h4>PluginRepositoryWidget.__downloadPluginsDone</h4> <b>__downloadPluginsDone</b>(<i></i>) <p> Private method called, when the download of the plugins is finished. </p><a NAME="PluginRepositoryWidget.__downloadRepositoryFileDone" ID="PluginRepositoryWidget.__downloadRepositoryFileDone"></a> <h4>PluginRepositoryWidget.__downloadRepositoryFileDone</h4> <b>__downloadRepositoryFileDone</b>(<i>status, filename</i>) <p> Private method called after the repository file was downloaded. </p><dl> <dt><i>status</i></dt> <dd> flaging indicating a successful download (boolean) </dd><dt><i>filename</i></dt> <dd> full path of the downloaded file (string) </dd> </dl><a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a> <h4>PluginRepositoryWidget.__formatDescription</h4> <b>__formatDescription</b>(<i>lines</i>) <p> Private method to format the description. </p><dl> <dt><i>lines</i></dt> <dd> lines of the description (list of strings) </dd> </dl><dl> <dt>Returns:</dt> <dd> formatted description (string) </dd> </dl><a NAME="PluginRepositoryWidget.__isUpToDate" ID="PluginRepositoryWidget.__isUpToDate"></a> <h4>PluginRepositoryWidget.__isUpToDate</h4> <b>__isUpToDate</b>(<i>filename, version</i>) <p> Private method to check, if the given archive is up-to-date. </p><dl> <dt><i>filename</i></dt> <dd> data for the filename field (string) </dd><dt><i>version</i></dt> <dd> data for the version field (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> flag indicating up-to-date (boolean) </dd> </dl><a NAME="PluginRepositoryWidget.__populateList" ID="PluginRepositoryWidget.__populateList"></a> <h4>PluginRepositoryWidget.__populateList</h4> <b>__populateList</b>(<i></i>) <p> Private method to populate the list of available plugins. </p><a NAME="PluginRepositoryWidget.__proxyAuthenticationRequired" ID="PluginRepositoryWidget.__proxyAuthenticationRequired"></a> <h4>PluginRepositoryWidget.__proxyAuthenticationRequired</h4> <b>__proxyAuthenticationRequired</b>(<i>proxy, auth</i>) <p> Private slot to handle a proxy authentication request. </p><dl> <dt><i>proxy</i></dt> <dd> reference to the proxy object (QNetworkProxy) </dd><dt><i>auth</i></dt> <dd> reference to the authenticator object (QAuthenticator) </dd> </dl><a NAME="PluginRepositoryWidget.__resortRepositoryList" ID="PluginRepositoryWidget.__resortRepositoryList"></a> <h4>PluginRepositoryWidget.__resortRepositoryList</h4> <b>__resortRepositoryList</b>(<i></i>) <p> Private method to resort the tree. </p><a NAME="PluginRepositoryWidget.__selectedItems" ID="PluginRepositoryWidget.__selectedItems"></a> <h4>PluginRepositoryWidget.__selectedItems</h4> <b>__selectedItems</b>(<i></i>) <p> Private method to get all selected items without the toplevel ones. </p><dl> <dt>Returns:</dt> <dd> list of selected items (list) </dd> </dl><a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a> <h4>PluginRepositoryWidget.__sslErrors</h4> <b>__sslErrors</b>(<i>sslErrors</i>) <p> Private slot to handle SSL errors. </p><dl> <dt><i>sslErrors</i></dt> <dd> list of SSL errors (list of QSslError) </dd> </dl><a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a> <h4>PluginRepositoryWidget.__updateList</h4> <b>__updateList</b>(<i></i>) <p> Private slot to download a new list and display the contents. </p><a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a> <h4>PluginRepositoryWidget.addEntry</h4> <b>addEntry</b>(<i>name, short, description, url, author, version, filename, status</i>) <p> Public method to add an entry to the list. </p><dl> <dt><i>name</i></dt> <dd> data for the name field (string) </dd><dt><i>short</i></dt> <dd> data for the short field (string) </dd><dt><i>description</i></dt> <dd> data for the description field (list of strings) </dd><dt><i>url</i></dt> <dd> data for the url field (string) </dd><dt><i>author</i></dt> <dd> data for the author field (string) </dd><dt><i>version</i></dt> <dd> data for the version field (string) </dd><dt><i>filename</i></dt> <dd> data for the filename field (string) </dd><dt><i>status</i></dt> <dd> status of the plugin (string [stable, unstable, unknown]) </dd> </dl><a NAME="PluginRepositoryWidget.getDownloadedPlugins" ID="PluginRepositoryWidget.getDownloadedPlugins"></a> <h4>PluginRepositoryWidget.getDownloadedPlugins</h4> <b>getDownloadedPlugins</b>(<i></i>) <p> Public method to get the list of recently downloaded plugin files. </p><dl> <dt>Returns:</dt> <dd> list of plugin filenames (list of strings) </dd> </dl><a NAME="PluginRepositoryWidget.on_buttonBox_clicked" ID="PluginRepositoryWidget.on_buttonBox_clicked"></a> <h4>PluginRepositoryWidget.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) <p> Private slot to handle the click of a button of the button box. </p><a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a> <h4>PluginRepositoryWidget.on_repositoryList_currentItemChanged</h4> <b>on_repositoryList_currentItemChanged</b>(<i>current, previous</i>) <p> Private slot to handle the change of the current item. </p><dl> <dt><i>current</i></dt> <dd> reference to the new current item (QTreeWidgetItem) </dd><dt><i>previous</i></dt> <dd> reference to the old current item (QTreeWidgetItem) </dd> </dl><a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a> <h4>PluginRepositoryWidget.on_repositoryList_itemSelectionChanged</h4> <b>on_repositoryList_itemSelectionChanged</b>(<i></i>) <p> Private slot to handle a change of the selection. </p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="PluginRepositoryWindow" ID="PluginRepositoryWindow"></a> <h2>PluginRepositoryWindow</h2> <p> Main window class for the standalone dialog. </p> <h3>Derived from</h3> QMainWindow <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#PluginRepositoryWindow.__init__">PluginRepositoryWindow</a></td> <td>Constructor</td> </tr><tr> <td><a href="#PluginRepositoryWindow.__startPluginInstall">__startPluginInstall</a></td> <td>Private slot to start the eric5 plugin installation dialog.</td> </tr> </table> <a NAME="PluginRepositoryWindow.__init__" ID="PluginRepositoryWindow.__init__"></a> <h4>PluginRepositoryWindow (Constructor)</h4> <b>PluginRepositoryWindow</b>(<i>parent = None</i>) <p> Constructor </p><dl> <dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> </dl><a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a> <h4>PluginRepositoryWindow.__startPluginInstall</h4> <b>__startPluginInstall</b>(<i></i>) <p> Private slot to start the eric5 plugin installation dialog. </p> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
