SettingsSchemaKey

class SettingsSchemaKey(*args, **kwargs)

SettingsSchemaKey is an opaque data structure and can only be accessed using the following functions.

Methods

class SettingsSchemaKey

get_default_value() → Variant

Gets the default value for key.

Note that this is the default value according to the schema. System administrator defaults and lockdown are not visible via this API.

Added in version 2.40.

get_description() → str | None

Gets the description for key.

If no description has been provided in the schema for key, returns None.

The description can be one sentence to several paragraphs in length. Paragraphs are delimited with a double newline. Descriptions can be translated and the value returned from this function is is the current locale.

This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.

Added in version 2.34.

get_name() → str

Gets the name of key.

Added in version 2.44.

get_range() → Variant

Queries the range of a key.

This function will return a Variant that fully describes the range of values that are valid for key.

The type of Variant returned is (sv). The string describes the type of range restriction in effect. The type and meaning of the value contained in the variant depends on the string.

If the string is 'type' then the variant contains an empty array. The element type of that empty array is the expected type of value and all values of that type are valid.

If the string is 'enum' then the variant contains an array enumerating the possible values. Each item in the array is a possible valid value and no other values are valid.

If the string is 'flags' then the variant contains an array. Each item in the array is a value that may appear zero or one times in an array to be used as the value for this key. For example, if the variant contained the array ['x', 'y'] then the valid values for the key would be [], ['x'], ['y'], ['x', 'y'] and ['y', 'x'].

Finally, if the string is 'range' then the variant contains a pair of like-typed values – the minimum and maximum permissible values for this key.

This information should not be used by normal programs. It is considered to be a hint for introspection purposes. Normal programs should already know what is permitted by their own schema. The format may change in any way in the future – but particularly, new forms may be added to the possibilities described above.

You should free the returned value with unref() when it is no longer needed.

Added in version 2.40.

get_summary() → str | None

Gets the summary for key.

If no summary has been provided in the schema for key, returns None.

The summary is a short description of the purpose of the key; usually one short sentence. Summaries can be translated and the value returned from this function is is the current locale.

This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.

Added in version 2.34.

get_value_type() → VariantType

Gets the VariantType of key.

Added in version 2.40.

range_check(value: Variant) → bool

Checks if the given value is within the permitted range for key.

It is a programmer error if value is not of the correct type — you must check for this first.

Added in version 2.40.

Parameters:

value – the value to check