Package org.gnome.gio

Class SettingsSchemaKey

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gio.SettingsSchemaKey

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class SettingsSchemaKey
extends ProxyInstance

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

Constructor Summary

Constructors

Constructor	Description
SettingsSchemaKey(MemorySegment address)	Create a SettingsSchemaKey proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
Variant	getDefaultValue()	Gets the default value for key.
@Nullable String	getDescription()	Gets the description for key.
String	getName()	Gets the name of key.
Variant	getRange()	Queries the range of a key.
@Nullable String	getSummary()	Gets the summary for key.
static @Nullable Type	getType()	Get the GType of the SettingsSchemaKey class
VariantType	getValueType()	Gets the GVariantType of key.
boolean	rangeCheck(Variant value)	Checks if the given value is within the permitted range for key.
SettingsSchemaKey	ref()	Increase the reference count of key, returning a new reference.
void	unref()	Decrease the reference count of key, possibly freeing it.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SettingsSchemaKey

public SettingsSchemaKey(MemorySegment address)

Create a SettingsSchemaKey proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SettingsSchemaKey class

Returns:

the GType

getDefaultValue

public Variant getDefaultValue()

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.

Returns:

the default value for the key

Since:

2.40

getDescription

public @Nullable String getDescription()

Gets the description for key.

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

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.

Returns:

the description for key, or null

Since:

2.34

getName

public String getName()

Gets the name of key.

Returns:

the name of key.

Since:

2.44

getRange

public Variant getRange()

Queries the range of a key.

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

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

Returns:

a GVariant describing the range

Since:

2.40

getSummary

public @Nullable String getSummary()

Gets the summary for key.

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

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.

Returns:

the summary for key, or null

Since:

2.34

getValueType

public VariantType getValueType()

Gets the GVariantType of key.

Returns:

the type of this SettingsSchemaKey

Since:

2.40

rangeCheck

public boolean rangeCheck(Variant value)

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.

Parameters:

value - the value to check

Returns:

true if value is valid for this SettingsSchemaKey

Since:

2.40

ref

public SettingsSchemaKey ref()

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

Returns:

a new reference to this SettingsSchemaKey

Since:

2.40

unref

public void unref()

Decrease the reference count of key, possibly freeing it.

Since:

2.40