glok-core/uk.co.nickthecoder.glok.event/KeyEvent

KeyEvent

class KeyEvent(val eventType: EventType<KeyEvent>, val key: Key, val scanCode: Int, val repeated: Boolean, val mods: Int) : Event

These events are fired when a key is pressed or released. Do not use these events to detect characters being typed (use KeyTypedEvent).

There is no simple relationship between KeyEvent and KeyTypedEvents, it's complicated, and platform dependent. For example, on my laptop, I can generate a KeyTypedEvent for the degree character °, by holding down CapsLock and pressing O twice. (On Linux, I've set CapsLock as my Compose key, which combines the next 2 keys pressed into a single character).

Constructors

constructor(eventType: EventType<KeyEvent>, key: Key, scanCode: Int, repeated: Boolean, mods: Int)

Properties

open override val eventType: EventType<KeyEvent>

Either EventType.KEY_PRESSED or EventType.KEY_RELEASED

val isAltDown: Boolean

val isControlDown: Boolean

val isShiftDown: Boolean

val isSuperDown: Boolean

val key: Key

Which key was pressed / released.

Holds state information for the Shift, Control, Alt and Super keys. See isShiftDown, isControlDown, isAltDown, isSuperDown.

val repeated: Boolean

For events of type EventType.KEY_PRESSED, which are generated due to a key is held down.

val scanCode: Int

Keyboard specific identifier for the key pressed/released. This is rarely used, as key is a device-independent identifier.

Functions

fun matches(keyCombination: KeyCombination): Boolean

open override fun toString(): String