Class Settings

Namespace

Gio

Assembly

Gio-2.0.dll

public class Settings : Object, IDisposable, NativeObject, GTypeProvider, InstanceFactory

Inheritance

object

Object

Settings

Implements

IDisposable

NativeObject

GTypeProvider

InstanceFactory

Inherited Members

Object.Handle

Object.Dispose()

Object.CompatControl(nuint, nint)

Object.InterfaceFindProperty(TypeInterface, string)

Object.InterfaceInstallProperty(TypeInterface, ParamSpec)

Object.AddWeakPointer(ref nint)

Object.BindProperty(string, Object, string, BindingFlags)

Object.BindPropertyFull(string, Object, string, BindingFlags, Closure, Closure)

Object.ForceFloating()

Object.FreezeNotify()

Object.GetData(string)

Object.GetProperty(string, Value)

Object.GetQdata(Quark)

Object.GetValist(string, nint)

Object.Getv(string[], Value[])

Object.IsFloating()

Object.Notify(string)

Object.NotifyByPspec(ParamSpec)

Object.Ref()

Object.RefSink()

Object.RemoveWeakPointer(ref nint)

Object.RunDispose()

Object.SetData(string, nint)

Object.SetProperty(string, Value)

Object.SetQdata(Quark, nint)

Object.SetValist(string, nint)

Object.Setv(string[], Value[])

Object.StealData(string)

Object.StealQdata(Quark)

Object.TakeRef()

Object.ThawNotify()

Object.Unref()

Object.WatchClosure(Closure)

Object.NotifySignal

Object.OnNotify

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Settings(params ConstructArgument[])

