• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • Plasma
  • DataEngineManager
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Plasma::DataEngineManager Class Reference

#include <Plasma/DataEngineManager>

Inheritance diagram for Plasma::DataEngineManager:
Inheritance graph
[legend]

Public Member Functions

Plasma::DataEngine * engine (const QString &name) const
 
Plasma::DataEngine * loadEngine (const QString &name)
 
void unloadEngine (const QString &name)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

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 ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Member Functions

void timerEvent (QTimerEvent *event)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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
namethe name of the engine

Definition at line 106 of file dataenginemanager.cpp.

QStringList Plasma::DataEngineManager::listAllEngines ( const QString &  parentApp = QString())
static
Returns
a listing of all known DataEngines by name
Parameters
parentAppthe 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 160 of file dataenginemanager.cpp.

KPluginInfo::List Plasma::DataEngineManager::listEngineInfo ( const QString &  parentApp = QString())
static

Returns a list of all known DataEngines.

Parameters
parentAppthe 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 183 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
categorythe 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.
parentAppthe 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 188 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
namethe name of the engine
Returns
the data engine that was loaded, or the NullEngine on failure.

Definition at line 122 of file dataenginemanager.cpp.

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

Singleton pattern accessor.

Definition at line 90 of file dataenginemanager.cpp.

void Plasma::DataEngineManager::timerEvent ( QTimerEvent *  event)
protectedvirtual

Reimplemented from QObject.

Reimplemented from QObject.

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


The documentation for this class was generated from the following files:
  • dataenginemanager.h
  • dataenginemanager.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:23:12 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal