Enum Class KeyMatch

java.lang.Object

java.lang.Enum<KeyMatch>

org.gnome.gdk.KeyMatch

All Implemented Interfaces:

Serializable, Comparable<KeyMatch>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum KeyMatch
extends Enum<KeyMatch>
implements Enumeration

Describes how well an event matches a given keyval and modifiers.

GdkKeyMatch values are returned by KeyEvent.matches(int, Set).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXACT	The key event matches
NONE	The key event does not match
PARTIAL	The key event matches if keyboard state (specifically, the currently active group) is ignored

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the KeyMatch class.
int	getValue()	Get the numeric value of this enum
static KeyMatch	of(int value)	Create a new KeyMatch for the provided value
static KeyMatch	of(MemorySegment address)	Create a new KeyMatch for the value in the provided memory address.
static KeyMatch	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyMatch[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final KeyMatch NONE

The key event does not match

PARTIAL

public static final KeyMatch PARTIAL

The key event matches if keyboard state (specifically, the currently active group) is ignored

EXACT

public static final KeyMatch EXACT

The key event matches

Method Details

values

public static KeyMatch[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static KeyMatch valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static KeyMatch of(int value)

Create a new KeyMatch for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static KeyMatch of(MemorySegment address)

Create a new KeyMatch for the value in the provided memory address.

Parameters:

address - the memory address holding a enum value

Returns:

the enum for the value in the provided memory address

getType

public static @Nullable Type getType()

Get the GType of the KeyMatch class.

Returns:

the GType