[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public Settings(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Settings(CreationData)

[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected Settings(CreationData data)

Parameters

data CreationData

Settings(SettingsHandle)

protected Settings(SettingsHandle handle)

Parameters

handle SettingsHandle

Fields

BackendPropertyDefinition

public static readonly Property<SettingsBackend?, Settings> BackendPropertyDefinition

Field Value

Property<SettingsBackend, Settings>

ChangeEventSignal

Signal Descriptor for OnChangeEvent.

public static readonly ReturningSignal<Settings, Settings.ChangeEventSignalArgs, bool> ChangeEventSignal

Field Value

ReturningSignal<Settings, Settings.ChangeEventSignalArgs, bool>

ChangedSignal

Signal Descriptor for OnChanged.

public static readonly Signal<Settings, Settings.ChangedSignalArgs> ChangedSignal

Field Value

Signal<Settings, Settings.ChangedSignalArgs>

DelayApplyPropertyDefinition

public static readonly Property<bool, Settings> DelayApplyPropertyDefinition

Field Value

Property<bool, Settings>

HasUnappliedPropertyDefinition

public static readonly Property<bool, Settings> HasUnappliedPropertyDefinition

Field Value

Property<bool, Settings>

PathPropertyDefinition

public static readonly Property<string?, Settings> PathPropertyDefinition

Field Value

Property<string, Settings>

SchemaIdPropertyDefinition

public static readonly Property<string?, Settings> SchemaIdPropertyDefinition

Field Value

Property<string, Settings>

SchemaPropertyDefinition

public static readonly Property<string?, Settings> SchemaPropertyDefinition

Field Value

Property<string, Settings>

SettingsSchemaPropertyDefinition

public static readonly Property<SettingsSchema, Settings> SettingsSchemaPropertyDefinition

Field Value

Property<SettingsSchema, Settings>

WritableChangeEventSignal

Signal Descriptor for OnWritableChangeEvent.

public static readonly ReturningSignal<Settings, Settings.WritableChangeEventSignalArgs, bool> WritableChangeEventSignal

Field Value

ReturningSignal<Settings, Settings.WritableChangeEventSignalArgs, bool>

WritableChangedSignal

Signal Descriptor for OnWritableChanged.

public static readonly Signal<Settings, Settings.WritableChangedSignalArgs> WritableChangedSignal

Field Value

Signal<Settings, Settings.WritableChangedSignalArgs>

Properties

Backend

public SettingsBackend? Backend { get; }

Property Value

SettingsBackend

DelayApply

public bool DelayApply { get; }

Property Value

bool

HasUnapplied

public bool HasUnapplied { get; }

Property Value

bool

Path

public string? Path { get; }

Property Value

string

Schema

public string? Schema { get; }

Property Value

string

SchemaId

public string? SchemaId { get; }

Property Value

string

SettingsSchema

public SettingsSchema SettingsSchema { get; }

Property Value

SettingsSchema

Methods

Apply()

public void Apply()

Bind(string, Object, string, SettingsBindFlags)

[Version("2.26")]
public void Bind(string key, Object @object, string property, SettingsBindFlags flags)

Parameters

key string

object Object

property string

flags SettingsBindFlags

BindWithMapping(string, Object, string, SettingsBindFlags, Closure?, Closure?)

[Version("2.82")]
public void BindWithMapping(string key, Object @object, string property, SettingsBindFlags flags, Closure? getMapping, Closure? setMapping)

Parameters

key string

object Object

property string

flags SettingsBindFlags

getMapping Closure

setMapping Closure

BindWritable(string, Object, string, bool)

[Version("2.26")]
public void BindWritable(string key, Object @object, string property, bool inverted)

Parameters

key string

object Object

property string

inverted bool

CreateAction(string)

[Version("2.32")]
public Action CreateAction(string key)

Parameters

key string

Returns

Action

Delay()

[Version("2.26")]
public void Delay()

GetBoolean(string)

[Version("2.26")]
public bool GetBoolean(string key)

Parameters

key string

Returns

bool

GetChild(string)

[Version("2.26")]
public Settings GetChild(string name)

Parameters

name string

Returns

Settings

GetDefaultValue(string)

[Version("2.40")]
public Variant? GetDefaultValue(string key)

Parameters

key string

Returns

Variant

GetDouble(string)

[Version("2.26")]
public double GetDouble(string key)

Parameters

key string

Returns

double

GetEnum(string)

[Version("2.26")]
public int GetEnum(string key)

Parameters

key string

Returns

int

GetFlags(string)

[Version("2.26")]
public uint GetFlags(string key)

Parameters

key string

Returns

uint

GetGType()

public static Type GetGType()

Returns

Type

GetHasUnapplied()

[Version("2.26")]
public bool GetHasUnapplied()

Returns

bool

GetInt(string)

[Version("2.26")]
public int GetInt(string key)

Parameters

key string

Returns

int

GetInt64(string)

[Version("2.50")]
public long GetInt64(string key)

Parameters

key string

Returns

long

GetMapped(string, SettingsGetMapping)

public nint GetMapped(string key, SettingsGetMapping mapping)

Parameters

key string

mapping SettingsGetMapping

A callback. If it raises an exception the application will terminate. To receive this unhandled exception see SetHandler(Action<Exception>?).

Returns

nint

GetRange(string)

[Version("2.28")]
public Variant GetRange(string key)

Parameters

key string

Returns

Variant

GetString(string)

[Version("2.26")]
public string GetString(string key)

Parameters

key string

Returns

string

GetStrv(string)

[Version("2.26")]
public string[] GetStrv(string key)

Parameters

key string

Returns

string[]

GetUint(string)

[Version("2.30")]
public uint GetUint(string key)

Parameters

key string

Returns

uint

GetUint64(string)

[Version("2.50")]
public ulong GetUint64(string key)

Parameters

key string

Returns

ulong

GetUserValue(string)

[Version("2.40")]
public Variant? GetUserValue(string key)

Parameters

key string

Returns

Variant

GetValue(string)

[Version("2.26")]
public Variant GetValue(string key)

Parameters

key string

Returns

Variant

IsWritable(string)

[Version("2.26")]
public bool IsWritable(string name)

Parameters

name string

Returns

bool

ListChildren()

public string[] ListChildren()

Returns

string[]

ListKeys()

public string[] ListKeys()

Returns

string[]

ListRelocatableSchemas()

[Version("2.28")]
public static string[] ListRelocatableSchemas()

Returns

string[]

ListSchemas()

[Version("2.26")]
public static string[] ListSchemas()

Returns

string[]

New(string)

[Version("2.26")]
public static Settings New(string schemaId)

Parameters

schemaId string

Returns

Settings

NewFromPointer(nint, bool)

Creates a new managed Settings instance for a given pointer.

public static Settings NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint

ownsHandle bool

Returns

Settings

NewFull(SettingsSchema, SettingsBackend?, string?)

[Version("2.32")]
public static Settings NewFull(SettingsSchema schema, SettingsBackend? backend, string? path)

Parameters

schema SettingsSchema

backend SettingsBackend

path string

Returns

Settings

NewWithBackend(string, SettingsBackend)

[Version("2.26")]
public static Settings NewWithBackend(string schemaId, SettingsBackend backend)

Parameters

schemaId string

backend SettingsBackend

Returns

Settings

NewWithBackendAndPath(string, SettingsBackend, string)

[Version("2.26")]
public static Settings NewWithBackendAndPath(string schemaId, SettingsBackend backend, string path)

Parameters

schemaId string

backend SettingsBackend

path string

Returns

Settings

NewWithPath(string, string)

[Version("2.26")]
public static Settings NewWithPath(string schemaId, string path)

Parameters

schemaId string

path string

Returns

Settings

NewWithProperties(ConstructArgument[])

Creates a new Settings and sets the properties specified by the construct arguments.

public static Settings NewWithProperties(ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

The properties to set.

Returns

Settings

RangeCheck(string, Variant)

[Version("2.28")]
public bool RangeCheck(string key, Variant value)

Parameters

key string

value Variant

Returns

bool

Reset(string)

public void Reset(string key)

Parameters

key string

Revert()

public void Revert()

SetBoolean(string, bool)

[Version("2.26")]
public bool SetBoolean(string key, bool value)

Parameters

key string

value bool

Returns

bool

SetDouble(string, double)

[Version("2.26")]
public bool SetDouble(string key, double value)

Parameters

key string

value double

Returns

bool

SetEnum(string, int)

public bool SetEnum(string key, int value)

Parameters

key string

value int

Returns

bool

SetFlags(string, uint)

public bool SetFlags(string key, uint value)

Parameters

key string

value uint

Returns

bool

SetInt(string, int)

[Version("2.26")]
public bool SetInt(string key, int value)

Parameters

key string

value int

Returns

bool

SetInt64(string, long)

[Version("2.50")]
public bool SetInt64(string key, long value)

Parameters

key string

value long

Returns

bool

SetString(string, string)

[Version("2.26")]
public bool SetString(string key, string value)

Parameters

key string

value string

Returns

bool

SetStrv(string, string[]?)

[Version("2.26")]
public bool SetStrv(string key, string[]? value)

Parameters

key string

value string[]

Returns

bool

SetUint(string, uint)

[Version("2.30")]
public bool SetUint(string key, uint value)

Parameters

key string

value uint

Returns

bool

SetUint64(string, ulong)

[Version("2.50")]
public bool SetUint64(string key, ulong value)

Parameters

key string

value ulong

Returns

bool

SetValue(string, Variant)

[Version("2.26")]
public bool SetValue(string key, Variant value)

Parameters

key string

value Variant

Returns

bool

Sync()

public static void Sync()

Unbind(Object, string)

[Version("2.26")]
public static void Unbind(Object @object, string property)

Parameters

object Object

property string

Events

OnChangeEvent

public event ReturningSignalHandler<Settings, Settings.ChangeEventSignalArgs, bool> OnChangeEvent

Event Type

ReturningSignalHandler<Settings, Settings.ChangeEventSignalArgs, bool>

OnChanged

public event SignalHandler<Settings, Settings.ChangedSignalArgs> OnChanged

Event Type

SignalHandler<Settings, Settings.ChangedSignalArgs>

OnWritableChangeEvent

public event ReturningSignalHandler<Settings, Settings.WritableChangeEventSignalArgs, bool> OnWritableChangeEvent

Event Type

ReturningSignalHandler<Settings, Settings.WritableChangeEventSignalArgs, bool>

OnWritableChanged

public event SignalHandler<Settings, Settings.WritableChangedSignalArgs> OnWritableChanged

Event Type

SignalHandler<Settings, Settings.WritableChangedSignalArgs>