plugin.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 1999 Simon Hausmann <hausmann@kde.org>
             (C) 1999 David Faure <faure@kde.org>

   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 <QtXml/QDomElement>
#include <QtCore/QObject>
#include <kaction.h>
#include <kxmlguiclient.h>

#include <kparts/kparts_export.h>

class KComponentData;

namespace KParts
{

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;
    };

    Plugin( QObject* parent = 0 );
    virtual ~Plugin();

    virtual QString xmlFile() const;

    virtual QString localXMLFile() const;

    static void loadPlugins( QObject *parent, const KComponentData &instance );

    static void loadPlugins( QObject *parent, const QList<PluginInfo> &pluginInfos );

    static void loadPlugins( QObject *parent, const QList<PluginInfo> &pluginInfos, const KComponentData &instance );

    static void loadPlugins(QObject *parent, KXMLGUIClient* parentGUIClient,
            const KComponentData &instance, bool enableNewPluginsByDefault = true,
            int interfaceVersionRequired = 0);

    static QList<Plugin *> pluginObjects( QObject *parent );

protected:
    static QList<Plugin::PluginInfo> pluginInfos(const KComponentData &instance);

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED static Plugin* loadPlugin( QObject * parent, const char* libname );
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED static Plugin* loadPlugin( QObject * parent, const QByteArray &libname );
#endif

    static Plugin* loadPlugin( QObject * parent, const QString &libname );

    static Plugin* loadPlugin( QObject * parent, const QString &libname, const QString &keyword  );

    virtual void setComponentData(const KComponentData &instance);

private:
    static bool hasPlugin( QObject* parent, const QString& library );
    class PluginPrivate;
    PluginPrivate* const d;
};

}

#endif