libplasma
Plasma::DataEngineScript Class Reference
#include <dataenginescript.h>

Detailed Description
Definition at line 34 of file dataenginescript.h.
Public Member Functions | |
DataEngine * | dataEngine () const |
DataEngineScript (QObject *parent=0) | |
void | setDataEngine (DataEngine *dataEngine) |
virtual bool | sourceRequestEvent (const QString &name) |
virtual bool | updateSourceEvent (const QString &source) |
~DataEngineScript () | |
Protected Member Functions | |
int | minimumPollingInterval () const |
void | removeAllData (const QString &source) |
void | removeAllSources () |
void | removeData (const QString &source, const QString &key) |
void | setData (const QString &source, const QVariant &value) |
void | setData (const QString &source, const QString &key, const QVariant &value) |
void | setMaxSourceCount (uint limit) |
void | setMinimumPollingInterval (int minimumMs) |
void | setPollingInterval (uint frequency) |
Constructor & Destructor Documentation
Plasma::DataEngineScript::DataEngineScript | ( | QObject * | parent = 0 |
) | [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 33 of file dataenginescript.cpp.
Plasma::DataEngineScript::~DataEngineScript | ( | ) |
Definition at line 39 of file dataenginescript.cpp.
Member Function Documentation
DataEngine * Plasma::DataEngineScript::dataEngine | ( | ) | const |
Returns the Plasma::DataEngine associated with this script component.
Definition at line 49 of file dataenginescript.cpp.
int Plasma::DataEngineScript::minimumPollingInterval | ( | ) | const [protected] |
Definition at line 109 of file dataenginescript.cpp.
void Plasma::DataEngineScript::removeAllData | ( | const QString & | source | ) | [protected] |
Definition at line 81 of file dataenginescript.cpp.
void Plasma::DataEngineScript::removeAllSources | ( | ) | [protected] |
Definition at line 124 of file dataenginescript.cpp.
void Plasma::DataEngineScript::removeData | ( | const QString & | source, | |
const QString & | key | |||
) | [protected] |
Definition at line 88 of file dataenginescript.cpp.
void Plasma::DataEngineScript::setData | ( | const QString & | source, | |
const QVariant & | value | |||
) | [protected] |
Definition at line 74 of file dataenginescript.cpp.
void Plasma::DataEngineScript::setData | ( | const QString & | source, | |
const QString & | key, | |||
const QVariant & | value | |||
) | [protected] |
Definition at line 66 of file dataenginescript.cpp.
void Plasma::DataEngineScript::setDataEngine | ( | DataEngine * | dataEngine | ) |
Sets the Plasma::DataEngine associated with this DataEngineScript.
Definition at line 44 of file dataenginescript.cpp.
void Plasma::DataEngineScript::setMaxSourceCount | ( | uint | limit | ) | [protected] |
Definition at line 95 of file dataenginescript.cpp.
void Plasma::DataEngineScript::setMinimumPollingInterval | ( | int | minimumMs | ) | [protected] |
Definition at line 102 of file dataenginescript.cpp.
void Plasma::DataEngineScript::setPollingInterval | ( | uint | frequency | ) | [protected] |
Definition at line 117 of file dataenginescript.cpp.
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 54 of file dataenginescript.cpp.
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 60 of file dataenginescript.cpp.
The documentation for this class was generated from the following files: