Gio.SettingsSchemaKey¶

Fields¶

None

Methods¶

	`get_default_value` ()
	`get_description` ()
	`get_name` ()
	`get_range` ()
	`get_summary` ()
	`get_value_type` ()
	`range_check` (value)
	`ref` ()
	`unref` ()

Details¶

class Gio.SettingsSchemaKey¶

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

get_default_value()[source]¶

Returns:	the default value for the key
Return type:	`GLib.Variant`

Gets the default value for self.

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

New in version 2.40.

get_description()[source]¶

Returns:	the description for self, or `None`
Return type:	`str`

Gets the description for self.

If no description has been provided in the schema for self, 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.

New in version 2.34.

get_name()[source]¶

Returns:	the name of self.
Return type:	`str`

Gets the name of self.

New in version 2.44.

get_range()[source]¶

Returns:	a `GLib.Variant` describing the range
Return type:	`GLib.Variant`

Queries the range of a key.

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

The type of GLib.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 GLib.Variant.unref() when it is no longer needed.

New in version 2.40.

get_summary()[source]¶

Returns:	the summary for self, or `None`
Return type:	`str`

Gets the summary for self.

If no summary has been provided in the schema for self, 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.

New in version 2.34.

get_value_type()[source]¶

Returns:	the type of self
Return type:	`GLib.VariantType`

Gets the GLib.VariantType of self.

New in version 2.40.

range_check(value)[source]¶

Parameters:	value (`GLib.Variant`) – the value to check
Returns:	`True` if value is valid for self
Return type:	`bool`

Checks if the given value is of the correct type and within the permitted range for self.

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

New in version 2.40.

ref()[source]¶

Returns:	a new reference to self
Return type:	`Gio.SettingsSchemaKey`

Increase the reference count of self, returning a new reference.

New in version 2.40.

unref()[source]¶: Decrease the reference count of self, possibly freeing it.

New in version 2.40.