Kanzi Engine Lua API
Previous
Next
Contents
Manual
Classes
Modules

Class KeyboardMetadata

Defines properties and message types for Keyboard.

Property Types

See also PropertyType

Message Types

See also MessageType
KeyboardMetadata.KeyDownMessage

Occurs when the user presses a specific key on their keyboard.

Arguments: KeyboardMetadata.KeyDownMessageArguments
KeyboardMetadata.KeyUpMessage

Occurs when the user releases a specific key on their keyboard.

Arguments: KeyboardMetadata.KeyUpMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

See also MessageArguments

KeyboardMetadata.KeyDownMessageArguments

KeyboardMetadata.KeyStateChangedMessageArguments

KeyProperty

Sets the target logical key.

Example
local value = arguments:getKeyProperty()
arguments:setKeyProperty(value)
KeyModifiersProperty

Sets the target key modifiers.

Example
local value = arguments:getKeyModifiersProperty()
arguments:setKeyModifiersProperty(value)

KeyboardMetadata.KeyUpMessageArguments