datacontainer.h

Go to the documentation of this file.

/*
 *   Copyright 2006-2007 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_DATACONTAINER_H
#define PLASMA_DATACONTAINER_H

#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QTimer>

#include <kjob.h>
#include <plasma/plasma_export.h>
#include <plasma/dataengine.h>

namespace Plasma
{

class DataContainerPrivate;

class PLASMA_EXPORT DataContainer : public QObject
{
    friend class DataEngine;
    friend class DataEnginePrivate;
    Q_OBJECT

    public:
        explicit DataContainer(QObject *parent = 0);
        virtual ~DataContainer();

        const DataEngine::Data data() const;

        void setData(const QString &key, const QVariant &value);

        void removeAllData();

        bool visualizationIsConnected(QObject *visualization) const;

        void connectVisualization(QObject *visualization, uint pollingInterval,
                                  Plasma::IntervalAlignment alignment);

        void setStorageEnabled(bool store);

        bool isStorageEnabled() const;

        bool needsToBeStored() const;

        void setNeedsToBeStored(bool store);

        DataEngine* getDataEngine();

    public Q_SLOTS:
        void disconnectVisualization(QObject *visualization);

        void forceImmediateUpdate();

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

        void becameUnused(const QString &source);

        void updateRequested(DataContainer *source);

    protected:
        void checkForUpdate();

        uint timeSinceLastUpdate() const;

        void setNeedsUpdate(bool update = true);

    protected Q_SLOTS:
        void checkUsage();

        void timerEvent(QTimerEvent * event);

    private:
        friend class SignalRelay;
        friend class DataContainerPrivate;
        friend class DataEngineManager;
        DataContainerPrivate *const d;

        Q_PRIVATE_SLOT(d, void storeJobFinished(KJob *job))
        Q_PRIVATE_SLOT(d, void populateFromStoredData(KJob *job))
        Q_PRIVATE_SLOT(d, void retrieve())
};

} // Plasma namespace

#endif // multiple inclusion guard