ContextRegistryInfo Class Reference

A class to introspect the registry contents. More...

#include <contextregistryinfo.h>

List of all members.

Signals

void keysChanged (const QStringList &currentKeys)
 DEPRECATED use changed signal instead.
void keysAdded (const QStringList &newKeys)
 DEPRECATED use changed signal instead.
void keysRemoved (const QStringList &removedKeys)
 DEPRECATED use changed signal instead.
void changed ()
 Emitted when the list of provided keys changes (keys were added or removed).

Public Member Functions

QStringList listKeys () const
 Returns the list of all the keys currently availible in the registry.
QStringList listKeys (QString providername) const
 Returns the list of all the keys associated with the given provider.
QStringList listKeysForPlugin (QString plugin) const
 DEPRECATED Returns the list of all the keys associated with the given plugin.
QStringList listProviders () const
 DEPRECATED Returns the list of all unique providers in the registry.
QStringList listPlugins () const
 DEPRECATED Returns the list of all unique plugins in the registry.
QString backendName () const
 Returns the name of the currently used registry backend. Ie. "cdb" or "xml".

Static Public Member Functions

static ContextRegistryInfoinstance (const QString &backendName="")
 Returns the singleton instance of the ContextRegistryInfo.

Protected Member Functions

void connectNotify (const char *signal)
 Called when people connect to signals.

Private Slots

void onKeysChanged (const QStringList &currentKeys)
 This is connected to the keysChanged of the actual info backend instance.
void onKeysAdded (const QStringList &newKeys)
 This is connected to the keysAdded of the actual info backend instance.
void onKeysRemoved (const QStringList &removedKeys)
 This is connected to the keysRemoved of the actual info backend instance.
void onListChanged ()
 This is connected to the listChanged of the actual info backend instance.

Private Member Functions

 ContextRegistryInfo ()
 ContextRegistryInfo (const ContextRegistryInfo &)
 Private constructor. Do not use.
ContextRegistryInfooperator= (const ContextRegistryInfo &)
 Private operator. Do not use.

Static Private Attributes

static ContextRegistryInforegistryInstance = NULL
 Holds the actual pointer to the singelton instance.

Friends

class ContextRegistryInfoUnitTest


Detailed Description

A class to introspect the registry contents.

This is a singelton class used to obtain information about the keys (properties) in the registry database. The information can be provided either from xml files or from a cdb database. It's possible to list all the keys in the registry and also list all keys belonging to a one particular provider.


Constructor & Destructor Documentation

ContextRegistryInfo::ContextRegistryInfo (  )  [inline, private]

ContextRegistryInfo::ContextRegistryInfo ( const ContextRegistryInfo  )  [private]

Private constructor. Do not use.

Private constructor. Do not use.


Member Function Documentation

ContextRegistryInfo * ContextRegistryInfo::instance ( const QString &  backendName = ""  )  [static]

Returns the singleton instance of the ContextRegistryInfo.

The object is constructed automaticall on first access.

Parameters:
backendName the optional name of the backend to use (force).

QStringList ContextRegistryInfo::listKeys (  )  const

Returns the list of all the keys currently availible in the registry.

QStringList ContextRegistryInfo::listKeys ( QString  providername  )  const

Returns the list of all the keys associated with the given provider.

QStringList ContextRegistryInfo::listKeysForPlugin ( QString  plugin  )  const

DEPRECATED Returns the list of all the keys associated with the given plugin.

QStringList ContextRegistryInfo::listProviders (  )  const

DEPRECATED Returns the list of all unique providers in the registry.

The lists consist of strings with dbus names of the providers.

QStringList ContextRegistryInfo::listPlugins (  )  const

DEPRECATED Returns the list of all unique plugins in the registry.

QString ContextRegistryInfo::backendName (  )  const

Returns the name of the currently used registry backend. Ie. "cdb" or "xml".

ContextRegistryInfo& ContextRegistryInfo::operator= ( const ContextRegistryInfo  )  [private]

Private operator. Do not use.

void ContextRegistryInfo::connectNotify ( const char *  signal  )  [protected]

Called when people connect to signals.

Used to emit deprecation warnings when people connect to deprecated signals.

void ContextRegistryInfo::onKeysChanged ( const QStringList &  currentKeys  )  [private, slot]

This is connected to the keysChanged of the actual info backend instance.

Will be removed when deprecated keysChanged() signal is removed.

void ContextRegistryInfo::onKeysAdded ( const QStringList &  newKeys  )  [private, slot]

This is connected to the keysAdded of the actual info backend instance.

Will be removed when deprecated keysAdded() signal is removed.

void ContextRegistryInfo::onKeysRemoved ( const QStringList &  removedKeys  )  [private, slot]

This is connected to the keysRemoved of the actual info backend instance.

Will be removed when deprecated keysRemoved() signal is removed.

void ContextRegistryInfo::onListChanged (  )  [private, slot]

This is connected to the listChanged of the actual info backend instance.

Gets called when the list of keys changes.

void ContextRegistryInfo::keysChanged ( const QStringList &  currentKeys  )  [signal]

DEPRECATED use changed signal instead.

Emitted when the registry changes. For performance reasons this is not a strict signal - it's emitted also even when no actual changes happened to the key content. For strict monitoring of a partular key use the ContextPropertyInfo.

Parameters:
currentKeys List of all the keys that are now in the registry.

void ContextRegistryInfo::keysAdded ( const QStringList &  newKeys  )  [signal]

DEPRECATED use changed signal instead.

Emitted when new keys become availible in the registry. The list contains only the new keys.

Parameters:
newKeys New keys that appeared in the regisitry.

void ContextRegistryInfo::keysRemoved ( const QStringList &  removedKeys  )  [signal]

DEPRECATED use changed signal instead.

Emitted when keys disappear (are removed) from the registry. The list contains only the removed keys.

Parameters:
removedKeys The list of removed keys.

void ContextRegistryInfo::changed (  )  [signal]

Emitted when the list of provided keys changes (keys were added or removed).

This is not a strict signal - it's possible for the emission to happen even if no actual change happened.


Friends And Related Function Documentation

friend class ContextRegistryInfoUnitTest [friend]


Member Data Documentation

Holds the actual pointer to the singelton instance.

Mutex protected during creation.


The documentation for this class was generated from the following files:

Generated on Sun Apr 21 16:11:51 2013 for libcontextsubscriber by  doxygen 1.5.6