harmony 鸿蒙native_interface_accessibility.h

2025-06-12
浏览 (4)

native_interface_accessibility.h

Overview

Declares APIs that enable third-party applications to access the native accessibility features.

Library: libace_ndk.z.so

File to include:

Since: 8

Related module: Native Accessibility

Summary

Structs

Name	Description
ArkUI_AccessibilityElementInfo	Provides accessibility node information, which is used to transfer node information to accessibility services and applications (such as screen readers).
ArkUI_AccessibilityElementInfoList	Defines an accessibility node list, which contains required accessibility node information.
ArkUI_AccessibilityEventInfo	Provides accessibility event information. After a component completes an action requested by an accessibility service or application, it needs to send a success event to confirm the operation. Similarly, if the component needs to synchronize its state change with the accessibility service or application due to its own interactive behavior, it should actively trigger an event to communicate the change.
ArkUI_AccessibilityProvider	Defines a third-party accessibility provider, which carries callback function implementations.
ArkUI_AccessibilityProviderCallbacks	Defines a struct for third-party accessibility provider callback functions, which third-party platforms need to implement. These functions are registered with the system side through OH_ArkUI_AccessibilityProviderRegisterCallback.
ArkUI_AccessibilityActionArguments	Provides additional information of the action to be executed.
ArkUI_AccessibleRect	Provides the coordinate position where the node is located.
ArkUI_AccessibleRangeInfo	Sets the current value, maximum value, and minimum value of the component attributes. Used by specific components, such as Slider, Rating, and Progress.
ArkUI_AccessibleGridInfo	Sets the number of rows, number of columns, and selection mode. Used by specific components, such as List, Flex, Select, and Swiper.
ArkUI_AccessibleGridItemInfo	Sets the component item attribute values. Used by specific components, such as List, Flex, Select, and Swiper.
ArkUI_AccessibleAction	Defines a struct for accessibility operation content.

Enums

Name	Description
{ ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL = 0, ARKUI_ACCESSIBILITY_NATIVE_RESULT_FAILED = -1, ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER = -2, ARKUI_ACCESSIBILITY_NATIVE_RESULT_OUT_OF_MEMORY = -3, } ArkUI_AcessbilityErrorCode;	Enumerates the error codes.
{ ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_CURRENT = 0, ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_PREDECESSORS = 1 << 0, ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_SIBLINGS = 1 << 1, ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_CHILDREN = 1 << 2, ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_RECURSIVE_CHILDREN = 1 << 3, } ArkUI_AccessibilitySearchMode;	Enumerates the search modes.
{ ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INVALID = -1, ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INPUT = 1 << 0, ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_ACCESSIBILITY = 1 << 1, } ArkUI_AccessibilityFocusType;	Enumerates the focus types.
{ ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_INVALID = 0, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CLICK = 0x00000010, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_LONG_CLICK = 0x00000020, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_GAIN_ACCESSIBILITY_FOCUS = 0x00000040, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CLEAR_ACCESSIBILITY_FOCUS = 0x00000080, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SCROLL_FORWARD = 0x00000100, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SCROLL_BACKWARD = 0x00000200, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_COPY = 0x00000400, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_PASTE = 0x00000800, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CUT = 0x00001000, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SELECT_TEXT = 0x00002000, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SET_TEXT = 0x00004000, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SET_CURSOR_POSITION = 0x00100000, } ArkUI_Accessibility_ActionType;	Enumerates the action types.
{ ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_INVALID = 0, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_CLICKED = 0x00000001, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_LONG_CLICKED = 0x00000002, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_SELECTED = 0x00000004, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_TEXT_UPDATE = 0x00000010, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_STATE_UPDATE = 0x00000020, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_CONTENT_UPDATE = 0x00000800, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_SCROLLED = 0x000001000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ACCESSIBILITY_FOCUSED = 0x00008000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ACCESSIBILITY_FOCUS_CLEARED = 0x00010000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_REQUEST_ACCESSIBILITY_FOCUS = 0x02000000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_OPEN = 0x20000000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_CLOSE = 0x08000000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ANNOUNCE_FOR_ACCESSIBILITY = 0x10000000, ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_FOCUS_NODE_UPDATE = 0x10000001, } ArkUI_AccessibilityEventType;	Enumerates the event types.
{ ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_INVALID = 0, ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_UP = 0x00000001, ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_DOWN = 0x00000002, ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_LEFT = 0x00000004, ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_RIGHT = 0x00000008, ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_FORWARD = 0x00000010, ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_BACKWARD = 0x00000020, } ArkUI_AccessibilityFocusMoveDirection;	Enumerates the focus movement directions.

