• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

libplasma

Plasma::DataEngineManager

Plasma::DataEngineManager Class Reference

#include <dataenginemanager.h>

Inheritance diagram for Plasma::DataEngineManager:

Inheritance graph
[legend]

List of all members.


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 37 of file dataenginemanager.h.


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 ()
static DataEngineManager * self ()

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 97 of file dataenginemanager.cpp.

QStringList Plasma::DataEngineManager::listAllEngines (  )  [static]

Returns a listing of all known engines by name.

Definition at line 168 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 109 of file dataenginemanager.cpp.

DataEngineManager * Plasma::DataEngineManager::self (  )  [static]

Singleton pattern accessor.

Definition at line 82 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:
  • dataenginemanager.h
  • dataenginemanager.cpp

libplasma

Skip menu "libplasma"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libplasma
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal