kate/kate/interfaces/kate
#include <pluginmanager.h>
Signals | |
void | pluginLoaded (const QString &name, Kate::Plugin *plugin) |
void | pluginUnloaded (const QString &name, Kate::Plugin *plugin) |
Public Member Functions | |
PluginManager (void *pluginManager) | |
virtual | ~PluginManager () |
class Plugin * | loadPlugin (const QString &name, bool permanent=true) |
class Plugin * | plugin (const QString &name) |
bool | pluginAvailable (const QString &name) |
void | unloadPlugin (const QString &name, bool permanent=true) |
Detailed Description
Interface to the plugin manager.
This interface provides access to Kate's plugin manager. To load a plugin call loadPlugin(), to unload a plugin call unloadPlugin(). To check, whether a plugin is loaded use plugin(), and to check a plugin's availability use pluginAvailable().
To access the plugin manager use Application::pluginManager(). You should never have to create an instance of this class yourself.
- Note
- Usually the Kate application itself loads/unloads the plugins, so plugins actually never have to call loadPlugin() or unloadPlugin().
- See also
- Plugin
Definition at line 48 of file pluginmanager.h.
Constructor & Destructor Documentation
Kate::PluginManager::PluginManager | ( | void * | pluginManager | ) |
Constructor.
Create a new plugin manager. You as a plugin developer should never have to create a plugin manager yourself. Get the plugin manager with the Application instance.
- Parameters
-
pluginManager internal usage
Definition at line 43 of file pluginmanager.cpp.
|
virtual |
Virtual destructor.
Definition at line 49 of file pluginmanager.cpp.
Member Function Documentation
Load the plugin name
.
If the plugin does not exist the return value is NULL.
- Parameters
-
name the plugin name permanent if true the plugin will be loaded at the next Kate startup, otherwise it will only be loaded temporarily during the current session.
- Returns
- pointer to the plugin on success, otherwise NULL
- See also
- unloadPlugin()
Definition at line 64 of file pluginmanager.cpp.
Get a plugin with identifier name
.
- Parameters
-
name the plugin's name
- Returns
- pointer to the plugin if a plugin with
name
is loaded, otherwise NULL
Definition at line 54 of file pluginmanager.cpp.
Check, whether a plugin with name
exists.
- Returns
- true if the plugin exists, otherwise false
Definition at line 59 of file pluginmanager.cpp.
|
signal |
New plugin loaded.
- Parameters
-
name name of new loaded plugin plugin new loaded plugin
|
signal |
This signal is emitted when the plugin has been unloaded, aka deleted.
Warning !!! DO NOT ACCESS THE DATA REFERENCED BY THE POINTER, IT IS ALREADY INVALID Use the pointer only to remove mappings in hash or maps
- Parameters
-
name name of unloaded plugin plugin unloaded plugin, already deleted
Unload the plugin name
.
- Parameters
-
name the plugin name permanent if true the plugin will not be loaded on the next Kate startup, even if it was loaded with permanent set to true.
- See also
- loadPlugin()
Definition at line 69 of file pluginmanager.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:31:36 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.