diff -r 8f69edb4ad73 -r 1f7d52f024b1 src/eric7/Documentation/Source/eric7.PluginManager.PluginManager.html
--- a/src/eric7/Documentation/Source/eric7.PluginManager.PluginManager.html Thu Nov 16 13:58:04 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginManager.html Thu Nov 16 15:56:12 2023 +0100
@@ -118,7 +118,7 @@
</tr>
<tr>
<td><a href="#PluginManager.__insertPluginsPaths">__insertPluginsPaths</a></td>
-<td>Private method to insert the valid plugin paths intos the search path.</td>
+<td>Private method to insert the valid plugin paths into the search path.</td>
</tr>
<tr>
<td><a href="#PluginManager.__loadPlugins">__loadPlugins</a></td>
@@ -210,7 +210,7 @@
</tr>
<tr>
<td><a href="#PluginManager.getPluginObject">getPluginObject</a></td>
-<td>Public method to activate an ondemand plugin given by type and typename.</td>
+<td>Public method to activate an on-demand plugin given by type and type name.</td>
</tr>
<tr>
<td><a href="#PluginManager.getPluginPreviewPixmap">getPluginPreviewPixmap</a></td>
@@ -337,7 +337,7 @@
</p>
<dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
<dd>
reference to the module to be activated
</dd>
@@ -346,7 +346,13 @@
<dt>Return:</dt>
<dd>
flag indicating, if the module satisfies all requirements
- for being activated (boolean)
+ for being activated
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<dl>
@@ -371,7 +377,7 @@
</p>
<dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
<dd>
reference to the module to be deactivated
</dd>
@@ -380,7 +386,13 @@
<dt>Return:</dt>
<dd>
flag indicating, if the module satisfies all requirements
- for being deactivated (boolean)
+ for being deactivated
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a>
@@ -414,7 +426,7 @@
</p>
<dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (Module)</dt>
<dd>
module to extract short info from
</dd>
@@ -422,7 +434,7 @@
<dl>
<dt>Return:</dt>
<dd>
-dictionay containing plug-in data
+dictionary containing plug-in data
</dd>
</dl>
<dl>
@@ -437,7 +449,7 @@
<b>__insertPluginsPaths</b>(<i></i>)
<p>
- Private method to insert the valid plugin paths intos the search path.
+ Private method to insert the valid plugin paths into the search path.
</p>
<a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a>
<h4>PluginManager.__loadPlugins</h4>
@@ -460,7 +472,13 @@
<dt>Return:</dt>
<dd>
tuple of a flag indicating existence of any of the plugin
- directories (boolean) and a message (string)
+ directories and a message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
</dd>
</dl>
<a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a>
@@ -473,7 +491,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the availability of plugins (boolean)
+flag indicating the availability of plugins
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a>
@@ -485,13 +509,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="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a>
@@ -543,44 +567,48 @@
</p>
<a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a>
<h4>PluginManager.checkPluginEntry</h4>
-<b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status, </i>)
+<b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status, category, </i>)
<p>
Public method to check a plug-in's data for an update.
</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="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a>
@@ -604,9 +632,9 @@
</p>
<dl>
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
<dd>
-type of the plugin to clear private data for (string)
+type of the plugin to clear private data for
</dd>
</dl>
<a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a>
@@ -618,14 +646,14 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
name of the module to be deactivated
</dd>
-<dt><i>onDemand</i></dt>
+<dt><i>onDemand</i> (bool)</dt>
<dd>
flag indicating deactivation of an
- on demand plugin (boolean)
+ on demand plugin
</dd>
</dl>
<a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a>
@@ -673,15 +701,21 @@
</p>
<dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-language of the requested API files (string)
+language of the requested API files
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of API filenames (list of string)
+list of API filenames
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a>
@@ -724,6 +758,12 @@
plug-in configuration data
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a>
<h4>PluginManager.getPluginDetails</h4>
<b>getPluginDetails</b>(<i>name</i>)
@@ -733,9 +773,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the module to get detailed infos about (string)
+name of the module to get detailed infos about
</dd>
</dl>
<dl>
@@ -744,6 +784,12 @@
details of the plugin as a dictionary
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a>
<h4>PluginManager.getPluginDir</h4>
<b>getPluginDir</b>(<i>key</i>)
@@ -753,15 +799,21 @@
</p>
<dl>
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
<dd>
-key of the plug-in directory (string)
+key of the plug-in directory
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-path of the requested plugin directory (string)
+path of the requested plugin directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a>
@@ -774,16 +826,21 @@
</p>
<dl>
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
<dd>
-type of the plugins (string)
+type of the plugins
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
dictionary with name as key and display string as value
- (dictionary of string)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
</dd>
</dl>
<a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a>
@@ -827,6 +884,12 @@
</ul>
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of dict
+</dd>
+</dl>
<a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a>
<h4>PluginManager.getPluginInfos</h4>
<b>getPluginInfos</b>(<i></i>)
@@ -858,15 +921,21 @@
</p>
<dl>
-<dt><i>pluginPath</i></dt>
+<dt><i>pluginPath</i> (str)</dt>
<dd>
-name of the path to search (string)
+name of the path to search
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-list of plugin module names (list of string)
+list of plugin module names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a>
@@ -874,8 +943,8 @@
<b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>)
<p>
- Public method to activate an ondemand plugin given by type and
- typename.
+ Public method to activate an on-demand plugin given by type and
+ type name.
</p>
<dl>
@@ -914,19 +983,25 @@
</p>
<dl>
-<dt><i>type_</i></dt>
+<dt><i>type_</i> (str)</dt>
<dd>
-type of the plugin (string)
+type of the plugin
</dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the plugin type (string)
+name of the plugin type
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-preview pixmap (QPixmap)
+preview pixmap
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPixmap
</dd>
</dl>
<a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a>
@@ -966,8 +1041,14 @@
<dt>Return:</dt>
<dd>
dictionary with indicator as key and a list of tuples as
- values. Each tuple contains the vcs name (string) and vcs display
- string (string).
+ values. Each tuple contains the vcs name (str) and vcs display
+ string (str).
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
</dd>
</dl>
<a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a>
@@ -982,9 +1063,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the plug-in (string)
+name of the plug-in
</dd>
</dl>
<dl>
@@ -1014,10 +1095,9 @@
</p>
<dl>
-<dt><i>toolbarManager</i></dt>
+<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
<dd>
reference to the toolbar manager object
- (EricToolBarManager)
</dd>
</dl>
<a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a>
@@ -1029,15 +1109,21 @@
</p>
<dl>
-<dt><i>pluginName</i></dt>
+<dt><i>pluginName</i> (str)</dt>
<dd>
-name of the plugin to check for (string)
+name of the plugin to check for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, if the plugin is active (boolean)
+flag indicating, if the plugin is active
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a>
@@ -1049,15 +1135,21 @@
</p>
<dl>
-<dt><i>pluginName</i></dt>
+<dt><i>pluginName</i> (str)</dt>
<dd>
-name of the plugin to check for (string)
+name of the plugin to check for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, if the plugin is loaded (boolean)
+flag indicating, if the plugin is loaded
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a>
@@ -1072,15 +1164,21 @@
</p>
<dl>
-<dt><i>pluginName</i></dt>
+<dt><i>pluginName</i> (str)</dt>
<dd>
-name of the file to be checked (string)
+name of the file to be checked
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a valid plugin name (boolean)
+flag indicating a valid plugin name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a>
@@ -1170,24 +1268,29 @@
</p>
<dl>
-<dt><i>pluginName</i></dt>
+<dt><i>pluginName</i> (str)</dt>
<dd>
-name of the plugin module (string)
+name of the plugin module
</dd>
-<dt><i>package</i></dt>
+<dt><i>package</i> (str)</dt>
<dd>
-name of the plugin package (string)
+name of the plugin package
</dd>
-<dt><i>internalPackages</i></dt>
+<dt><i>internalPackages</i> (list of str)</dt>
<dd>
-list of intenal packages (list of string)
+list of intenal packages
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating the plugin module was found in sys.modules
- (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a>
@@ -1199,15 +1302,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the module to be unloaded (string)
+name of the module to be unloaded
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
