make it clearer in the apidox that the engine MUST create a source if it plans to populate it asynchronously, and show engine writers how to do this with setSource

svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=714173
This commit is contained in:
Aaron J. Seigo 2007-09-18 21:21:05 +00:00
parent fc53b1a7f0
commit 2b2b7f02e5

View File

@ -224,6 +224,13 @@ class PLASMA_EXPORT DataEngine : public QObject
* otherwise the requesting visualization may not receive notice of a
* data update.
*
* If the source can not be populated with data immediately (e.g. due to
* an asynchronous data acquisition method such as an HTTP request)
* the source must still be created, even if it is empty. This can
* be accomplished in these cases with the follow line:
*
* setData(name, DataEngine::Data());
*
* @return true if a DataContainer was set up, false otherwise
*/
virtual bool sourceRequested(const QString &name);