kparts Library API Documentation

KParts::Plugin Class Reference

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

#include <plugin.h>

Inheritance diagram for KParts::Plugin:

QObject KXMLGUIClient List of all members.

Public Methods

 Plugin (QObject *parent=0, const char *name=0)
virtual ~Plugin ()
virtual QString xmlFile () const
virtual QString localXMLFile () const

Static Public Methods

void loadPlugins (QObject *parent, const KInstance *instance)
void loadPlugins (QObject *parent, const QValueList< PluginInfo > &pluginInfos)
void loadPlugins (QObject *parent, const QValueList< PluginInfo > &pluginInfos, const KInstance *instance)
void loadPlugins (QObject *parent, KXMLGUIClient *parentGUIClient, KInstance *instance, bool enableNewPluginsByDefault=true)
QPtrList< Plugin > pluginObjects (QObject *parent)

Protected Methods

virtual void setInstance (KInstance *instance)

Static Protected Methods

QValueList< Plugin::PluginInfo > pluginInfos (const KInstance *instance)
Plugin * loadPlugin (QObject *parent, const char *libname)

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.

Definition at line 46 of file plugin.h.


Constructor & Destructor Documentation

Plugin::Plugin QObject   parent = 0,
const char *    name = 0
 

Construct a new KParts plugin.

Definition at line 52 of file plugin.cpp.

Plugin::~Plugin   [virtual]
 

Destructor.

Definition at line 59 of file plugin.cpp.


Member Function Documentation

QString Plugin::xmlFile   const [virtual]
 

Reimplemented for internal reasons.

Reimplemented from KXMLGUIClient.

Definition at line 64 of file plugin.cpp.

References QString::fromLatin1(), QString::isEmpty(), QString::length(), and KXMLGUIClient::xmlFile().

QString Plugin::localXMLFile   const [virtual]
 

Reimplemented for internal reasons.

Reimplemented from KXMLGUIClient.

Definition at line 76 of file plugin.cpp.

References QString::fromLatin1(), QString::isEmpty(), QString::length(), and KXMLGUIClient::xmlFile().

void Plugin::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.

It is recommended to use the last loadPlugins method instead, to support enabling and disabling of plugins.

Definition at line 135 of file plugin.cpp.

References KNotifyClient::instance(), and pluginInfos().

Referenced by loadPlugins().

void Plugin::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 .

It is recommended to use the last loadPlugins method instead, to support enabling and disabling of plugins.

Definition at line 164 of file plugin.cpp.

References loadPlugins().

void Plugin::loadPlugins QObject   parent,
const QValueList< PluginInfo > &    pluginInfos,
const KInstance   instance
[static]
 

Load the plugin libraries specified by the list pluginInfos, make the Plugin objects children of parent, and use the given instance.

It is recommended to use the last loadPlugins method instead, to support enabling and disabling of plugins.

Definition at line 140 of file plugin.cpp.

References QValueList::begin(), QFile::encodeName(), QValueList::end(), KNotifyClient::instance(), and QString::isEmpty().

void Plugin::loadPlugins QObject   parent,
KXMLGUIClient   parentGUIClient,
KInstance   instance,
bool    enableNewPluginsByDefault = true
[static]
 

Load the plugin libraries for the given instance, make the Plugin objects children of parent, and insert the plugin as a child GUI client of parentGUIClient.

This method uses the KConfig object of the given instance, to find out which plugins are enabled and which are disabled. What happens by default (i.e. for new plugins that are not in that config file) is controlled by enableNewPluginsByDefault. It can be overridden by the plugin if it sets the EnabledByDefault key in the .desktop file.

If a disabled plugin is already loaded it will be removed from the GUI factory and deleted.

This method is automatically called by KParts::Plugin and by KParts::MainWindow.

If you call this method in an already constructed GUI (like when the user has changed which plugins are enabled) you need to add the new plugins to the KXMLGUIFactory:

 if( factory() )
 {
   QPtrList<KParts::Plugin> plugins = KParts::Plugin::pluginObjects( this );
   QPtrListIterator<KParts::Plugin> it( plugins );
   KParts::Plugin * plugin;
   while( ( plugin = it.current() ) != 0 )
   {
     ++it;
     factory()->addClient(  plugin );
   }
 }

Definition at line 221 of file plugin.cpp.

References QDomElement::attribute(), QValueList::begin(), KInstance::config(), KInstance::dirs(), QFile::encodeName(), QValueList::end(), KXMLGUIClient::factory(), KStandardDirs::findResource(), KXMLGUIClient::insertChildClient(), KNotifyClient::instance(), KInstance::instanceName(), QString::isEmpty(), QString::isNull(), QObject::name(), pluginInfos(), QObject::queryList(), and KXMLGUIFactory::removeClient().

QPtrList< KParts::Plugin > 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 inheriting KParts::Plugin .

Definition at line 179 of file plugin.cpp.

References QPtrList::append(), and QObject::queryList().

QValueList< Plugin::PluginInfo > Plugin::pluginInfos const KInstance   instance [static, protected]
 

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

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

Definition at line 89 of file plugin.cpp.

References QValueList::append(), QMap::begin(), KInstance::dirs(), QMap::end(), QFileInfo::fileName(), QMap::find(), KStandardDirs::findAllResources(), KXMLGUIClient::findMostRecentXMLFile(), QMap::insert(), KNotifyClient::instance(), and KInstance::instanceName().

Referenced by loadPlugins().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kparts Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun May 16 22:04:11 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003