Package ch.bailu.gtk.gtk

Class EventControllerKey

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gtk.EventController

ch.bailu.gtk.gtk.EventControllerKey

All Implemented Interfaces:

PointerInterface

public class EventControllerKey
extends EventController

`GtkEventControllerKey` is an event controller that provides access
to key events.

https://docs.gtk.org/gtk4/class.EventControllerKey.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EventControllerKey.OnImUpdate
static interface	EventControllerKey.OnKeyPressed
static interface	EventControllerKey.OnKeyReleased
static interface	EventControllerKey.OnModifiers

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDestroyNotify, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SIGNAL_ON_IM_UPDATE
static final String	SIGNAL_ON_KEY_PRESSED
static final String	SIGNAL_ON_KEY_RELEASED
static final String	SIGNAL_ON_MODIFIERS

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
EventControllerKey()	Creates a new event controller that will handle key events.
EventControllerKey(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
boolean	forward(Widget widget)	Forwards the current event of this @controller to a @widget.
static ClassHandler	getClassHandler()
int	getGroup()	Gets the key group of the current event of this @controller.
IMContext	getImContext()	Gets the input method context of the key @controller.
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
SignalHandler	onImUpdate(EventControllerKey.OnImUpdate signal)	Connect to signal "im-update".
SignalHandler	onKeyPressed(EventControllerKey.OnKeyPressed signal)	Connect to signal "key-pressed".
SignalHandler	onKeyReleased(EventControllerKey.OnKeyReleased signal)	Connect to signal "key-released".
SignalHandler	onModifiers(EventControllerKey.OnModifiers signal)	Connect to signal "modifiers".
void	setImContext(IMContext im_context)	Sets the input method context of the key @controller.

Methods inherited from class ch.bailu.gtk.gtk.EventController

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

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Field Details

SIGNAL_ON_IM_UPDATE

public static final String SIGNAL_ON_IM_UPDATE

See Also:

• Constant Field Values

SIGNAL_ON_KEY_PRESSED

public static final String SIGNAL_ON_KEY_PRESSED

See Also:

• Constant Field Values

SIGNAL_ON_KEY_RELEASED

public static final String SIGNAL_ON_KEY_RELEASED

See Also:

• Constant Field Values

SIGNAL_ON_MODIFIERS

public static final String SIGNAL_ON_MODIFIERS

See Also:

• Constant Field Values

Constructor Details

EventControllerKey

public EventControllerKey(PointerContainer pointer)

EventControllerKey

public EventControllerKey()

Creates a new event controller that will handle key events.

Method Details

getClassHandler

public static ClassHandler getClassHandler()

forward

public boolean forward(@Nonnull
 Widget widget)

Forwards the current event of this @controller to a @widget.

This function can only be used in handlers for the
[signal@Gtk.EventControllerKey::key-pressed],
[signal@Gtk.EventControllerKey::key-released]
or [signal@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 [method@Gdk.KeyEvent.get_layout].

Returns:

the key group

getImContext

public IMContext getImContext()

Gets the input method context of the key @controller.

Returns:

the `GtkIMContext`

setImContext

public void setImContext(@Nullable
 IMContext im_context)

Sets the input method context of the key @controller.

Parameters:

im_context - a `GtkIMContext`

onImUpdate

public SignalHandler onImUpdate(EventControllerKey.OnImUpdate signal)

Connect to signal "im-update".
See EventControllerKey.OnImUpdate.onImUpdate() for signal description.
Field SIGNAL_ON_IM_UPDATE contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onKeyPressed

public SignalHandler onKeyPressed(EventControllerKey.OnKeyPressed signal)

Connect to signal "key-pressed".
See EventControllerKey.OnKeyPressed.onKeyPressed(int, int, int) for signal description.
Field SIGNAL_ON_KEY_PRESSED contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onKeyReleased

public SignalHandler onKeyReleased(EventControllerKey.OnKeyReleased signal)

Connect to signal "key-released".
See EventControllerKey.OnKeyReleased.onKeyReleased(int, int, int) for signal description.
Field SIGNAL_ON_KEY_RELEASED contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onModifiers

public SignalHandler onModifiers(EventControllerKey.OnModifiers signal)

Connect to signal "modifiers".
See EventControllerKey.OnModifiers.onModifiers(int) for signal description.
Field SIGNAL_ON_MODIFIERS contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()