plasmaengine.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007 Sebastian Sauer <mail@dipe.org>
 *
 * This file is part of SuperKaramba.
 *
 * SuperKaramba is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * SuperKaramba 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 General Public License
 * along with SuperKaramba; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef PLASMAENGINE_H
#define PLASMAENGINE_H

#include <QObject>

#include "superkaramba_export.h"
#include "sensor.h"
#include "meters/meter.h"

#include <plasma/dataengine.h>

class PlasmaSensorConnector : public QObject
{
        Q_OBJECT
    public:
        explicit PlasmaSensorConnector(Meter *meter, const QString& source);
        virtual ~PlasmaSensorConnector();
        Meter* meter() const;

    public Q_SLOTS:

        QString source() const;

        void setSource(const QString& source);

        QString format() const;

        void setFormat(const QString& format);

    Q_SIGNALS:

        void sourceUpdated(const QString& source, QVariantMap data);

    private Q_SLOTS:

        void dataUpdated(const QString& source, const Plasma::DataEngine::Data &data);

    private:
        class Private;
        Private* const d;
};

class SUPERKARAMBA_EXPORT PlasmaSensor :  public Sensor
{
        Q_OBJECT
    public:
        PlasmaSensor(int interval = -1);
        virtual ~PlasmaSensor();
        Plasma::DataEngine* engineImpl() const;
        void setEngineImpl(Plasma::DataEngine* engine, const QString& engineName);

    public Q_SLOTS:

        QString engine();

        virtual void setEngine(const QString& name);

        bool isValid() const;

        QStringList sources() const;

        QVariant property(const QByteArray& name) const;

        void setProperty(const QByteArray& name, const QVariant& value);

        QVariantMap query(const QString& source);

        virtual QObject* connectSource(const QString& source, QObject* visualization = 0);

        virtual void disconnectSource(const QString& source, QObject* visualization = 0);

    Q_SIGNALS:

        void sourceAdded(const QString& source);

        void sourceRemoved(const QString& source);

        void sourceUpdated(const QString& source, QVariantMap data);

    protected Q_SLOTS:

        virtual void update();

        virtual void dataUpdated(const QString& source, Plasma::DataEngine::Data data);

    private:
        class Private;
        Private* const d;
};

#endif // PLASMAENGINE_H