Kate::PluginManager Class Reference

#include <pluginmanager.h>

Inheritance diagram for Kate::PluginManager:

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)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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 <cullm.nosp@m.ann@.nosp@m.kde.o.nosp@m.rg>

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

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

Definition at line 59 of file pluginmanager.cpp.

void Kate::PluginManager::pluginLoaded ( const QString &  name, Kate::Plugin *  plugin  )

signal

New plugin loaded.

Parameters

name	name of new loaded plugin
plugin	new loaded plugin

void Kate::PluginManager::pluginUnloaded ( const QString &  name, Kate::Plugin *  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

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

Definition at line 69 of file pluginmanager.cpp.

---

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

• pluginmanager.h
• pluginmanager.cpp