alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

apidox clarifications

Browse Source 
svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=788145
This commit is contained in:
Aaron J. Seigo 2008-03-20 20:54:51 +00:00
parent 9d5aa89497
commit 5bd198db4a
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
dataengine.h
View File

@ -120,10 +120,10 @@ class PLASMA_EXPORT DataEngine : public QObject
Plasma::IntervalAlignment intervalAlignment = NoAlignment) const;
/**
* Connects all sources to an object for data updates. The object must
* have a slot with the following signature:
* Connects all currently existing sources to an object for data updates.
* The object must have a slot with the following signature:
*
* SLOT(dataUpdated(QString, Plasma::DataEngine::Data))
* SLOT(dataUpdated(QString,Plasma::DataEngine::Data))
*
* The data is a QHash of QVariants keyed by QString names, allowing
* one data source to provide sets of related data.
@ -131,6 +131,10 @@ class PLASMA_EXPORT DataEngine : public QObject
* This method may be called multiple times for the same visualization
* without side-effects. This can be useful to change the updateInterval.
*
* Note that this method does not automatically connect sources that
* may appear later on. Connecting and responding to the sourceAdded sigal
* is still required to achieve that.
*
* @param visualization the object to connect the data source to
* @param updateInterval the frequency, in milliseconds, with which to signal updates;
* a value of 0 (the default) means to update only
@ -140,7 +144,7 @@ class PLASMA_EXPORT DataEngine : public QObject
* per-visualization and can be handy for items that require
* constant updates such as scrolling graphs or clocks.
**/
Q_INVOKABLE void connectAllSources(QObject* viualization, uint updateInterval = 0,
Q_INVOKABLE void connectAllSources(QObject* visualization, uint updateInterval = 0,
Plasma::IntervalAlignment intervalAlignment = NoAlignment) const;
/**