class Plugin

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

Full nameKParts::Plugin
Definition#include <plugin.h>
InheritsKXMLGUIClient (kdeui) [private], QObject (qt)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected 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, named kpartplugin 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.

QAction*  action ( const char* name )

Retrieve an action by name.

Reimplemented from KXMLGUIClient

QActionCollection*  actionCollection ()

Retrieve the entire action collection for the plugin.

Reimplemented from KXMLGUIClient

QActionaction ( const QDomElement &element )

[virtual]

Retrieve an action for a given QDomElement.

Reimplemented from KXMLGUIClient

void  setDocument ( QDomDocument doc )

[virtual]

Set the QDomDocument describing the part.

QDomDocument  document ()

[const virtual]

Retrieve the QDomDocument describing the part.

Reimplemented from KXMLGUIClient

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

[static]

Load the plugin libraries from the directories appropriate to instance.

void  loadPlugins ( QObject *parent, const QValueList<QDomDocument> &docs )

[static]

Load the plugin libraries specified by the list docs.

const QValueList<QDomDocument>  pluginDocuments ( const KInstance * instance )

[protected static]

Look for plugins in the instance's "data" directory (+"/kpartplugins")

Returns: A list of QDomDocument s, containing the parsed xml documents returned by plugins.

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

[protected static]

Returns: The plugin created from the library libname


Generated by: dfaure@faure on Sun Mar 26 14:24:54 2000, using kdoc 2.0a35.