Functions

Name	Description
int32_t OH_ArkUI_AccessibilityProviderRegisterCallback( ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacks* callbacks);	Registers callback functions.
void OH_ArkUI_SendAccessibilityAsyncEvent( ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityEventInfo* eventInfo, void (*callback)(int32_t errorCode));	Proactively sends an event to notify the accessibility service.
ArkUI_AccessibilityElementInfo* OH_ArkUI_CreateAccessibilityElementInfo(void);	Creates an ArkUI_AccessibilityElementInfo struct, which must be released by calling OH_ArkUI_DestoryAccessibilityElementInfo after use.
void OH_ArkUI_DestoryAccessibilityElementInfo(ArkUI_AccessibilityElementInfo* elementInfo);	Destroys an ArkUI_AccessibilityElementInfo struct.
ArkUI_AccessibilityElementInfo* OH_ArkUI_AddAndGetAccessibilityElementInfo(ArkUI_AccessibilityElementInfoList* list);	Adds an ArkUI_AccessibilityElementInfo member to the specified list and returns the ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetElementId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t elementId);	Sets the ID for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetParentId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t parentId);	Sets the parent ID for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetComponentType(ArkUI_AccessibilityElementInfo* elementInfo, const char* componentType);	Sets the component type for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetContents(ArkUI_AccessibilityElementInfo* elementInfo, const char* contents);	Sets the component content for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetHintText(ArkUI_AccessibilityElementInfo* elementInfo, const char* hintText);	Sets the hint text for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityText(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityText);	Sets the accessibility text for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityDescription(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityDescription);	Sets the accessibility description for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetChildNodeIds(ArkUI_AccessibilityElementInfo* elementInfo, int32_t childCount, int64_t* childNodeIds);	Sets the number of child nodes and child node IDs for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetOperationActions(ArkUI_AccessibilityElementInfo* elementInfo, int32_t operationCount, ArkUI_AccessibleAction* operationActions);	Sets the number of actions and the actions themselves for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetScreenRect(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRect* screenRect);	Sets the screen rectangle for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetCheckable(ArkUI_AccessibilityElementInfo* elementInfo, bool checkable);	Sets whether an ArkUI_AccessibilityElementInfo struct is checkable.
int32_t OH_ArkUI_AccessibilityElementInfoSetChecked(ArkUI_AccessibilityElementInfo* elementInfo, bool checked);	Sets whether an ArkUI_AccessibilityElementInfo struct is checked.
int32_t OH_ArkUI_AccessibilityElementInfoSetFocusable(ArkUI_AccessibilityElementInfo* elementInfo, bool focusable);	Sets whether an ArkUI_AccessibilityElementInfo struct is focusable.
int32_t OH_ArkUI_AccessibilityElementInfoSetFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool isFocused);	Sets whether an ArkUI_AccessibilityElementInfo struct is focused.
int32_t OH_ArkUI_AccessibilityElementInfoSetVisible(ArkUI_AccessibilityElementInfo* elementInfo, bool isVisible);	Sets whether an ArkUI_AccessibilityElementInfo struct is visible.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityFocused);	Sets whether an ArkUI_AccessibilityElementInfo struct is focused for accessibility purposes.
int32_t OH_ArkUI_AccessibilityElementInfoSetSelected(ArkUI_AccessibilityElementInfo* elementInfo, bool selected);	Sets whether an ArkUI_AccessibilityElementInfo struct is selected.
int32_t OH_ArkUI_AccessibilityElementInfoSetClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool clickable);	Sets whether an ArkUI_AccessibilityElementInfo struct is clickable.
int32_t OH_ArkUI_AccessibilityElementInfoSetLongClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool longClickable);	Sets whether an ArkUI_AccessibilityElementInfo struct is long-clickable.
int32_t OH_ArkUI_AccessibilityElementInfoSetEnabled(ArkUI_AccessibilityElementInfo* elementInfo, bool isEnabled);	Sets whether an ArkUI_AccessibilityElementInfo struct is enabled.
int32_t OH_ArkUI_AccessibilityElementInfoSetIsPassword(ArkUI_AccessibilityElementInfo* elementInfo, bool isPassword);	Sets whether an ArkUI_AccessibilityElementInfo struct is a password.
int32_t OH_ArkUI_AccessibilityElementInfoSetScrollable(ArkUI_AccessibilityElementInfo* elementInfo, bool scrollable);	Sets whether an ArkUI_AccessibilityElementInfo struct is scrollable.
int32_t OH_ArkUI_AccessibilityElementInfoSetEditable(ArkUI_AccessibilityElementInfo* elementInfo, bool editable);	Sets whether an ArkUI_AccessibilityElementInfo struct is editable.
int32_t OH_ArkUI_AccessibilityElementInfoSetIsHint(ArkUI_AccessibilityElementInfo* elementInfo, bool isHint);	Sets whether an ArkUI_AccessibilityElementInfo struct is a hint.
int32_t OH_ArkUI_AccessibilityElementInfoSetRangeInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRangeInfo* rangeInfo);	Sets the range information for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetGridInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridInfo* gridInfo);	Sets the grid information for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetGridItemInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridItemInfo* gridItem);	Sets the grid item information for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd(ArkUI_AccessibilityElementInfo* elementInfo, int32_t textEndSelected);	Sets the end position of the selected text for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t currentItemIndex);	Sets the index of the currently focused item for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetStartItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t startItemIndex);	Sets the index of the first item displayed on the screen for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetEndItemIndex( ArkUI_AccessibilityElementInfo* elementInfo, int32_t endItemIndex);	Sets the index of the last item displayed on the screen for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetItemCount( ArkUI_AccessibilityElementInfo* elementInfo, int32_t itemCount);	Sets the total number of items for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset( ArkUI_AccessibilityElementInfo* elementInfo, int32_t offset);	Sets the offset for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup( ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityGroup);	Sets the accessibility group for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel( ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityLevel);	Sets the accessibility level for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetZIndex( ArkUI_AccessibilityElementInfo* elementInfo, int32_t zIndex);	Sets the z-index for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity( ArkUI_AccessibilityElementInfo* elementInfo, float opacity);	Sets the opacity for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundColor( ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundColor);	Sets the background color for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundImage( ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundImage);	Sets the background image for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetBlur( ArkUI_AccessibilityElementInfo* elementInfo, const char* blur);	Sets the blur effect for an ArkUI_AccessibilityElementInfo struct.
int32_t OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior( ArkUI_AccessibilityElementInfo* elementInfo, const char* hitTestBehavior);	Sets the hit test mode for an ArkUI_AccessibilityElementInfo struct.
ArkUI_AccessibilityEventInfo* OH_ArkUI_CreateAccessibilityEventInfo(void);	Creates an ArkUI_AccessibilityEventInfo struct, which must be released by calling OH_ArkUI_DestoryAccessibilityEventInfo after use.
void OH_ArkUI_DestoryAccessibilityEventInfo(ArkUI_AccessibilityEventInfo* eventInfo);	Destroys an ArkUI_AccessibilityEventInfo struct.
int32_t OH_ArkUI_AccessibilityEventSetEventType( ArkUI_AccessibilityEventInfo* eventInfo, ArkUI_AccessibilityEventType eventType);	Sets the event type for an ArkUI_AccessibilityEventInfo struct.
int32_t OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility( ArkUI_AccessibilityEventInfo* eventInfo, const char* textAnnouncedForAccessibility);	Sets the text to be announced for accessibility in an ArkUI_AccessibilityEventInfo struct.
int32_t OH_ArkUI_AccessibilityEventSetRequestFocusId( ArkUI_AccessibilityEventInfo* eventInfo, int32_t requestFocusId);	Sets the ID of the node to focus on in an ArkUI_AccessibilityEventInfo struct.
int32_t OH_ArkUI_AccessibilityEventSetElementInfo( ArkUI_AccessibilityEventInfo* eventInfo, ArkUI_AccessibilityElementInfo* elementInfo);	Sets the component information in an ArkUI_AccessibilityEventInfo struct.
int32_t OH_ArkUI_FindAccessibilityActionArgumentByKey( ArkUI_AccessibilityActionArguments* arguments, const char* key, char** value);	Obtains the value associated with a specified key in an ArkUI_AccessibilityEventInfo struct.