Plasma
Plasma::DataEngineManager Class Reference
DataEngine loader and life time manager. More...
#include <Plasma/DataEngineManager>

Public Member Functions | |
Plasma::DataEngine * | engine (const QString &name) const |
Plasma::DataEngine * | loadEngine (const QString &name) |
void | unloadEngine (const QString &name) |
Static Public Member Functions | |
static QStringList | listAllEngines (const QString &parentApp=QString()) |
static KPluginInfo::List | listEngineInfo (const QString &parentApp=QString()) |
static KPluginInfo::List | listEngineInfoByCategory (const QString &category, const QString &parentApp=QString()) |
static DataEngineManager * | self () |
Detailed Description
DataEngine loader and life time manager.
Plasma::DataEngineManager provides facilities for listing, loading and according to reference count unloading of DataEngines.
Definition at line 42 of file dataenginemanager.h.
Member Function Documentation
Plasma::DataEngine * Plasma::DataEngineManager::engine | ( | const QString & | name | ) | const |
Returns a data engine object if one is loaded and available.
On failure, the fallback NullEngine (which does nothing and !isValid()) is returned.
- Parameters:
-
name the name of the engine
Definition at line 96 of file dataenginemanager.cpp.
QStringList Plasma::DataEngineManager::listAllEngines | ( | const QString & | parentApp = QString() |
) | [static] |
- Returns:
- a listing of all known DataEngines by name
- Parameters:
-
parentApp the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of QString() will result in a list containing only applets not specifically registered to an application.
Definition at line 168 of file dataenginemanager.cpp.
KPluginInfo::List Plasma::DataEngineManager::listEngineInfo | ( | const QString & | parentApp = QString() |
) | [static] |
Returns a list of all known DataEngines.
- Parameters:
-
parentApp the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of QString() will result in a list containing only applets not specifically registered to an application.
- Returns:
- list of DataEngines
Definition at line 191 of file dataenginemanager.cpp.
KPluginInfo::List Plasma::DataEngineManager::listEngineInfoByCategory | ( | const QString & | category, | |
const QString & | parentApp = QString() | |||
) | [static] |
Returns a list of all known DataEngines filtering by category.
- Parameters:
-
category the category to filter applets on. Uses the X-KDE-PluginInfo-Category entry (if any) in the plugin info. The value of QString() will result in a list of engines with an empty category. parentApp the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of QString() will result in a list containing only applets not specifically registered to an application.
- Returns:
- list of DataEngines
- Since:
- 4.3
Definition at line 205 of file dataenginemanager.cpp.
Plasma::DataEngine * Plasma::DataEngineManager::loadEngine | ( | const QString & | name | ) |
Loads a data engine and increases the reference count on it.
This should be called once per object (or set of objects) using the DataEngine. Afterwards, dataEngine should be used or the return value cached. Call unloadDataEngine when finished with the engine.
- Parameters:
-
name the name of the engine
- Returns:
- the data engine that was loaded, or the NullEngine on failure.
Definition at line 108 of file dataenginemanager.cpp.
DataEngineManager * Plasma::DataEngineManager::self | ( | ) | [static] |
Singleton pattern accessor.
Definition at line 81 of file dataenginemanager.cpp.
void Plasma::DataEngineManager::unloadEngine | ( | const QString & | name | ) |
Decreases the reference count on the engine.
If the count reaches zero, then the engine is deleted to save resources.
Definition at line 153 of file dataenginemanager.cpp.
The documentation for this class was generated from the following files: