pluginloader.h

Go to the documentation of this file.

/*
 *   Copyright 2010 by Ryan Rix <ry@n.rix.si>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLUGIN_LOADER_H
#define PLUGIN_LOADER_H

#include <plasma/plasma.h>
#include <kplugininfo.h>

namespace Plasma {

class Applet;
class DataEngine;
class Service;
class AbstractRunner;

class PluginLoaderPrivate;

//TODO:
// * add support for ContainmentActions plugins
// * add KPluginInfo listing support for Containments (already loaded via the applet loading code)

class PLASMA_EXPORT PluginLoader
{
public: 
    PluginLoader();

    virtual ~PluginLoader();

    Applet *loadApplet(const QString &name, uint appletId = 0,
                       const QVariantList &args = QVariantList());

    DataEngine *loadDataEngine(const QString &name);

    AbstractRunner *loadRunner(const QString &name);

    Service *loadService(const QString &name, const QVariantList &args, QObject *parent = 0);

    KPluginInfo::List listAppletInfo(const QString &category, const QString &parentApp = QString());

    KPluginInfo::List listDataEngineInfo(const QString &parentApp = QString());

    KPluginInfo::List listRunnerInfo(const QString &parentApp = QString());

    static void setPluginLoader(PluginLoader* loader);

    static PluginLoader* pluginLoader();

protected:
    virtual Applet *internalLoadApplet(const QString &name, uint appletId = 0,
                                       const QVariantList &args = QVariantList());

    virtual AbstractRunner *internalLoadRunner(const QString &name);

    virtual DataEngine *internalLoadDataEngine(const QString &name);

    virtual Service *internalLoadService(const QString &name, const QVariantList &args, QObject *parent = 0);

    virtual KPluginInfo::List internalAppletInfo(const QString &category) const;

    virtual KPluginInfo::List internalDataEngineInfo() const;

    virtual KPluginInfo::List internalRunnerInfo() const;

    virtual KPluginInfo::List internalServiceInfo() const;

    KPluginInfo::List standardInternalAppletInfo(const QString &category) const;

    KPluginInfo::List standardInternalDataEngineInfo() const;

    KPluginInfo::List standardInternalRunnerInfo() const;

    KPluginInfo::List standardInternalServiceInfo() const;

private:
    PluginLoaderPrivate * const d;
};

}

Q_DECLARE_METATYPE(Plasma::PluginLoader*)

#endif