diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.PluginManager.PluginManager.html
--- a/Documentation/Source/eric5.PluginManager.PluginManager.html Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.PluginManager.PluginManager.html Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
<body><a NAME="top" ID="top"></a>
<h1>eric5.PluginManager.PluginManager</h1>
<p>
-Module implementing the Plugin Manager.
+Module implementing the Plugin Manager.
</p>
<h3>Global Attributes</h3>
<table>
@@ -32,7 +32,7 @@
<table>
<tr>
<td><a href="#PluginManager">PluginManager</a></td>
-<td>Class implementing the Plugin Manager.</td>
+<td>Class implementing the Plugin Manager.</td>
</tr>
</table>
<h3>Functions</h3>
@@ -43,32 +43,32 @@
<a NAME="PluginManager" ID="PluginManager"></a>
<h2>PluginManager</h2>
<p>
- Class implementing the Plugin Manager.
+ Class implementing the Plugin Manager.
</p><h4>Signals</h4>
<dl>
<dt>allPlugginsActivated()</dt>
<dd>
-emitted at startup after all plugins have
- been activated
+emitted at startup after all plugins have
+ been activated
</dd><dt>pluginAboutToBeActivated(modulName, pluginObject)</dt>
<dd>
-emitted just before a
- plugin is activated
+emitted just before a
+ plugin is activated
</dd><dt>pluginAboutToBeDeactivated(modulName, pluginObject)</dt>
<dd>
-emitted just before a
- plugin is deactivated
+emitted just before a
+ plugin is deactivated
</dd><dt>pluginActivated(modulName, pluginObject)</dt>
<dd>
-emitted just after a plugin
- was activated
+emitted just after a plugin
+ was activated
</dd><dt>pluginDeactivated(modulName, pluginObject)</dt>
<dd>
-emitted just after a plugin
- was deactivated
+emitted just after a plugin
+ was deactivated
</dd><dt>shutdown()</dt>
<dd>
-emitted at shutdown of the IDE
+emitted at shutdown of the IDE
</dd>
</dl>
<h3>Derived from</h3>
@@ -81,603 +81,603 @@
<table>
<tr>
<td><a href="#PluginManager.__init__">PluginManager</a></td>
-<td>Constructor</td>
+<td>Constructor</td>
</tr><tr>
<td><a href="#PluginManager.__canActivatePlugin">__canActivatePlugin</a></td>
-<td>Private method to check, if a plugin can be activated.</td>
+<td>Private method to check, if a plugin can be activated.</td>
</tr><tr>
<td><a href="#PluginManager.__canDeactivatePlugin">__canDeactivatePlugin</a></td>
-<td>Private method to check, if a plugin can be deactivated.</td>
+<td>Private method to check, if a plugin can be deactivated.</td>
</tr><tr>
<td><a href="#PluginManager.__checkPluginsDownloadDirectory">__checkPluginsDownloadDirectory</a></td>
-<td>Private slot to check for the existence of the plugins download directory.</td>
+<td>Private slot to check for the existence of the plugins download directory.</td>
</tr><tr>
<td><a href="#PluginManager.__getShortInfo">__getShortInfo</a></td>
-<td>Private method to extract the short info from a module.</td>
+<td>Private method to extract the short info from a module.</td>
</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 intos the search path.</td>
</tr><tr>
<td><a href="#PluginManager.__loadPlugins">__loadPlugins</a></td>
-<td>Private method to load the plugins found.</td>
+<td>Private method to load the plugins found.</td>
</tr><tr>
<td><a href="#PluginManager.__pluginDirectoriesExist">__pluginDirectoriesExist</a></td>
-<td>Private method to check, if the plugin folders exist.</td>
+<td>Private method to check, if the plugin folders exist.</td>
</tr><tr>
<td><a href="#PluginManager.__pluginModulesExist">__pluginModulesExist</a></td>
-<td>Private method to check, if there are plugins available.</td>
+<td>Private method to check, if there are plugins available.</td>
</tr><tr>
<td><a href="#PluginManager.activatePlugin">activatePlugin</a></td>
-<td>Public method to activate a plugin.</td>
+<td>Public method to activate a plugin.</td>
</tr><tr>
<td><a href="#PluginManager.activatePlugins">activatePlugins</a></td>
-<td>Public method to activate all plugins having the "autoactivate" attribute set to True.</td>
+<td>Public method to activate all plugins having the "autoactivate" attribute set to True.</td>
</tr><tr>
<td><a href="#PluginManager.deactivatePlugin">deactivatePlugin</a></td>
-<td>Public method to deactivate a plugin.</td>
+<td>Public method to deactivate a plugin.</td>
</tr><tr>
<td><a href="#PluginManager.deactivateVcsPlugins">deactivateVcsPlugins</a></td>
-<td>Public method to deactivated all activated VCS plugins.</td>
+<td>Public method to deactivated all activated VCS plugins.</td>
</tr><tr>
<td><a href="#PluginManager.finalizeSetup">finalizeSetup</a></td>
-<td>Public method to finalize the setup of the plugin manager.</td>
+<td>Public method to finalize the setup of the plugin manager.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginApiFiles">getPluginApiFiles</a></td>
-<td>Public method to get the list of API files installed by a plugin.</td>
+<td>Public method to get the list of API files installed by a plugin.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginConfigData">getPluginConfigData</a></td>
-<td>Public method to get the config data of all active, non on-demand plugins used by the configuration dialog.</td>
+<td>Public method to get the config data of all active, non on-demand plugins used by the configuration dialog.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginDetails">getPluginDetails</a></td>
-<td>Public method to get detailed information about a plugin.</td>
+<td>Public method to get detailed information about a plugin.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginDir">getPluginDir</a></td>
-<td>Public method to get the path of a plugin directory.</td>
+<td>Public method to get the path of a plugin directory.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginDisplayStrings">getPluginDisplayStrings</a></td>
-<td>Public method to get the display strings of all plugins of a specific type.</td>
+<td>Public method to get the display strings of all plugins of a specific type.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginExeDisplayData">getPluginExeDisplayData</a></td>
-<td>Public method to get data to display information about a plugins external tool.</td>
+<td>Public method to get data to display information about a plugins external tool.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginInfos">getPluginInfos</a></td>
-<td>Public method to get infos about all loaded plugins.</td>
+<td>Public method to get infos about all loaded plugins.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginModules">getPluginModules</a></td>
-<td>Public method to get a list of plugin modules.</td>
+<td>Public method to get a list of plugin modules.</td>
</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 ondemand plugin given by type and typename.</td>
</tr><tr>
<td><a href="#PluginManager.getPluginPreviewPixmap">getPluginPreviewPixmap</a></td>
-<td>Public method to get a preview pixmap of a plugin of a specific type.</td>
+<td>Public method to get a preview pixmap of a plugin of a specific type.</td>
</tr><tr>
<td><a href="#PluginManager.getVcsSystemIndicators">getVcsSystemIndicators</a></td>
-<td>Public method to get the Vcs System indicators.</td>
+<td>Public method to get the Vcs System indicators.</td>
</tr><tr>
<td><a href="#PluginManager.initOnDemandPlugin">initOnDemandPlugin</a></td>
-<td>Public method to create a plugin object for the named on demand plugin.</td>
+<td>Public method to create a plugin object for the named on demand plugin.</td>
</tr><tr>
<td><a href="#PluginManager.initOnDemandPlugins">initOnDemandPlugins</a></td>
-<td>Public method to create plugin objects for all on demand plugins.</td>
+<td>Public method to create plugin objects for all on demand plugins.</td>
</tr><tr>
<td><a href="#PluginManager.isPluginActive">isPluginActive</a></td>
-<td>Public method to check, if a certain plugin is active.</td>
+<td>Public method to check, if a certain plugin is active.</td>
</tr><tr>
<td><a href="#PluginManager.isPluginLoaded">isPluginLoaded</a></td>
-<td>Public method to check, if a certain plugin is loaded.</td>
+<td>Public method to check, if a certain plugin is loaded.</td>
</tr><tr>
<td><a href="#PluginManager.isValidPluginName">isValidPluginName</a></td>
-<td>Public methode to check, if a file name is a valid plugin name.</td>
+<td>Public methode to check, if a file name is a valid plugin name.</td>
</tr><tr>
<td><a href="#PluginManager.loadPlugin">loadPlugin</a></td>
-<td>Public method to load a plugin module.</td>
+<td>Public method to load a plugin module.</td>
</tr><tr>
<td><a href="#PluginManager.preferencesChanged">preferencesChanged</a></td>
-<td>Public slot to react to changes in configuration.</td>
+<td>Public slot to react to changes in configuration.</td>
</tr><tr>
<td><a href="#PluginManager.removePluginFromSysModules">removePluginFromSysModules</a></td>
-<td>Public method to remove a plugin and all related modules from sys.modules.</td>
+<td>Public method to remove a plugin and all related modules from sys.modules.</td>
</tr><tr>
<td><a href="#PluginManager.shutdown">shutdown</a></td>
-<td>Public method called to perform actions upon shutdown of the IDE.</td>
+<td>Public method called to perform actions upon shutdown of the IDE.</td>
</tr><tr>
<td><a href="#PluginManager.unloadPlugin">unloadPlugin</a></td>
-<td>Public method to unload a plugin module.</td>
+<td>Public method to unload a plugin module.</td>
</tr>
</table>
<a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a>
<h4>PluginManager (Constructor)</h4>
<b>PluginManager</b>(<i>parent = None, doLoadPlugins = True, develPlugin = None</i>)
<p>
- Constructor
+ Constructor
</p><p>
- The Plugin Manager deals with three different plugin directories.
- The first is the one, that is part of eric5 (eric5/Plugins). The
- second one is the global plugin directory called 'eric5plugins',
- which is located inside the site-packages directory. The last one
- is the user plugin directory located inside the .eric5 directory
- of the users home directory.
+ The Plugin Manager deals with three different plugin directories.
+ The first is the one, that is part of eric5 (eric5/Plugins). The
+ second one is the global plugin directory called 'eric5plugins',
+ which is located inside the site-packages directory. The last one
+ is the user plugin directory located inside the .eric5 directory
+ of the users home directory.
</p><dl>
<dt><i>parent</i></dt>
<dd>
-reference to the parent object (QObject)
+reference to the parent object (QObject)
</dd><dt><i>doLoadPlugins=</i></dt>
<dd>
-flag indicating, that plugins should
- be loaded (boolean)
+flag indicating, that plugins should
+ be loaded (boolean)
</dd><dt><i>develPlugin=</i></dt>
<dd>
-filename of a plugin to be loaded for
- development (string)
+filename of a plugin to be loaded for
+ development (string)
</dd>
</dl><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.
+ Private method to check, if a plugin can be activated.
</p><dl>
<dt><i>module</i></dt>
<dd>
-reference to the module to be activated
+reference to the module to be activated
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating, if the module satisfies all requirements
- for being activated (boolean)
+flag indicating, if the module satisfies all requirements
+ for being activated (boolean)
</dd>
</dl><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.
+ Private method to check, if a plugin can be deactivated.
</p><dl>
<dt><i>module</i></dt>
<dd>
-reference to the module to be deactivated
+reference to the module to be deactivated
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating, if the module satisfies all requirements
- for being deactivated (boolean)
+flag indicating, if the module satisfies all requirements
+ for being deactivated (boolean)
</dd>
</dl><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.
+ Private slot to check for the existence of the plugins download directory.
</p><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.
+ Private method to extract the short info from a module.
</p><dl>
<dt><i>module</i></dt>
<dd>
-module to extract short info from
+module to extract short info from
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-short info as a tuple giving plugin name (string),
- short description (string), error flag (boolean) and
- version (string)
+short info as a tuple giving plugin name (string),
+ short description (string), error flag (boolean) and
+ version (string)
</dd>
</dl><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 intos the search path.
+ Private method to insert the valid plugin paths intos 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.
+ 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.
+ Private method to check, if the plugin folders exist.
</p><p>
- If the plugin folders don't exist, they are created (if possible).
+ If the plugin folders don't exist, they are created (if possible).
</p><dl>
<dt>Returns:</dt>
<dd>
-tuple of a flag indicating existence of any of the plugin
- directories (boolean) and a message (string)
+tuple of a flag indicating existence of any of the plugin
+ directories (boolean) and a message (string)
</dd>
</dl><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.
+ Private method to check, if there are plugins available.
</p><dl>
<dt>Returns:</dt>
<dd>
-flag indicating the availability of plugins (boolean)
+flag indicating the availability of plugins (boolean)
</dd>
</dl><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.
+ Public method to activate a plugin.
</p><dl>
<dt><i>name</i></dt>
<dd>
-name of the module to be activated
+name of the module to be activated
</dd><dt><i>onDemand=</i></dt>
<dd>
-flag indicating activation of an
- on demand plugin (boolean)
+flag indicating activation of an
+ on demand plugin (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-reference to the initialized plugin object
+reference to the initialized plugin object
</dd>
</dl><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.
+ Public method to activate all plugins having the "autoactivate" attribute
+ set to True.
</p><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.
+ Public method to deactivate a plugin.
</p><dl>
<dt><i>name</i></dt>
<dd>
-name of the module to be deactivated
+name of the module to be deactivated
</dd><dt><i>onDemand=</i></dt>
<dd>
-flag indicating deactivation of an
- on demand plugin (boolean)
+flag indicating deactivation of an
+ on demand plugin (boolean)
</dd>
</dl><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.
+ Public method to deactivated all activated VCS plugins.
</p><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.
+ 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.
+ Public method to get the list of API files installed by a plugin.
</p><dl>
<dt><i>language</i></dt>
<dd>
-language of the requested API files (string)
+language of the requested API files (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-list of API filenames (list of string)
+list of API filenames (list of string)
</dd>
</dl><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.
+ Public method to get the config data of all active, non on-demand plugins
+ used by the configuration dialog.
</p><p>
- Plugins supporting this functionality must provide the plugin module
- function 'getConfigData' returning a dictionary with unique keys
- of lists with the following list contents:
- <dl>
- <dt>display string</dt>
- <dd>string shown in the selection area of the configuration page.
- This should be a localized string</dd>
- <dt>pixmap name</dt>
- <dd>filename of the pixmap to be shown next to the display string</dd>
- <dt>page creation function</dt>
- <dd>plugin module function to be called to create the configuration
- page. The page must be subclasses from
- Preferences.ConfigurationPages.ConfigurationPageBase and must
- implement a method called 'save' to save the settings. A parent
- entry will be created in the selection list, if this value is None.</dd>
- <dt>parent key</dt>
- <dd>dictionary key of the parent entry or None, if this defines a
- toplevel entry.</dd>
- <dt>reference to configuration page</dt>
- <dd>This will be used by the configuration dialog and must always be None</dd>
- </dl>
+ Plugins supporting this functionality must provide the plugin module
+ function 'getConfigData' returning a dictionary with unique keys
+ of lists with the following list contents:
+ <dl>
+ <dt>display string</dt>
+ <dd>string shown in the selection area of the configuration page.
+ This should be a localized string</dd>
+ <dt>pixmap name</dt>
+ <dd>filename of the pixmap to be shown next to the display string</dd>
+ <dt>page creation function</dt>
+ <dd>plugin module function to be called to create the configuration
+ page. The page must be subclasses from
+ Preferences.ConfigurationPages.ConfigurationPageBase and must
+ implement a method called 'save' to save the settings. A parent
+ entry will be created in the selection list, if this value is None.</dd>
+ <dt>parent key</dt>
+ <dd>dictionary key of the parent entry or None, if this defines a
+ toplevel entry.</dd>
+ <dt>reference to configuration page</dt>
+ <dd>This will be used by the configuration dialog and must always be None</dd>
+ </dl>
</p><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.
+ Public method to get detailed information about a plugin.
</p><dl>
<dt><i>name</i></dt>
<dd>
-name of the module to get detailed infos about (string)
+name of the module to get detailed infos about (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-details of the plugin as a dictionary
+details of the plugin as a dictionary
</dd>
</dl><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.
+ Public method to get the path of a plugin directory.
</p><dl>
<dt>Returns:</dt>
<dd>
-path of the requested plugin directory (string)
+path of the requested plugin directory (string)
</dd>
</dl><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.
+ Public method to get the display strings of all plugins of a specific type.
</p><dl>
<dt><i>type_</i></dt>
<dd>
-type of the plugins (string)
+type of the plugins (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-dictionary with name as key and display string as value
- (dictionary of string)
+dictionary with name as key and display string as value
+ (dictionary of string)
</dd>
</dl><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.
+ Public method to get data to display information about a plugins
+ external tool.
</p><dl>
<dt>Returns:</dt>
<dd>
-list of dictionaries containing the data. Each dictionary must
- either contain data for the determination or the data to be displayed.<br />
- A dictionary of the first form must have the following entries:
- <ul>
- <li>programEntry - indicator for this dictionary form (boolean),
- always True</li>
- <li>header - string to be diplayed as a header (string)</li>
- <li>exe - the executable (string)</li>
- <li>versionCommand - commandline parameter for the exe (string)</li>
- <li>versionStartsWith - indicator for the output line containing
- the version (string)</li>
- <li>versionPosition - number of element containing the
- version (integer)</li>
- <li>version - version to be used as default (string)</li>
- <li>versionCleanup - tuple of two integers giving string positions
- start and stop for the version string (tuple of integers)</li>
- </ul>
- A dictionary of the second form must have the following entries:
- <ul>
- <li>programEntry - indicator for this dictionary form (boolean),
- always False</li>
- <li>header - string to be diplayed as a header (string)</li>
- <li>text - entry text to be shown (string)</li>
- <li>version - version text to be shown (string)</li>
- </ul>
+list of dictionaries containing the data. Each dictionary must
+ either contain data for the determination or the data to be displayed.<br />
+ A dictionary of the first form must have the following entries:
+ <ul>
+ <li>programEntry - indicator for this dictionary form (boolean),
+ always True</li>
+ <li>header - string to be diplayed as a header (string)</li>
+ <li>exe - the executable (string)</li>
+ <li>versionCommand - commandline parameter for the exe (string)</li>
+ <li>versionStartsWith - indicator for the output line containing
+ the version (string)</li>
+ <li>versionPosition - number of element containing the
+ version (integer)</li>
+ <li>version - version to be used as default (string)</li>
+ <li>versionCleanup - tuple of two integers giving string positions
+ start and stop for the version string (tuple of integers)</li>
+ </ul>
+ A dictionary of the second form must have the following entries:
+ <ul>
+ <li>programEntry - indicator for this dictionary form (boolean),
+ always False</li>
+ <li>header - string to be diplayed as a header (string)</li>
+ <li>text - entry text to be shown (string)</li>
+ <li>version - version text to be shown (string)</li>
+ </ul>
</dd>
</dl><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 plugins.
+ Public method to get infos about all loaded plugins.
</p><dl>
<dt>Returns:</dt>
<dd>
-list of tuples giving module name (string), plugin name (string),
- version (string), autoactivate (boolean), active (boolean),
- short description (string), error flag (boolean)
+list of tuples giving module name (string), plugin name (string),
+ version (string), autoactivate (boolean), active (boolean),
+ short description (string), error flag (boolean)
</dd>
</dl><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.
+ Public method to get a list of plugin modules.
</p><dl>
<dt><i>pluginPath</i></dt>
<dd>
-name of the path to search (string)
+name of the path to search (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-list of plugin module names (list of string)
+list of plugin module names (list of string)
</dd>
</dl><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 ondemand plugin given by type and typename.
+ Public method to activate an ondemand plugin given by type and typename.
</p><dl>
<dt><i>type_</i></dt>
<dd>
-type of the plugin to be activated (string)
+type of the plugin to be activated (string)
</dd><dt><i>typename</i></dt>
<dd>
-name of the plugin within the type category (string)
+name of the plugin within the type category (string)
</dd><dt><i>maybeActive=</i></dt>
<dd>
-flag indicating, that the plugin may be active
- already (boolean)
+flag indicating, that the plugin may be active
+ already (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-reference to the initialized plugin object
+reference to the initialized plugin object
</dd>
</dl><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.
+ Public method to get a preview pixmap of a plugin of a specific type.
</p><dl>
<dt><i>type_</i></dt>
<dd>
-type of the plugin (string)
+type of the plugin (string)
</dd><dt><i>name</i></dt>
<dd>
-name of the plugin type (string)
+name of the plugin type (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-preview pixmap (QPixmap)
+preview pixmap (QPixmap)
</dd>
</dl><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.
+ Public method to get the Vcs System indicators.
</p><p>
- Plugins supporting this functionality must support the module function
- getVcsSystemIndicator returning a dictionary with indicator as key and
- a tuple with the vcs name (string) and vcs display string (string).
+ Plugins supporting this functionality must support the module function
+ getVcsSystemIndicator returning a dictionary with indicator as key and
+ a tuple with the vcs name (string) and vcs display string (string).
</p><dl>
<dt>Returns:</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).
+dictionary with indicator as key and a list of tuples as values.
+ Each tuple contains the vcs name (string) and vcs display string (string).
</dd>
</dl><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.
+ Public method to create a plugin object for the named on demand plugin.
</p><p>
- Note: The plugin is not activated.
+ Note: The plugin is not activated.
</p><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.
+ Public method to create plugin objects for all on demand plugins.
</p><p>
- Note: The plugins are not activated.
+ Note: The plugins are not activated.
</p><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.
+ Public method to check, if a certain plugin is active.
</p><dl>
<dt><i>pluginName</i></dt>
<dd>
-name of the plugin to check for (string or QString)
+name of the plugin to check for (string or QString)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating, if the plugin is active (boolean)
+flag indicating, if the plugin is active (boolean)
</dd>
</dl><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.
+ Public method to check, if a certain plugin is loaded.
</p><dl>
<dt><i>pluginName</i></dt>
<dd>
-name of the plugin to check for (string or QString)
+name of the plugin to check for (string or QString)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating, if the plugin is loaded (boolean)
+flag indicating, if the plugin is loaded (boolean)
</dd>
</dl><a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a>
<h4>PluginManager.isValidPluginName</h4>
<b>isValidPluginName</b>(<i>pluginName</i>)
<p>
- Public methode to check, if a file name is a valid plugin name.
+ Public methode to check, if a file name is a valid plugin name.
</p><p>
- Plugin modules must start with "Plugin" and have the extension ".py".
+ Plugin modules must start with "Plugin" and have the extension ".py".
</p><dl>
<dt><i>pluginName</i></dt>
<dd>
-name of the file to be checked (string)
+name of the file to be checked (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating a valid plugin name (boolean)
+flag indicating a valid plugin name (boolean)
</dd>
</dl><a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a>
<h4>PluginManager.loadPlugin</h4>
<b>loadPlugin</b>(<i>name, directory, reload_ = False</i>)
<p>
- Public method to load a plugin module.
+ Public method to load a plugin module.
</p><p>
- Initially all modules are inactive. Modules that are requested on
- demand are sorted out and are added to the on demand list. Some
- basic validity checks are performed as well. Modules failing these
- checks are added to the failed modules list.
+ Initially all modules are inactive. Modules that are requested on
+ demand are sorted out and are added to the on demand list. Some
+ basic validity checks are performed as well. Modules failing these
+ checks are added to the failed modules list.
</p><dl>
<dt><i>name</i></dt>
<dd>
-name of the module to be loaded (string)
+name of the module to be loaded (string)
</dd><dt><i>directory</i></dt>
<dd>
-name of the plugin directory (string)
+name of the plugin directory (string)
</dd><dt><i>reload_</i></dt>
<dd>
-flag indicating to reload the module (boolean)
+flag indicating to reload the module (boolean)
</dd>
</dl><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.
+ 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.
+ Public method to remove a plugin and all related modules from sys.modules.
</p><dl>
<dt><i>pluginName</i></dt>
<dd>
-name of the plugin module (string)
+name of the plugin module (string)
</dd><dt><i>package</i></dt>
<dd>
-name of the plugin package (string)
+name of the plugin package (string)
</dd><dt><i>internalPackages</i></dt>
<dd>
-list of intenal packages (list of string)
+list of intenal packages (list of string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating the plugin module was found in sys.modules (boolean)
+flag indicating the plugin module was found in sys.modules (boolean)
</dd>
</dl><a NAME="PluginManager.shutdown" ID="PluginManager.shutdown"></a>
<h4>PluginManager.shutdown</h4>
<b>shutdown</b>(<i></i>)
<p>
- Public method called to perform actions upon shutdown of the IDE.
+ Public method called to perform actions upon shutdown of the IDE.
</p><a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a>
<h4>PluginManager.unloadPlugin</h4>
<b>unloadPlugin</b>(<i>name, directory</i>)
<p>
- Public method to unload a plugin module.
+ Public method to unload a plugin module.
</p><dl>
<dt><i>name</i></dt>
<dd>
-name of the module to be unloaded (string)
+name of the module to be unloaded (string)
</dd><dt><i>directory</i></dt>
<dd>
-name of the plugin directory (string)
+name of the plugin directory (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
