native_interface_accessibility.h
概述
声明用于第三方注册无障碍访问Native Accessibility的API。
库： libace_ndk.z.so
引用文件： <arkui/native_interface_accessibility.h>
起始版本： 13
相关模块：Native Accessibility
汇总
类型定义
| 名称 | 描述 |
|---|---|
| typedef struct ArkUI_AccessibilityElementInfo ArkUI_AccessibilityElementInfo | 无障碍节点信息，用于向无障碍服务、辅助应用（屏幕朗读）传递节点信息。 |
| typedef struct ArkUI_AccessibilityElementInfoList ArkUI_AccessibilityElementInfoList | 无障碍节点列表，包含需要的无障碍节点列表信息 。 |
| typedef struct ArkUI_AccessibilityEventInfo ArkUI_AccessibilityEventInfo | 无障碍事件信息，无障碍服务或辅助应用要求控件执行操作后，需要发送执行成功事件。控件自身交互诉求需要同步状态给无障碍服务或辅助应用时，也需要主动发送事件。 |
| typedef struct ArkUI_AccessibilityProvider ArkUI_AccessibilityProvider | 第三方操作provider，承载回调函数实现。 |
| typedef struct ArkUI_AccessibilityProviderCallbacks | 第三方操作provider回调函数结构定义，需要第三方平台实现的相关函数，通过OH_ArkUI_AccessibilityProviderRegisterCallback注册到系统侧。 |
| typedef struct ArkUI_AccessibilityProviderCallbacksWithInstance | 适配多实例场景第三方操作provider回调函数结构定义，需要第三方平台实现的相关函数，通过OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance注册到系统侧。 |
| typedef struct ArkUI_AccessibilityActionArguments ArkUI_AccessibilityActionArguments | 用于设置无障碍操作的具体参数。 |
| typedef struct ArkUI_AccessibleRect | 节点所在坐标位置。 |
| typedef struct ArkUI_AccessibleRangeInfo | 用于特定组件设置组件的当前值、最大值、最小值，如Slider、Rating、Progress组件。 |
| typedef struct ArkUI_AccessibleGridInfo | 用于特定组件设置组件的行数、列数以及选择模式，如list、flex、select、swiper组件。 |
| typedef struct ArkUI_AccessibleGridItemInfo | 用于特定组件设置组件的属性值，如list、flex、select、swiper组件。 |
| typedef struct ArkUI_AccessibleAction | 无障碍操作内容结构。 |
枚举
| 名称 | 描述 |
|---|---|
| ArkUI_AcessbilityErrorCode { 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_AccessibilitySearchMode { 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_AccessibilityFocusType { ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INVALID = -1, ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INPUT = 1 << 0, ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_ACCESSIBILITY = 1 << 1, }; |
焦点类型 |
| ArkUI_Accessibility_ActionType { 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_NATIVE_ACTION_TYPE_NEXT_HTML_ITEM = 0x02000000, ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_PREVIOUS_HTML_ITEM = 0x04000000, }; |
执行操作类型 |
| ArkUI_AccessibilityEventType { 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_AccessibilityFocusMoveDirection { 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, }; |
焦点移动方向。 |
函数
| 名称 | 描述 |
|---|---|
| int32_t OH_ArkUI_AccessibilityProviderRegisterCallback( ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacks* callbacks); |
第三方操作provider回调函数结构定义，需要第三方平台实现的相关函数，通过OH_ArkUI_AccessibilityProviderRegisterCallback注册到系统侧。 |
| int32_t OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance( const char* instanceId, ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacks* callbacks); |
无障碍多实例场景第三方平台注册回调函数。 |
| void OH_ArkUI_SendAccessibilityAsyncEvent( ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityEventInfo* eventInfo, void (*callback)(int32_t errorCode)); |
主动上报事件接口，通知无障碍服务。 |
| ArkUI_AccessibilityElementInfo* OH_ArkUI_CreateAccessibilityElementInfo(void); | 创建一个ArkUI_AccessibilityElementInfo对象，创建后需要调用OH_ArkUI_DestoryAccessibilityElementInfo释放。 |
| void OH_ArkUI_DestoryAccessibilityElementInfo(ArkUI_AccessibilityElementInfo* elementInfo); | 销毁一个ArkUI_AccessibilityElementInfo对象。 |
| ArkUI_AccessibilityElementInfo* OH_ArkUI_AddAndGetAccessibilityElementInfo(ArkUI_AccessibilityElementInfoList* list); | 在指定的list中增加element成员，并返回element结构。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetElementId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t elementId); | 为ArkUI_AccessibilityElementInfo设置componentId。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetParentId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t parentId); | 为ArkUI_AccessibilityElementInfo设置parentId。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetComponentType(ArkUI_AccessibilityElementInfo* elementInfo, const char* componentType); | 为ArkUI_AccessibilityElementInfo设置组件类型。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetContents(ArkUI_AccessibilityElementInfo* elementInfo, const char* contents); | 设为ArkUI_AccessibilityElementInfo设置组件文本内容。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetHintText(ArkUI_AccessibilityElementInfo* elementInfo, const char* hintText); | 为ArkUI_AccessibilityElementInfo设置提示文本。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityText(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityText); | 为ArkUI_AccessibilityElementInfo设置Accessibility文本。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityDescription(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityDescription); | 为ArkUI_AccessibilityElementInfo设置Accessibility描述信息。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetChildNodeIds(ArkUI_AccessibilityElementInfo* elementInfo, int32_t childCount, int64_t* childNodeIds); | 为ArkUI_AccessibilityElementInfo设置childCount和childNodeIds。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetOperationActions(ArkUI_AccessibilityElementInfo* elementInfo, int32_t operationCount, ArkUI_AccessibleAction* operationActions); | 为ArkUI_AccessibilityElementInfo设置operationActions。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetScreenRect(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRect* screenRect); | 为ArkUI_AccessibilityElementInfo设置屏幕区域。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetCheckable(ArkUI_AccessibilityElementInfo* elementInfo, bool checkable); | 为ArkUI_AccessibilityElementInfo设置是否可查。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetChecked(ArkUI_AccessibilityElementInfo* elementInfo, bool checked); | 为ArkUI_AccessibilityElementInfo设置是否被检查。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetFocusable(ArkUI_AccessibilityElementInfo* elementInfo, bool focusable); | 为ArkUI_AccessibilityElementInfo设置是否可聚焦。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool isFocused); | 为ArkUI_AccessibilityElementInfo设置是否聚焦。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetVisible(ArkUI_AccessibilityElementInfo* elementInfo, bool isVisible); | 为ArkUI_AccessibilityElementInfo设置是否可见。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityFocused); | 为ArkUI_AccessibilityElementInfo设置accessibilityFocused。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetSelected(ArkUI_AccessibilityElementInfo* elementInfo, bool selected); | 为ArkUI_AccessibilityElementInfo设置是否被选中。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool clickable); | 为ArkUI_AccessibilityElementInfo设置是否支持点击。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetLongClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool longClickable); | 为ArkUI_AccessibilityElementInfo设置是否支持长按。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetEnabled(ArkUI_AccessibilityElementInfo* elementInfo, bool isEnabled); | 为ArkUI_AccessibilityElementInfo设置是否启用。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetIsPassword(ArkUI_AccessibilityElementInfo* elementInfo, bool isPassword); | 为ArkUI_AccessibilityElementInfo设置是否为密码。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetScrollable(ArkUI_AccessibilityElementInfo* elementInfo, bool scrollable); | 为ArkUI_AccessibilityElementInfo设置是否支持滚动。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetEditable(ArkUI_AccessibilityElementInfo* elementInfo, bool editable); | 为ArkUI_AccessibilityElementInfo设置是否支持编辑。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetIsHint(ArkUI_AccessibilityElementInfo* elementInfo, bool isHint); | 为ArkUI_AccessibilityElementInfo设置isHint。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetRangeInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRangeInfo* rangeInfo); | 为ArkUI_AccessibilityElementInfo设置rangeInfo。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetGridInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridInfo* gridInfo); | 为ArkUI_AccessibilityElementInfo设置gridInfo。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetGridItemInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridItemInfo* gridItem); | 为ArkUI_AccessibilityElementInfo设置gridItem。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextStart); | 为ArkUI_AccessibilityElementInfo设置selectedTextStart。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextEnd); | 为ArkUI_AccessibilityElementInfo设置selectedTextEnd。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t currentItemIndex); | 为ArkUI_AccessibilityElementInfo设置currentItemIndex。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetStartItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t startItemIndex); | 为ArkUI_AccessibilityElementInfo设置startItemIndex。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetEndItemIndex( ArkUI_AccessibilityElementInfo* elementInfo, int32_t endItemIndex); |
为ArkUI_AccessibilityElementInfo设置endItemIndex。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetItemCount( ArkUI_AccessibilityElementInfo* elementInfo, int32_t itemCount); |
为ArkUI_AccessibilityElementInfo设置itemCount。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset( ArkUI_AccessibilityElementInfo* elementInfo, int32_t offset); |
为ArkUI_AccessibilityElementInfo设置offset。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup( ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityGroup); |
为ArkUI_AccessibilityElementInfo设置无障碍分组。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel( ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityLevel); |
为ArkUI_AccessibilityElementInfo设置无障碍重要性。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetZIndex( ArkUI_AccessibilityElementInfo* elementInfo, int32_t zIndex); |
为ArkUI_AccessibilityElementInfo设置zIndex。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity( ArkUI_AccessibilityElementInfo* elementInfo, float opacity); |
为ArkUI_AccessibilityElementInfo设置透明度。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundColor( ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundColor); |
为ArkUI_AccessibilityElementInfo设置背景色。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundImage( ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundImage); |
为ArkUI_AccessibilityElementInfo设置背景图。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetBlur( ArkUI_AccessibilityElementInfo* elementInfo, const char* blur); |
为ArkUI_AccessibilityElementInfo设置模糊度。 |
| int32_t OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior( ArkUI_AccessibilityElementInfo* elementInfo, const char* hitTestBehavior); |
为ArkUI_AccessibilityElementInfo设置hitTest模式。 |
| ArkUI_AccessibilityEventInfo* OH_ArkUI_CreateAccessibilityEventInfo(void); | 创建一个ArkUI_AccessibilityEventInfo对象，创建后需要调用OH_ArkUI_DestoryAccessibilityEventInfo释放。 |
| void OH_ArkUI_DestoryAccessibilityEventInfo(ArkUI_AccessibilityEventInfo* eventInfo); | 销毁ArkUI_AccessibilityEventInfo对象。 |
| int32_t OH_ArkUI_AccessibilityEventSetEventType( ArkUI_AccessibilityEventInfo* eventInfo, ArkUI_AccessibilityEventType eventType); |
为ArkUI_AccessibilityEventInfo设置事件类型。 |
| int32_t OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility( ArkUI_AccessibilityEventInfo* eventInfo, const char* textAnnouncedForAccessibility); |
为ArkUI_AccessibilityEventInfo设置textAnnouncedForAccessibility。 |
| int32_t OH_ArkUI_AccessibilityEventSetRequestFocusId( ArkUI_AccessibilityEventInfo* eventInfo, int32_t requestFocusId); |
为ArkUI_AccessibilityEventInfo设置requestFocusId。 |
| int32_t OH_ArkUI_AccessibilityEventSetElementInfo( ArkUI_AccessibilityEventInfo* eventInfo, ArkUI_AccessibilityElementInfo* elementInfo); |
为ArkUI_AccessibilityEventInfo设置elementInfo。 |
| int32_t OH_ArkUI_FindAccessibilityActionArgumentByKey( ArkUI_AccessibilityActionArguments* arguments, const char* key, char** value); |
获取ArkUI_AccessibilityActionArguments中指定key的value值。 |