settings

Documentation

Overview

Package settings provides read-only access to a small number of host settings required for toolkits similar to XSettings. It is not for general purpose settings. Upstream API documentation can be found at https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Settings.html.

Index

• func OnSignalSettingChanged(callback func(changed Changed)) error
• func ReadAll(namespaces []string) (map[string](map[string]dbus.Variant), error)
• func ReadOne(namespace, key string) (any, error)
• type Changed

Functions

func OnSignalSettingChanged

func OnSignalSettingChanged(callback func(changed Changed)) error

OnSignalSettingChanged listens for the SettingChanged signal. This signal is emitted when a setting changes.

func ReadAll

func ReadAll(namespaces []string) (map[string](map[string]dbus.Variant), error)

ReadAll returns all values for the corresponding namespaces passed. 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.*”.

func ReadOne

func ReadOne(namespace, key string) (any, error)

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

Types

type Changed

type Changed struct {
	Namespace string // Namespace of changed setting.
	Key       string // The key of changed setting.
	Value     any    // The new value.
}

Changed is the result given when a setting changes its value.