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

complete runner and service aspects of pluginloader

Browse Source 
svn path=/trunk/KDE/kdelibs/; revision=1156223
This commit is contained in:
Aaron J. Seigo 2010-07-28 18:17:36 +00:00
parent e944870acc
commit ccd6cd16ee
1 changed files with 40 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
pluginloader.h
View File

@ -28,6 +28,7 @@ namespace Plasma {
class Applet; class Applet;
class DataEngine; class DataEngine;
class Service; class Service;
class AbstractRunner;
class PluginLoaderPrivate; class PluginLoaderPrivate;
@ -63,10 +64,17 @@ public:
* Load a DataEngine plugin. * Load a DataEngine plugin.
* *
* @param name the name of the engine * @param name the name of the engine
* @return the data engine that was loaded, or the NullEngine on failure. * @return the DataEngine that was loaded, or the NullEngine on failure.
**/ **/
DataEngine *loadDataEngine(const QString &name); DataEngine *loadDataEngine(const QString &name);
/**
* Load a Runner plugin
*
* @return the Runner that was loaded, or 0 on failure.
*/
AbstractRunner *loadRunner(const QString &name);
/** /**
* Load a Service plugin. * Load a Service plugin.
* *
@ -151,6 +159,18 @@ protected:
virtual Applet *internalLoadApplet(const QString &name, uint appletId = 0, virtual Applet *internalLoadApplet(const QString &name, uint appletId = 0,
const QVariantList &args = QVariantList()); const QVariantList &args = QVariantList());
/**
* A re-implementable method that allows subclasses to override
* the default behaviour of loadRunner. If the runner requested is not recognized,
* then the implementation should return a NULL pointer. This method is called
* by loadRunner prior to attempting to load a DataEgine using the standard Plasma
* plugin mechanisms.
*
* @param name the name of the engine
* @return the data engine that was loaded, or the NullEngine on failure.
**/
virtual AbstractRunner *internalLoadRunner(const QString &name);
/** /**
* A re-implementable method that allows subclasses to override * A re-implementable method that allows subclasses to override
* the default behaviour of loadDataEngine. If the engine requested is not recognized, * the default behaviour of loadDataEngine. If the engine requested is not recognized,
@ -212,6 +232,13 @@ protected:
*/ */
virtual KPluginInfo::List internalRunnerInfo() const; virtual KPluginInfo::List internalRunnerInfo() const;
/**
* Returns a list of all known Runner implementations
*
* @return list of AbstractRunners, or an empty list if none
*/
virtual KPluginInfo::List internalServiceInfo() const;
/** /**
* Standardized mechanism for providing internal Applets by install .desktop files * Standardized mechanism for providing internal Applets by install .desktop files
* in $APPPDATA/plasma/internal/applets/ * in $APPPDATA/plasma/internal/applets/
@ -242,7 +269,7 @@ protected:
/** /**
* Standardized mechanism for providing internal Applets by install .desktop files * Standardized mechanism for providing internal Applets by install .desktop files
* in $APPPDATA/plasma/internal/dataengines/ * in $APPPDATA/plasma/internal/runners/
* *
* For applications that do this, internalRunnerInfo can be implemented as a one-liner * For applications that do this, internalRunnerInfo can be implemented as a one-liner
* call to this method. * call to this method.
@ -251,6 +278,17 @@ protected:
*/ */
KPluginInfo::List standardInternalRunnerInfo() const; KPluginInfo::List standardInternalRunnerInfo() const;
/**
* Standardized mechanism for providing internal Applets by install .desktop files
* in $APPPDATA/plasma/internal/services/
*
* For applications that do this, internalRunnerInfo can be implemented as a one-liner
* call to this method.
*
* @return list of applets
*/
KPluginInfo::List standardInternalServiceInfo() const;
private: private:
PluginLoaderPrivate * const d; PluginLoaderPrivate * const d;
}; };