Class EventControllerKey

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.EventController

org.gnome.gtk.EventControllerKey

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class EventControllerKey
extends EventController

Provides access to key events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventControllerKey.Builder<B extends EventControllerKey.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	EventControllerKey.EventControllerKeyClass
static interface	EventControllerKey.ImUpdateCallback	Functional interface declaration of the ImUpdateCallback callback.
static interface	EventControllerKey.KeyPressedCallback	Functional interface declaration of the KeyPressedCallback callback.
static interface	EventControllerKey.KeyReleasedCallback	Functional interface declaration of the KeyReleasedCallback callback.
static interface	EventControllerKey.ModifiersCallback	Functional interface declaration of the ModifiersCallback callback.

Nested classes/interfaces inherited from class EventController

EventController.EventController$Impl, EventController.EventControllerClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
EventControllerKey()	Create a new EventControllerKey.
EventControllerKey(MemorySegment address)	Create a EventControllerKey instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected EventControllerKey	asParent()	Return this instance as if it were its parent type.
static EventControllerKey.Builder<? extends EventControllerKey.Builder>	builder()	A EventControllerKey.Builder object constructs a EventControllerKey with the specified properties.
void	emitImUpdate()	Emits the "im-update" signal.
boolean	emitKeyPressed(int keyval, int keycode, Set<ModifierType> state)	Emits the "key-pressed" signal.
void	emitKeyReleased(int keyval, int keycode, Set<ModifierType> state)	Emits the "key-released" signal.
boolean	emitModifiers(Set<ModifierType> state)	Emits the "modifiers" signal.
boolean	forward(Widget widget)	Forwards the current event of this this EventControllerKey to a widget.
int	getGroup()	Gets the key group of the current event of this controller.
@Nullable IMContext	getImContext()	Gets the input method context of the key controller.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the EventControllerKey class.
SignalConnection<EventControllerKey.ImUpdateCallback>	onImUpdate(EventControllerKey.ImUpdateCallback handler)	Emitted whenever the input method context filters away a keypress and prevents the controller receiving it.
SignalConnection<EventControllerKey.KeyPressedCallback>	onKeyPressed(EventControllerKey.KeyPressedCallback handler)	Emitted whenever a key is pressed.
SignalConnection<EventControllerKey.KeyReleasedCallback>	onKeyReleased(EventControllerKey.KeyReleasedCallback handler)	Emitted whenever a key is released.
SignalConnection<EventControllerKey.ModifiersCallback>	onModifiers(EventControllerKey.ModifiersCallback handler)	Emitted whenever the state of modifier keys and pointer buttons change.
void	setImContext(@Nullable IMContext imContext)	Sets the input method context of the key controller.

Methods inherited from class EventController

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getName, getPropagationLimit, getPropagationPhase, getWidget, reset, setName, setPropagationLimit, setPropagationPhase, setStaticName

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

EventControllerKey

public EventControllerKey(MemorySegment address)

Create a EventControllerKey instance for the provided memory address.

Parameters:

address - the memory address of the native object

EventControllerKey

public EventControllerKey()

Create a new EventControllerKey.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the EventControllerKey class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected EventControllerKey asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class EventController

Returns:

the instance as if it were its parent type

forward

public boolean forward(Widget widget)

Forwards the current event of this this EventControllerKey to a widget.

This function can only be used in handlers for the Gtk.EventControllerKey::key-pressed, Gtk.EventControllerKey::key-released or Gtk.EventControllerKey::modifiers signals.

Parameters:

widget - a GtkWidget

Returns:

whether the widget handled the event

getGroup

public int getGroup()

Gets the key group of the current event of this controller.

See KeyEvent#getLayout.

Returns:

the key group

getImContext

public @Nullable IMContext getImContext()

Gets the input method context of the key controller.

Returns:

the GtkIMContext

setImContext

public void setImContext(@Nullable IMContext imContext)

Sets the input method context of the key controller.

Parameters:

imContext - a GtkIMContext

onImUpdate

public SignalConnection<EventControllerKey.ImUpdateCallback> onImUpdate(EventControllerKey.ImUpdateCallback handler)

Emitted whenever the input method context filters away a keypress and prevents the controller receiving it.

See setImContext(IMContext) and IMContext.filterKeypress(Event).

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerKey.ImUpdateCallback.run()

emitImUpdate

public void emitImUpdate()

Emits the "im-update" signal. See onImUpdate(EventControllerKey.ImUpdateCallback).

onKeyPressed

public SignalConnection<EventControllerKey.KeyPressedCallback> onKeyPressed(EventControllerKey.KeyPressedCallback handler)

Emitted whenever a key is pressed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerKey.KeyPressedCallback.run(int, int, Set)

emitKeyPressed

public boolean emitKeyPressed(int keyval,
 int keycode,
 Set<ModifierType> state)

Emits the "key-pressed" signal. See onKeyPressed(EventControllerKey.KeyPressedCallback).

onKeyReleased

public SignalConnection<EventControllerKey.KeyReleasedCallback> onKeyReleased(EventControllerKey.KeyReleasedCallback handler)

Emitted whenever a key is released.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerKey.KeyReleasedCallback.run(int, int, Set)

emitKeyReleased

public void emitKeyReleased(int keyval,
 int keycode,
 Set<ModifierType> state)

Emits the "key-released" signal. See onKeyReleased(EventControllerKey.KeyReleasedCallback).

onModifiers

public SignalConnection<EventControllerKey.ModifiersCallback> onModifiers(EventControllerKey.ModifiersCallback handler)

Emitted whenever the state of modifier keys and pointer buttons change.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• EventControllerKey.ModifiersCallback.run(Set)

emitModifiers

public boolean emitModifiers(Set<ModifierType> state)

Emits the "modifiers" signal. See onModifiers(EventControllerKey.ModifiersCallback).

builder

public static EventControllerKey.Builder<? extends EventControllerKey.Builder> builder()

A EventControllerKey.Builder object constructs a EventControllerKey with the specified properties. Use the various set...() methods to set properties, and finish construction with EventControllerKey.Builder.build().

Returns:

the builder object