Defines properties and message types for NavigationManipulator.

Inherits properties and message types from InputManipulatorMetadata.

Message Types

See also MessageType
NavigationManipulatorMetadata.KeyNavigationStartedMessage

Occurs when Kanzi recognizes the key-pressed and key repeat gestures for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.

Arguments: NavigationManipulatorMetadata.KeyNavigationMessageArguments

NavigationManipulatorMetadata.KeyNavigationFinishedMessage

Occurs when Kanzi recognizes the key-released gesture for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.

Arguments: NavigationManipulatorMetadata.KeyNavigationMessageArguments

NavigationManipulatorMetadata.KeyNavigationCanceledMessage

Occurs when the key-pressed gesture is canceled for the navigation direction.

Arguments: NavigationManipulatorMetadata.KeyNavigationMessageArguments

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.

NavigationDirectionProperty

The navigation direction.

Example
local value = arguments:getNavigationDirectionProperty()
arguments:setNavigationDirectionProperty(value)
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)