You.i Engine
CYIAccessibilityAttributes::Action Struct Reference

Detailed Description

The accessibility Action structure of the CYIAccessibilityAttributes class instance.

When an accessible node has actions registered using SetActions the AccessibilityActionRequested signal will be emitted when the associated actions occurs while the node has accessibility focus. The supported action names are described below:

'magicTap' - Occurs when the user double taps the screen with two fingers. This action should be used to perform the most intended action for the node. This action is only available on the iOS platform.
'escape' - Occurs when the user performs a z-shaped gesture with two fingers. This action should be used to dismiss a modal or navigate back in a view stack. This action is only available on the iOS platform.
'activate' - Occurs when the user double taps with one finger. This action should be used to activate the view, it is the action which would occur when a user taps on the view when accessibility is not enabled.
'increment' - On iOS this occurs when the user swipes up. On Android this occurs when the user performs the assigned increment gesture. For this action to apply the adjustable role must be set on the node. This action may be used to scroll a list forward or increment the value of a scroll bar.
'decrement' - On iOS this occurs when the user swipes down. On Android this occurs when the user performs the assigned decrement gesture. For this action to apply the adjustable role must be set on the node. This action may be used to scroll a list backward or decrement the value of a scroll bar.
'longpress' - Occurs when the user double taps and holds on the screen. This action should be used to implement the same behaviour that occurs when a user long holds on a node when accessibility is not enabled. This action is only available on the Android platform and may only be used on later versions of Android, earlier versions send touch events as if accessibility was disabled to achieve the same effect.

#include <accessibility/YiAccessibilityAttributes.h>

Public Member Functions

 Action ()
 
 Action (CYIString name)
 
 Action (CYIString name, CYIString label)
 

Public Attributes

CYIString name
 
CYIString label
 

Constructor & Destructor Documentation

◆ Action() [1/3]

CYIAccessibilityAttributes::Action::Action ( )
inline

◆ Action() [2/3]

CYIAccessibilityAttributes::Action::Action ( CYIString  name)
inline

◆ Action() [3/3]

CYIAccessibilityAttributes::Action::Action ( CYIString  name,
CYIString  label 
)
inline

Member Data Documentation

◆ label

CYIString CYIAccessibilityAttributes::Action::label

◆ name

CYIString CYIAccessibilityAttributes::Action::name

The documentation for this struct was generated from the following file: