KDE 4.0 API Reference libplasma
Plasma::DataEngineManager Class Reference
#include <dataenginemanager.h>
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 35 of file dataenginemanager.h.
Public Member Functions | |
| DataEngineManager () | |
| ~DataEngineManager () | |
| Plasma::DataEngine * | dataEngine (const QString &name) const |
| Plasma::DataEngine * | loadDataEngine (const QString &name) |
| void | unloadDataEngine (const QString &name) |
Static Public Member Functions | |
| static DataEngineManager * | self () |
| static QStringList | knownEngines () |
Constructor & Destructor Documentation
| Plasma::DataEngineManager::DataEngineManager | ( | ) |
Default constructor.
Usually the singleton method self() is the preferred access mechanism.
Definition at line 84 of file dataenginemanager.cpp.
| Plasma::DataEngineManager::~DataEngineManager | ( | ) |
Definition at line 89 of file dataenginemanager.cpp.
Member Function Documentation
| DataEngineManager * Plasma::DataEngineManager::self | ( | ) | [static] |
| Plasma::DataEngine * Plasma::DataEngineManager::dataEngine | ( | 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 94 of file dataenginemanager.cpp.
| Plasma::DataEngine * Plasma::DataEngineManager::loadDataEngine | ( | 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 106 of file dataenginemanager.cpp.
| void Plasma::DataEngineManager::unloadDataEngine | ( | 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 141 of file dataenginemanager.cpp.
| QStringList Plasma::DataEngineManager::knownEngines | ( | ) | [static] |
Returns a listing of all known engines by name.
Definition at line 156 of file dataenginemanager.cpp.
The documentation for this class was generated from the following files:
