QValueSpaceSubscriber Class Reference

Member Function Documentation

QValueSpaceSubscriber::QValueSpaceSubscriber ( QObject * parent = 0 )

Constructs a QValueSpaceSubscriber with the specified parent that refers to the root path.

The constructed Value Space subscriber will access all available layers.

This function was introduced in Qt Mobility 1.0.

QValueSpaceSubscriber::QValueSpaceSubscriber ( const QString & path, QObject * parent = 0 )

Constructs a QValueSpaceSubscriber with the specified parent that refers to path.

The constructed Value Space subscriber will access all available layers.

This function was introduced in Qt Mobility 1.0.

QValueSpaceSubscriber::QValueSpaceSubscriber ( QValueSpace::LayerOptions filter, const QString & path, QObject * parent = 0 )

Constructs a QValueSpaceSubscriber with the specified parent that refers to path. The filter parameter is used to limit which layers this QValueSpaceSubscriber will access.

If a layer matching filter is not found, the constructed QValueSpaceSubscriber will be unconnected.

This function was introduced in Qt Mobility 1.0.

See also isConnected().

QValueSpaceSubscriber::QValueSpaceSubscriber ( const QUuid & uuid, const QString & path, QObject * parent = 0 )

Constructs a QValueSpaceSubscriber with the specified parent that refers to path. This QValueSpaceSubscriber will only use the layer identified by uuid.

Use of this constructor is not platform agnostic. If possible use one of the constructors that take a QValueSpace::LayerOptions parameter instead.

If a layer with a matching uuid is not found, the constructed QValueSpaceSubscriber will be unconnected.

This function was introduced in Qt Mobility 1.0.

See also QValueSpace and isConnected().

QValueSpaceSubscriber::~QValueSpaceSubscriber () [virtual]

Destroys the QValueSpaceSubscriber.

This function was introduced in Qt Mobility 1.0.

void QValueSpaceSubscriber::cd ( const QString & path )

Changes the path to the absolute path if path starts with a '/'; otherwise changes to the sub path of the current path.

This function was introduced in Qt Mobility 1.0.

void QValueSpaceSubscriber::cdUp ()

Sets the path to parent of the current path.

This function was introduced in Qt Mobility 1.0.

void QValueSpaceSubscriber::contentsChanged () [signal]

Emitted whenever any value under the current path changes.

Note: that if a value changes multiple times in quick succession, only the most recent value may be accessible via the value() function.

This function was introduced in Qt Mobility 1.0.

bool QValueSpaceSubscriber::isConnected () const

Returns true if this QValueSpaceSubscriber is connected to at least one available layer; otherwise returns false. An unconnected QValueSpaceSubscriber is constructed if the filtering parameters passed to the constructor eliminate all available layers.

This function was introduced in Qt Mobility 1.0.

QStringList QValueSpaceSubscriber::subPaths () const

Returns a list of sub-paths under the current path. For example, given a Value Space tree containing:

 /Settings/Nokia/Device
 /Settings/Nokia/Other
 /Settings/Qt
 /Device/Buttons

QValueSpaceSubscriber("/Settings").subPaths() will return a list containing { Nokia, Qt } in no particular order.

This function was introduced in Qt Mobility 1.0.

QVariant QValueSpaceSubscriber::value ( const QString & subPath = QString(), const QVariant & def = QVariant() ) const

Returns the value of the subPath under this subscriber path, or the value of this subscriber path if subPath is empty. If the value does not exists def is returned.

The following code shows how the subscriber path and subPath relate.

 QValueSpaceSubscriber base("/Settings");
 QValueSpaceSubscriber equiv("/Settings/Nokia/General/Mappings");

 // Is true
 equiv.value() == base.value("Nokia/General/Mappings");

This function was introduced in Qt Mobility 1.0.