class Plugin


Definition#include <plugin.h>
InheritsKXMLGUIClient [virtual public], QObject
Annotated List
Files
Globals
Hierarchy
Index
Main

Public Methods

Public Static Methods


Detailed Description

A plugin is the way to add actions to an existing KParts application, or to a Part.

The XML of those plugins looks exactly like of the shell or parts, with one small difference: The document tag should have an additional attribute, named "library", and contain the name of the library implementing the plugin.

If you want this plugin to be used by a part, you need to install the rc file under the directory "data" (KDEDIR/share/apps usually)+"/instancename/kpartplugins/" where instancename is the name of the part's instance.

 Plugin ( QObject* parent = 0, const char* name = 0 )

Construct a new KParts plugin.

Plugin ()

[virtual]

Destructor.

void  loadPlugins ( QObject *parent, const KInstance * instance )

[static]

Load the plugin libraries from the directories appropriate to instance and make the Plugin objects children of parent .

void  loadPlugins ( QObject *parent, const QValueList<PluginInfo> &pluginInfos )

[static]

Load the plugin libraries specified by the list docs and make the Plugin objects children of parent .

QList<Plugin>  pluginObjects ( QObject *parent )

[static]

Returns a list of plugin objects loaded for parent. This functions basically calls the queryList method of QObject to retrieve the list of child objects inheritting KParts::Plugin .

protected: /** * Look for plugins in the @p instance's "data"  directory (+"/kpartplugins") * * @return A list of @ref QDomDocument s, containing the parsed xml documents returned by plugins. */ static QValueList<Plugin::PluginInfo> pluginInfos( const KInstance * instance )

Plugin*  loadPlugin ( QObject * parent, const char* libname )

[static]

Returns: The plugin created from the library libname