Plasma::DataSource Class Reference

#include <datasource.h>

Inheritance diagram for Plasma::DataSource:

Public Types
enum	Change { NoChange = 0, DataEngineChanged = 1, SourcesChanged = 2 }
typedef QFlags< Change >	Changes
typedef QMap< QString, QVariant >	Data

Properties
QStringList	connectedSources
QQmlPropertyMap	data
QString	dataEngine
QString	engine
int	interval
Plasma::Types::IntervalAlignment	intervalAlignment
QQmlPropertyMap	models
QStringList	sources
bool	valid
Properties inherited from QObject
	objectName

Signals
void	connectedSourcesChanged ()
void	dataChanged ()
void	engineChanged ()
void	intervalAlignmentChanged ()
void	intervalChanged ()
void	newData (const QString &sourceName, const QVariantMap &data)
void	sourceAdded (const QString &source)
void	sourceConnected (const QString &source)
void	sourceDisconnected (const QString &source)
void	sourceRemoved (const QString &source)
void	sourcesChanged ()

Public Slots
void	dataUpdated (const QString &sourceName, const Plasma::DataEngine::Data &data)
void	modelChanged (const QString &sourceName, QAbstractItemModel *model)

Public Member Functions
	DataSource (QObject *parent=nullptr)
void	classBegin () override
void	componentComplete () override
QStringList	connectedSources () const
Q_INVOKABLE void	connectSource (const QString &source)
QQmlPropertyMap *	data () const
Q_INVOKABLE void	disconnectSource (const QString &source)
QString	engine () const
int	interval () const
Plasma::Types::IntervalAlignment	intervalAlignment () const
QQmlPropertyMap *	models () const
Q_INVOKABLE QObject *	serviceForSource (const QString &source)
void	setConnectedSources (const QStringList &s)
void	setEngine (const QString &e)
void	setInterval (const int interval)
void	setIntervalAlignment (Plasma::Types::IntervalAlignment intervalAlignment)
QStringList	sources () const
bool	valid () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Protected Slots
void	removeSource (const QString &source)
void	setupData ()
void	updateSources ()

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Provides data from a range of plugins.

Definition at line 33 of file datasource.h.

Property Documentation

connectedSources

QStringList Plasma::DataSource::connectedSources

readwrite

List of all the sources connected to the DataEngine.

Definition at line 96 of file datasource.h.

data

QQmlPropertyMap Plasma::DataSource::data

read

All the data fetched by this dataengine.

This is a map of maps.

1. At the first level, there are the source names.
2. At the second level, there are source-specific keys set by the DataEngine.

Refer to a particular DataEngine implementation for available sources, keys and expected value types.

Definition at line 122 of file datasource.h.

dataEngine

QString Plasma::DataSource::dataEngine

readwrite

Plugin name of the Plasma DataEngine.

Definition at line 85 of file datasource.h.

interval

int Plasma::DataSource::interval

readwrite

Polling interval in milliseconds when the data will be fetched again.

If 0, no polling will be done.

Definition at line 65 of file datasource.h.

intervalAlignment

Plasma::Types::IntervalAlignment Plasma::DataSource::intervalAlignment

readwrite

The interval to align polling to.

Definition at line 75 of file datasource.h.

models

QQmlPropertyMap Plasma::DataSource::models

read

All the models associated to this DataEngine, indexed by source.

In order for a model to be available, besides being implemented in the DataEngine, the user has to be connected to its source, i.e. the source name has to be present in connectedSources list.

Definition at line 135 of file datasource.h.

sources

QStringList Plasma::DataSource::sources

read

Read-only list of all the sources available from the DataEngine (connected or not).

Definition at line 106 of file datasource.h.

valid

bool Plasma::DataSource::valid

read

True if the connection to the Plasma DataEngine is valid.

Definition at line 56 of file datasource.h.

Member Function Documentation

connectSource()

void Plasma::DataSource::connectSource

(

const QString &

source

)

Connects a new source and adds it to the connectedSources list.

Definition at line 216 of file datasource.cpp.

disconnectSource()

void Plasma::DataSource::disconnectSource

(

const QString &

source

)

Disconnects from a DataEngine source and removes it from the connectedSources list.

Definition at line 230 of file datasource.cpp.

serviceForSource()

QObject * Plasma::DataSource::serviceForSource

(

const QString &

source

)

Returns

a Plasma::Service given a source name

Parameters

source

source name we want a service of

Definition at line 203 of file datasource.cpp.

---

The documentation for this class was generated from the following files:

• datasource.h
• datasource.cpp