• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • Plasma
  • DataEngineScript
Public Member Functions | Protected Member Functions | List of all members
Plasma::DataEngineScript Class Reference

#include <Plasma/Scripting/DataEngineScript>

Inheritance diagram for Plasma::DataEngineScript:
Inheritance graph
[legend]

Public Member Functions

 DataEngineScript (QObject *parent=0)
 
 ~DataEngineScript ()
 
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
 ~ScriptEngine ()
 
virtual bool init ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Protected Member Functions

void addSource (DataContainer *source)
 
DataEngine::SourceDict containerDict () const
 
KPluginInfo description () const
 
void forceImmediateUpdateOfAllVisualizations ()
 
QString mainScript () const
 
int minimumPollingInterval () const
 
const Package * package () const
 
void removeAllData (const QString &source)
 
void removeAllSources ()
 
void removeData (const QString &source, const QString &key)
 
void removeSource (const QString &source)
 
void scheduleSourcesUpdated ()
 
void setData (const QString &source, const QString &key, const QVariant &value)
 
void setData (const QString &source, const QVariant &value)
 
void setData (const QString &source, const DataEngine::Data &values)
 
void setIcon (const QString &icon)
 
void setMaxSourceCount (uint limit)
 
void setMinimumPollingInterval (int minimumMs)
 
void setName (const QString &name)
 
void setPollingInterval (uint frequency)
 
void updateAllSources ()
 
- Protected Member Functions inherited from Plasma::ScriptEngine
 ScriptEngine (QObject *parent=0)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
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)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Provides a restricted interface for scripting a DataEngine.

Definition at line 41 of file dataenginescript.h.

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 35 of file dataenginescript.cpp.

Plasma::DataEngineScript::~DataEngineScript ( )

Definition at line 41 of file dataenginescript.cpp.

Member Function Documentation

void Plasma::DataEngineScript::addSource ( DataContainer *  source)
protected

Definition at line 169 of file dataenginescript.cpp.

DataEngine::SourceDict Plasma::DataEngineScript::containerDict ( ) const
protected

Definition at line 176 of file dataenginescript.cpp.

DataEngine * Plasma::DataEngineScript::dataEngine ( ) const

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

Definition at line 51 of file dataenginescript.cpp.

KPluginInfo Plasma::DataEngineScript::description ( ) const
protected
Returns
the KPluginInfo associated with this plasmoid

Definition at line 91 of file dataenginescript.cpp.

void Plasma::DataEngineScript::forceImmediateUpdateOfAllVisualizations ( )
protected

Definition at line 219 of file dataenginescript.cpp.

QString Plasma::DataEngineScript::mainScript ( ) const
protectedvirtual
Returns
absolute path to the main script file for this plasmoid

Reimplemented from Plasma::ScriptEngine.

Definition at line 79 of file dataenginescript.cpp.

int Plasma::DataEngineScript::minimumPollingInterval ( ) const
protected

Definition at line 147 of file dataenginescript.cpp.

const Package * Plasma::DataEngineScript::package ( ) const
protectedvirtual
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 85 of file dataenginescript.cpp.

void Plasma::DataEngineScript::removeAllData ( const QString &  source)
protected

Definition at line 119 of file dataenginescript.cpp.

void Plasma::DataEngineScript::removeAllSources ( )
protected

Definition at line 162 of file dataenginescript.cpp.

void Plasma::DataEngineScript::removeData ( const QString &  source,
const QString &  key 
)
protected

Definition at line 126 of file dataenginescript.cpp.

void Plasma::DataEngineScript::removeSource ( const QString &  source)
protected

Definition at line 205 of file dataenginescript.cpp.

void Plasma::DataEngineScript::scheduleSourcesUpdated ( )
protected

Definition at line 198 of file dataenginescript.cpp.

Service * Plasma::DataEngineScript::serviceForSource ( const QString &  source)
virtual
Parameters
sourcethe 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 73 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setData ( const QString &  source,
const QString &  key,
const QVariant &  value 
)
protected

Definition at line 97 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setData ( const QString &  source,
const QVariant &  value 
)
protected

Definition at line 105 of file dataenginescript.cpp.

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

Adds a set of values to a source.

Parameters
sourcethe name of the source to set the data on a key/value collection to add to the source
Since
4.5

Definition at line 112 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setDataEngine ( DataEngine *  dataEngine)

Sets the Plasma::DataEngine associated with this DataEngineScript.

Definition at line 46 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setIcon ( const QString &  icon)
protected

Definition at line 191 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setMaxSourceCount ( uint  limit)
protected

Definition at line 133 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setMinimumPollingInterval ( int  minimumMs)
protected

Definition at line 140 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setName ( const QString &  name)
protected

Definition at line 184 of file dataenginescript.cpp.

void Plasma::DataEngineScript::setPollingInterval ( uint  frequency)
protected

Definition at line 155 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
namethe name of the source that should be created
Returns
true if a DataContainer was set up, false otherwise

Definition at line 61 of file dataenginescript.cpp.

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 56 of file dataenginescript.cpp.

void Plasma::DataEngineScript::updateAllSources ( )
protected

Definition at line 212 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
sourcethe 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 67 of file dataenginescript.cpp.


The documentation for this class was generated from the following files:
  • dataenginescript.h
  • dataenginescript.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:23:12 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal