• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Native Accessibility
2
3## 概述
4
5描述三方平台通过XComponent接入ArkUI无障碍框架的接口说明。更多详细介绍请参考[通过XComponent接入无障碍](../../ui/ndk-accessibility-xcomponent.md)。
6
7描述了三方平台需要实现的接口以及相关的结构、枚举定义说明。
8
9> **说明:**
10>
11> 该模块从API Version13 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
12
13## 汇总
14
15
16### 文件
17
18| 名称                                                         | 描述                                                         |
19| ------------------------------------------------------------ | ------------------------------------------------------------ |
20| [native_interface_accessibility.h](native__interface__accessibility_8h.md) | 声明用于访问Native Accessibility的API。 |
21
22### 类型定义
23
24| 名称                                                         | 描述                                                         |
25| ------------------------------------------------------------ | ------------------------------------------------------------ |
26| [ArkUI_AccessibilityElementInfo](#arkui_accessibilityelementinfo) | 无障碍节点信息,用于向无障碍服务、辅助应用传递节点信息。     |
27| [ArkUI_AccessibilityElementInfoList](#arkui_accessibilityelementinfolist) | 无障碍节点列表,包含需要的无障碍节点列表信息 。              |
28| [ArkUI_AccessibilityEventInfo](#arkui_accessibilityeventinfo) | 无障碍事件信息,无障碍服务或辅助应用要求组件执行操作后,需要发送执行成功事件。组件自身交互诉求需要同步状态给无障碍服务或辅助应用时,也需要主动发送事件。 |
29| [ArkUI_AccessibilityProvider](#arkui_accessibilityprovider)  | 三方操作provider,承载回调函数实现。                         |
30| [ArkUI_AccessibilityProviderCallbacks](#arkui_accessibilityprovidercallbacks) | 三方操作provider回调函数结构定义,需要三方平台实现的相关函数,通过OH_ArkUI_AccessibilityProviderRegisterCallback注册到系统侧。 |
31| [ArkUI_AccessibilityActionArguments](#arkui_accessibilityactionarguments) | Action附加字段,对需要执行的Action进行处理的说明。           |
32| [ArkUI_AccessibleRect](#arkui_accessiblerect)                | 节点所在坐标位置。                                           |
33| [ArkUI_AccessibleRangeInfo](#arkui_accessiblerangeinfo)      | 特定组件需要使用,如Slider、Rating、Progress组件。设置组件属性中的当前值以及最大值、最小值。 |
34| [ArkUI_AccessibleGridInfo](#arkui_accessiblegridinfo)        | 特定组件需要使用,如list、flex、select、swiper组件。设置组件,”行数“,”列数“,以及选择模式。 |
35| [ArkUI_AccessibleGridItemInfo](#arkui_accessiblegriditeminfo) | 特定组件需要使用,如list、flex、select、swiper组件。设置组件item的属性值。 |
36| [ArkUI_AccessibleAction](#arkui_accessibleaction)            | 无障碍操作内容结构。                                         |
37
38### 枚举
39
40| 名称                                                         | 描述           |
41| ------------------------------------------------------------ | -------------- |
42| [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)    | 错误码。       |
43| [ArkUI_AccessibilitySearchMode](#arkui_accessibilitysearchmode) | 查询模式。     |
44| [ArkUI_AccessibilityFocusType](#arkui_accessibilityfocustype) | 焦点类型。     |
45| [ArkUI_Accessibility_ActionType](#arkui_accessibility_actiontype) | 操作类型。     |
46| [ArkUI_AccessibilityEventType](#arkui_accessibilityeventtype) | 事件类型。     |
47| [ArkUI_AccessibilityFocusMoveDirection](#arkui_accessibilityfocusmovedirection) | 焦点移动方向。 |
48
49## 类型定义说明
50
51### ArkUI_AccessibilityElementInfo
52
53```
54typedef struct ArkUI_AccessibilityElementInfo ArkUI_AccessibilityElementInfo
55```
56
57**描述:**
58
59无障碍节点信息,用于向无障碍服务、辅助应用传递节点信息。
60
61**起始版本:**
62
6313
64
65### ArkUI_AccessibilityElementInfoList
66
67```
68typedef struct ArkUI_AccessibilityElementInfoList ArkUI_AccessibilityElementInfoList
69```
70
71**描述:**
72
73无障碍节点列表,包含需要的无障碍节点列表信息。
74
75**起始版本:**
76
7713
78
79### ArkUI_AccessibilityEventInfo
80
81```
82typedef struct ArkUI_AccessibilityEventInfo ArkUI_AccessibilityEventInfo
83```
84
85**描述:**
86
87无障碍事件信息,无障碍服务或辅助应用要求组件执行操作后,需要发送执行成功事件。组件自身交互诉求需要同步状态给无障碍服务或辅助应用时,也需要主动发送事件。
88
89**起始版本:**
90
9113
92
93### ArkUI_AccessibilityProvider
94
95```
96typedef struct ArkUI_AccessibilityProvider ArkUI_AccessibilityProvider
97```
98
99**描述:**
100
101三方操作provider,承载回调函数实现。
102
103**起始版本:**
104
10513
106
107### ArkUI_AccessibilityProviderCallbacks
108
109```C
110typedef struct ArkUI_AccessibilityProviderCallbacks {
111    int32_t (*findAccessibilityNodeInfosById)(int64_t elementId, ArkUI_AccessibilitySearchMode mode, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
112    int32_t (*findAccessibilityNodeInfosByText)(int64_t elementId, const char* text, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
113    int32_t (*findFocusedAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusType focusType, int32_t requestId, ArkUI_AccessibilityElementInfo* elementinfo);
114    int32_t (*findNextFocusAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction, int32_t requestId, ArkUI_AccessibilityElementInfo* elementList);
115    int32_t (*executeAccessibilityAction)(int64_t elementId, ArkUI_Accessibility_ActionType action, ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId);
116    int32_t (*clearFocusedFocusAccessibilityNode)();
117    int32_t (*getAccessibilityNodeCursorPosition)(int64_t elementId, int32_t requestId, int32_t* index);
118} ArkUI_AccessibilityProviderCallbacks;
119```
120
121**描述:**
122
123三方操作provider回调函数结构定义,需要三方平台实现的相关函数,通过OH_ArkUI_AccessibilityProviderRegisterCallback注册到系统侧。
124
125| 回调函数                                                     | 函数功能                             |
126| ------------------------------------------------------------ | ------------------------------------ |
127| [findAccessibilityNodeInfosById](#findaccessibilitynodeinfosbyid) | 基于指定的节点,查询所需的节点信息。 |
128| [findAccessibilityNodeInfosByText](#findaccessibilitynodeinfosbytext) | 查询满足指定text内容的节点信息。     |
129| [findFocusedAccessibilityNode](#findfocusedaccessibilitynode) | 从指定节点查找已经聚焦的节点。       |
130| [findNextFocusAccessibilityNode](#findnextfocusaccessibilitynode) | 从指定节点查询指定方向的节点。       |
131| [executeAccessibilityAction](#executeaccessibilityaction)    | 对指定节点执行指定的操作(Action)。 |
132| [clearFocusedFocusAccessibilityNode](#clearfocusedfocusaccessibilitynode) | 清除当前获焦的节点。                 |
133| [getAccessibilityNodeCursorPosition](#getaccessibilitynodecursorposition) | 获取当前组件中(文本组件)光标位置。 |
134
135**起始版本:**
136
13713
138
139### ArkUI_AccessibilityProviderCallbacksWithInstance
140
141```C
142typedef struct ArkUI_AccessibilityProviderCallbacksWithInstance {
143    int32_t (*findAccessibilityNodeInfosById)(const char* instanceId, int64_t elementId, ArkUI_AccessibilitySearchMode mode, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
144    int32_t (*findAccessibilityNodeInfosByText)(const char* instanceId, int64_t elementId, const char* text, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
145    int32_t (*findFocusedAccessibilityNode)(const char* instanceId, int64_t elementId, ArkUI_AccessibilityFocusType focusType, int32_t requestId, ArkUI_AccessibilityElementInfo* elementinfo);
146    int32_t (*findNextFocusAccessibilityNode)(const char* instanceId, int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction, int32_t requestId, ArkUI_AccessibilityElementInfo* elementList);
147    int32_t (*executeAccessibilityAction)(const char* instanceId, int64_t elementId, ArkUI_Accessibility_ActionType action, ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId);
148    int32_t (*clearFocusedFocusAccessibilityNode)(const char* instanceId);
149    int32_t (*getAccessibilityNodeCursorPosition)(const char* instanceId, int64_t elementId, int32_t requestId, int32_t* index);
150} ArkUI_AccessibilityProviderCallbacksWithInstance;
151```
152
153**描述:**
154
155适配多实例场景三方操作provider回调函数结构定义,需要三方平台实现的相关函数,通过OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance注册到系统侧。
156
157| 回调函数                                                     | 函数功能                             |
158| ------------------------------------------------------------ | ------------------------------------ |
159| [findAccessibilityNodeInfosById](#findaccessibilitynodeinfosbyid-1) | 由接入方平台实现的回调函数,注册给系统侧调用。基于指定的节点,查询所需的节点信息。支持多实例场景。 |
160| [findAccessibilityNodeInfosByText](#findaccessibilitynodeinfosbytext-1) | 由接入方平台实现的回调函数,注册给系统侧调用。基于指定的节点,查询满足指定组件文本内容的节点信息。支持多实例场景。 |
161| [findFocusedAccessibilityNode](#findfocusedaccessibilitynode-1) | 由接入方平台实现的回调函数,注册给系统侧调用。从指定节点查找已经聚焦的节点。支持多实例场景。  |
162| [findNextFocusAccessibilityNode](#findnextfocusaccessibilitynode-1) | 由接入方平台实现的回调函数,注册给系统侧调用。从指定节点查询指定方向的节点。支持多实例场景。  |
163| [executeAccessibilityAction](#executeaccessibilityaction-1)    | 由接入方平台实现的回调函数,注册给系统侧调用。对指定节点执行指定的操作。支持多实例场景。  |
164| [clearFocusedFocusAccessibilityNode](#clearfocusedfocusaccessibilitynode-1) | 由接入方平台实现的回调函数,注册给系统侧调用。 清除当前获焦的节点。支持多实例场景。  |
165| [getAccessibilityNodeCursorPosition](#getaccessibilitynodecursorposition-1) | 由接入方平台实现的回调函数,注册给系统侧调用。获取当前组件中(文本组件)光标位置。支持多实例场景。 |
166
167**起始版本:**
168
16915
170
171### ArkUI_AccessibilityActionArguments
172
173**描述:**
174
175Action附加字段,对需要执行的Action进行处理说明。
176
177**起始版本:**
178
17913
180
181
182
183### ArkUI_AccessibleRect
184
185**描述:**
186
187节点所在坐标位置。
188
189**参数:**
190
191| 名称         | 类型  | 描述                |
192| ------------ | ----- | ------------------- |
193| leftTopX     | int32 | 左上角X轴坐标位置。 |
194| leftTopY     | int32 | 左上角Y轴坐标位置。 |
195| rightBottomX | int32 | 右下角X轴坐标位置。 |
196| rightBottomY | int32 | 右下角Y轴坐标位置。 |
197
198**起始版本:**
199
20013
201
202
203
204### ArkUI_AccessibleRangeInfo
205
206**描述:**
207
208特定组件需要使用,如Slider、Rating、Progress组件。设置组件属性中的当前值以及最大值、最小值。
209
210**参数:**
211
212| 名称    | 类型   | 描述     |
213| ------- | ------ | -------- |
214| min     | double | 最小值。 |
215| max     | double | 最大值。 |
216| current | double | 当前值。 |
217
218**起始版本:**
219
22013
221
222
223
224### ArkUI_AccessibleGridInfo
225
226**描述:**
227
228特定组件需要使用,如list、flex、select、swiper组件。设置组件,”行数“,”列数“,以及选择模式。
229
230**参数:**
231
232| 名称          | 类型  | 描述       |
233| ------------- | ----- | ---------- |
234| rowCount      | int32 | 列数。     |
235| columnCount   | int32 | 行数。     |
236| selectionMode | int32 | 选择模式。 |
237
238**起始版本:**
239
24013
241
242
243
244### ArkUI_AccessibleGridItemInfo
245
246**描述:**
247
248特定组件需要使用,如list、flex、select、swiper组件。设置组件item的属性值。
249
250**参数:**
251
252| 名称        | 类型  | 描述         |
253| ----------- | ----- | ------------ |
254| heading     | bool  | 是否是标题。 |
255| selected    | bool  | 是否被选中。 |
256| columnIndex | int32 | 行下标。     |
257| rowIndex    | int32 | 列下标。     |
258| columnSpan  | int32 | 行跨度。     |
259| rowSpan     | int32 | 列跨度。     |
260
261**起始版本:**
262
26313
264
265### ArkUI_AccessibleAction
266
267**描述:**
268
269无障碍操作事件结构。
270
271**参数:**
272
273| 名称        | 类型                                                         | 描述             |
274| ----------- | ------------------------------------------------------------ | ---------------- |
275| actionType  | [ArkUI_Accessibility_ActionType](#arkui_accessibility_actiontype) | 无障碍操作类型。 |
276| description | char*                                                        | 描述信息。       |
277
278**起始版本:**
279
28013
281
282## 函数说明
283
284### findAccessibilityNodeInfosById
285
286```C
287int32_t (*findAccessibilityNodeInfosById)(int64_t elementId, ArkUI_AccessibilitySearchMode mode, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
288```
289
290**描述:**
291
292由接入方平台实现的回调函数,注册给系统侧调用。基于指定的节点,查询所需的节点信息。
293
294**起始版本:** 13
295
296**参数:**
297
298| 名称        | 描述                                                         |
299| ----------- | ------------------------------------------------------------ |
300| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
301| mode        | 查询模式,支持如下查询类型:[ArkUI_AccessibilitySearchMode](#arkui_accessibilitysearchmode)。 |
302| requestId   | 请求id,用于关联请求过程,方便问题定位。三方输出日志关键日志时,建议一起输出。 |
303| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
304
305**返回:**
306
307 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
308
309### findAccessibilityNodeInfosByText
310
311```C
312int32_t (*findAccessibilityNodeInfosByText)(int64_t elementId, const char* text, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
313```
314
315**描述:**
316
317由接入方平台实现的回调函数,注册给系统侧调用。基于指定的节点,查询满足指定text内容的节点信息。
318
319**起始版本:** 13
320
321**参数:**
322
323| 名称        | 描述                                                         |
324| ----------- | ------------------------------------------------------------ |
325| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
326| text        | 指定文本,匹配节点中无障碍属性的文本内容。                   |
327| requestId   | 请求id,用于关联请求过程,方便问题定位。三方输出日志关键日志时,建议一起输出。 |
328| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
329
330**返回:**
331
332 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
333
334### findFocusedAccessibilityNode
335
336```C
337int32_t (*findFocusedAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusType focusType, int32_t requestId, ArkUI_AccessibilityElementInfo* elementinfo);
338```
339
340**描述:**
341
342由接入方平台实现的回调函数,注册给系统侧调用。从指定节点查找已经聚焦的节点。
343
344**起始版本:** 13
345
346**参数:**
347
348| 名称        | 描述                                                         |
349| ----------- | ------------------------------------------------------------ |
350| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
351| focusType   | 无障碍焦点类型[ArkUI_AccessibilityFocusType](#arkui_accessibilityfocustype)。 |
352| requestId   | 请求id,用于关联请求过程,方便问题定位。三方输出日志关键日志时,建议一起输出。 |
353| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
354
355**返回:**
356
357 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
358
359
360
361### findNextFocusAccessibilityNode
362
363```C
364int32_t (*findNextFocusAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction, int32_t requestId, ArkUI_AccessibilityElementInfo* elementList);
365```
366
367**描述:**
368
369由接入方平台实现的回调函数,注册给系统侧调用。从指定节点查询指定方向的节点。
370
371**起始版本:** 13
372
373**参数:**
374
375| 名称        | 描述                                                         |
376| ----------- | ------------------------------------------------------------ |
377| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
378| focusType   | 无障碍焦点类型ArkUI_AccessibilityFocusType](#arkui_accessibilityfocustype)。 |
379| requestId   | 请求id,用于关联请求过程,方便问题定位。三方输出日志关键日志时,建议一起输出。 |
380| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
381
382**返回:**
383
384 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
385
386### executeAccessibilityAction
387
388```C
389int32_t (*executeAccessibilityAction)(int64_t elementId, ArkUI_Accessibility_ActionType action, ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId);
390```
391
392**描述:**
393
394由接入方平台实现的回调函数,注册给系统侧调用。对指定节点执行指定的操作([ArkUI_Accessibility_ActionType](#arkui_accessibility_actiontype))。
395
396**起始版本:** 13
397
398**参数:**
399
400| 名称            | 描述                                                         |
401| --------------- | ------------------------------------------------------------ |
402| elementId       | 指定节点的id。                                               |
403| action          | 执行操作类型[ArkUI_Accessibility_ActionType](#arkui_accessibility_actiontype)。 |
404| requestId       | 请求id,用于关联请求过程,方便问题定位。三方输出日志关键日志时,建议一起输出。 |
405| actionArguments | Action辅助配置信息。                                         |
406
407**返回:**
408
409 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
410
411### clearFocusedFocusAccessibilityNode
412
413```C
414int32_t (*clearFocusedFocusAccessibilityNode)();
415```
416
417**描述:**
418
419由接入方平台实现的回调函数,注册给系统侧调用。 清除当前获焦的节点。
420
421**起始版本:** 13
422
423**参数:**  无
424
425**返回:**
426
427 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
428
429### getAccessibilityNodeCursorPosition
430
431```C
432int32_t (*getAccessibilityNodeCursorPosition)(int64_t elementId, int32_t requestId, int32_t* index);
433```
434
435**描述:**
436
437由接入方平台实现的回调函数,注册给系统侧调用。获取当前组件中(文本组件)光标位置。
438
439**起始版本:** 13
440
441**参数:**
442
443| 名称      | 描述                                                         |
444| --------- | ------------------------------------------------------------ |
445| elementId | 指定节点的id。                                               |
446| requestId | 请求id,用于关联请求过程,方便问题定位。三方输出日志关键日志时,建议一起输出。 |
447| index     | 返回光标位置结果。                                           |
448
449**返回:**
450
451 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
452
453### findAccessibilityNodeInfosById
454
455```C
456int32_t (*findAccessibilityNodeInfosById)(const char* instanceId, int64_t elementId, ArkUI_AccessibilitySearchMode mode, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
457```
458
459**描述:**
460
461由接入方平台实现的回调函数,注册给系统侧调用。基于指定的节点,查询所需的节点信息。支持多实例场景。
462
463**起始版本:** 15
464
465**参数:**
466
467| 名称        | 描述                                                         |
468| ----------- | ------------------------------------------------------------ |
469| instanceId  | 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
470| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
471| mode        | 查询模式,支持如下查询类型:[ArkUI_AccessibilitySearchMode](#arkui_accessibilitysearchmode)。 |
472| requestId   | 请求id,用于关联请求过程,方便问题定位。建议日志打印时附带输出该信息,方便定位。 |
473| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
474
475**返回:**
476
477[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
478
479### findAccessibilityNodeInfosByText
480
481```C
482int32_t (*findAccessibilityNodeInfosByText)(const char* instanceId, int64_t elementId, const char* text, int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList);
483```
484
485**描述:**
486
487由接入方平台实现的回调函数,注册给系统侧调用。基于指定的节点,查询满足指定组件文本内容的节点信息。支持多实例场景。
488
489**起始版本:** 15
490
491**参数:**
492
493| 名称        | 描述                                                         |
494| ----------- | ------------------------------------------------------------ |
495| instanceId  | 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
496| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
497| text        | 指定文本,匹配节点中无障碍属性的文本内容。                   |
498| requestId   | 请求id,用于关联请求过程,方便问题定位。建议日志打印时附带输出该信息,方便定位。 |
499| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
500
501**返回:**
502
503[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
504
505### findFocusedAccessibilityNode
506
507```C
508int32_t (*findFocusedAccessibilityNode)(const char* instanceId, int64_t elementId, ArkUI_AccessibilityFocusType focusType, int32_t requestId, ArkUI_AccessibilityElementInfo* elementinfo);
509```
510
511**描述:**
512
513由接入方平台实现的回调函数,注册给系统侧调用。从指定节点查找已经聚焦的节点。支持多实例场景。
514
515**起始版本:** 15
516
517**参数:**
518
519| 名称        | 描述                                                         |
520| ----------- | ------------------------------------------------------------ |
521| instanceId  | 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
522| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
523| focusType   | 无障碍焦点类型[ArkUI_AccessibilityFocusType](#arkui_accessibilityfocustype)。 |
524| requestId   | 请求id,用于关联请求过程,方便问题定位。建议日志打印时附带输出该信息,方便定位。 |
525| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
526
527**返回:**
528
529[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
530
531
532
533### findNextFocusAccessibilityNode
534
535```C
536int32_t (*findNextFocusAccessibilityNode)(const char* instanceId, int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction, int32_t requestId, ArkUI_AccessibilityElementInfo* elementList);
537```
538
539**描述:**
540
541由接入方平台实现的回调函数,注册给系统侧调用。从指定节点查询指定方向的节点。支持多实例场景。
542
543**起始版本:** 15
544
545**参数:**
546
547| 名称        | 描述                                                         |
548| ----------- | ------------------------------------------------------------ |
549| instanceId  | 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
550| elementId   | 指定节点的id,从该节点出发进行搜索查询。当指定为-1时,代表从组件树的根节点进行查询。 |
551| focusType   | 无障碍焦点类型[ArkUI_AccessibilityFocusType](#arkui_accessibilityfocustype)。 |
552| requestId   | 请求id,用于关联请求过程,方便问题定位。建议日志打印时附带输出该信息,方便定位。 |
553| elementList | 查询结果,接入方根据查收调节将结果返回。                     |
554
555**返回:**
556
557[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
558
559### executeAccessibilityAction
560
561```C
562int32_t (*executeAccessibilityAction)(const char* instanceId, int64_t elementId, ArkUI_Accessibility_ActionType action, ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId);
563```
564
565**描述:**
566
567由接入方平台实现的回调函数,注册给系统侧调用。对指定节点执行指定的操作([ArkUI_Accessibility_ActionType](#arkui_accessibility_actiontype))。支持多实例场景。
568
569**起始版本:** 15
570
571**参数:**
572
573| 名称            | 描述                                                         |
574| --------------- | ------------------------------------------------------------ |
575| instanceId      | 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
576| elementId       | 指定节点的id。                                               |
577| action          | 执行操作类型[ArkUI_Accessibility_ActionType](#arkui_accessibility_actiontype)。 |
578| requestId       | 请求id,用于关联请求过程,方便问题定位。建议日志打印时附带输出该信息,方便定位。 |
579| actionArguments | Action辅助配置信息。                                         |
580
581**返回:**
582
583[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
584
585### clearFocusedFocusAccessibilityNode
586
587```C
588int32_t (*clearFocusedFocusAccessibilityNode)(const char* instanceId);
589```
590
591**描述:**
592
593由接入方平台实现的回调函数,注册给系统侧调用。 清除当前获焦的节点。支持多实例场景。
594
595**起始版本:** 15
596
597**参数:**
598
599| 名称            | 描述                                                         |
600| --------------- | ------------------------------------------------------------ |
601| instanceId | 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
602
603**返回:**
604
605[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
606
607### getAccessibilityNodeCursorPosition
608
609```C
610int32_t (*getAccessibilityNodeCursorPosition)(const char* instanceId, int64_t elementId, int32_t requestId, int32_t* index);
611```
612
613**描述:**
614
615由接入方平台实现的回调函数,注册给系统侧调用。获取当前组件中(文本组件)光标位置。支持多实例场景。
616
617**起始版本:** 15
618
619**参数:**
620
621| 名称      | 描述                                                         |
622| --------- | ------------------------------------------------------------ |
623| instanceId| 指定当前接入的第三方实例的id,id与接入方调用方法[OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance](#oh_arkui_accessibilityproviderregistercallbackwithinstance)传入的instanceId一致。 |
624| elementId | 指定节点的id。                                               |
625| requestId | 请求id,用于关联请求过程,方便问题定位。建议日志打印时附带输出该信息,方便定位。 |
626| index     | 返回光标位置结果。                                           |
627
628**返回:**
629
630[ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
631
632
633
634### OH_ArkUI_AccessibilityProviderRegisterCallback
635
636```C
637int32_t OH_ArkUI_AccessibilityProviderRegisterCallback(
638    ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacks* callbacks);
639```
640
641**描述:**
642
643注册回调函数。
644
645**起始版本:** 13
646
647**参数:**
648
649| 名称      | 描述                       |
650| --------- | -------------------------- |
651| provider  | 三方平台接入provider句柄。 |
652| callbacks | 回调函数实现。             |
653
654**返回:**
655
656 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
657
658
659### OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance
660
661```C
662int32_t OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance(const char* instanceId,
663    ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityProviderCallbacksWithInstance* callbacks);
664```
665
666**描述:**
667
668多实例场景第三方平台注册回调函数。
669
670**起始版本:** 15
671
672**参数:**
673
674| 名称      | 描述                       |
675| --------- | -------------------------- |
676| instanceId| 三方平台接入的实例ID,用于区分多实例场景中不同的第三方实例,ID由三方平台指定与维护。 |
677| provider  | 三方平台接入provider句柄。 |
678| callbacks | 回调函数实现。             |
679
680**返回:**
681
682 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
683
684
685
686### OH_ArkUI_SendAccessibilityAsyncEvent
687
688```C
689void OH_ArkUI_SendAccessibilityAsyncEvent(
690    ArkUI_AccessibilityProvider* provider, ArkUI_AccessibilityEventInfo* eventInfo, void (*callback)(int32_t errorCode));
691```
692
693**描述:**
694
695主动上报事件接口,通知无障碍服务。
696
697**起始版本:** 13
698
699**参数:**
700
701| 名称      | 描述                       |
702| --------- | -------------------------- |
703| provider  | 三方平台接入provider句柄。 |
704| eventInfo | 上报事件。                 |
705| callback  | 结果返回回调。             |
706
707**返回:** 无
708
709
710
711### OH_ArkUI_CreateAccessibilityElementInfo
712
713```C
714ArkUI_AccessibilityElementInfo* OH_ArkUI_CreateAccessibilityElementInfo(void);
715```
716
717**描述:**
718
719创建elementInfo结构,创建后需要调用[OH_ArkUI_DestoryAccessibilityElementInfo](#oh_arkui_destoryaccessibilityelementinfo)释放。
720
721**起始版本:** 13
722
723**返回:**
724
725返回创建完成的ArkUI_AccessibilityElementInfo结构指针,如果创建失败返回NULL。
726
727### OH_ArkUI_DestoryAccessibilityElementInfo
728
729```C
730void OH_ArkUI_DestoryAccessibilityElementInfo(ArkUI_AccessibilityElementInfo* elementInfo);
731```
732
733**描述:**
734
735销毁elementInfo。
736
737**起始版本:** 13
738
739**参数:**
740
741| 名称        | 描述                            |
742| ----------- | ------------------------------- |
743| elementInfo | 需要删除释放的Element结构指针。 |
744
745**返回:** 无
746
747
748
749### OH_ArkUI_AddAndGetAccessibilityElementInfo
750
751```C
752ArkUI_AccessibilityElementInfo* OH_ArkUI_AddAndGetAccessibilityElementInfo(ArkUI_AccessibilityElementInfoList* list);
753```
754
755**描述:**
756
757在指定的list中增加Element成员,并返回Element结构。
758
759**起始版本:** 13
760
761**参数:**
762
763| 名称 | 描述                                                         |
764| ---- | ------------------------------------------------------------ |
765| list | 指定的ArkUI_AccessibilityElementInfoList结构,新创建的ElementInfo成员加入该list后返回给函数调用方。 |
766
767**返回:**
768
769返回创建完成的ArkUI_AccessibilityElementInfo结构指针,如果创建失败返回NULL。
770
771
772
773### OH_ArkUI_AccessibilityElementInfoSetElementId
774
775```C
776int32_t OH_ArkUI_AccessibilityElementInfoSetElementId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t elementId);
777```
778
779**描述:**
780
781设置Element的ElementId。
782
783**起始版本:** 13
784
785**参数:**
786
787| 名称        | 描述          |
788| ----------- | ------------- |
789| elementInfo | Element结构。 |
790| elementId   | 元素组件id。  |
791
792**返回:**
793
794 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
795
796
797
798### OH_ArkUI_AccessibilityElementInfoSetParentId
799
800```C
801int32_t OH_ArkUI_AccessibilityElementInfoSetParentId(ArkUI_AccessibilityElementInfo* elementInfo, int32_t parentId);
802```
803
804**描述:**
805
806设置Element的parentId。
807
808**起始版本:** 13
809
810**参数:**
811
812| 名称        | 描述           |
813| ----------- | -------------- |
814| elementInfo | Element结构。  |
815| parentId    | 元素父组件id。 |
816
817**返回:**
818
819 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
820
821
822
823### OH_ArkUI_AccessibilityElementInfoSetComponentType
824
825```C
826int32_t OH_ArkUI_AccessibilityElementInfoSetComponentType(ArkUI_AccessibilityElementInfo* elementInfo, const char* componentType);
827```
828
829**描述:**
830
831设置Element的componentType。
832
833**起始版本:** 13
834
835**参数:**
836
837| 名称          | 描述           |
838| ------------- | -------------- |
839| elementInfo   | Element结构。  |
840| componentType | 元素组件类型。 |
841
842**返回:**
843
844 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
845
846
847
848### OH_ArkUI_AccessibilityElementInfoSetContents
849
850```c
851int32_t OH_ArkUI_AccessibilityElementInfoSetContents(ArkUI_AccessibilityElementInfo* elementInfo, const char* contents);
852```
853
854**描述:**
855
856设置Element的contents。
857
858**起始版本:** 13
859
860**参数:**
861
862| 名称        | 描述           |
863| ----------- | -------------- |
864| elementInfo | Element结构。  |
865| contents    | 元素组件内容。 |
866
867**返回:**
868
869 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
870
871
872
873### OH_ArkUI_AccessibilityElementInfoSetHintText
874
875```C
876int32_t OH_ArkUI_AccessibilityElementInfoSetHintText(ArkUI_AccessibilityElementInfo* elementInfo, const char* hintText);
877```
878
879**描述:**
880
881设置Element的hintText。
882
883**起始版本:** 13
884
885**参数:**
886
887| 名称        | 描述          |
888| ----------- | ------------- |
889| elementInfo | Element结构。 |
890| hintText    | 提示文本。    |
891
892**返回:**
893
894 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
895
896
897
898### OH_ArkUI_AccessibilityElementInfoSetAccessibilityText
899
900```C
901int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityText(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityText);
902```
903
904**描述:**
905
906设置Element的accessibilityText。
907
908**起始版本:** 13
909
910**参数:**
911
912| 名称              | 描述                   |
913| ----------------- | ---------------------- |
914| elementInfo       | Element结构。          |
915| accessibilityText | 元素的无障碍文本信息。 |
916
917**返回:**
918
919 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
920
921
922
923### OH_ArkUI_AccessibilityElementInfoSetAccessibilityDescription
924
925```C
926int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityDescription(ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityDescription);
927```
928
929**描述:**
930
931设置Element的accessibilityDescription。
932
933**起始版本:** 13
934
935**参数:**
936
937| 名称                     | 描述             |
938| ------------------------ | ---------------- |
939| elementInfo              | Element结构。    |
940| accessibilityDescription | 元素的描述信息。 |
941
942**返回:**
943
944 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
945
946
947
948### OH_ArkUI_AccessibilityElementInfoSetChildNodeIds
949
950```C
951int32_t OH_ArkUI_AccessibilityElementInfoSetChildNodeIds(ArkUI_AccessibilityElementInfo* elementInfo, int32_t childCount, int64_t* childNodeIds);
952```
953
954**描述:**
955
956设置Element的childCount和childNodeIds。
957
958**起始版本:** 13
959
960**参数:**
961
962| 名称         | 描述           |
963| ------------ | -------------- |
964| elementInfo  | Element结构。  |
965| childCount   | 子节点个数。   |
966| childNodeIds | 子节点id列表。 |
967
968**返回:**
969
970 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
971
972
973
974### OH_ArkUI_AccessibilityElementInfoSetOperationActions
975
976```C
977int32_t OH_ArkUI_AccessibilityElementInfoSetOperationActions(ArkUI_AccessibilityElementInfo* elementInfo, int32_t operationCount, ArkUI_AccessibleAction* operationActions);
978```
979
980**描述:**
981
982设置Element的operationCount和operationActions。
983
984**起始版本:** 13
985
986**参数:**
987
988| 名称             | 描述                   |
989| ---------------- | ---------------------- |
990| elementInfo      | Element结构。          |
991| operationCount   | 组件支持的action数量。 |
992| operationActions | 组件支持的action。     |
993
994**返回:**
995
996 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
997
998
999
1000### OH_ArkUI_AccessibilityElementInfoSetScreenRect
1001
1002```C
1003int32_t OH_ArkUI_AccessibilityElementInfoSetScreenRect(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRect* screenRect);
1004```
1005
1006**描述:**
1007
1008设置Element的screenRect。
1009
1010**起始版本:** 13
1011
1012**参数:**
1013
1014| 名称             | 描述               |
1015| ---------------- | ------------------ |
1016| elementInfo      | Element结构。      |
1017| screenRect       | 元素显示区域。     |
1018
1019**返回:**
1020
1021 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1022
1023
1024
1025### OH_ArkUI_AccessibilityElementInfoSetCheckable
1026
1027```C
1028int32_t OH_ArkUI_AccessibilityElementInfoSetCheckable(ArkUI_AccessibilityElementInfo* elementInfo, bool checkable);
1029```
1030
1031**描述:**
1032
1033设置Element的checkable。
1034
1035**起始版本:** 13
1036
1037**参数:**
1038
1039| 名称        | 描述           |
1040| ----------- | -------------- |
1041| elementInfo | Element结构。  |
1042| checkable   | 元素是否可查。 |
1043
1044**返回:**
1045
1046 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1047
1048
1049
1050### OH_ArkUI_AccessibilityElementInfoSetChecked
1051
1052```C
1053int32_t OH_ArkUI_AccessibilityElementInfoSetChecked(ArkUI_AccessibilityElementInfo* elementInfo, bool checked);
1054```
1055
1056**描述:**
1057
1058设置Element的checked。
1059
1060**起始版本:** 13
1061
1062**参数:**
1063
1064| 名称        | 描述             |
1065| ----------- | ---------------- |
1066| elementInfo | Element结构。    |
1067| checked     | 元素是否被检查。 |
1068
1069**返回:**
1070
1071 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1072
1073
1074
1075### OH_ArkUI_AccessibilityElementInfoSetFocusable
1076
1077```C
1078int32_t OH_ArkUI_AccessibilityElementInfoSetFocusable(ArkUI_AccessibilityElementInfo* elementInfo, bool focusable);
1079```
1080
1081**描述:**
1082
1083设置Element的focusable。
1084
1085**起始版本:** 13
1086
1087**参数:**
1088
1089| 名称        | 描述             |
1090| ----------- | ---------------- |
1091| elementInfo | Element结构。    |
1092| focusable   | 元素是否可聚焦。 |
1093
1094**返回:**
1095
1096 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1097
1098
1099
1100### OH_ArkUI_AccessibilityElementInfoSetFocused
1101
1102```C
1103int32_t OH_ArkUI_AccessibilityElementInfoSetFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool isFocused);
1104```
1105
1106**描述:**
1107
1108设置Element的isFocused。
1109
1110**起始版本:** 13
1111
1112**参数:**
1113
1114| 名称        | 描述           |
1115| ----------- | -------------- |
1116| elementInfo | Element结构。  |
1117| isFocused   | 元素是否聚焦。 |
1118
1119**返回:**
1120
1121 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1122
1123
1124
1125### OH_ArkUI_AccessibilityElementInfoSetVisible
1126
1127```C
1128int32_t OH_ArkUI_AccessibilityElementInfoSetVisible(ArkUI_AccessibilityElementInfo* elementInfo, bool isVisible);
1129```
1130
1131**描述:**
1132
1133设置Element的isVisible。
1134
1135**起始版本:** 13
1136
1137**参数:**
1138
1139| 名称        | 描述           |
1140| ----------- | -------------- |
1141| elementInfo | Element结构。  |
1142| isVisible   | 元素是否可见。 |
1143
1144**返回:**
1145
1146 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1147
1148
1149
1150### OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused
1151
1152```C
1153int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityFocused);
1154```
1155
1156**描述:**
1157
1158设置Element的accessibilityFocused。
1159
1160**起始版本:** 13
1161
1162**参数:**
1163
1164| 名称                 | 描述             |
1165| -------------------- | ---------------- |
1166| elementInfo          | Element结构。    |
1167| accessibilityFocused | 无障碍获焦状态。 |
1168
1169**返回:**
1170
1171 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1172
1173
1174
1175### OH_ArkUI_AccessibilityElementInfoSetSelected
1176
1177```C
1178int32_t OH_ArkUI_AccessibilityElementInfoSetSelected(ArkUI_AccessibilityElementInfo* elementInfo, bool selected);
1179```
1180
1181**描述:**
1182
1183设置Element的selected。
1184
1185**起始版本:** 13
1186
1187**参数:**
1188
1189| 名称        | 描述             |
1190| ----------- | ---------------- |
1191| elementInfo | Element结构。    |
1192| selected    | 元素是否被选中。 |
1193
1194**返回:**
1195
1196 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1197
1198
1199
1200### OH_ArkUI_AccessibilityElementInfoSetClickable
1201
1202```C
1203int32_t OH_ArkUI_AccessibilityElementInfoSetClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool clickable);
1204```
1205
1206**描述:**
1207
1208设置Element的clickable。
1209
1210**起始版本:** 13
1211
1212**参数:**
1213
1214| 名称        | 描述             |
1215| ----------- | ---------------- |
1216| elementInfo | Element结构。    |
1217| clickable   | 元素是否可点击。 |
1218
1219**返回:**
1220
1221 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1222
1223
1224
1225### OH_ArkUI_AccessibilityElementInfoSetLongClickable
1226
1227```C
1228int32_t OH_ArkUI_AccessibilityElementInfoSetLongClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool longClickable);
1229```
1230
1231**描述:**
1232
1233设置Element的longClickable。
1234
1235**起始版本:** 13
1236
1237**参数:**
1238
1239| 名称          | 描述               |
1240| ------------- | ------------------ |
1241| elementInfo   | Element结构。      |
1242| longClickable | 元素是否可长点击。 |
1243
1244**返回:**
1245
1246 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1247
1248
1249
1250### OH_ArkUI_AccessibilityElementInfoSetEnabled
1251
1252```C
1253int32_t OH_ArkUI_AccessibilityElementInfoSetEnabled(ArkUI_AccessibilityElementInfo* elementInfo, bool isEnabled);
1254```
1255
1256**描述:**
1257
1258设置Element的isEnabled。
1259
1260**起始版本:** 13
1261
1262**参数:**
1263
1264| 名称        | 描述           |
1265| ----------- | -------------- |
1266| elementInfo | Element结构。  |
1267| isEnabled   | 元素是否启用。 |
1268
1269**返回:**
1270
1271 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1272
1273
1274
1275### OH_ArkUI_AccessibilityElementInfoSetIsPassword
1276
1277```C
1278int32_t OH_ArkUI_AccessibilityElementInfoSetIsPassword(ArkUI_AccessibilityElementInfo* elementInfo, bool isPassword);
1279```
1280
1281**描述:**
1282
1283设置Element的isPassword。
1284
1285**起始版本:** 13
1286
1287**参数:**
1288
1289| 名称        | 描述             |
1290| ----------- | ---------------- |
1291| elementInfo | Element结构。    |
1292| isPassword  | 元素是否为密码。 |
1293
1294**返回:**
1295
1296 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1297
1298
1299
1300### OH_ArkUI_AccessibilityElementInfoSetScrollable
1301
1302```C
1303int32_t OH_ArkUI_AccessibilityElementInfoSetScrollable(ArkUI_AccessibilityElementInfo* elementInfo, bool scrollable);
1304```
1305
1306**描述:**
1307
1308设置Element的scrollable。
1309
1310**起始版本:** 13
1311
1312**参数:**
1313
1314| 名称        | 描述             |
1315| ----------- | ---------------- |
1316| elementInfo | Element结构。    |
1317| scrollable  | 元素是否可滚动。 |
1318
1319**返回:**
1320
1321 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1322
1323
1324
1325### OH_ArkUI_AccessibilityElementInfoSetEditable
1326
1327```C
1328int32_t OH_ArkUI_AccessibilityElementInfoSetEditable(ArkUI_AccessibilityElementInfo* elementInfo, bool editable);
1329```
1330
1331**描述:**
1332
1333设置Element的editable。
1334
1335**起始版本:** 13
1336
1337**参数:**
1338
1339| 名称        | 描述             |
1340| ----------- | ---------------- |
1341| elementInfo | Element结构。    |
1342| editable    | 元素是否可编辑。 |
1343
1344**返回:**
1345
1346 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1347
1348
1349
1350### OH_ArkUI_AccessibilityElementInfoSetIsHint
1351
1352```C
1353int32_t OH_ArkUI_AccessibilityElementInfoSetIsHint(ArkUI_AccessibilityElementInfo* elementInfo, bool isHint);
1354```
1355
1356**描述:**
1357
1358设置Element的isHint。
1359
1360**起始版本:** 13
1361
1362**参数:**
1363
1364| 名称        | 描述                 |
1365| ----------- | -------------------- |
1366| elementInfo | Element结构。        |
1367| isHint      | 元素是否为提示状态。 |
1368
1369**返回:**
1370
1371 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1372
1373
1374
1375### OH_ArkUI_AccessibilityElementInfoSetRangeInfo
1376
1377```C
1378int32_t OH_ArkUI_AccessibilityElementInfoSetRangeInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRangeInfo* rangeInfo);
1379```
1380
1381**描述:**
1382
1383设置Element的rangeInfo。
1384
1385**起始版本:** 13
1386
1387**参数:**
1388
1389| 名称        | 描述                                                         |
1390| ----------- | ------------------------------------------------------------ |
1391| elementInfo | Element结构。                                                |
1392| rangeInfo   | 特定组件需要使用,如Slider、Rating、Progress组件。设置组件属性中的当前值以及最大值、最小值。 |
1393
1394**返回:**
1395
1396 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1397
1398
1399
1400### OH_ArkUI_AccessibilityElementInfoSetGridInfo
1401
1402```C
1403int32_t OH_ArkUI_AccessibilityElementInfoSetGridInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridInfo* gridInfo);
1404```
1405
1406**描述:**
1407
1408设置Element的gridInfo。
1409
1410**起始版本:** 13
1411
1412**参数:**
1413
1414| 名称        | 描述                                                         |
1415| ----------- | ------------------------------------------------------------ |
1416| elementInfo | Element结构。                                                |
1417| gridInfo    | 特定组件需要使用,如list、flex、select、swiper组件。设置组件,”行数“,”列数“,以及选择模式。 |
1418
1419**返回:**
1420
1421 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1422
1423
1424
1425### OH_ArkUI_AccessibilityElementInfoSetGridItemInfo
1426
1427```C
1428int32_t OH_ArkUI_AccessibilityElementInfoSetGridItemInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridItemInfo* gridItem);
1429```
1430
1431**描述:**
1432
1433设置Element的gridItem。
1434
1435**起始版本:** 13
1436
1437**参数:**
1438
1439| 名称        | 描述                                                 |
1440| ----------- | ---------------------------------------------------- |
1441| elementInfo | Element结构。                                        |
1442| gridItem    | 特定组件需要使用,如list、flex、select、swiper组件。 |
1443
1444**返回:**
1445
1446 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1447
1448
1449
1450### OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart
1451
1452```
1453int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextStart);
1454```
1455
1456**描述:**
1457
1458设置Element的selectedTextStart。
1459
1460**起始版本:** 13
1461
1462**参数:**
1463
1464| 名称              | 描述                               |
1465| ----------------- | ---------------------------------- |
1466| elementInfo       | Element结构。                      |
1467| selectedTextStart | 文本组件使用,设置选择的起点位置。 |
1468
1469**返回:**
1470
1471 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1472
1473
1474
1475### OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd
1476
1477```C
1478int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextEnd);
1479```
1480
1481**描述:**
1482
1483设置Element的selectedTextEnd。
1484
1485**起始版本:** 13
1486
1487**参数:**
1488
1489| 名称            | 描述                               |
1490| --------------- | ---------------------------------- |
1491| elementInfo     | Element结构。                      |
1492| selectedTextEnd | 文本组件使用,设置选择的结束位置。 |
1493
1494**返回:**
1495
1496 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1497
1498
1499
1500### OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex
1501
1502```C
1503int32_t OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t currentItemIndex);
1504```
1505
1506**描述:**
1507
1508设置Element的currentItemIndex。
1509
1510**起始版本:** 13
1511
1512**参数:**
1513
1514| 名称             | 描述                                                         |
1515| ---------------- | ------------------------------------------------------------ |
1516| elementInfo      | Element结构。                                                |
1517| currentItemIndex | 当前项的索引,当前获焦组件的index信息。如,list、select、swiper、tab_bar等组件 |
1518
1519**返回:**
1520
1521 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1522
1523
1524
1525### OH_ArkUI_AccessibilityElementInfoSetStartItemIndex
1526
1527```C
1528int32_t OH_ArkUI_AccessibilityElementInfoSetStartItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t startItemIndex);
1529```
1530
1531**描述:**
1532
1533设置Element的startItemIndex。
1534
1535**起始版本:** 13
1536
1537**参数:**
1538
1539| 名称           | 描述                                                         |
1540| -------------- | ------------------------------------------------------------ |
1541| elementInfo    | Element结构。                                                |
1542| startItemIndex | 当前屏幕中显示的第一个item的index,当前获焦组件的index信息。如,list、select、swiper、tab_bar等组件。 |
1543
1544**返回:**
1545
1546 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1547
1548
1549
1550### OH_ArkUI_AccessibilityElementInfoSetEndItemIndex
1551
1552```C
1553int32_t OH_ArkUI_AccessibilityElementInfoSetEndItemIndex(
1554    ArkUI_AccessibilityElementInfo* elementInfo, int32_t endItemIndex);
1555```
1556
1557**描述:**
1558
1559设置Element的endItemIndex。
1560
1561**起始版本:** 13
1562
1563**参数:**
1564
1565| 名称         | 描述                                                         |
1566| ------------ | ------------------------------------------------------------ |
1567| elementInfo  | Element结构。                                                |
1568| endItemIndex | 当前屏幕中显示的最后一个item的index,当前获焦组件的index信息。如,list、select、swiper、tab_bar等组件。 |
1569
1570**返回:**
1571
1572 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1573
1574
1575
1576### OH_ArkUI_AccessibilityElementInfoSetItemCount
1577
1578```C
1579int32_t OH_ArkUI_AccessibilityElementInfoSetItemCount(
1580    ArkUI_AccessibilityElementInfo* elementInfo, int32_t itemCount);
1581```
1582
1583**描述:**
1584
1585设置Element的itemCount。
1586
1587**起始版本:** 13
1588
1589**参数:**
1590
1591| 名称        | 描述                                                      |
1592| ----------- | --------------------------------------------------------- |
1593| elementInfo | Element结构。                                             |
1594| itemCount   | 组件的item总数。如,list、select、swiper、tab_bar等组件。 |
1595
1596**返回:**
1597
1598 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1599
1600
1601
1602### OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset
1603
1604```C
1605int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset(
1606    ArkUI_AccessibilityElementInfo* elementInfo, int32_t offset);
1607```
1608
1609**描述:**
1610
1611设置Element的offset。
1612
1613**起始版本:** 13
1614
1615**参数:**
1616
1617| 名称        | 描述                                                         |
1618| ----------- | ------------------------------------------------------------ |
1619| elementInfo | Element结构。                                                |
1620| offset      | 对于可滚动类组件,如list,grid,内容区相对组件的顶部坐标滚动的像素偏移量。 |
1621
1622**返回:**
1623
1624 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1625
1626
1627
1628### OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup
1629
1630```C
1631int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup(
1632    ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityGroup);
1633```
1634
1635**描述:**
1636
1637设置Element的accessibilityGroup。
1638
1639**起始版本:** 13
1640
1641**参数:**
1642
1643| 名称               | 描述                                                         |
1644| ------------------ | ------------------------------------------------------------ |
1645| elementInfo        | Element结构。                                                |
1646| accessibilityGroup | 无障碍组,设置为true时,表示该组件及其所有子组件为一整个可以选中的组件,无障碍服务将不再关注其子组件内容。 |
1647
1648**返回:**
1649
1650 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1651
1652
1653
1654### OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel
1655
1656```C
1657int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel(
1658    ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityLevel);
1659```
1660
1661**描述:**
1662
1663设置Element的accessibilityLevel。
1664
1665**起始版本:** 13
1666
1667**参数:**
1668
1669| 名称               | 描述                                                         |
1670| ------------------ | ------------------------------------------------------------ |
1671| elementInfo        | Element结构。                                                |
1672| accessibilityLevel | 无障碍重要性,用于控制某个组件是否可被无障碍辅助服务所识别。 |
1673
1674**返回:**
1675
1676 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1677
1678
1679
1680### OH_ArkUI_AccessibilityElementInfoSetZIndex
1681
1682```C
1683int32_t OH_ArkUI_AccessibilityElementInfoSetZIndex(
1684    ArkUI_AccessibilityElementInfo* elementInfo, int32_t zIndex);
1685```
1686
1687**描述:**
1688
1689设置Element的zIndex。
1690
1691**起始版本:** 13
1692
1693**参数:**
1694
1695| 名称        | 描述                                             |
1696| ----------- | ------------------------------------------------ |
1697| elementInfo | Element结构。                                    |
1698| zIndex      | 组件z序,用于控制元素在垂直于屏幕的z轴上的位置。 |
1699
1700**返回:**
1701
1702 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1703
1704
1705
1706### OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity
1707
1708```C
1709int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity(
1710    ArkUI_AccessibilityElementInfo* elementInfo, float opacity);
1711```
1712
1713**描述:**
1714
1715设置Element的opacity。
1716
1717**起始版本:** 13
1718
1719**参数:**
1720
1721| 名称        | 描述                                                         |
1722| ----------- | ------------------------------------------------------------ |
1723| elementInfo | Element结构。                                                |
1724| opacity     | 组件透明度信息,其取值范围是0到1,其中1表示完全不透明,而0则表示完全透明。 |
1725
1726**返回:**
1727
1728 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1729
1730
1731
1732### OH_ArkUI_AccessibilityElementInfoSetBackgroundColor
1733
1734```C
1735int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundColor(
1736    ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundColor);
1737```
1738
1739**描述:**
1740
1741设置Element的backgroundColor。
1742
1743**起始版本:** 13
1744
1745**参数:**
1746
1747| 名称            | 描述             |
1748| --------------- | ---------------- |
1749| elementInfo     | Element结构。    |
1750| backgroundColor | 组件背景色信息。 |
1751
1752**返回:**
1753
1754 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1755
1756
1757
1758### OH_ArkUI_AccessibilityElementInfoSetBackgroundImage
1759
1760```C
1761int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundImage(
1762    ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundImage);
1763```
1764
1765**描述:**
1766
1767设置Element的backgroundImage。
1768
1769**起始版本:** 13
1770
1771**参数:**
1772
1773| 名称            | 描述               |
1774| --------------- | ------------------ |
1775| elementInfo     | Element结构。      |
1776| backgroundImage | 组件背景图片信息。 |
1777
1778**返回:**
1779
1780 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1781
1782
1783
1784### OH_ArkUI_AccessibilityElementInfoSetBlur
1785
1786```C
1787int32_t OH_ArkUI_AccessibilityElementInfoSetBlur(
1788    ArkUI_AccessibilityElementInfo* elementInfo, const char* blur);
1789```
1790
1791**描述:**
1792
1793设置Element的blur。
1794
1795**起始版本:** 13
1796
1797**参数:**
1798
1799| 名称        | 描述             |
1800| ----------- | ---------------- |
1801| elementInfo | Element结构。    |
1802| blur        | 组件模糊度信息。 |
1803
1804**返回:**
1805
1806 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1807
1808
1809
1810### OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior
1811
1812```C
1813int32_t OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior(
1814    ArkUI_AccessibilityElementInfo* elementInfo, const char* hitTestBehavior);
1815```
1816
1817**描述:**
1818
1819设置Element的hitTestBehavior。
1820
1821**起始版本:** 13
1822
1823**参数:**
1824
1825| 名称            | 描述                                                         |
1826| --------------- | ------------------------------------------------------------ |
1827| elementInfo     | Element结构。                                                |
1828| hitTestBehavior | hitTest模式。取值:<br/>HitTestMode.Default: 默认模式<br/>HitTestMode.Block:阻塞模式<br/>HitTestMode.Transparent:透传模式<br/>HitTestMode.None: 关闭模式 |
1829
1830**返回:**
1831
1832 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1833
1834
1835
1836### OH_ArkUI_CreateAccessibilityEventInfo
1837
1838```C
1839ArkUI_AccessibilityEventInfo* OH_ArkUI_CreateAccessibilityEventInfo(void);
1840```
1841
1842**描述:**
1843
1844创建eventInfo结构,创建后需要调用OH_ArkUI_DestoryAccessibilityEventInfo释放。
1845
1846**起始版本:** 13
1847
1848**返回:**
1849
1850返回创建完成的ArkUI_AccessibilityEventInfo结构指针,如果创建失败返回NULL。
1851
1852### OH_ArkUI_DestoryAccessibilityEventInfo
1853
1854```C
1855void OH_ArkUI_DestoryAccessibilityEventInfo(ArkUI_AccessibilityEventInfo* eventInfo);
1856```
1857
1858**描述:**
1859
1860销毁eventInfo结构。
1861
1862**起始版本:** 13
1863
1864**参数:**
1865
1866| 名称      | 描述                              |
1867| --------- | --------------------------------- |
1868| eventInfo | 需要删除释放的eventInfo结构指针。 |
1869
1870**返回:** 无
1871
1872
1873
1874### OH_ArkUI_AccessibilityEventSetEventType
1875
1876```C
1877int32_t OH_ArkUI_AccessibilityEventSetEventType(
1878    ArkUI_AccessibilityEventInfo* eventInfo,  ArkUI_AccessibilityEventType eventType);
1879```
1880
1881**描述:**
1882
1883设置eventInfo结构的eventType。
1884
1885**起始版本:** 13
1886
1887**参数:**
1888
1889| 名称      | 描述                                                         |
1890| --------- | ------------------------------------------------------------ |
1891| eventInfo | eventInfo结构指针。                                          |
1892| eventType | 事件类型[ArkUI_AccessibilityEventType](#arkui_accessibilityeventtype)。 |
1893
1894**返回:**
1895
1896 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1897
1898
1899
1900### OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility
1901
1902```C
1903int32_t OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility(
1904    ArkUI_AccessibilityEventInfo* eventInfo, const char* textAnnouncedForAccessibility);
1905```
1906
1907**描述:**
1908
1909设置eventInfo结构的textAnnouncedForAccessibility。
1910
1911**起始版本:** 13
1912
1913**参数:**
1914
1915| 名称                          | 描述                                                         |
1916| ----------------------------- | ------------------------------------------------------------ |
1917| eventInfo                     | eventInfo结构指针。                                          |
1918| textAnnouncedForAccessibility | 当发送主动播报事件时,需要播报的内容。事件类型:ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_VIEW_ANNOUNCE_FOR_ACCESSIBILITY |
1919
1920**返回:**
1921
1922 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1923
1924
1925
1926### OH_ArkUI_AccessibilityEventSetRequestFocusId
1927
1928```
1929int32_t OH_ArkUI_AccessibilityEventSetRequestFocusId(
1930    ArkUI_AccessibilityEventInfo* eventInfo, int32_t requestFocusId);
1931```
1932
1933**描述:**
1934
1935设置eventInfo结构的requestFocusId。
1936
1937**起始版本:** 13
1938
1939**参数:**
1940
1941| 名称           | 描述                                                         |
1942| -------------- | ------------------------------------------------------------ |
1943| eventInfo      | eventInfo结构指针。                                          |
1944| requestFocusId | 当发送主动聚焦事件时,聚焦的节点id。聚焦需要保障不能变化。事件类型:ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_VIEW_REQUEST_FOCUS_FOR_ACCESSIBILITY |
1945
1946**返回:**
1947
1948 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1949
1950
1951
1952### OH_ArkUI_AccessibilityEventSetElementInfo
1953
1954```C
1955int32_t OH_ArkUI_AccessibilityEventSetElementInfo(
1956    ArkUI_AccessibilityEventInfo* eventInfo,  ArkUI_AccessibilityElementInfo* elementInfo);
1957```
1958
1959**描述:**
1960
1961设置eventInfo结构的elementInfo。
1962
1963**起始版本:** 13
1964
1965**参数:**
1966
1967| 名称        | 描述                     |
1968| ----------- | ------------------------ |
1969| eventInfo   | eventInfo结构指针。      |
1970| elementInfo | 设置发送事件的组件信息。 |
1971
1972**返回:**
1973
1974 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
1975
1976
1977
1978### OH_ArkUI_FindAccessibilityActionArgumentByKey
1979
1980```
1981int32_t OH_ArkUI_FindAccessibilityActionArgumentByKey(
1982    ArkUI_AccessibilityActionArguments* arguments, const char* key, char** value);
1983```
1984
1985**描述:**
1986
1987获取ArkUI_AccessibilityActionArguments中指定key的value值。
1988
1989**起始版本:** 13
1990
1991**参数:**
1992
1993| 名称      | 描述                   |
1994| --------- | ---------------------- |
1995| arguments | action辅助参数内容。   |
1996| key       | 指定key。              |
1997| value     | 指定key对应的value值。 |
1998
1999**返回:**
2000
2001 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode)
2002
2003
2004
2005## 枚举类型说明
2006
2007### ArkUI_AcessbilityErrorCode
2008
2009**描述:**
2010
2011错误码定义。
2012
2013| 枚举值                                          | 描述       |
2014| ----------------------------------------------- | ---------- |
2015| ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESS       | 成功。     |
2016| ARKUI_ACCESSIBILITY_NATIVE_RESULT_FAILED        | 失败。     |
2017| ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER | 参数错误。 |
2018| ARKUI_ACCESSIBILITY_NATIVE_RESULT_OUT_OF_MEMORY | 内存不足。 |
2019
2020**起始版本:**
2021
202213
2023
2024### ArkUI_AccessibilitySearchMode
2025
2026**描述:**
2027
2028查询模式。
2029
2030| 枚举值                                                       | 描述                                                     |
2031| ------------------------------------------------------------ | -------------------------------------------------------- |
2032| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_CURRENT      | 只查询指定节点信息。                                     |
2033| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_PREDECESSORS | 查询父组件。查询结果包含指定节点信息。                   |
2034| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_SIBLINGS     | 查询兄弟节点组件。查询结果包含指定节点信息。             |
2035| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_CHILDREN     | 查询当前节点的下一层孩子节点。查询结果包含指定节点信息。 |
2036| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_RECURSIVE_CHILDREN | 查询当前节点的所有孩子节点。查询结果包含指定节点信息。   |
2037
2038**起始版本:**
2039
204013
2041
2042### ArkUI_AccessibilityFocusType
2043
2044**描述:**
2045
2046焦点类型。
2047
2048| 枚举值                                              | 描述             |
2049| --------------------------------------------------- | ---------------- |
2050| ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INVALID       | 无效值。         |
2051| ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INPUT         | 组件获焦类型。   |
2052| ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_ACCESSIBILITY | 无障碍获焦类型。 |
2053
2054**起始版本:**
2055
205613
2057
2058### ArkUI_Accessibility_ActionType
2059
2060**描述:**
2061
2062执行操作类型。
2063
2064| 枚举值                                                      | 描述                                                         |
2065| ----------------------------------------------------------- | ------------------------------------------------------------ |
2066| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_INVALID                   | 无效值。                                                     |
2067| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CLICK                     | 点击事件。                                                   |
2068| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_LONG_CLICK                | 长按事件。                                                   |
2069| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_GAIN_ACCESSIBILITY_FOCUS  | 执行无障碍节点获焦。                                         |
2070| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CLEAR_ACCESSIBILITY_FOCUS | 清除无障碍节点获焦状态。                                     |
2071| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SCROLL_FORWARD            | 支持滚动的组件向前滚动。                                     |
2072| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SCROLL_BACKWARD           | 支持滚动的组件向后滚动。                                     |
2073| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_COPY                      | 针对文本组件支持选中内容的拷贝。                             |
2074| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_PASTE                     | 针对文本组件在光标所在位置粘贴。                             |
2075| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CUT                       | 针对文本组件支持选中内容的剪切。                             |
2076| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SELECT_TEXT               | 针对文本组件进行选择操作。结合[ArkUI_AccessibilityActionArguments](#arkui_accessibilityactionarguments)使用,配置selectTextStart,selectTextEnd,selectTextInForWard。进入编辑区选择一段文本内容。 |
2077| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SET_TEXT                  | 针对文本组件设置文本内容。                                   |
2078| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SET_CURSOR_POSITION       | 针对文本组件设置光标位置。结合[ArkUI_AccessibilityActionArguments](#arkui_accessibilityactionarguments)使用,配置offset设置位置。 |
2079| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_NEXT_HTML_ITEM            | 起始版本:API 15。配置后表示支持通过[findNextFocusAccessibilityNode](#findnextfocusaccessibilitynode-1)查找下一个焦点,方向为[ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_FORWARD](#arkui_accessibilityfocusmovedirection)。  |
2080| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_PREVIOUS_HTML_ITEM        | 起始版本:API 15。配置后表示支持通过[findNextFocusAccessibilityNode](#findnextfocusaccessibilitynode-1)查找上一个焦点,方向为[ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_BACKWARD](#arkui_accessibilityfocusmovedirection)。 |
2081
2082**起始版本:**
2083
208413
2085
2086### ArkUI_AccessibilityEventType
2087
2088**描述:**
2089
2090事件类型。
2091
2092| 枚举值                                                       | 描述                                             |
2093| ------------------------------------------------------------ | ------------------------------------------------ |
2094| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_INVALID                | 无效值。                                         |
2095| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_CLICKED                | 被点击事件。                                     |
2096| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_LONG_CLICKED           | 被长按事件。                                     |
2097| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_SELECTED               | 被选中事件。                                     |
2098| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_TEXT_UPDATE            | 文本更新时需发送事件。                           |
2099| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_STATE_UPDATE      | 页面跳转、切换、大小变化、移动等需要发送该事件。 |
2100| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_CONTENT_UPDATE    | 页面内容发生变化时需要发送该事件。               |
2101| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_SCROLLED               | 可以滚动的组件发生滚动事件时需要发送该事件。     |
2102| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ACCESSIBILITY_FOCUSED  | 被无障碍聚焦事件。                               |
2103| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ACCESSIBILITY_FOCUS_CLEARED | 清除无障碍聚焦事件。                             |
2104| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_REQUEST_ACCESSIBILITY_FOCUS | 主动请求指定节点聚焦。                           |
2105| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_OPEN              | 页面关闭时需要发送该事件。                       |
2106| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_CLOSE             | 页面打开时需要发送该事件。                       |
2107| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ANNOUNCE_FOR_ACCESSIBILITY | 请求主动播报指定内容的事件。                     |
2108| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_FOCUS_NODE_UPDATE      | 获焦组件发生位置或大小变化时需要发生事件。       |
2109
2110**起始版本:**
2111
211213
2113
2114### ArkUI_AccessibilityFocusMoveDirection
2115
2116**描述:**
2117
2118焦点移动方向。
2119
2120| 枚举值                                        | 描述                                 |
2121| --------------------------------------------- | ------------------------------------ |
2122| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_INVALID  | 无效值。                             |
2123| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_UP       | 焦点向上移动。                       |
2124| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_DOWN     | 焦点向下移动。                       |
2125| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_LEFT     | 焦点向左移动。                       |
2126| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_RIGHT    | 焦点向右移动。                       |
2127| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_FORWARD  | 焦点向下一个可聚焦节点移动,基于查询请求中指定的基准节点。 |
2128| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_BACKWARD | 焦点向上一个可聚焦节点移动,基于查询请求中指定的基准节点。 |
2129
2130**起始版本:**
2131
213213