kparts Library API Documentation

plugin.h

00001 /* This file is part of the KDE project
00002    Copyright (C) 1999 Simon Hausmann <hausmann@kde.org>
00003              (C) 1999 David Faure <faure@kde.org>
00004 
00005    This library is free software; you can redistribute it and/or
00006    modify it under the terms of the GNU Library General Public
00007    License as published by the Free Software Foundation; either
00008    version 2 of the License, or (at your option) any later version.
00009 
00010    This library is distributed in the hope that it will be useful,
00011    but WITHOUT ANY WARRANTY; without even the implied warranty of
00012    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013    Library General Public License for more details.
00014 
00015    You should have received a copy of the GNU Library General Public License
00016    along with this library; see the file COPYING.LIB.  If not, write to
00017    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00018    Boston, MA 02111-1307, USA.
00019 */
00020 #ifndef PLUGIN_H
00021 #define PLUGIN_H
00022 
00023 #include <qobject.h>
00024 #include <kaction.h>
00025 #include <kxmlguiclient.h>
00026 
00027 class KInstance;
00028 
00029 namespace KParts
00030 {
00031 
00046 class Plugin : public QObject, virtual public KXMLGUIClient
00047 {
00048     Q_OBJECT
00049 public:
00050     struct PluginInfo
00051     {
00052         QString m_relXMLFileName; // relative filename, i.e. instanceName/kpartplugins/name
00053         QString m_absXMLFileName; // full path of most recent filename matching the relative
00054                                   // filename
00055         QDomDocument m_document;
00056     };
00057 
00061     Plugin( QObject* parent = 0, const char* name = 0 );
00065     virtual ~Plugin();
00066 
00070     virtual QString xmlFile() const;
00071 
00075     virtual QString localXMLFile() const;
00076 
00084     static void loadPlugins( QObject *parent, const KInstance * instance );
00085 
00093     static void loadPlugins( QObject *parent, const QValueList<PluginInfo> &pluginInfos );
00094 
00102     static void loadPlugins( QObject *parent, const QValueList<PluginInfo> &pluginInfos, const KInstance * instance );
00103 
00119     static void loadPlugins( QObject *parent, KXMLGUIClient* parentGUIClient, KInstance* instance, bool enableNewPluginsByDefault = true );
00120 
00127     static QPtrList<Plugin> pluginObjects( QObject *parent );
00128 
00129 protected:
00135     static QValueList<Plugin::PluginInfo> pluginInfos( const KInstance * instance );
00136 
00141     static Plugin* loadPlugin( QObject * parent, const char* libname );
00142 
00143     virtual void setInstance( KInstance *instance );
00144 
00145 private:
00146     static bool hasPlugin( QObject* parent, const QString& library );
00147     class PluginPrivate;
00148     PluginPrivate *d;
00149 };
00150 
00151 }
00152 
00153 #endif
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 27 22:15:45 2005 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001