EventControllerKey

open class EventControllerKey(pointer: <Error class: unknown class><<Error class: unknown class>>) : EventController

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

Constructors

Link copied to clipboard
constructor()

Creates a new event controller that will handle key events.

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gtkEventControllerKeyPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open var name: String?

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

Link copied to clipboard

The limit for which events this controller will handle.

Link copied to clipboard

The propagation phase at which this controller will handle events.

Link copied to clipboard
open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

Link copied to clipboard
fun connectImUpdate(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.

Link copied to clipboard
fun connectKeyPressed(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.

Link copied to clipboard
fun connectKeyReleased(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.

Link copied to clipboard
fun connectModifiers(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.

Link copied to clipboard
open fun forward(widget: Widget): Boolean

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

Link copied to clipboard
open fun getCurrentEvent(): <Error class: unknown class>?

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

Link copied to clipboard
open fun getCurrentEventDevice(): <Error class: unknown class>?

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

Link copied to clipboard
open fun getCurrentEventState(): <Error class: unknown class>

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

Link copied to clipboard
open fun getCurrentEventTime(): <Error class: unknown class>

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

Link copied to clipboard
open fun getGroup(): <Error class: unknown class>

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

Link copied to clipboard
open fun getImContext(): ImContext?

Gets the input method context of the key @controller.

Link copied to clipboard
open fun reset()

Resets the @controller to a clean state.

Link copied to clipboard
open fun setImContext(imContext: ImContext? = null)

Sets the input method context of the key @controller.

Link copied to clipboard
open fun setStaticName(name: String? = null)

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