plasma-framework/src/declarativeimports/core/datasource.h

146 lines
4.7 KiB
C
Raw Normal View History

/*
* Copyright 2009 by Alan Alpert <alan.alpert@nokia.com>
* Copyright 2010 by Ménard Alexis <menard@kde.org>
* Copyright 2010 by Marco MArtin <mart@kde.org>
2013-02-15 03:33:22 +01:00
* Copyright 2013 by Sebastian Kügler <sebas@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 DATASOURCE_H
#define DATASOURCE_H
#include <QObject>
2013-02-15 03:33:22 +01:00
#include <QtQml>
#include <QQmlPropertyMap>
2013-02-15 03:33:22 +01:00
#include <Plasma/DataEngineConsumer>
#include <Plasma/DataEngine>
class QQmlPropertyMap;
namespace Plasma
{
class DataEngine;
class DataSource : public QObject, DataEngineConsumer
{
Q_OBJECT
public:
enum Change {
NoChange = 0,
DataEngineChanged = 1,
SourcesChanged = 2
};
Q_DECLARE_FLAGS(Changes, Change)
typedef QHash<QString, QVariant> Data;
DataSource(QObject* parent=0);
2011-12-23 13:28:02 +01:00
/**
* true if the connection to the Plasma DataEngine is valid
*/
Q_PROPERTY(bool valid READ valid)
bool valid() const {return m_dataEngine && m_dataEngine->isValid();}
2011-12-23 13:28:02 +01:00
/**
* Polling interval in milliseconds when the data will be fetched again. If 0 no polling will be done.
*/
Q_PROPERTY(int interval READ interval WRITE setInterval NOTIFY intervalChanged)
int interval() const {return m_interval;}
void setInterval(const int interval);
2011-12-23 13:28:02 +01:00
/**
* Plugin name of the Plasma DataEngine
*/
Q_PROPERTY(QString dataEngine READ engine WRITE setEngine NOTIFY engineChanged)
Q_PROPERTY(QString engine READ engine WRITE setEngine NOTIFY engineChanged)
QString engine() const {return m_engine;}
void setEngine(const QString &e);
2011-12-23 13:28:02 +01:00
/**
* String array of all the source names connected to the DataEngine
*/
Q_PROPERTY(QStringList connectedSources READ connectedSources WRITE setConnectedSources NOTIFY connectedSourcesChanged)
QStringList connectedSources() const {return m_connectedSources;}
void setConnectedSources(const QStringList &s);
2011-12-23 13:28:02 +01:00
/**
* Read only string array of all the sources available from the DataEngine (connected or not)
*/
Q_PROPERTY(QStringList sources READ sources NOTIFY sourcesChanged)
QStringList sources() const {if (m_dataEngine) return m_dataEngine->sources(); else return QStringList();}
2011-12-23 13:28:02 +01:00
/**
* All the data fetched by this dataengine.
* This is an hash of hashes. At the first level, there are the source names, at the secons, they keys set by the DataEngine
*/
Q_PROPERTY(QVariantHash data READ data NOTIFY dataChanged);
QVariantHash data() const {return m_data;}
2011-12-23 13:28:02 +01:00
/**
* @returns a Plasma::Service given a source name
* @arg QString source source name we want a service of
*/
Q_INVOKABLE Plasma::Service *serviceForSource(const QString &source);
2011-12-23 13:28:02 +01:00
/**
* Connect a new source. It adds it to connectedSources
*/
Q_INVOKABLE void connectSource(const QString &source);
2011-12-23 13:28:02 +01:00
/**
* Disconnects from a DataEngine Source. It also removes it from connectedSources
*/
Q_INVOKABLE void disconnectSource(const QString &source);
protected Q_SLOTS:
void dataUpdated(const QString &sourceName, const Plasma::DataEngine::Data &data);
void removeSource(const QString &source);
void setupData();
Q_SIGNALS:
void newData(const QString &sourceName, const Plasma::DataEngine::Data &data);
void sourceAdded(const QString &source);
void sourceRemoved(const QString &source);
void sourceConnected(const QString &source);
void sourceDisconnected(const QString &source);
void intervalChanged();
void engineChanged();
void dataChanged();
void connectedSourcesChanged();
void sourcesChanged();
private:
QString m_id;
int m_interval;
QString m_engine;
QVariantHash m_data;
Plasma::DataEngine* m_dataEngine;
2013-02-15 03:33:22 +01:00
Plasma::DataEngineConsumer* m_dataEngineConsumer;
QStringList m_connectedSources;
QStringList m_oldSources;
QStringList m_newSources;
Changes m_changes;
2011-04-12 22:12:17 +02:00
QHash<QString, Plasma::Service *> m_services;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(DataSource::Changes)
}
#endif