GLib.SettingsBackend – gio-2.0 – Vala Binding Reference

Description:

[ CCode ( type_id = "g_settings_backend_get_type ()" ) ]
public abstract class SettingsBackend : Object

The SettingsBackend interface defines a generic interface for non-strictly-typed data that is stored in a hierarchy.

To implement an alternative storage backend for Settings, you need to implement the SettingsBackend interface and then make it implement the extension point g_settings_backend_extension_point_name.

The interface defines methods for reading and writing values, a method for determining if writing of certain values will fail (lockdown) and a change notification mechanism.

The semantics of the interface are very precisely defined and implementations must carefully adhere to the expectations of callers that are documented on each of the interface methods.

Some of the SettingsBackend functions accept or return a Tree. These trees always have strings as keys and Variant as values. g_settings_backend_create_tree is a convenience function to create suitable trees.

The SettingsBackend API is exported to allow third-party implementations, but does not carry the same stability guarantees as the public GIO API. For this reason, you have to define the C preprocessor symbol g_settings_enable_backend before including `gio/gsettingsbackend.h`.

Namespace: GLib

Package: gio-2.0

Content:

Static methods:

public static void flatten_tree (Tree<string,Variant> tree, out string path, out (unowned string)[] keys, out (unowned Variant)[] values)

Calculate the longest common prefix of all keys in a tree and write out an array of the key names relative to that prefix and, optionally, the value to store at each of those keys.

public static SettingsBackend get_default ()

Returns the default SettingsBackend .

public static SettingsBackend keyfile_settings_backend_new (string filename, string root_path, string? root_group)

Creates a keyfile-backed SettingsBackend .

public static SettingsBackend memory_settings_backend_new ()

Creates a memory-backed SettingsBackend .

public static SettingsBackend null_settings_backend_new ()

Creates a readonly SettingsBackend .

Creation methods:

Methods:

public void changed (string key, void* origin_tag)

Signals that a single key has possibly changed.

public void changed_tree (Tree<string,Variant> tree, void* origin_tag)

This call is a convenience wrapper.

public virtual Permission get_permission (string path)

public virtual bool get_writable (string key)

public void keys_changed (string path, string[] items, void* origin_tag)

Signals that a list of keys have possibly changed.

public void path_changed (string path, void* origin_tag)

Signals that all keys below a given path may have possibly changed.

public void path_writable_changed (string path)

Signals that the writability of all keys below a given path may have changed.

public virtual Variant read (string key, VariantType expected_type, bool default_value)

public virtual Variant read_user_value (string key, VariantType expected_type)

public virtual void reset (string key, void* origin_tag)

public virtual void subscribe (string name)

public virtual void sync ()

public virtual void unsubscribe (string name)

public void writable_changed (string key)

Signals that the writability of a single key has possibly changed.

public virtual bool write (string key, Variant value, void* origin_tag)

public virtual bool write_tree (Tree<string,Variant> tree, void* origin_tag)

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref