KDE 4.2 API Reference shell
KDevelop::PluginController Class Reference
#include <plugincontroller.h>
Inherits IPluginController.
Detailed Description
The KDevelop plugin controller.The Plugin controller is responsible for querying, loading and unloading available plugins.
Definition at line 51 of file plugincontroller.h.
Public Types | |
| enum | PluginDeletion { Now, Later } |
Public Member Functions | |
| QStringList | allPluginNames () |
| QList< IPlugin * > | allPluginsForExtension (const QString &extension, const QStringList &constraints=QStringList()) |
| QString | changeProfile (const QString &newProfile) |
| QString | currentProfile () const |
| ProfileEngine & | engine () const |
| QExtensionManager * | extensionManager () |
| QList< IPlugin * > | loadedPlugins () const |
| IPlugin * | loadPlugin (const QString &pluginName) |
| void | loadPlugins (PluginType offer) |
| IPlugin * | plugin (const QString &) |
| PluginController (Core *core) | |
| IPlugin * | pluginForExtension (const QString &extension, const QStringList &constraints) |
| IPlugin * | pluginForExtension (const QString &extension, const QString &pluginname="") |
| KPluginInfo | pluginInfo (IPlugin *) const |
| KUrl::List | profileResources (const QString &nameFilter) |
| KUrl::List | profileResourcesRecursive (const QString &nameFilter) |
| QStringList | projectPlugins () |
| QList< ContextMenuExtension > | queryPluginsForContextMenuExtensions (KDevelop::Context *context) const |
| void | unloadPlugin (IPlugin *plugin, PluginDeletion deletion) |
| void | unloadPlugin (const QString &plugin) |
| void | unloadPlugins (PluginType offer) |
Static Public Member Functions | |
| static KPluginInfo::List | queryExtensionPlugins (const QString &extension, const QStringList &constraints) |
Member Function Documentation
| QList< IPlugin * > KDevelop::PluginController::loadedPlugins | ( | ) | const |
| IPlugin * KDevelop::PluginController::loadPlugin | ( | const QString & | pluginName | ) |
Returns a uniquely specified plugin.
If it isn't already loaded, it will be.
- Parameters:
-
pluginName the name of the plugin, as given in the X-KDE-PluginInfo-Name property
- Returns:
- a pointer to the plugin instance or 0
Definition at line 149 of file plugincontroller.cpp.
| IPlugin * KDevelop::PluginController::plugin | ( | const QString & | pluginId | ) |
Get the plugin instance based on the ID.
The ID should be whatever is in X-KDE-PluginInfo-Name
Definition at line 338 of file plugincontroller.cpp.
| IPlugin * KDevelop::PluginController::pluginForExtension | ( | const QString & | extension, | |
| const QString & | pluginname = "" | |||
| ) |
Queries for the plugin which supports given extension interface.
All already loaded plugins will be queried and the first one to support the extension interface will be returned. Any plugin can be an extension, only "ServiceTypes=..." entry is required in .desktop file for that plugin.
- Parameters:
-
extension The extension interface pluginname The name of the plugin to load if multiple plugins for the extension exist, corresponds to the X-KDE-PluginInfo-Name
- Returns:
- A KDevelop extension plugin for given service type or 0 if no plugin supports it
Definition at line 402 of file plugincontroller.cpp.
| KPluginInfo KDevelop::PluginController::pluginInfo | ( | IPlugin * | plugin | ) | const |
| KUrl::List KDevelop::PluginController::profileResources | ( | const QString & | nameFilter | ) |
Reimplement this function only if your shell supports plugin profiles.
- Returns:
- The list of URLs to the profile resources (files) with given
extension.
- Parameters:
-
nameFilter Name filter for files.
- See also:
- QDir::setNameFilter documentation for name filters syntax.
Definition at line 216 of file plugincontroller.cpp.
| KUrl::List KDevelop::PluginController::profileResourcesRecursive | ( | const QString & | nameFilter | ) |
Reimplement this function only if your shell supports plugin profiles.
- Returns:
- The list of URLs to the resources (files) with given
extension. This list is obtained by a recursive search that process given profile and all it's subprofiles.
- Parameters:
-
nameFilter Name filter for files.
- See also:
- QDir::setNameFilter documentation for name filters syntax.
Definition at line 221 of file plugincontroller.cpp.
| void KDevelop::PluginController::unloadPlugin | ( | IPlugin * | plugin, | |
| PluginDeletion | deletion | |||
| ) |
Directly unload the given plugin, either deleting it now or later.
- Parameters:
-
plugin plugin to unload later if true, delete the plugin later, if false, delete it now.
Definition at line 190 of file plugincontroller.cpp.
| void KDevelop::PluginController::unloadPlugin | ( | const QString & | plugin | ) |
Unloads the plugin specified by plugin.
- Parameters:
-
plugin The name of the plugin as specified by the X-KDE-PluginInfo-Name key of the .desktop file for the plugin
Definition at line 182 of file plugincontroller.cpp.
The documentation for this class was generated from the following files:
