plasma-framework/dataengine.h
Aaron J. Seigo 4c4b013b89 * implement the engine, source and visualization classes
* queue updates so that multiple calls to setData don't result in a storm of updated signals
* some API cleanups, e.g. connect -> connectSource
* provide and install a ServiceType .desktop; this adds the X-EngineName QString symbol. maybe that's too generic.

svn path=/trunk/KDE/kdebase/workspace/plasma/lib/; revision=666241
2007-05-19 08:38:46 +00:00

106 lines
2.9 KiB
C++

/*
* Copyright (C) 2006 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 version 2 as
* published by the Free Software Foundation
*
* 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_ENGINE_H
#define PLASMA_ENGINE_H
#include <QAtomic>
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <kdemacros.h>
namespace Plasma
{
class DataSource;
class DataVisualization;
class KDE_EXPORT DataSource : public QObject
{
Q_OBJECT
public:
typedef QHash<QString, DataSource*> Dict;
typedef QHash<QString, QVariant> Data;
typedef QHash<QString, Dict> Grouping;
explicit DataSource(QObject* parent = 0);
virtual ~DataSource();
QString name();
void setName(const QString&);
const Data data() const;
void setData(const QString& key, const QVariant& value);
void checkForUpdate();
Q_SIGNALS:
void updated(const Plasma::DataSource::Data&);
private:
class Private;
Private* const d;
};
class KDE_EXPORT DataEngine : public QObject
{
Q_OBJECT
public:
typedef QHash<QString, DataEngine*> Dict;
DataEngine(QObject* parent);
virtual ~DataEngine();
virtual QStringList dataSources();
void connectSource(const QString& source, DataVisualization* visualization);
DataSource::Data query(const QString& source);
void ref();
void deref();
bool isUsed();
protected:
virtual void init();
void setData(const QString& source, const QVariant& value);
void setData(const QString& source, const QString& key, const QVariant& value);
/* void createDataSource(const QString& source,
const QString& domain = QString());*/
void removeDataSource(const QString& source);
void clearAllDataSources();
protected slots:
void checkForUpdates();
private:
class Private;
Private* const d;
};
} // Plasma namespace
#define K_EXPORT_PLASMA_DATAENGINE(libname, classname) \
K_EXPORT_COMPONENT_FACTORY( \
plasma_##libname##_engine, \
KGenericFactory<classname>("plasma_" #libname "_engine"))
#endif // multiple inclusion guard