/* This file is part of the KDE project Copyright (C) 1999 Simon Hausmann (C) 1999 David Faure This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef PLUGIN_H #define PLUGIN_H #include #include #include #include #include class KComponentData; namespace KParts { /** * 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. * * You should also install a "plugin info" .desktop file with the same name. * \see KPluginInfo * * For a tutorial on how to write plugins, see http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html#developing_plugins */ class KPARTS_EXPORT Plugin : public QObject, virtual public KXMLGUIClient { Q_OBJECT public: struct PluginInfo { QString m_relXMLFileName; // relative filename, i.e. kpartplugins/name QString m_absXMLFileName; // full path of most recent filename matching the relative // filename QDomDocument m_document; }; /** * Construct a new KParts plugin. */ Plugin( QObject* parent = 0 ); /** * Destructor. */ virtual ~Plugin(); /** * Reimplemented for internal reasons */ virtual QString xmlFile() const; /** * Reimplemented for internal reasons */ virtual QString localXMLFile() const; /** * Load the plugin libraries from the directories appropriate * to @p instance and make the Plugin objects children of @p parent. * * It is recommended to use the last loadPlugins method instead, * to support enabling and disabling of plugins. */ static void loadPlugins( QObject *parent, const KComponentData &instance ); /** * Load the plugin libraries specified by the list @p docs and make the * Plugin objects children of @p parent . * * It is recommended to use the last loadPlugins method instead, * to support enabling and disabling of plugins. */ static void loadPlugins( QObject *parent, const QList &pluginInfos ); /** * Load the plugin libraries specified by the list @p pluginInfos, make the * Plugin objects children of @p parent, and use the given @p instance. * * It is recommended to use the last loadPlugins method instead, * to support enabling and disabling of plugins. */ static void loadPlugins( QObject *parent, const QList &pluginInfos, const KComponentData &instance ); /** * Load the plugin libraries for the given @p instance, make the * Plugin objects children of @p parent, and insert the plugin as a child GUI client * of @p 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 * @p enableNewPluginsByDefault. It can be overridden by the plugin if it * sets the X-KDE-PluginInfo-EnabledByDefault key in the .desktop file * (with the same name as the .rc file) * * If a disabled plugin is already loaded it will be removed from the GUI * factory and deleted. * * If you change the binary interface offered by your part, you can avoid crashes * from old plugins lying around by setting X-KDE-InterfaceVersion=2 in the * .desktop files of the plugins, and passing 2 to @p interfaceVersionRequired, so that * the old plugins are not loaded. Increase both numbers every time a * binary incompatible change in the application's plugin interface is made. * * * This method is automatically called by KParts::Part and by KParts::MainWindow. * @see PartBase::setPluginLoadingMode, PartBase::setPluginInterfaceVersion * * 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: * \code * if( factory() ) * { * const QList plugins = KParts::Plugin::pluginObjects( this ); * foreach ( KParts::Plugin * plugin, plugins ) * factory()->addClient( plugin ); * } * \endcode */ static void loadPlugins(QObject *parent, KXMLGUIClient* parentGUIClient, const KComponentData &instance, bool enableNewPluginsByDefault = true, int interfaceVersionRequired = 0); /** * Returns a list of plugin objects loaded for @p parent. This * functions basically iterates over the children of the given object * and returns those that inherit from KParts::Plugin. **/ static QList pluginObjects( QObject *parent ); protected: /** * Look for plugins in the @p instance's "data" directory (+"/kpartplugins") * * @return A list of QDomDocument s, containing the parsed xml documents returned by plugins. */ static QList pluginInfos(const KComponentData &instance); /** * @internal * @return The plugin created from the library @p libname */ static Plugin* loadPlugin( QObject * parent, const QString &libname, const QString &keyword = QString() ); virtual void setComponentData(const KComponentData &instance, bool loadPlugins = true); private: static bool hasPlugin( QObject* parent, const QString& library ); class PluginPrivate; PluginPrivate* const d; }; } #endif