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

more accurate docs for updateInterval

Browse Source 
svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=796910
This commit is contained in:
Chani Armitage 2008-04-14 14:37:04 +00:00
parent 1e8d0d6051
commit 3c9e07518a
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
dataengine.h
View File

@ -107,14 +107,15 @@ class PLASMA_EXPORT DataEngine : public QObject
* *
* @param source the name of the data source * @param source the name of the data source
* @param visualization the object to connect the data source to * @param visualization the object to connect the data source to
* @param updateInterval the frequency, in milliseconds, with which to signal updates; * @param updateInterval the frequency, in milliseconds, with which to check for updates;
* a value of 0 (the default) means to update only * a value of 0 (the default) means to update only
* when there is new data spontaneously generated * when there is new data spontaneously generated
* (e.g. by the engine); any other value results in * (e.g. by the engine); any other value results in
* periodic updates from this source. This value is * periodic updates from this source. This value is
* per-visualization and can be handy for items that require * per-visualization and can be handy for items that require
* constant updates such as scrolling graphs or clocks. * constant updates such as scrolling graphs or clocks.
* @param intervalAlignment the number of ms to aling the interval to * If the data has not changed, no update will be sent.
* @param intervalAlignment the number of ms to align the interval to
**/ **/
Q_INVOKABLE void connectSource(const QString& source, QObject* visualization, Q_INVOKABLE void connectSource(const QString& source, QObject* visualization,
uint updateInterval = 0, uint updateInterval = 0,
@ -137,14 +138,15 @@ class PLASMA_EXPORT DataEngine : public QObject
* is still required to achieve that. * is still required to achieve that.
* *
* @param visualization the object to connect the data source to * @param visualization the object to connect the data source to
* @param updateInterval the frequency, in milliseconds, with which to signal updates; * @param updateInterval the frequency, in milliseconds, with which to check for updates;
* a value of 0 (the default) means to update only * a value of 0 (the default) means to update only
* when there is new data spontaneously generated * when there is new data spontaneously generated
* (e.g. by the engine); any other value results in * (e.g. by the engine); any other value results in
* periodic updates from this source. This value is * periodic updates from this source. This value is
* per-visualization and can be handy for items that require * per-visualization and can be handy for items that require
* constant updates such as scrolling graphs or clocks. * constant updates such as scrolling graphs or clocks.
* @param intervalAlignment the number of ms to aling the interval to * If the data has not changed, no update will be sent.
* @param intervalAlignment the number of ms to align the interval to
**/ **/
Q_INVOKABLE void connectAllSources(QObject* visualization, uint updateInterval = 0, Q_INVOKABLE void connectAllSources(QObject* visualization, uint updateInterval = 0,
Plasma::IntervalAlignment intervalAlignment = NoAlignment) const; Plasma::IntervalAlignment intervalAlignment = NoAlignment) const;