Kate::PluginManager Class Reference

Interface to the plugin manager. More...

#include <pluginmanager.h>

Inheritance diagram for Kate::PluginManager:

[legend]

List of all members.

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().

Author:

Christoph Cullmann <cullmann@kde.org>

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.

Kate::PluginManager::~PluginManager

(

)

[virtual]

Virtual destructor.

Definition at line 49 of file pluginmanager.cpp.

---

Member Function Documentation

Plugin * Kate::PluginManager::loadPlugin	(	const QString &	name,
		bool	permanent = true
	)

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()

Todo:

This method is not used yet, i.e. returns always NULL.

Definition at line 64 of file pluginmanager.cpp.

Plugin * Kate::PluginManager::plugin

(

const QString &

name

)

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.

bool Kate::PluginManager::pluginAvailable

(

const QString &

name

)

Check, whether a plugin with name exists.

Returns:

true if the plugin exists, otherwise false

Todo:

This method is not used yet, i.e. returns always false.

Definition at line 59 of file pluginmanager.cpp.

void Kate::PluginManager::unloadPlugin	(	const QString &	name,
		bool	permanent = true
	)

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()

Todo:

This method is not used yet, i.e. does nothing.

Definition at line 69 of file pluginmanager.cpp.

---

The documentation for this class was generated from the following files:

• pluginmanager.h
• pluginmanager.cpp