gdk4/org.gtkkn.bindings.gdk/KeyEvent

KeyEvent

open class KeyEvent(pointer: <Error class: unknown class><<Error class: unknown class>>) : Event

An event related to a key-based device.

Skipped during bindings generation

  • parameter keyval: keyval: Out parameter is not supported

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gdkKeyEventPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun getConsumedModifiers(): ModifierType

Extracts the consumed modifiers from a key event.

Link copied to clipboard
open fun getDevice(): Device?

Returns the device of an event.

Link copied to clipboard
open fun getDeviceTool(): DeviceTool?

Returns a GdkDeviceTool representing the tool that caused the event.

Link copied to clipboard
open fun getDisplay(): Display?

Retrieves the display associated to the @event.

Link copied to clipboard
open fun getEventSequence(): EventSequence

Returns the event sequence to which the event belongs.

Link copied to clipboard
open fun getEventType(): EventType

Retrieves the type of the event.

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

Extracts the keycode from a key event.

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

Extracts the keyval from a key event.

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

Extracts the layout from a key event.

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

Extracts the shift level from a key event.

Link copied to clipboard
open fun getModifierState(): ModifierType

Returns the modifier state field of an event.

Link copied to clipboard
open fun getPointerEmulated(): Boolean

Returns whether this event is an 'emulated' pointer event.

Link copied to clipboard
open fun getSeat(): Seat?

Returns the seat that originated the event.

Link copied to clipboard
open fun getSurface(): Surface?

Extracts the surface associated with an event.

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

Returns the timestamp of @event.

Link copied to clipboard
open fun isModifier(): Boolean

Extracts whether the key event is for a modifier key.

Link copied to clipboard
open fun matches(keyval: <Error class: unknown class>, modifiers: ModifierType): KeyMatch

Matches a key event against a keyval and modifiers.

Link copied to clipboard
open fun ref(): Event

Increase the ref count of @event.

Link copied to clipboard
open fun triggersContextMenu(): Boolean

Returns whether a GdkEvent should trigger a context menu, according to platform conventions.

Link copied to clipboard
open fun unref()

Decrease the ref count of @event.