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