Skip To Content ArcGIS for Developers Sign In Dashboard

Settings QML Type

Represents app settings. More...

Import Statement: import Esri.ArcGISExtras 1.1
Since: Esri.ArcGISExtras 1.0

Properties

Signals

Methods

Detailed Description

Settings is a wrapper for the Qt QSettings class, sharing many of its properties and methods.

Property Documentation

fallbacksEnabled : bool

Whether fallbacks are enabled.


path : string

Returns the path (read-only).


Signal Documentation

valueChanged()

Emitted when a value is changed.

Note: The corresponding handler is onValueChanged.


Method Documentation

bool boolValue(key, bool defaultValue)

Returns the bool value for the setting identified by key.

If the setting doesn't exist, returns defaultValue, which is false if not specified.


color colorValue(key, color defaultValue)

Returns the color value for the setting identified by key.

If the setting doesn't exist, returns defaultValue.

See also setColorValue().


bool contains(key)

Returns whether there is a setting identified by key.


real numberValue(key, real defaultValue)

Returns the numeric value for the setting identified by key.

If the setting doesn't exist, returns defaultValue, which is 0 if not specified.


void remove(key)

Removes the setting identified by key.


void setColorValue(key, color value)

Set the setting identified by key to a color value.

If the key already exists, the previous value is overwritten.

See also colorValue().


void setValue(key, jsobject value, jsobject defaultValue)

Sets the value of setting key to value.

If the key already exists, the previous value is overwritten.

Note: If defaultValue is equal to value then key is removed from settings.

See also value().


void synchronize()

Writes any unsaved changes to permanent storage, and reloads any settings that have been changed in the meantime by another application.


jsobject value(key, jsobject defaultValue)

Returns the value for the setting identified by key.

If the setting doesn't exist, returns defaultValue.

See also setValue().



Feedback on this topic?