service.h

Go to the documentation of this file.

/*
 *   Copyright 2008 Aaron Seigo <aseigo@kde.org>
 *
 *   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 PLASMA_SERVICE_H
#define PLASMA_SERVICE_H

#include <QtCore/QMap>
#include <QtCore/QObject>
#include <QtCore/QVariant>

#include <kconfiggroup.h>

#include <plasma/plasma_export.h>
#include <plasma/plasma.h>
#include "packagemetadata.h"

class QGraphicsWidget;
class QIODevice;
class QWidget;

namespace Plasma
{

class ServiceJob;
class ServicePrivate;

class PLASMA_EXPORT Service : public QObject
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(Service)
    Q_PROPERTY(QString destination READ destination WRITE setDestination)
    Q_PROPERTY(QStringList operationNames READ operationNames)
    Q_PROPERTY(QString name READ name)

public:
    ~Service();

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

    static Service *load(const QString &name, QObject *parent = 0);

    static Service *access(const KUrl &url, QObject *parent = 0);

    Q_INVOKABLE void setDestination(const QString &destination);

    Q_INVOKABLE QString destination() const;

    Q_INVOKABLE QStringList operationNames() const;

    Q_INVOKABLE KConfigGroup operationDescription(const QString &operationName);

    Q_INVOKABLE ServiceJob *startOperationCall(const KConfigGroup &description, QObject *parent = 0);

    Q_INVOKABLE bool isOperationEnabled(const QString &operation) const;

    Q_INVOKABLE QString name() const;

    Q_INVOKABLE void associateWidget(QWidget *widget, const QString &operation);

    Q_INVOKABLE void disassociateWidget(QWidget *widget);

    Q_INVOKABLE void associateWidget(QGraphicsWidget *widget, const QString &operation);

    Q_INVOKABLE void disassociateWidget(QGraphicsWidget *widget);

    Q_INVOKABLE QMap<QString, QVariant> parametersFromDescription(const KConfigGroup &description);

Q_SIGNALS:
    void finished(Plasma::ServiceJob *job);

    void operationsChanged();

    void serviceReady(Plasma::Service *service);

protected:
    explicit Service(QObject *parent = 0);

    Service(QObject *parent, const QVariantList &args);

    virtual ServiceJob *createJob(const QString &operation,
                                  QMap<QString, QVariant> &parameters) = 0;

    virtual void registerOperationsScheme();

    void setOperationsScheme(QIODevice *xml);

    void setName(const QString &name);

    void setOperationEnabled(const QString &operation, bool enable);

private:
    Q_PRIVATE_SLOT(d, void jobFinished(KJob *))
    Q_PRIVATE_SLOT(d, void associatedWidgetDestroyed(QObject *))
    Q_PRIVATE_SLOT(d, void associatedGraphicsWidgetDestroyed(QObject *))

    ServicePrivate * const d;

    friend class Applet;
    friend class DataEnginePrivate;
    friend class GetSource;
    friend class PackagePrivate;
    friend class ServiceProvider;
    friend class RemoveService;
    friend class PluginLoader;
};

} // namespace Plasma

#define K_EXPORT_PLASMA_SERVICE(libname, classname) \
K_PLUGIN_FACTORY(factory, registerPlugin<classname>();) \
K_EXPORT_PLUGIN(factory("plasma_service_" #libname)) \
K_EXPORT_PLUGIN_VERSION(PLASMA_VERSION)

#endif // multiple inclusion guard