gtk4/org.gtkkn.bindings.gtk/EventControllerKey

EventControllerKey

open class EventControllerKey( val gtkEventControllerKeyPointer: <Error class: unknown class><<Error class: unknown class>>) : EventController(source)

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

Constructors

EventControllerKey

constructor()

Creates a new event controller that will handle key events.

constructor(gtkEventControllerKeyPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gtkEventControllerKeyPointer

val gtkEventControllerKeyPointer: <Error class: unknown class><<Error class: unknown class>>

gtkEventControllerPointer

val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>

name

open var name: String?

The name for this controller, typically used for debugging purposes.

propagationLimit

open var propagationLimit: PropagationLimit

The limit for which events this controller will handle.

propagationPhase

open var propagationPhase: PropagationPhase

The propagation phase at which this controller will handle events.

widget

open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

emitImUpdate

fun emitImUpdate()

Emits the "im-update" signal. See onImUpdate.

emitKeyReleased

fun emitKeyReleased(keyval: <Error class: unknown class>, keycode: <Error class: unknown class>, state: <Error class: unknown class>)

Emits the "key-released" signal. See onKeyReleased.

forward

open fun forward(widget: Widget): Boolean

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

getCurrentEvent

open fun getCurrentEvent(): <Error class: unknown class>?

Returns the event that is currently being handled by the controller.

getCurrentEventDevice

open fun getCurrentEventDevice(): <Error class: unknown class>?

Returns the device of the event that is currently being handled by the controller.

getCurrentEventState

open fun getCurrentEventState(): <Error class: unknown class>

Returns the modifier state of the event that is currently being handled by the controller.

getCurrentEventTime

open fun getCurrentEventTime(): <Error class: unknown class>

Returns the timestamp of the event that is currently being handled by the controller.

getGroup

open fun getGroup(): <Error class: unknown class>

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

getImContext

open fun getImContext(): ImContext?

Gets the input method context of the key @controller.

onImUpdate

fun onImUpdate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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

onKeyPressed

fun onKeyPressed( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted whenever a key is pressed.

onKeyReleased

fun onKeyReleased( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted whenever a key is released.

onModifiers

fun onModifiers( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Boolean): <Error class: unknown class>

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

reset

open fun reset()

Resets the @controller to a clean state.

setImContext

open fun setImContext(imContext: ImContext? = null)

Sets the input method context of the key @controller.

setStaticName

open fun setStaticName(name: String? = null)

Sets a name on the controller that can be used for debugging.