Module implementing the Plugin Manager.
None |
PluginManager | Class implementing the Plugin Manager. |
None |
Class implementing the Plugin Manager.
None |
None |
PluginManager | Constructor |
__canActivatePlugin | Private method to check, if a plugin can be activated. |
__canDeactivatePlugin | Private method to check, if a plugin can be deactivated. |
__checkPluginsDownloadDirectory | Private slot to check for the existance of the plugins download directory. |
__getShortInfo | Private method to extract the short info from a module. |
__insertPluginsPaths | Private method to insert the valid plugin paths intos the search path. |
__loadPlugins | Private method to load the plugins found. |
__pluginDirectoriesExist | Private method to check, if the plugin folders exist. |
__pluginModulesExist | Private method to check, if there are plugins available. |
activatePlugin | Public method to activate a plugin. |
activatePlugins | Public method to activate all plugins having the "autoactivate" attribute set to True. |
deactivatePlugin | Public method to deactivate a plugin. |
deactivateVcsPlugins | Public method to deactivated all activated VCS plugins. |
finalizeSetup | Public method to finalize the setup of the plugin manager. |
getPluginApiFiles | Public method to get the list of API files installed by a plugin. |
getPluginConfigData | Public method to get the config data of all active, non on-demand plugins used by the configuration dialog. |
getPluginDetails | Public method to get detailed information about a plugin. |
getPluginDir | Public method to get the path of a plugin directory. |
getPluginDisplayStrings | Public method to get the display strings of all plugins of a specific type. |
getPluginExeDisplayData | Public method to get data to display information about a plugins external tool. |
getPluginInfos | Public method to get infos about all loaded plugins. |
getPluginModules | Public method to get a list of plugin modules. |
getPluginObject | Public method to activate an ondemand plugin given by type and typename. |
getPluginPreviewPixmap | Public method to get a preview pixmap of a plugin of a specific type. |
getVcsSystemIndicators | Public method to get the Vcs System indicators. |
initOnDemandPlugin | Public method to create a plugin object for the named on demand plugin. |
initOnDemandPlugins | Public method to create plugin objects for all on demand plugins. |
isPluginActive | Public method to check, if a certain plugin is active. |
isPluginLoaded | Public method to check, if a certain plugin is loaded. |
isValidPluginName | Public methode to check, if a file name is a valid plugin name. |
loadPlugin | Public method to load a plugin module. |
preferencesChanged | Public slot to react to changes in configuration. |
removePluginFromSysModules | Public method to remove a plugin and all related modules from sys.modules. |
shutdown | Public method called to perform actions upon shutdown of the IDE. |
unloadPlugin | Public method to unload a plugin module. |
None |
Constructor
The Plugin Manager deals with three different plugin directories. The first is the one, that is part of eric4 (eric4/Plugins). The second one is the global plugin directory called 'eric4plugins', which is located inside the site-packages directory. The last one is the user plugin directory located inside the .eric4 directory of the users home directory.
Private method to check, if a plugin can be activated.
Private method to check, if a plugin can be deactivated.
Private slot to check for the existance of the plugins download directory.
Private method to extract the short info from a module.
Private method to insert the valid plugin paths intos the search path.
Private method to load the plugins found.
Private method to check, if the plugin folders exist.
If the plugin folders don't exist, they are created (if possible).
Private method to check, if there are plugins available.
Public method to activate a plugin.
Public method to activate all plugins having the "autoactivate" attribute set to True.
Public method to deactivate a plugin.
Public method to deactivated all activated VCS plugins.
Public method to finalize the setup of the plugin manager.
Public method to get the list of API files installed by a plugin.
Public method to get the config data of all active, non on-demand plugins used by the configuration dialog.
Plugins supporting this functionality must provide the plugin module function 'getConfigData' returning a dictionary with unique keys of lists with the following list contents:
Public method to get detailed information about a plugin.
Public method to get the path of a plugin directory.
Public method to get the display strings of all plugins of a specific type.
Public method to get data to display information about a plugins external tool.
Public method to get infos about all loaded plugins.
Public method to get a list of plugin modules.
Public method to activate an ondemand plugin given by type and typename.
Public method to get a preview pixmap of a plugin of a specific type.
Public method to get the Vcs System indicators.
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 (QString).
Public method to create a plugin object for the named on demand plugin.
Note: The plugin is not activated.
Public method to create plugin objects for all on demand plugins.
Note: The plugins are not activated.
Public method to check, if a certain plugin is active.
Public method to check, if a certain plugin is loaded.
Public methode to check, if a file name is a valid plugin name.
Plugin modules must start with "Plugin" and have the extension ".py".
Public method to load a plugin module.
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.
Public slot to react to changes in configuration.
Public method to remove a plugin and all related modules from sys.modules.
Public method called to perform actions upon shutdown of the IDE.
Public method to unload a plugin module.