Settings#

Description#

Settings interface

This interface provides read-only access to a small number of standardized host settings required for toolkits similar to XSettings. It is not for general purpose settings.

Implementations can provide keys not listed below; they are entirely implementation details that are undocumented. If you are a toolkit and want to use this please open an issue.

Currently the interface provides the following standardized keys:

org.freedesktop.appearance color-scheme (u)

Indicates the system’s preferred color scheme. Supported values are:
- 0: No preference
- 1: Prefer dark appearance
- 2: Prefer light appearance
Unknown values should be treated as 0 (no preference).
org.freedesktop.appearance accent-color ((ddd))

Indicates the system’s preferred accent color as a tuple of RGB values in the sRGB color space, in the range [0,1]. Out-of-range RGB values should be treated as an unset accent color.
org.freedesktop.appearance contrast (u)

Indicates the system’s preferred contrast level. Supported values are:
- 0: No preference (normal contrast)
- 1: Higher contrast
Unknown values should be treated as 0 (no preference).

This documentation describes version 2 of this interface.

Properties#

org.freedesktop.portal.Settings:version#

version readable u

Methods#

org.freedesktop.portal.Settings.ReadAll#

ReadAll (
  IN namespaces as,
  OUT value a{sa{sv}}
)

If namespaces is an empty array or contains an empty string it matches all. Globbing is supported but only for trailing sections, e.g. “org.example.*”.

namespaces: List of namespaces to filter results by, supports simple globbing explained below.
value: Dictionary of namespaces to its keys and values.

org.freedesktop.portal.Settings.Read#

Read (
  IN namespace s,
  IN key s,
  OUT value v
)

Reads a single value. Returns an error on any unknown namespace or key.

Deprecated, use ReadOne instead. The value argument was intended to have the value inside one layer of variant as it is in ReadOne, for example <string “hello”> in GVariant text notation; but it is actually returned inside two layers of variant, for example <<string “hello”>>.

namespace: Namespace to look up key in.
key: The key to get.
value: The value key is set to.

Warning

This method is deprecated.

org.freedesktop.portal.Settings.ReadOne#

ReadOne (
  IN namespace s,
  IN key s,
  OUT value v
)

Reads a single value which may be any valid DBus type. Returns an error on any unknown namespace or key.

This method was added in version 2.

namespace: Namespace to look up key in.
key: The key to get.
value: The value key is set to.

Signals#

org.freedesktop.portal.Settings::SettingChanged#

SettingChanged (
  namespace s,
  key s,
  value v
)

Emitted when a setting changes.

namespace: Namespace of changed setting.
key: The key of changed setting.
value: The new value.