colibrio-reader-framework/com.colibrio.readingsystem.base/KeyboardEngineEventData

KeyboardEngineEventData

class KeyboardEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.KEYBOARD_ENGINE_EVENT, val type: EngineEventDataType, val code: String, val isComposing: Boolean, val key: String, val keyCode: Int, val location: Int, val modifiers: KeyboardModifierStates, val readerDocumentEventState: ReaderDocumentEventState, val repeated: Boolean, val target: EngineEventTargetData?, val userGenerated: Boolean) : ReaderViewEngineEventData

The serializable version of IKeyboardEngineEvent, used for "keydown" and "keyup" events.

Constructors

fun KeyboardEngineEventData(objectType: EngineEventDataObjectType = EngineEventDataObjectType.KEYBOARD_ENGINE_EVENT, type: EngineEventDataType, code: String, isComposing: Boolean, key: String, keyCode: Int, location: Int, modifiers: KeyboardModifierStates, readerDocumentEventState: ReaderDocumentEventState, repeated: Boolean, target: EngineEventTargetData?, userGenerated: Boolean)

Types

Companion

object Companion

Functions

serialize

open override fun serialize(generator: JsonGenerator)

Properties

code

val code: String

Represents a physical key on the keyboard (as opposed to the character generated by pressing the key). In other words, this property returns a value that isn't altered by keyboard layout or the state of the modifier keys.

isComposing

val isComposing: Boolean

Indicates if the event was fired within a composition session, i.e. between "compositionstart" and "compositionend"

key

val key: String

Returns the value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout.

keyCode

val keyCode: Int

Represents a system and implementation dependent numerical code identifying the unmodified value of the pressed key. This is usually the decimal ASCII (RFC 20) or Windows 1252 code corresponding to the key. If the key can't be identified, this value is 0.

location

val location: Int

A number representing the location of the key on the keyboard or other input device.

modifiers

val modifiers: KeyboardModifierStates

Contains the state of keyboard modifier keys.

objectType

val objectType: EngineEventDataObjectType

The type of engine event object this JSON structure represents.

readerDocumentEventState

val readerDocumentEventState: ReaderDocumentEventState

Describes how the reader document acted on the event.