--- a/src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PluginManager.PluginRepositoryDialog</h1>
-
<p>
Module implementing a dialog showing the available plugins.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>SSL_AVAILABLE</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PluginRepositoryDialog">PluginRepositoryDialog</a></td>
<td>Class for the dialog variant.</td>
@@ -37,10 +35,9 @@
<td>Class defining the various plugin status.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#PluginRepositoryDownloadCleanup">PluginRepositoryDownloadCleanup</a></td>
<td>Module function to clean up the plug-in downloads area.</td>
@@ -50,30 +47,29 @@
<td>Method to register a plug-in's data.</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>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PluginRepositoryDialog.__init__">PluginRepositoryDialog</a></td>
<td>Constructor</td>
@@ -87,19 +83,20 @@
<td>Public method to get the list of recently downloaded plugin files.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PluginRepositoryDialog.__init__" ID="PluginRepositoryDialog.__init__"></a>
<h4>PluginRepositoryDialog (Constructor)</h4>
<b>PluginRepositoryDialog</b>(<i>pluginManager, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>pluginManager</i> (PluginManager)</dt>
@@ -114,17 +111,17 @@
<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>Return:</dt>
<dd>
@@ -142,10 +139,10 @@
<hr />
<a NAME="PluginRepositoryWidget" ID="PluginRepositoryWidget"></a>
<h2>PluginRepositoryWidget</h2>
-
<p>
Class implementing a dialog showing the available plugins.
</p>
+
<h3>Signals</h3>
<dl>
@@ -158,19 +155,20 @@
<h3>Derived from</h3>
QWidget, Ui_PluginRepositoryDialog
<h3>Class Attributes</h3>
+<table>
+<tr><td>AuthorRole</td></tr>
+<tr><td>DescrRole</td></tr>
+<tr><td>FilenameRole</td></tr>
+<tr><td>UrlRole</td></tr>
+</table>
-<table>
-<tr><td>AuthorRole</td></tr><tr><td>DescrRole</td></tr><tr><td>FilenameRole</td></tr><tr><td>UrlRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PluginRepositoryWidget.__init__">PluginRepositoryWidget</a></td>
<td>Constructor</td>
@@ -316,19 +314,20 @@
<td>Public method to reload the list of plugins.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PluginRepositoryWidget.__init__" ID="PluginRepositoryWidget.__init__"></a>
<h4>PluginRepositoryWidget (Constructor)</h4>
<b>PluginRepositoryWidget</b>(<i>pluginManager, integrated=False, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>pluginManager</i> (PluginManager)</dt>
@@ -347,10 +346,10 @@
<a NAME="PluginRepositoryWidget.__changeScheme" ID="PluginRepositoryWidget.__changeScheme"></a>
<h4>PluginRepositoryWidget.__changeScheme</h4>
<b>__changeScheme</b>(<i>url, newScheme=""</i>)
-
<p>
Private method to change the scheme of the given URL.
</p>
+
<dl>
<dt><i>url</i> (str)</dt>
@@ -377,31 +376,31 @@
<a NAME="PluginRepositoryWidget.__cleanupDownloads" ID="PluginRepositoryWidget.__cleanupDownloads"></a>
<h4>PluginRepositoryWidget.__cleanupDownloads</h4>
<b>__cleanupDownloads</b>(<i></i>)
-
<p>
Private slot to cleanup the plug-in downloads area.
</p>
+
<a NAME="PluginRepositoryWidget.__closeAndInstall" ID="PluginRepositoryWidget.__closeAndInstall"></a>
<h4>PluginRepositoryWidget.__closeAndInstall</h4>
<b>__closeAndInstall</b>(<i></i>)
-
<p>
Private method to close the dialog and invoke the install dialog.
</p>
+
<a NAME="PluginRepositoryWidget.__downloadButtonClicked" ID="PluginRepositoryWidget.__downloadButtonClicked"></a>
<h4>PluginRepositoryWidget.__downloadButtonClicked</h4>
<b>__downloadButtonClicked</b>(<i></i>)
-
<p>
Private slot to handle a click of the Download button.
</p>
+
<a NAME="PluginRepositoryWidget.__downloadCancel" ID="PluginRepositoryWidget.__downloadCancel"></a>
<h4>PluginRepositoryWidget.__downloadCancel</h4>
<b>__downloadCancel</b>(<i>reply=None</i>)
-
<p>
Private slot to cancel the current download.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -412,10 +411,10 @@
<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> (str)</dt>
@@ -434,11 +433,11 @@
<a NAME="PluginRepositoryWidget.__downloadFileDone" ID="PluginRepositoryWidget.__downloadFileDone"></a>
<h4>PluginRepositoryWidget.__downloadFileDone</h4>
<b>__downloadFileDone</b>(<i>reply, fileName, doneMethod</i>)
-
<p>
Private method called, after the file has been downloaded
from the Internet.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -457,24 +456,24 @@
<a NAME="PluginRepositoryWidget.__downloadInstallButtonClicked" ID="PluginRepositoryWidget.__downloadInstallButtonClicked"></a>
<h4>PluginRepositoryWidget.__downloadInstallButtonClicked</h4>
<b>__downloadInstallButtonClicked</b>(<i></i>)
-
<p>
Private slot to handle a click of the Download & Install button.
</p>
+
<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> (bool)</dt>
@@ -489,24 +488,24 @@
<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.__downloadProgress" ID="PluginRepositoryWidget.__downloadProgress"></a>
<h4>PluginRepositoryWidget.__downloadProgress</h4>
<b>__downloadProgress</b>(<i>done, total</i>)
-
<p>
Private slot to show the download progress.
</p>
+
<dl>
<dt><i>done</i> (int)</dt>
@@ -521,10 +520,10 @@
<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> (list of str)</dt>
@@ -547,10 +546,10 @@
<a NAME="PluginRepositoryWidget.__hasHiddenPlugins" ID="PluginRepositoryWidget.__hasHiddenPlugins"></a>
<h4>PluginRepositoryWidget.__hasHiddenPlugins</h4>
<b>__hasHiddenPlugins</b>(<i></i>)
-
<p>
Private method to check, if there are any hidden plug-ins.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -566,38 +565,38 @@
<a NAME="PluginRepositoryWidget.__hidePlugin" ID="PluginRepositoryWidget.__hidePlugin"></a>
<h4>PluginRepositoryWidget.__hidePlugin</h4>
<b>__hidePlugin</b>(<i></i>)
-
<p>
Private slot to hide the current plug-in.
</p>
+
<a NAME="PluginRepositoryWidget.__hideSelectedPlugins" ID="PluginRepositoryWidget.__hideSelectedPlugins"></a>
<h4>PluginRepositoryWidget.__hideSelectedPlugins</h4>
<b>__hideSelectedPlugins</b>(<i></i>)
-
<p>
Private slot to hide all selected plug-ins.
</p>
+
<a NAME="PluginRepositoryWidget.__initHeaderItemsCache" ID="PluginRepositoryWidget.__initHeaderItemsCache"></a>
<h4>PluginRepositoryWidget.__initHeaderItemsCache</h4>
<b>__initHeaderItemsCache</b>(<i></i>)
-
<p>
Private method to initialize the cache variables for the header items.
</p>
+
<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.__reachabilityChanged" ID="PluginRepositoryWidget.__reachabilityChanged"></a>
<h4>PluginRepositoryWidget.__reachabilityChanged</h4>
<b>__reachabilityChanged</b>(<i>reachability</i>)
-
<p>
Private slot handling reachability state changes.
</p>
+
<dl>
<dt><i>reachability</i> (QNetworkInformation.Reachability)</dt>
@@ -608,17 +607,17 @@
<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 status and category items.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -634,17 +633,17 @@
<a NAME="PluginRepositoryWidget.__showAllPlugins" ID="PluginRepositoryWidget.__showAllPlugins"></a>
<h4>PluginRepositoryWidget.__showAllPlugins</h4>
<b>__showAllPlugins</b>(<i></i>)
-
<p>
Private slot to show all plug-ins.
</p>
+
<a NAME="PluginRepositoryWidget.__sslErrors" ID="PluginRepositoryWidget.__sslErrors"></a>
<h4>PluginRepositoryWidget.__sslErrors</h4>
<b>__sslErrors</b>(<i>reply, errors</i>)
-
<p>
Private slot to handle SSL errors.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -659,10 +658,10 @@
<a NAME="PluginRepositoryWidget.__updateHiddenPluginsList" ID="PluginRepositoryWidget.__updateHiddenPluginsList"></a>
<h4>PluginRepositoryWidget.__updateHiddenPluginsList</h4>
<b>__updateHiddenPluginsList</b>(<i>hideList</i>)
-
<p>
Private method to store the list of hidden plug-ins to the settings.
</p>
+
<dl>
<dt><i>hideList</i> (list of str)</dt>
@@ -673,17 +672,17 @@
<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.__updateStatus" ID="PluginRepositoryWidget.__updateStatus"></a>
<h4>PluginRepositoryWidget.__updateStatus</h4>
<b>__updateStatus</b>(<i>filename, version</i>)
-
<p>
Private method to check the given archive update status.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -711,10 +710,10 @@
<a NAME="PluginRepositoryWidget.addEntry" ID="PluginRepositoryWidget.addEntry"></a>
<h4>PluginRepositoryWidget.addEntry</h4>
<b>addEntry</b>(<i>name, short, description, url, author, version, filename, status, category, </i>)
-
<p>
Public method to add an entry to the list.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -757,10 +756,10 @@
<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>Return:</dt>
<dd>
@@ -776,10 +775,10 @@
<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>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -790,10 +789,10 @@
<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> (QTreeWidgetItem)</dt>
@@ -808,10 +807,10 @@
<a NAME="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested" ID="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested"></a>
<h4>PluginRepositoryWidget.on_repositoryList_customContextMenuRequested</h4>
<b>on_repositoryList_customContextMenuRequested</b>(<i>pos</i>)
-
<p>
Private slot to show the context menu.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -822,18 +821,18 @@
<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>
+
<a NAME="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled" ID="PluginRepositoryWidget.on_repositoryUrlEditButton_toggled"></a>
<h4>PluginRepositoryWidget.on_repositoryUrlEditButton_toggled</h4>
<b>on_repositoryUrlEditButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot to set the read only status of the repository URL line
edit.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -844,35 +843,33 @@
<a NAME="PluginRepositoryWidget.reloadList" ID="PluginRepositoryWidget.reloadList"></a>
<h4>PluginRepositoryWidget.reloadList</h4>
<b>reloadList</b>(<i></i>)
-
<p>
Public method to reload the list of plugins.
</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>
EricMainWindow
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PluginRepositoryWindow.__init__">PluginRepositoryWindow</a></td>
<td>Constructor</td>
@@ -882,19 +879,20 @@
<td>Private slot to start the eric plugin installation dialog.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</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> (QWidget)</dt>
@@ -905,52 +903,56 @@
<a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a>
<h4>PluginRepositoryWindow.__startPluginInstall</h4>
<b>__startPluginInstall</b>(<i></i>)
-
<p>
Private slot to start the eric plugin installation dialog.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="PluginStatus" ID="PluginStatus"></a>
<h2>PluginStatus</h2>
-
<p>
Class defining the various plugin status.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
+<table>
+<tr><td>Error</td></tr>
+<tr><td>LocalUpdate</td></tr>
+<tr><td>New</td></tr>
+<tr><td>RemoteUpdate</td></tr>
+<tr><td>UpToDate</td></tr>
+</table>
-<table>
-<tr><td>Error</td></tr><tr><td>LocalUpdate</td></tr><tr><td>New</td></tr><tr><td>RemoteUpdate</td></tr><tr><td>UpToDate</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="PluginRepositoryDownloadCleanup" ID="PluginRepositoryDownloadCleanup"></a>
<h2>PluginRepositoryDownloadCleanup</h2>
<b>PluginRepositoryDownloadCleanup</b>(<i>quiet=False</i>)
-
<p>
Module function to clean up the plug-in downloads area.
</p>
+
<dl>
<dt><i>quiet</i> (bool)</dt>
@@ -964,10 +966,10 @@
<a NAME="registerPlugin" ID="registerPlugin"></a>
<h2>registerPlugin</h2>
<b>registerPlugin</b>(<i>name, short, description, url, author, version, filename, status, category, </i>)
-
<p>
Method to register a plug-in's data.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1009,4 +1011,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
