--- a/src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html Thu Nov 16 13:58:04 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginRepositoryDialog.html Thu Nov 16 15:56:12 2023 +0100
@@ -32,6 +32,10 @@
<td><a href="#PluginRepositoryWindow">PluginRepositoryWindow</a></td>
<td>Main window class for the standalone dialog.</td>
</tr>
+<tr>
+<td><a href="#PluginStatus">PluginStatus</a></td>
+<td>Class defining the various plugin status.</td>
+</tr>
</table>
<h3>Functions</h3>
@@ -124,7 +128,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of plugin filenames (list of strings)
+list of plugin filenames
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -150,7 +160,7 @@
<h3>Class Attributes</h3>
<table>
-<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>
+<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>
@@ -218,10 +228,6 @@
<td>Private slot to show the download progress.</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>
@@ -238,6 +244,10 @@
<td>Private slot to hide all selected plug-ins.</td>
</tr>
<tr>
+<td><a href="#PluginRepositoryWidget.__initHeaderItemsCache">__initHeaderItemsCache</a></td>
+<td>Private method to initialize the cache variables for the header items.</td>
+</tr>
+<tr>
<td><a href="#PluginRepositoryWidget.__populateList">__populateList</a></td>
<td>Private method to populate the list of available plugins.</td>
</tr>
@@ -251,7 +261,7 @@
</tr>
<tr>
<td><a href="#PluginRepositoryWidget.__selectedItems">__selectedItems</a></td>
-<td>Private method to get all selected items without the toplevel ones.</td>
+<td>Private method to get all selected items without the status and category items.</td>
</tr>
<tr>
<td><a href="#PluginRepositoryWidget.__showAllPlugins">__showAllPlugins</a></td>
@@ -347,7 +357,7 @@
<dd>
URL to be modified
</dd>
-<dt><i>newScheme</i></dt>
+<dt><i>newScheme</i> (str)</dt>
<dd>
scheme to be set for the given URL
</dd>
@@ -408,15 +418,15 @@
</p>
<dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (str)</dt>
<dd>
-URL for the download (string)
+URL for the download
</dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-local name of the file (string)
+local name of the file
</dd>
-<dt><i>doneMethod</i></dt>
+<dt><i>doneMethod</i> (function)</dt>
<dd>
method to be called when done
</dd>
@@ -439,7 +449,7 @@
<dd>
local name of the file
</dd>
-<dt><i>doneMethod</i> (func)</dt>
+<dt><i>doneMethod</i> (function)</dt>
<dd>
method to be called when done
</dd>
@@ -467,13 +477,13 @@
</p>
<dl>
-<dt><i>status</i></dt>
+<dt><i>status</i> (bool)</dt>
<dd>
-flag indicating a successful download (boolean)
+flag indicating a successful download
</dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-full path of the downloaded file (string)
+full path of the downloaded file
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__downloadPlugins" ID="PluginRepositoryWidget.__downloadPlugins"></a>
@@ -499,31 +509,13 @@
</p>
<dl>
-<dt><i>done</i></dt>
+<dt><i>done</i> (int)</dt>
<dd>
-number of bytes downloaded so far (integer)
-</dd>
-<dt><i>total</i></dt>
-<dd>
-total bytes to be downloaded (integer)
+number of bytes downloaded so far
</dd>
-</dl>
-<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>
+<dt><i>total</i> (int)</dt>
<dd>
-flaging indicating a successful download (boolean)
-</dd>
-<dt><i>filename</i></dt>
-<dd>
-full path of the downloaded file (string)
+total bytes to be downloaded
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__formatDescription" ID="PluginRepositoryWidget.__formatDescription"></a>
@@ -535,15 +527,21 @@
</p>
<dl>
-<dt><i>lines</i></dt>
+<dt><i>lines</i> (list of str)</dt>
<dd>
-lines of the description (list of strings)
+lines of the description
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-formatted description (string)
+formatted description
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__hasHiddenPlugins" ID="PluginRepositoryWidget.__hasHiddenPlugins"></a>
@@ -556,7 +554,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the presence of hidden plug-ins (boolean)
+flag indicating the presence of hidden plug-ins
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__hidePlugin" ID="PluginRepositoryWidget.__hidePlugin"></a>
@@ -573,6 +577,13 @@
<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>)
@@ -606,12 +617,18 @@
<b>__selectedItems</b>(<i></i>)
<p>
- Private method to get all selected items without the toplevel ones.
+ Private method to get all selected items without the status and category items.
</p>
<dl>
<dt>Return:</dt>
<dd>
-list of selected items (list)
+list of selected items without header items
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__showAllPlugins" ID="PluginRepositoryWidget.__showAllPlugins"></a>
@@ -630,13 +647,13 @@
</p>
<dl>
-<dt><i>reply</i></dt>
+<dt><i>reply</i> (QNetworkReply)</dt>
<dd>
-reference to the reply object (QNetworkReply)
+reference to the reply object
</dd>
-<dt><i>errors</i></dt>
+<dt><i>errors</i> (list of QSslError)</dt>
<dd>
-list of SSL errors (list of QSslError)
+list of SSL errors
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__updateHiddenPluginsList" ID="PluginRepositoryWidget.__updateHiddenPluginsList"></a>
@@ -648,10 +665,9 @@
</p>
<dl>
-<dt><i>hideList</i></dt>
+<dt><i>hideList</i> (list of str)</dt>
<dd>
list of plug-ins to add to the list of hidden ones
- (list of string)
</dd>
</dl>
<a NAME="PluginRepositoryWidget.__updateList" ID="PluginRepositoryWidget.__updateList"></a>
@@ -670,63 +686,72 @@
</p>
<dl>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-data for the filename field (string)
+data for the filename field
</dd>
-<dt><i>version</i></dt>
+<dt><i>version</i> (str)</dt>
<dd>
-data for the version field (string)
+data for the version field
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-plug-in update status (integer, one of PluginStatusNew,
- PluginStatusUpToDate, PluginStatusLocalUpdate,
- PluginStatusRemoteUpdate)
+plug-in update status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int (one of PluginStatusNew, PluginStatusUpToDate,
+ PluginStatusLocalUpdate, PluginStatusRemoteUpdate)
</dd>
</dl>
<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>)
+<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></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-data for the name field (string)
+data for the name field
</dd>
-<dt><i>short</i></dt>
+<dt><i>short</i> (str)</dt>
<dd>
-data for the short field (string)
+data for the short field
</dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (list of str)</dt>
<dd>
-data for the description field (list of strings)
+data for the description field
</dd>
-<dt><i>url</i></dt>
+<dt><i>url</i> (str)</dt>
<dd>
-data for the url field (string)
+data for the url field
</dd>
-<dt><i>author</i></dt>
+<dt><i>author</i> (str)</dt>
<dd>
-data for the author field (string)
+data for the author field
</dd>
-<dt><i>version</i></dt>
+<dt><i>version</i> (str)</dt>
<dd>
-data for the version field (string)
+data for the version field
</dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-data for the filename field (string)
+data for the filename field
</dd>
-<dt><i>status</i></dt>
+<dt><i>status</i> (str)</dt>
<dd>
-status of the plugin (string [stable, unstable, unknown])
+status of the plugin (one of stable, unstable, unknown)
+</dd>
+<dt><i>category</i> (str)</dt>
+<dd>
+category designation of the plugin
</dd>
</dl>
<a NAME="PluginRepositoryWidget.getDownloadedPlugins" ID="PluginRepositoryWidget.getDownloadedPlugins"></a>
@@ -739,7 +764,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of plugin filenames (list of strings)
+list of plugin filenames
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="PluginRepositoryWidget.on_buttonBox_clicked" ID="PluginRepositoryWidget.on_buttonBox_clicked"></a>
@@ -751,9 +782,9 @@
</p>
<dl>
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
<dd>
-reference to the button pressed (QAbstractButton)
+reference to the button pressed
</dd>
</dl>
<a NAME="PluginRepositoryWidget.on_repositoryList_currentItemChanged" ID="PluginRepositoryWidget.on_repositoryList_currentItemChanged"></a>
@@ -765,13 +796,13 @@
</p>
<dl>
-<dt><i>current</i></dt>
+<dt><i>current</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the new current item (QTreeWidgetItem)
+reference to the new current item
</dd>
-<dt><i>previous</i></dt>
+<dt><i>previous</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the old current item (QTreeWidgetItem)
+reference to the old current item
</dd>
</dl>
<a NAME="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested" ID="PluginRepositoryWidget.on_repositoryList_customContextMenuRequested"></a>
@@ -783,9 +814,9 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
<dd>
-position to show the menu (QPoint)
+position to show the menu
</dd>
</dl>
<a NAME="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged" ID="PluginRepositoryWidget.on_repositoryList_itemSelectionChanged"></a>
@@ -805,9 +836,9 @@
</p>
<dl>
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
<dd>
-state of the push button (boolean)
+state of the push button
</dd>
</dl>
<a NAME="PluginRepositoryWidget.reloadList" ID="PluginRepositoryWidget.reloadList"></a>
@@ -866,9 +897,9 @@
</p>
<dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
</dd>
</dl>
<a NAME="PluginRepositoryWindow.__startPluginInstall" ID="PluginRepositoryWindow.__startPluginInstall"></a>
@@ -881,6 +912,38 @@
<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>
+<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>)
@@ -900,44 +963,48 @@
<hr />
<a NAME="registerPlugin" ID="registerPlugin"></a>
<h2>registerPlugin</h2>
-<b>registerPlugin</b>(<i>name, short, description, url, author, version, filename, status</i>)
+<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></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-data for the name field (string)
+data for the name field
</dd>
-<dt><i>short</i></dt>
+<dt><i>short</i> (str)</dt>
<dd>
-data for the short field (string)
+data for the short field
</dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (list of str)</dt>
<dd>
-data for the description field (list of strings)
+data for the description field
</dd>
-<dt><i>url</i></dt>
+<dt><i>url</i> (str)</dt>
<dd>
-data for the url field (string)
+data for the url field
</dd>
-<dt><i>author</i></dt>
+<dt><i>author</i> (str)</dt>
<dd>
-data for the author field (string)
+data for the author field
</dd>
-<dt><i>version</i></dt>
+<dt><i>version</i> (str)</dt>
<dd>
-data for the version field (string)
+data for the version field
</dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
<dd>
-data for the filename field (string)
+data for the filename field
</dd>
-<dt><i>status</i></dt>
+<dt><i>status</i> (str)</dt>
<dd>
-status of the plugin (string [stable, unstable, unknown])
+status of the plugin (one of stable, unstable, unknown)
+</dd>
+<dt><i>category</i> (str)</dt>
+<dd>
+category designation of the plugin
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
