Plasma::DataEngineScript Class Reference

#include <Plasma/Scripting/DataEngineScript>

Inheritance diagram for Plasma::DataEngineScript:

Public Member Functions
	DataEngineScript (QObject *parent=nullptr)
DataEngine *	dataEngine () const
virtual Service *	serviceForSource (const QString &source)
void	setDataEngine (DataEngine *dataEngine)
virtual bool	sourceRequestEvent (const QString &name)
virtual QStringList	sources () const
virtual bool	updateSourceEvent (const QString &source)
Public Member Functions inherited from Plasma::ScriptEngine
virtual bool	init ()
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 Member Functions
void	addSource (DataContainer *source)
DataEngine::SourceDict	containerDict () const
KPluginInfo	description () const
void	forceImmediateUpdateOfAllVisualizations ()
QString	mainScript () const override
KPluginMetaData	metadata () const
int	minimumPollingInterval () const
Package	package () const override
void	removeAllData (const QString &source)
void	removeAllSources ()
void	removeData (const QString &source, const QString &key)
void	removeSource (const QString &source)
void	setData (const QString &source, const DataEngine::Data &values)
void	setData (const QString &source, const QString &key, const QVariant &value)
void	setData (const QString &source, const QVariant &value)
void	setMinimumPollingInterval (int minimumMs)
void	setPollingInterval (uint frequency)
void	updateAllSources ()
Protected Member Functions inherited from Plasma::ScriptEngine
	ScriptEngine (QObject *parent=nullptr)
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)

Additional Inherited Members
Properties inherited from QObject
	objectName
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

Detailed Description

Provides a restricted interface for scripting a DataEngine.

Definition at line 28 of file dataenginescript.h.

Constructor & Destructor Documentation

DataEngineScript()

Plasma::DataEngineScript::DataEngineScript ( QObject *  parent = nullptr )

explicit

Default constructor for a DataEngineScript.

Subclasses should not attempt to access the Plasma::DataEngine associated with this DataEngineScript in the constructor. All such set up that requires the DataEngine itself should be done in the init() method.

Definition at line 23 of file dataenginescript.cpp.

Member Function Documentation

dataEngine()

DataEngine * Plasma::DataEngineScript::dataEngine

(

)

const

Returns the Plasma::DataEngine associated with this script component.

Definition at line 39 of file dataenginescript.cpp.

description()

KPluginInfo Plasma::DataEngineScript::description ( ) const

protected

Returns

the KPluginInfo associated with this dataengine

Deprecated:

since 5.67 use metadata()

Definition at line 80 of file dataenginescript.cpp.

mainScript()

QString Plasma::DataEngineScript::mainScript ( ) const

overrideprotectedvirtual

Returns

absolute path to the main script file for this plasmoid

Reimplemented from Plasma::ScriptEngine.

Definition at line 68 of file dataenginescript.cpp.

metadata()

KPluginMetaData Plasma::DataEngineScript::metadata ( ) const

protected

Returns

the KPluginMetaData associated with this dataengine

Since

5.67

Definition at line 86 of file dataenginescript.cpp.

package()

Package Plasma::DataEngineScript::package ( ) const

overrideprotectedvirtual

Returns

the Package associated with this plasmoid which can be used to request resources, such as images and interface files.

Reimplemented from Plasma::ScriptEngine.

Definition at line 74 of file dataenginescript.cpp.

serviceForSource()

Service * Plasma::DataEngineScript::serviceForSource ( const QString &  source )

virtual

Parameters

source

the source to targe the Service at

Returns

a Service that has the source as a destination. The service is parented to the DataEngine, but may be deleted by the caller when finished with it

Definition at line 61 of file dataenginescript.cpp.

setData()

void Plasma::DataEngineScript::setData ( const QString &  source, const DataEngine::Data &  values  )

protected

Adds a set of values to a source.

Parameters

source

the name of the source to set the data on @values a key/value collection to add to the source

Since

4.5

Definition at line 106 of file dataenginescript.cpp.

setDataEngine()

void Plasma::DataEngineScript::setDataEngine

(

DataEngine *

dataEngine

)

Sets the Plasma::DataEngine associated with this DataEngineScript.

Definition at line 34 of file dataenginescript.cpp.

sourceRequestEvent()

bool Plasma::DataEngineScript::sourceRequestEvent ( const QString &  name )

virtual

Called when the script should create a source that does not currently exist.

Parameters

name	the name of the source that should be created

Returns

true if a DataContainer was set up, false otherwise

Definition at line 49 of file dataenginescript.cpp.

sources()

QStringList Plasma::DataEngineScript::sources ( ) const

virtual

Returns

a list of all the data sources available via this DataEngine Whether these sources are currently available (which is what the default implementation provides) or not is up to the DataEngine to decide. By default, this returns dataEngine()->sources()

Definition at line 44 of file dataenginescript.cpp.

updateSourceEvent()

bool Plasma::DataEngineScript::updateSourceEvent ( const QString &  source )

virtual

Called when the script should refresh the data contained in a given source.

Parameters

source

the name of the source that should be updated

Returns

true if the data was changed, or false if there was no change or if the change will occur later

Definition at line 55 of file dataenginescript.cpp.

---

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

• dataenginescript.h
• dataenginescript.cpp