Nemo QML Plugin Configuration

API Documentation

ConfigurationGroup QML Type

Provides access to a group of configuration values More...

Import Statement: import Nemo.Configuration 1.0

List of all members, including inherited members

Properties

path : string
scope : ConfigurationGroup
synchronous : bool

Signals

valueChanged(key)
valuesChanged()

Methods

void clear()
void setValue(string key, variant value)
void sync()
variant value(string key, variant defaultValue, int typeHint)

Detailed Description

ConfigurationGroup provides access to a group of DConf key values relative to path. ConfigurationGroups can be nested in which case path is relative to the parent ConfigurationGroup.

Key values can be accessed using the value() and setValue() methods. Value change notifications are via the valueChanged and valuesChanged signals.

Properties declared on the ConfigurationGroup will be synchronized with DConf keys with the same name. Due to the requirement that QML properties start with a lower case letter this method does not allow accessing all possible key values. The value() and setValue() methods can be used in these cases.

Property Documentation

path : string

This property holds the path of the configuration group. If this ConfigurationGroup is nested within another ConfigurationGroup then path is relative to the path of the parent group.

scope : ConfigurationGroup

This property holds the parent scope of the configuration group. The path property is relative to the path of the parent scope.

This property is automatically set when creating nested ConfigurationGroups.

synchronous : bool

This property holds whether synchronous access is used.

Defaults to false.

Signal Documentation

valueChanged(key)

This signal is emitted when the value of key changes.

valuesChanged()

This signal is emitted when unknown properties of this configuration group change.

Method Documentation

void clear()

Clears all values for properties in this configuration group.

void setValue(string key, variant value)

Sets the value of key to value.

void sync()

Forces any pending writes to be synchronized with the backing store.

variant value(string key, variant defaultValue, int typeHint)

Returns the value of key as a variant. If key does not exist defaultValue will be returned. If specified, the key value will be converted to the meta type id typeHint.