Package org.gnome.gdk

Class KeyEvent

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gdk.Event

org.gnome.gdk.KeyEvent

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class KeyEvent
extends Event

An event related to a key-based device.

Nested Class Summary

Nested classes/interfaces inherited from class org.gnome.gdk.Event

Event.Event$Impl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected KeyEvent	asParent()	Returns this instance as if it were its parent type.
Set<ModifierType>	getConsumedModifiers()	Extracts the consumed modifiers from a key event.
int	getKeycode()	Extracts the keycode from a key event.
int	getKeyval()	Extracts the keyval from a key event.
int	getLayout()	Extracts the layout from a key event.
int	getLevel()	Extracts the shift level from a key event.
boolean	getMatch(Out<Integer> keyval, Out<Set<ModifierType>> modifiers)	Gets a keyval and modifier combination that will match the event.
static @Nullable Type	getType()	Get the GType of the KeyEvent class
boolean	isModifier()	Extracts whether the key event is for a modifier key.
KeyMatch	matches(int keyval, Set<ModifierType> modifiers)	Matches a key event against a keyval and modifiers.
KeyMatch	matches(int keyval, ModifierType... modifiers)	Matches a key event against a keyval and modifiers.

Methods inherited from class org.gnome.gdk.Event

eventsGetAngle, eventsGetCenter, eventsGetDistance, getAxes, getAxis, getDevice, getDeviceTool, getDisplay, getEventSequence, getEventType, getHistory, getModifierState, getPointerEmulated, getPosition, getSeat, getSurface, getTime, ref, triggersContextMenu, unref

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getMemoryLayout, getPrivate, readGClass, writeGClass

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

KeyEvent

public KeyEvent(MemorySegment address)

Create a KeyEvent 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 KeyEvent class

Returns:

the GType

asParent

protected KeyEvent asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Event

getConsumedModifiers

public Set<ModifierType> getConsumedModifiers()

Extracts the consumed modifiers from a key event.

Returns:

the consumed modifiers or this KeyEvent

getKeycode

public int getKeycode()

Extracts the keycode from a key event.

Returns:

the keycode of this KeyEvent

getKeyval

public int getKeyval()

Extracts the keyval from a key event.

Returns:

the keyval of this KeyEvent

getLayout

public int getLayout()

Extracts the layout from a key event.

Returns:

the layout of this KeyEvent

getLevel

public int getLevel()

Extracts the shift level from a key event.

Returns:

the shift level of this KeyEvent

getMatch

public boolean getMatch(Out<Integer> keyval,
 Out<Set<ModifierType>> modifiers)

Gets a keyval and modifier combination that will match the event.

See matches(int, java.util.Set<org.gnome.gdk.ModifierType>).

Parameters:

keyval - return location for a keyval

modifiers - return location for modifiers

Returns:

true on success

isModifier

public boolean isModifier()

Extracts whether the key event is for a modifier key.

Returns:

true if the this KeyEvent is for a modifier key

matches

public KeyMatch matches(int keyval,
 Set<ModifierType> modifiers)

Matches a key event against a keyval and modifiers.

This is typically used to trigger keyboard shortcuts such as Ctrl-C.

Partial matches are possible where the combination matches if the currently active group is ignored.

Note that we ignore Caps Lock for matching.

Parameters:

keyval - the keyval to match

modifiers - the modifiers to match

Returns:

a GdkKeyMatch value describing whether this KeyEvent matches

matches

public KeyMatch matches(int keyval,
 ModifierType... modifiers)

Matches a key event against a keyval and modifiers.

This is typically used to trigger keyboard shortcuts such as Ctrl-C.

Partial matches are possible where the combination matches if the currently active group is ignored.

Note that we ignore Caps Lock for matching.

Parameters:

keyval - the keyval to match

modifiers - the modifiers to match

Returns:

a GdkKeyMatch value describing whether this KeyEvent matches