--- a/src/eric7/Documentation/Source/eric7.PluginManager.PluginManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PluginManager.PluginManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PluginManager.PluginManager</h1>
-
<p>
Module implementing the Plugin Manager.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>SSL_AVAILABLE</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PluginManager">PluginManager</a></td>
<td>Class implementing the Plugin Manager.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PluginManager" ID="PluginManager"></a>
<h2>PluginManager</h2>
-
<p>
Class implementing the Plugin Manager.
</p>
+
<h3>Signals</h3>
<dl>
@@ -79,19 +78,17 @@
<h3>Derived from</h3>
QObject
<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="#PluginManager.__init__">PluginManager</a></td>
<td>Constructor</td>
@@ -273,16 +270,16 @@
<td>Public method to unload a plugin module.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a>
<h4>PluginManager (Constructor)</h4>
<b>PluginManager</b>(<i>parent=None, disabledPlugins=None, doLoadPlugins=True, develPlugin=None</i>)
-
<p>
Constructor
</p>
@@ -294,6 +291,7 @@
is the user plugin directory located inside the .eric7 directory
of the users home directory.
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -331,10 +329,10 @@
<a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a>
<h4>PluginManager.__canActivatePlugin</h4>
<b>__canActivatePlugin</b>(<i>module</i>)
-
<p>
Private method to check, if a plugin can be activated.
</p>
+
<dl>
<dt><i>module</i> (Module)</dt>
@@ -371,10 +369,10 @@
<a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a>
<h4>PluginManager.__canDeactivatePlugin</h4>
<b>__canDeactivatePlugin</b>(<i>module</i>)
-
<p>
Private method to check, if a plugin can be deactivated.
</p>
+
<dl>
<dt><i>module</i> (Module)</dt>
@@ -398,18 +396,18 @@
<a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a>
<h4>PluginManager.__checkPluginsDownloadDirectory</h4>
<b>__checkPluginsDownloadDirectory</b>(<i></i>)
-
<p>
Private slot to check for the existence of the plugins download
directory.
</p>
+
<a NAME="PluginManager.__downloadRepositoryFileDone" ID="PluginManager.__downloadRepositoryFileDone"></a>
<h4>PluginManager.__downloadRepositoryFileDone</h4>
<b>__downloadRepositoryFileDone</b>(<i>reply</i>)
-
<p>
Private method called after the repository file was downloaded.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -420,10 +418,10 @@
<a NAME="PluginManager.__getShortInfo" ID="PluginManager.__getShortInfo"></a>
<h4>PluginManager.__getShortInfo</h4>
<b>__getShortInfo</b>(<i>module</i>)
-
<p>
Private method to extract the short info from a module.
</p>
+
<dl>
<dt><i>module</i> (Module)</dt>
@@ -447,27 +445,27 @@
<a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a>
<h4>PluginManager.__insertPluginsPaths</h4>
<b>__insertPluginsPaths</b>(<i></i>)
-
<p>
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>
<b>__loadPlugins</b>(<i></i>)
-
<p>
Private method to load the plugins found.
</p>
+
<a NAME="PluginManager.__pluginDirectoriesExist" ID="PluginManager.__pluginDirectoriesExist"></a>
<h4>PluginManager.__pluginDirectoriesExist</h4>
<b>__pluginDirectoriesExist</b>(<i></i>)
-
<p>
Private method to check, if the plugin folders exist.
</p>
<p>
If the plugin folders don't exist, they are created (if possible).
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -484,10 +482,10 @@
<a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a>
<h4>PluginManager.__pluginModulesExist</h4>
<b>__pluginModulesExist</b>(<i></i>)
-
<p>
Private method to check, if there are plugins available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -503,10 +501,10 @@
<a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a>
<h4>PluginManager.__sslErrors</h4>
<b>__sslErrors</b>(<i>reply, errors</i>)
-
<p>
Private slot to handle SSL errors.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -521,10 +519,10 @@
<a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a>
<h4>PluginManager.activatePlugin</h4>
<b>activatePlugin</b>(<i>name, onDemand=False</i>)
-
<p>
Public method to activate a plugin.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -560,18 +558,18 @@
<a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a>
<h4>PluginManager.activatePlugins</h4>
<b>activatePlugins</b>(<i></i>)
-
<p>
Public method to activate all plugins having the "autoactivate"
attribute set to True.
</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, category, </i>)
-
<p>
Public method to check a plug-in's data for an update.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -614,14 +612,13 @@
<a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a>
<h4>PluginManager.checkPluginUpdatesAvailable</h4>
<b>checkPluginUpdatesAvailable</b>(<i></i>)
-
<p>
Public method to check the availability of updates of plug-ins.
</p>
+
<a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a>
<h4>PluginManager.clearPluginsPrivateData</h4>
<b>clearPluginsPrivateData</b>(<i>type_</i>)
-
<p>
Public method to clear the private data of plug-ins of a specified
type.
@@ -630,6 +627,7 @@
Plugins supporting this functionality must support the module function
clearPrivateData() and have the module level attribute pluginType.
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -640,10 +638,10 @@
<a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a>
<h4>PluginManager.deactivatePlugin</h4>
<b>deactivatePlugin</b>(<i>name, onDemand=False</i>)
-
<p>
Public method to deactivate a plugin.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -659,24 +657,24 @@
<a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a>
<h4>PluginManager.deactivateVcsPlugins</h4>
<b>deactivateVcsPlugins</b>(<i></i>)
-
<p>
Public method to deactivated all activated VCS plugins.
</p>
+
<a NAME="PluginManager.doShutdown" ID="PluginManager.doShutdown"></a>
<h4>PluginManager.doShutdown</h4>
<b>doShutdown</b>(<i></i>)
-
<p>
Public method called to perform actions upon shutdown of the IDE.
</p>
+
<a NAME="PluginManager.downLoadRepositoryFile" ID="PluginManager.downLoadRepositoryFile"></a>
<h4>PluginManager.downLoadRepositoryFile</h4>
<b>downLoadRepositoryFile</b>(<i>url=None</i>)
-
<p>
Public method to download the plugin repository file.
</p>
+
<dl>
<dt><i>url</i> (QUrl or str (optional))</dt>
@@ -688,17 +686,17 @@
<a NAME="PluginManager.finalizeSetup" ID="PluginManager.finalizeSetup"></a>
<h4>PluginManager.finalizeSetup</h4>
<b>finalizeSetup</b>(<i></i>)
-
<p>
Public method to finalize the setup of the plugin manager.
</p>
+
<a NAME="PluginManager.getPluginApiFiles" ID="PluginManager.getPluginApiFiles"></a>
<h4>PluginManager.getPluginApiFiles</h4>
<b>getPluginApiFiles</b>(<i>language</i>)
-
<p>
Public method to get the list of API files installed by a plugin.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -721,7 +719,6 @@
<a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a>
<h4>PluginManager.getPluginConfigData</h4>
<b>getPluginConfigData</b>(<i></i>)
-
<p>
Public method to get the config data of all active, non on-demand
plugins used by the configuration dialog.
@@ -752,6 +749,7 @@
be None</dd>
</dl>
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -767,10 +765,10 @@
<a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a>
<h4>PluginManager.getPluginDetails</h4>
<b>getPluginDetails</b>(<i>name</i>)
-
<p>
Public method to get detailed information about a plugin.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -793,10 +791,10 @@
<a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a>
<h4>PluginManager.getPluginDir</h4>
<b>getPluginDir</b>(<i>key</i>)
-
<p>
Public method to get the path of a plugin directory.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -819,11 +817,11 @@
<a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a>
<h4>PluginManager.getPluginDisplayStrings</h4>
<b>getPluginDisplayStrings</b>(<i>type_</i>)
-
<p>
Public method to get the display strings of all plugins of a specific
type.
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -846,11 +844,11 @@
<a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a>
<h4>PluginManager.getPluginExeDisplayData</h4>
<b>getPluginExeDisplayData</b>(<i></i>)
-
<p>
Public method to get data to display information about a plugins
external tool.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -893,10 +891,10 @@
<a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a>
<h4>PluginManager.getPluginInfos</h4>
<b>getPluginInfos</b>(<i></i>)
-
<p>
Public method to get infos about all loaded plug-ins.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -915,10 +913,10 @@
<a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a>
<h4>PluginManager.getPluginModules</h4>
<b>getPluginModules</b>(<i>pluginPath</i>)
-
<p>
Public method to get a list of plugin modules.
</p>
+
<dl>
<dt><i>pluginPath</i> (str)</dt>
@@ -941,11 +939,11 @@
<a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a>
<h4>PluginManager.getPluginObject</h4>
<b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>)
-
<p>
Public method to activate an on-demand plugin given by type and
type name.
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -977,10 +975,10 @@
<a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a>
<h4>PluginManager.getPluginPreviewPixmap</h4>
<b>getPluginPreviewPixmap</b>(<i>type_, name</i>)
-
<p>
Public method to get a preview pixmap of a plugin of a specific type.
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -1007,11 +1005,11 @@
<a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a>
<h4>PluginManager.getPluginQtHelpFiles</h4>
<b>getPluginQtHelpFiles</b>(<i></i>)
-
<p>
Public method to get the list of QtHelp documentation files provided
by a plug-in.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1028,7 +1026,6 @@
<a NAME="PluginManager.getVcsSystemIndicators" ID="PluginManager.getVcsSystemIndicators"></a>
<h4>PluginManager.getVcsSystemIndicators</h4>
<b>getVcsSystemIndicators</b>(<i></i>)
-
<p>
Public method to get the Vcs System indicators.
</p>
@@ -1037,6 +1034,7 @@
getVcsSystemIndicator returning a dictionary with indicator as key and
a tuple with the vcs name (string) and vcs display string (string).
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1054,13 +1052,13 @@
<a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a>
<h4>PluginManager.initOnDemandPlugin</h4>
<b>initOnDemandPlugin</b>(<i>name</i>)
-
<p>
Public method to create a plugin object for the named on demand plugin.
</p>
<p>
Note: The plug-in is not activated.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1079,20 +1077,20 @@
<a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a>
<h4>PluginManager.initOnDemandPlugins</h4>
<b>initOnDemandPlugins</b>(<i></i>)
-
<p>
Public method to create plugin objects for all on demand plugins.
</p>
<p>
Note: The plugins are not activated.
</p>
+
<a NAME="PluginManager.initPluginToolbars" ID="PluginManager.initPluginToolbars"></a>
<h4>PluginManager.initPluginToolbars</h4>
<b>initPluginToolbars</b>(<i>toolbarManager</i>)
-
<p>
Public method to initialize plug-in toolbars.
</p>
+
<dl>
<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
@@ -1103,10 +1101,10 @@
<a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a>
<h4>PluginManager.isPluginActive</h4>
<b>isPluginActive</b>(<i>pluginName</i>)
-
<p>
Public method to check, if a certain plugin is active.
</p>
+
<dl>
<dt><i>pluginName</i> (str)</dt>
@@ -1129,10 +1127,10 @@
<a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a>
<h4>PluginManager.isPluginLoaded</h4>
<b>isPluginLoaded</b>(<i>pluginName</i>)
-
<p>
Public method to check, if a certain plugin is loaded.
</p>
+
<dl>
<dt><i>pluginName</i> (str)</dt>
@@ -1155,13 +1153,13 @@
<a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a>
<h4>PluginManager.isValidPluginName</h4>
<b>isValidPluginName</b>(<i>pluginName</i>)
-
<p>
Public method to check, if a file name is a valid plugin name.
</p>
<p>
Plugin modules must start with "Plugin" and have the extension ".py".
</p>
+
<dl>
<dt><i>pluginName</i> (str)</dt>
@@ -1184,10 +1182,10 @@
<a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a>
<h4>PluginManager.loadDocumentationSetPlugins</h4>
<b>loadDocumentationSetPlugins</b>(<i></i>)
-
<p>
Public method to load just the documentation sets plugins.
</p>
+
<dl>
<dt>Raises <b>PluginModulesError</b>:</dt>
@@ -1199,7 +1197,6 @@
<a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a>
<h4>PluginManager.loadPlugin</h4>
<b>loadPlugin</b>(<i>name, directory, reload_=False, install=False</i>)
-
<p>
Public method to load a plugin module.
</p>
@@ -1209,6 +1206,7 @@
basic validity checks are performed as well. Modules failing these
checks are added to the failed modules list.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1240,10 +1238,10 @@
<a NAME="PluginManager.pipInstall" ID="PluginManager.pipInstall"></a>
<h4>PluginManager.pipInstall</h4>
<b>pipInstall</b>(<i>packages</i>)
-
<p>
Public method to install the given package via pip.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -1254,18 +1252,18 @@
<a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a>
<h4>PluginManager.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public slot to react to changes in configuration.
</p>
+
<a NAME="PluginManager.removePluginFromSysModules" ID="PluginManager.removePluginFromSysModules"></a>
<h4>PluginManager.removePluginFromSysModules</h4>
<b>removePluginFromSysModules</b>(<i>pluginName, package, internalPackages</i>)
-
<p>
Public method to remove a plugin and all related modules from
sys.modules.
</p>
+
<dl>
<dt><i>pluginName</i> (str)</dt>
@@ -1296,10 +1294,10 @@
<a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a>
<h4>PluginManager.unloadPlugin</h4>
<b>unloadPlugin</b>(<i>name</i>)
-
<p>
Public method to unload a plugin module.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1321,4 +1319,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
