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。 | 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 782**返回:** 783 784 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 785 786 787 788### OH_ArkUI_AccessibilityElementInfoSetCheckable 789 790```C 791int32_t OH_ArkUI_AccessibilityElementInfoSetCheckable(ArkUI_AccessibilityElementInfo* elementInfo, bool checkable); 792``` 793 794**描述:** 795 796设置Element的checkable。 797 798**起始版本:** 13 799 800**参数:** 801 802| 名称 | 描述 | 803| ----------- | -------------- | 804| elementInfo | Element结构。 | 805| checkable | 元素是否可查。 | 806 807**返回:** 808 809 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 810 811 812 813### OH_ArkUI_AccessibilityElementInfoSetChecked 814 815```C 816int32_t OH_ArkUI_AccessibilityElementInfoSetChecked(ArkUI_AccessibilityElementInfo* elementInfo, bool checked); 817``` 818 819**描述:** 820 821设置Element的checked。 822 823**起始版本:** 13 824 825**参数:** 826 827| 名称 | 描述 | 828| ----------- | ---------------- | 829| elementInfo | Element结构。 | 830| checked | 元素是否被检查。 | 831 832**返回:** 833 834 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 835 836 837 838### OH_ArkUI_AccessibilityElementInfoSetFocusable 839 840```C 841int32_t OH_ArkUI_AccessibilityElementInfoSetFocusable(ArkUI_AccessibilityElementInfo* elementInfo, bool focusable); 842``` 843 844**描述:** 845 846设置Element的focusable。 847 848**起始版本:** 13 849 850**参数:** 851 852| 名称 | 描述 | 853| ----------- | ---------------- | 854| elementInfo | Element结构。 | 855| focusable | 元素是否可聚焦。 | 856 857**返回:** 858 859 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 860 861 862 863### OH_ArkUI_AccessibilityElementInfoSetFocused 864 865```C 866int32_t OH_ArkUI_AccessibilityElementInfoSetFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool isFocused); 867``` 868 869**描述:** 870 871设置Element的isFocused。 872 873**起始版本:** 13 874 875**参数:** 876 877| 名称 | 描述 | 878| ----------- | -------------- | 879| elementInfo | Element结构。 | 880| isFocused | 元素是否聚焦。 | 881 882**返回:** 883 884 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 885 886 887 888### OH_ArkUI_AccessibilityElementInfoSetVisible 889 890```C 891int32_t OH_ArkUI_AccessibilityElementInfoSetVisible(ArkUI_AccessibilityElementInfo* elementInfo, bool isVisible); 892``` 893 894**描述:** 895 896设置Element的isVisible。 897 898**起始版本:** 13 899 900**参数:** 901 902| 名称 | 描述 | 903| ----------- | -------------- | 904| elementInfo | Element结构。 | 905| isVisible | 元素是否可见。 | 906 907**返回:** 908 909 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 910 911 912 913### OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused 914 915```C 916int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityFocused(ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityFocused); 917``` 918 919**描述:** 920 921设置Element的accessibilityFocused。 922 923**起始版本:** 13 924 925**参数:** 926 927| 名称 | 描述 | 928| -------------------- | ---------------- | 929| elementInfo | Element结构。 | 930| accessibilityFocused | 无障碍获焦状态。 | 931 932**返回:** 933 934 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 935 936 937 938### OH_ArkUI_AccessibilityElementInfoSetSelected 939 940```C 941int32_t OH_ArkUI_AccessibilityElementInfoSetSelected(ArkUI_AccessibilityElementInfo* elementInfo, bool selected); 942``` 943 944**描述:** 945 946设置Element的selected。 947 948**起始版本:** 13 949 950**参数:** 951 952| 名称 | 描述 | 953| ----------- | ---------------- | 954| elementInfo | Element结构。 | 955| selected | 元素是否被选中。 | 956 957**返回:** 958 959 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 960 961 962 963### OH_ArkUI_AccessibilityElementInfoSetClickable 964 965```C 966int32_t OH_ArkUI_AccessibilityElementInfoSetClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool clickable); 967``` 968 969**描述:** 970 971设置Element的clickable。 972 973**起始版本:** 13 974 975**参数:** 976 977| 名称 | 描述 | 978| ----------- | ---------------- | 979| elementInfo | Element结构。 | 980| clickable | 元素是否可点击。 | 981 982**返回:** 983 984 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 985 986 987 988### OH_ArkUI_AccessibilityElementInfoSetLongClickable 989 990```C 991int32_t OH_ArkUI_AccessibilityElementInfoSetLongClickable(ArkUI_AccessibilityElementInfo* elementInfo, bool longClickable); 992``` 993 994**描述:** 995 996设置Element的longClickable。 997 998**起始版本:** 13 999 1000**参数:** 1001 1002| 名称 | 描述 | 1003| ------------- | ------------------ | 1004| elementInfo | Element结构。 | 1005| longClickable | 元素是否可长点击。 | 1006 1007**返回:** 1008 1009 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1010 1011 1012 1013### OH_ArkUI_AccessibilityElementInfoSetEnabled 1014 1015```C 1016int32_t OH_ArkUI_AccessibilityElementInfoSetEnabled(ArkUI_AccessibilityElementInfo* elementInfo, bool isEnabled); 1017``` 1018 1019**描述:** 1020 1021设置Element的isEnabled。 1022 1023**起始版本:** 13 1024 1025**参数:** 1026 1027| 名称 | 描述 | 1028| ----------- | -------------- | 1029| elementInfo | Element结构。 | 1030| isEnabled | 元素是否启用。 | 1031 1032**返回:** 1033 1034 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1035 1036 1037 1038### OH_ArkUI_AccessibilityElementInfoSetIsPassword 1039 1040```C 1041int32_t OH_ArkUI_AccessibilityElementInfoSetIsPassword(ArkUI_AccessibilityElementInfo* elementInfo, bool isPassword); 1042``` 1043 1044**描述:** 1045 1046设置Element的isPassword。 1047 1048**起始版本:** 13 1049 1050**参数:** 1051 1052| 名称 | 描述 | 1053| ----------- | ---------------- | 1054| elementInfo | Element结构。 | 1055| isPassword | 元素是否为密码。 | 1056 1057**返回:** 1058 1059 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1060 1061 1062 1063### OH_ArkUI_AccessibilityElementInfoSetScrollable 1064 1065```C 1066int32_t OH_ArkUI_AccessibilityElementInfoSetScrollable(ArkUI_AccessibilityElementInfo* elementInfo, bool scrollable); 1067``` 1068 1069**描述:** 1070 1071设置Element的scrollable。 1072 1073**起始版本:** 13 1074 1075**参数:** 1076 1077| 名称 | 描述 | 1078| ----------- | ---------------- | 1079| elementInfo | Element结构。 | 1080| scrollable | 元素是否可滚动。 | 1081 1082**返回:** 1083 1084 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1085 1086 1087 1088### OH_ArkUI_AccessibilityElementInfoSetEditable 1089 1090```C 1091int32_t OH_ArkUI_AccessibilityElementInfoSetEditable(ArkUI_AccessibilityElementInfo* elementInfo, bool editable); 1092``` 1093 1094**描述:** 1095 1096设置Element的editable。 1097 1098**起始版本:** 13 1099 1100**参数:** 1101 1102| 名称 | 描述 | 1103| ----------- | ---------------- | 1104| elementInfo | Element结构。 | 1105| editable | 元素是否可编辑。 | 1106 1107**返回:** 1108 1109 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1110 1111 1112 1113### OH_ArkUI_AccessibilityElementInfoSetIsHint 1114 1115```C 1116int32_t OH_ArkUI_AccessibilityElementInfoSetIsHint(ArkUI_AccessibilityElementInfo* elementInfo, bool isHint); 1117``` 1118 1119**描述:** 1120 1121设置Element的isHint。 1122 1123**起始版本:** 13 1124 1125**参数:** 1126 1127| 名称 | 描述 | 1128| ----------- | -------------------- | 1129| elementInfo | Element结构。 | 1130| isHint | 元素是否为提示状态。 | 1131 1132**返回:** 1133 1134 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1135 1136 1137 1138### OH_ArkUI_AccessibilityElementInfoSetRangeInfo 1139 1140```C 1141int32_t OH_ArkUI_AccessibilityElementInfoSetRangeInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleRangeInfo* rangeInfo); 1142``` 1143 1144**描述:** 1145 1146设置Element的rangeInfo。 1147 1148**起始版本:** 13 1149 1150**参数:** 1151 1152| 名称 | 描述 | 1153| ----------- | ------------------------------------------------------------ | 1154| elementInfo | Element结构。 | 1155| rangeInfo | 特定组件需要使用,如Slider、Rating、Progress组件。设置组件属性中的当前值以及最大值、最小值。 | 1156 1157**返回:** 1158 1159 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1160 1161 1162 1163### OH_ArkUI_AccessibilityElementInfoSetGridInfo 1164 1165```C 1166int32_t OH_ArkUI_AccessibilityElementInfoSetGridInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridInfo* gridInfo); 1167``` 1168 1169**描述:** 1170 1171设置Element的gridInfo。 1172 1173**起始版本:** 13 1174 1175**参数:** 1176 1177| 名称 | 描述 | 1178| ----------- | ------------------------------------------------------------ | 1179| elementInfo | Element结构。 | 1180| gridInfo | 特定组件需要使用,如list、flex、select、swiper组件。设置组件,”行数“,”列数“,以及选择模式。 | 1181 1182**返回:** 1183 1184 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1185 1186 1187 1188### OH_ArkUI_AccessibilityElementInfoSetGridItemInfo 1189 1190```C 1191int32_t OH_ArkUI_AccessibilityElementInfoSetGridItemInfo(ArkUI_AccessibilityElementInfo* elementInfo, ArkUI_AccessibleGridItemInfo* gridItem); 1192``` 1193 1194**描述:** 1195 1196设置Element的gridItem。 1197 1198**起始版本:** 13 1199 1200**参数:** 1201 1202| 名称 | 描述 | 1203| ----------- | ---------------------------------------------------- | 1204| elementInfo | Element结构。 | 1205| gridItem | 特定组件需要使用,如list、flex、select、swiper组件。 | 1206 1207**返回:** 1208 1209 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1210 1211 1212 1213### OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart 1214 1215``` 1216int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextStart(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextStart); 1217``` 1218 1219**描述:** 1220 1221设置Element的selectedTextStart。 1222 1223**起始版本:** 13 1224 1225**参数:** 1226 1227| 名称 | 描述 | 1228| ----------------- | ---------------------------------- | 1229| elementInfo | Element结构。 | 1230| selectedTextStart | 文本组件使用,设置选择的起点位置。 | 1231 1232**返回:** 1233 1234 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1235 1236 1237 1238### OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd 1239 1240```C 1241int32_t OH_ArkUI_AccessibilityElementInfoSetSelectedTextEnd(ArkUI_AccessibilityElementInfo* elementInfo, int32_t selectedTextEnd); 1242``` 1243 1244**描述:** 1245 1246设置Element的selectedTextEnd。 1247 1248**起始版本:** 13 1249 1250**参数:** 1251 1252| 名称 | 描述 | 1253| --------------- | ---------------------------------- | 1254| elementInfo | Element结构。 | 1255| selectedTextEnd | 文本组件使用,设置选择的结束位置。 | 1256 1257**返回:** 1258 1259 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1260 1261 1262 1263### OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex 1264 1265```C 1266int32_t OH_ArkUI_AccessibilityElementInfoSetCurrentItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t currentItemIndex); 1267``` 1268 1269**描述:** 1270 1271设置Element的currentItemIndex。 1272 1273**起始版本:** 13 1274 1275**参数:** 1276 1277| 名称 | 描述 | 1278| ---------------- | ------------------------------------------------------------ | 1279| elementInfo | Element结构。 | 1280| currentItemIndex | 当前项的索引,当前获焦组件的index信息。如,list、select、swiper、tab_bar等组件 | 1281 1282**返回:** 1283 1284 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1285 1286 1287 1288### OH_ArkUI_AccessibilityElementInfoSetStartItemIndex 1289 1290```C 1291int32_t OH_ArkUI_AccessibilityElementInfoSetStartItemIndex(ArkUI_AccessibilityElementInfo* elementInfo, int32_t startItemIndex); 1292``` 1293 1294**描述:** 1295 1296设置Element的startItemIndex。 1297 1298**起始版本:** 13 1299 1300**参数:** 1301 1302| 名称 | 描述 | 1303| -------------- | ------------------------------------------------------------ | 1304| elementInfo | Element结构。 | 1305| startItemIndex | 当前屏幕中显示的第一个item的index,当前获焦组件的index信息。如,list、select、swiper、tab_bar等组件。 | 1306 1307**返回:** 1308 1309 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1310 1311 1312 1313### OH_ArkUI_AccessibilityElementInfoSetEndItemIndex 1314 1315```C 1316int32_t OH_ArkUI_AccessibilityElementInfoSetEndItemIndex( 1317 ArkUI_AccessibilityElementInfo* elementInfo, int32_t endItemIndex); 1318``` 1319 1320**描述:** 1321 1322设置Element的endItemIndex。 1323 1324**起始版本:** 13 1325 1326**参数:** 1327 1328| 名称 | 描述 | 1329| ------------ | ------------------------------------------------------------ | 1330| elementInfo | Element结构。 | 1331| endItemIndex | 当前屏幕中显示的最后一个item的index,当前获焦组件的index信息。如,list、select、swiper、tab_bar等组件。 | 1332 1333**返回:** 1334 1335 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1336 1337 1338 1339### OH_ArkUI_AccessibilityElementInfoSetItemCount 1340 1341```C 1342int32_t OH_ArkUI_AccessibilityElementInfoSetItemCount( 1343 ArkUI_AccessibilityElementInfo* elementInfo, int32_t itemCount); 1344``` 1345 1346**描述:** 1347 1348设置Element的itemCount。 1349 1350**起始版本:** 13 1351 1352**参数:** 1353 1354| 名称 | 描述 | 1355| ----------- | --------------------------------------------------------- | 1356| elementInfo | Element结构。 | 1357| itemCount | 组件的item总数。如,list、select、swiper、tab_bar等组件。 | 1358 1359**返回:** 1360 1361 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1362 1363 1364 1365### OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset 1366 1367```C 1368int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOffset( 1369 ArkUI_AccessibilityElementInfo* elementInfo, int32_t offset); 1370``` 1371 1372**描述:** 1373 1374设置Element的offset。 1375 1376**起始版本:** 13 1377 1378**参数:** 1379 1380| 名称 | 描述 | 1381| ----------- | ------------------------------------------------------------ | 1382| elementInfo | Element结构。 | 1383| offset | 对于可滚动类组件,如list,grid,内容区相对组件的顶部坐标滚动的像素偏移量。 | 1384 1385**返回:** 1386 1387 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1388 1389 1390 1391### OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup 1392 1393```C 1394int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityGroup( 1395 ArkUI_AccessibilityElementInfo* elementInfo, bool accessibilityGroup); 1396``` 1397 1398**描述:** 1399 1400设置Element的accessibilityGroup。 1401 1402**起始版本:** 13 1403 1404**参数:** 1405 1406| 名称 | 描述 | 1407| ------------------ | ------------------------------------------------------------ | 1408| elementInfo | Element结构。 | 1409| accessibilityGroup | 无障碍组,设置为true时,表示该组件及其所有子组件为一整个可以选中的组件,无障碍服务将不再关注其子组件内容。 | 1410 1411**返回:** 1412 1413 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1414 1415 1416 1417### OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel 1418 1419```C 1420int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityLevel( 1421 ArkUI_AccessibilityElementInfo* elementInfo, const char* accessibilityLevel); 1422``` 1423 1424**描述:** 1425 1426设置Element的accessibilityLevel。 1427 1428**起始版本:** 13 1429 1430**参数:** 1431 1432| 名称 | 描述 | 1433| ------------------ | ------------------------------------------------------------ | 1434| elementInfo | Element结构。 | 1435| accessibilityLevel | 无障碍重要性,用于控制某个组件是否可被无障碍辅助服务所识别。 | 1436 1437**返回:** 1438 1439 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1440 1441 1442 1443### OH_ArkUI_AccessibilityElementInfoSetZIndex 1444 1445```C 1446int32_t OH_ArkUI_AccessibilityElementInfoSetZIndex( 1447 ArkUI_AccessibilityElementInfo* elementInfo, int32_t zIndex); 1448``` 1449 1450**描述:** 1451 1452设置Element的zIndex。 1453 1454**起始版本:** 13 1455 1456**参数:** 1457 1458| 名称 | 描述 | 1459| ----------- | ------------------------------------------------ | 1460| elementInfo | Element结构。 | 1461| zIndex | 组件z序,用于控制元素在垂直于屏幕的z轴上的位置。 | 1462 1463**返回:** 1464 1465 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1466 1467 1468 1469### OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity 1470 1471```C 1472int32_t OH_ArkUI_AccessibilityElementInfoSetAccessibilityOpacity( 1473 ArkUI_AccessibilityElementInfo* elementInfo, float opacity); 1474``` 1475 1476**描述:** 1477 1478设置Element的opacity。 1479 1480**起始版本:** 13 1481 1482**参数:** 1483 1484| 名称 | 描述 | 1485| ----------- | ------------------------------------------------------------ | 1486| elementInfo | Element结构。 | 1487| opacity | 组件透明度信息,其取值范围是0到1,其中1表示完全不透明,而0则表示完全透明。 | 1488 1489**返回:** 1490 1491 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1492 1493 1494 1495### OH_ArkUI_AccessibilityElementInfoSetBackgroundColor 1496 1497```C 1498int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundColor( 1499 ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundColor); 1500``` 1501 1502**描述:** 1503 1504设置Element的backgroundColor。 1505 1506**起始版本:** 13 1507 1508**参数:** 1509 1510| 名称 | 描述 | 1511| --------------- | ---------------- | 1512| elementInfo | Element结构。 | 1513| backgroundColor | 组件背景色信息。 | 1514 1515**返回:** 1516 1517 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1518 1519 1520 1521### OH_ArkUI_AccessibilityElementInfoSetBackgroundImage 1522 1523```C 1524int32_t OH_ArkUI_AccessibilityElementInfoSetBackgroundImage( 1525 ArkUI_AccessibilityElementInfo* elementInfo, const char* backgroundImage); 1526``` 1527 1528**描述:** 1529 1530设置Element的backgroundImage。 1531 1532**起始版本:** 13 1533 1534**参数:** 1535 1536| 名称 | 描述 | 1537| --------------- | ------------------ | 1538| elementInfo | Element结构。 | 1539| backgroundImage | 组件背景图片信息。 | 1540 1541**返回:** 1542 1543 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1544 1545 1546 1547### OH_ArkUI_AccessibilityElementInfoSetBlur 1548 1549```C 1550int32_t OH_ArkUI_AccessibilityElementInfoSetBlur( 1551 ArkUI_AccessibilityElementInfo* elementInfo, const char* blur); 1552``` 1553 1554**描述:** 1555 1556设置Element的blur。 1557 1558**起始版本:** 13 1559 1560**参数:** 1561 1562| 名称 | 描述 | 1563| ----------- | ---------------- | 1564| elementInfo | Element结构。 | 1565| blur | 组件模糊度信息。 | 1566 1567**返回:** 1568 1569 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1570 1571 1572 1573### OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior 1574 1575```C 1576int32_t OH_ArkUI_AccessibilityElementInfoSetHitTestBehavior( 1577 ArkUI_AccessibilityElementInfo* elementInfo, const char* hitTestBehavior); 1578``` 1579 1580**描述:** 1581 1582设置Element的hitTestBehavior。 1583 1584**起始版本:** 13 1585 1586**参数:** 1587 1588| 名称 | 描述 | 1589| --------------- | ------------------------------------------------------------ | 1590| elementInfo | Element结构。 | 1591| hitTestBehavior | hitTest模式。取值:<br/>HitTestMode.Default: 默认模式<br/>HitTestMode.Block:阻塞模式<br/>HitTestMode.Transparent:透传模式<br/>HitTestMode.None: 关闭模式 | 1592 1593**返回:** 1594 1595 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1596 1597 1598 1599### OH_ArkUI_CreateAccessibilityEventInfo 1600 1601```C 1602ArkUI_AccessibilityEventInfo* OH_ArkUI_CreateAccessibilityEventInfo(void); 1603``` 1604 1605**描述:** 1606 1607创建eventInfo结构,创建后需要调用OH_ArkUI_DestoryAccessibilityEventInfo释放。 1608 1609**起始版本:** 13 1610 1611**返回:** 1612 1613返回创建完成的ArkUI_AccessibilityEventInfo结构指针,如果创建失败返回NULL。 1614 1615### OH_ArkUI_DestoryAccessibilityEventInfo 1616 1617```C 1618void OH_ArkUI_DestoryAccessibilityEventInfo(ArkUI_AccessibilityEventInfo* eventInfo); 1619``` 1620 1621**描述:** 1622 1623销毁eventInfo结构。 1624 1625**起始版本:** 13 1626 1627**参数:** 1628 1629| 名称 | 描述 | 1630| --------- | --------------------------------- | 1631| eventInfo | 需要删除释放的eventInfo结构指针。 | 1632 1633**返回:** 无 1634 1635 1636 1637### OH_ArkUI_AccessibilityEventSetEventType 1638 1639```C 1640int32_t OH_ArkUI_AccessibilityEventSetEventType( 1641 ArkUI_AccessibilityEventInfo* eventInfo, ArkUI_AccessibilityEventType eventType); 1642``` 1643 1644**描述:** 1645 1646设置eventInfo结构的eventType。 1647 1648**起始版本:** 13 1649 1650**参数:** 1651 1652| 名称 | 描述 | 1653| --------- | ------------------------------------------------------------ | 1654| eventInfo | eventInfo结构指针。 | 1655| eventType | 事件类型[ArkUI_AccessibilityEventType](#arkui_accessibilityeventtype)。 | 1656 1657**返回:** 1658 1659 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1660 1661 1662 1663### OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility 1664 1665```C 1666int32_t OH_ArkUI_AccessibilityEventSetTextAnnouncedForAccessibility( 1667 ArkUI_AccessibilityEventInfo* eventInfo, const char* textAnnouncedForAccessibility); 1668``` 1669 1670**描述:** 1671 1672设置eventInfo结构的textAnnouncedForAccessibility。 1673 1674**起始版本:** 13 1675 1676**参数:** 1677 1678| 名称 | 描述 | 1679| ----------------------------- | ------------------------------------------------------------ | 1680| eventInfo | eventInfo结构指针。 | 1681| textAnnouncedForAccessibility | 当发送主动播报事件时,需要播报的内容。事件类型:ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_VIEW_ANNOUNCE_FOR_ACCESSIBILITY | 1682 1683**返回:** 1684 1685 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1686 1687 1688 1689### OH_ArkUI_AccessibilityEventSetRequestFocusId 1690 1691``` 1692int32_t OH_ArkUI_AccessibilityEventSetRequestFocusId( 1693 ArkUI_AccessibilityEventInfo* eventInfo, int32_t requestFocusId); 1694``` 1695 1696**描述:** 1697 1698设置eventInfo结构的requestFocusId。 1699 1700**起始版本:** 13 1701 1702**参数:** 1703 1704| 名称 | 描述 | 1705| -------------- | ------------------------------------------------------------ | 1706| eventInfo | eventInfo结构指针。 | 1707| requestFocusId | 当发送主动聚焦事件时,聚焦的节点id。聚焦需要保障不能变化。事件类型:ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_VIEW_REQUEST_FOCUS_FOR_ACCESSIBILITY | 1708 1709**返回:** 1710 1711 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1712 1713 1714 1715### OH_ArkUI_AccessibilityEventSetElementInfo 1716 1717```C 1718int32_t OH_ArkUI_AccessibilityEventSetElementInfo( 1719 ArkUI_AccessibilityEventInfo* eventInfo, ArkUI_AccessibilityElementInfo* elementInfo); 1720``` 1721 1722**描述:** 1723 1724设置eventInfo结构的elementInfo。 1725 1726**起始版本:** 13 1727 1728**参数:** 1729 1730| 名称 | 描述 | 1731| ----------- | ------------------------ | 1732| eventInfo | eventInfo结构指针。 | 1733| elementInfo | 设置发送事件的组件信息。 | 1734 1735**返回:** 1736 1737 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1738 1739 1740 1741### OH_ArkUI_FindAccessibilityActionArgumentByKey 1742 1743``` 1744int32_t OH_ArkUI_FindAccessibilityActionArgumentByKey( 1745 ArkUI_AccessibilityActionArguments* arguments, const char* key, char** value); 1746``` 1747 1748**描述:** 1749 1750获取ArkUI_AccessibilityActionArguments中指定key的value值。 1751 1752**起始版本:** 13 1753 1754**参数:** 1755 1756| 名称 | 描述 | 1757| --------- | ---------------------- | 1758| arguments | action辅助参数内容。 | 1759| key | 指定key。 | 1760| value | 指定key对应的value值。 | 1761 1762**返回:** 1763 1764 [ArkUI_AcessbilityErrorCode](#arkui_acessbilityerrorcode) 1765 1766 1767 1768## 枚举类型说明 1769 1770### ArkUI_AcessbilityErrorCode 1771 1772**描述:** 1773 1774错误码定义。 1775 1776| 枚举值 | 描述 | 1777| ----------------------------------------------- | ---------- | 1778| ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESS | 成功。 | 1779| ARKUI_ACCESSIBILITY_NATIVE_RESULT_FAILED | 失败。 | 1780| ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER | 参数错误。 | 1781| ARKUI_ACCESSIBILITY_NATIVE_RESULT_OUT_OF_MEMORY | 内存不足。 | 1782 1783**起始版本:** 1784 178513 1786 1787### ArkUI_AccessibilitySearchMode 1788 1789**描述:** 1790 1791查询模式。 1792 1793| 枚举值 | 描述 | 1794| ------------------------------------------------------------ | -------------------------------------------------------- | 1795| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_CURRENT | 只查询指定节点信息。 | 1796| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_PREDECESSORS | 查询父组件。查询结果包含指定节点信息。 | 1797| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_SIBLINGS | 查询兄弟节点组件。查询结果包含指定节点信息。 | 1798| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_CHILDREN | 查询当前节点的下一层孩子节点。查询结果包含指定节点信息。 | 1799| ARKUI_ACCESSIBILITY_NATIVE_SEARCH_MODE_PREFETCH_RECURSIVE_CHILDREN | 查询当前节点的所有孩子节点。查询结果包含指定节点信息。 | 1800 1801**起始版本:** 1802 180313 1804 1805### ArkUI_AccessibilityFocusType 1806 1807**描述:** 1808 1809焦点类型。 1810 1811| 枚举值 | 描述 | 1812| --------------------------------------------------- | ---------------- | 1813| ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INVALID | 无效值。 | 1814| ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_INPUT | 组件获焦类型。 | 1815| ARKUI_ACCESSIBILITY_NATIVE_FOCUS_TYPE_ACCESSIBILITY | 无障碍获焦类型。 | 1816 1817**起始版本:** 1818 181913 1820 1821### ArkUI_Accessibility_ActionType 1822 1823**描述:** 1824 1825执行操作类型。 1826 1827| 枚举值 | 描述 | 1828| ----------------------------------------------------------- | ------------------------------------------------------------ | 1829| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_INVALID | 无效值。 | 1830| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CLICK | 点击事件。 | 1831| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_LONG_CLICK | 长按事件。 | 1832| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_GAIN_ACCESSIBILITY_FOCUS | 执行无障碍节点获焦。 | 1833| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CLEAR_ACCESSIBILITY_FOCUS | 清除无障碍节点获焦状态。 | 1834| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SCROLL_FORWARD | 支持滚动的组件向前滚动。 | 1835| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SCROLL_BACKWARD | 支持滚动的组件向后滚动。 | 1836| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_COPY | 针对文本组件支持选中内容的拷贝。 | 1837| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_PASTE | 针对文本组件在光标所在位置粘贴。 | 1838| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_CUT | 针对文本组件支持选中内容的剪切。 | 1839| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SELECT_TEXT | 针对文本组件进行选择操作。结合[ArkUI_AccessibilityActionArguments](#arkui_accessibilityactionarguments)使用,配置selectTextStart,selectTextEnd,selectTextInForWard。进入编辑区选择一段文本内容。 | 1840| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SET_TEXT | 针对文本组件设置文本内容。 | 1841| ARKUI_ACCESSIBILITY_NATIVE_ACTION_TYPE_SET_CURSOR_POSITION | 针对文本组件设置光标位置。结合[ArkUI_AccessibilityActionArguments](#arkui_accessibilityactionarguments)使用,配置offset设置位置。 | 1842 1843**起始版本:** 1844 184513 1846 1847### ArkUI_AccessibilityEventType 1848 1849**描述:** 1850 1851事件类型。 1852 1853| 枚举值 | 描述 | 1854| ------------------------------------------------------------ | ------------------------------------------------ | 1855| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_INVALID | 无效值。 | 1856| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_CLICKED | 被点击事件。 | 1857| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_LONG_CLICKED | 被长按事件。 | 1858| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_SELECTED | 被选中事件。 | 1859| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_TEXT_UPDATE | 文本更新时需发送事件。 | 1860| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_STATE_UPDATE | 页面跳转、切换、大小变化、移动等需要发送该事件。 | 1861| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_CONTENT_UPDATE | 页面内容发生变化时需要发送该事件。 | 1862| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_SCROLLED | 可以滚动的组件发生滚动事件时需要发送该事件。 | 1863| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ACCESSIBILITY_FOCUSED | 被无障碍聚焦事件。 | 1864| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ACCESSIBILITY_FOCUS_CLEARED | 清除无障碍聚焦事件。 | 1865| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_REQUEST_ACCESSIBILITY_FOCUS | 主动请求指定节点聚焦。 | 1866| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_OPEN | 页面关闭时需要发送该事件。 | 1867| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_PAGE_CLOSE | 页面打开时需要发送该事件。 | 1868| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_ANNOUNCE_FOR_ACCESSIBILITY | 请求主动播报指定内容的事件。 | 1869| ARKUI_ACCESSIBILITY_NATIVE_EVENT_TYPE_FOCUS_NODE_UPDATE | 获焦组件发生位置或大小变化时需要发生事件。 | 1870 1871**起始版本:** 1872 187313 1874 1875### ArkUI_AccessibilityFocusMoveDirection 1876 1877**描述:** 1878 1879焦点移动方向。 1880 1881| 枚举值 | 描述 | 1882| --------------------------------------------- | ------------------------------------ | 1883| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_INVALID | 无效值。 | 1884| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_UP | 焦点向上移动。 | 1885| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_DOWN | 焦点向下移动。 | 1886| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_LEFT | 焦点向左移动。 | 1887| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_RIGHT | 焦点向右移动。 | 1888| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_FORWARD | 焦点向前移动,基于查询结果中的关系。 | 1889| ARKUI_ACCESSIBILITY_NATIVE_DIRECTION_BACKWARD | 焦点向前移动,基于查询结果中的关系。 | 1890 1891**起始版本:** 1892 189313