Kanzi Engine Lua API
Previous
Next
Contents
Manual
Classes
Modules

Class KeyManipulatorMetadata

Defines properties and message types for KeyManipulator.

Inherits properties and message types from InputManipulatorMetadata.

Message Types

See also MessageType
KeyManipulatorMetadata.KeyPressedMessage

Occurs when Kanzi recognizes a key-pressed gesture. A key-pressed gesture occurs when Kanzi recognizes a key event that contains all the elements that compose that gesture.

Arguments: KeyManipulatorMetadata.KeyPressedMessageArguments
KeyManipulatorMetadata.KeyReleasedMessage

Occurs when Kanzi recognizes a key-released gesture. A key-released gesture occurs when Kanzi recognizes the release of one of the elements that compose that gesture.

Arguments: KeyManipulatorMetadata.KeyReleasedMessageArguments
KeyManipulatorMetadata.KeyCanceledMessage

Occurs when Kanzi recognizes a key-canceled gesture. A key-canceled gesture occurs when Kanzi recognizes that the user canceled a gesture.

Arguments: KeyManipulatorMetadata.KeyCanceledMessageArguments

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

KeyManipulatorMetadata.KeyCanceledMessageArguments

IsRepeatProperty

Whether the key press is a repeat caused by the user holding down a keyboard key.

Example
local value = arguments:getIsRepeatProperty()
arguments:setIsRepeatProperty(value)
KeyProperty

Sets the target logical key to handle.

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

Sets the target key modifiers to handle.

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

Sets whether Caps Lock is on during the key event.

Example
local value = arguments:getCapsLockProperty()
arguments:setCapsLockProperty(value)

KeyManipulatorMetadata.KeyPressedMessageArguments

IsRepeatProperty

Whether the key press is a repeat caused by the user holding down a keyboard key.

Example
local value = arguments:getIsRepeatProperty()
arguments:setIsRepeatProperty(value)
KeyProperty

Sets the target logical key to handle.

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

Sets the target key modifiers to handle.

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

Sets whether Caps Lock is on during the key event.

Example
local value = arguments:getCapsLockProperty()
arguments:setCapsLockProperty(value)

KeyManipulatorMetadata.KeyReleasedMessageArguments

KeyProperty

Sets the target logical key to handle.

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

Sets the target key modifiers to handle.

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

Sets whether Caps Lock is on during the key event.

Example
local value = arguments:getCapsLockProperty()
arguments:setCapsLockProperty(value)