• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# native_type.h
2<!--Kit: ArkUI-->
3<!--Subsystem: ArkUI-->
4<!--Owner: @piggyguy; @xiang-shouxing; @yangfan229-->
5<!--Designer: @piggyguy; @xiang-shouxing; @yangfan229-->
6<!--Tester: @fredyuan912-->
7<!--Adviser: @HelloCrease-->
8
9## 概述
10
11提供NativeModule公共的类型定义。
12
13**引用文件:** <arkui/native_type.h>
14
15**库:** libace_ndk.z.so
16
17**系统能力:** SystemCapability.ArkUI.ArkUI.Full
18
19**起始版本:** 12
20
21**相关模块:** [ArkUI_NativeModule](capi-arkui-nativemodule.md)
22
23## 汇总
24
25### 结构体
26
27| 名称 | typedef关键字 | 描述 |
28| -- | -- | -- |
29| [ArkUI_ContextCallback](capi-arkui-nativemodule-arkui-contextcallback.md) | ArkUI_ContextCallback | 事件回调类型。 |
30| [ArkUI_NumberValue](capi-arkui-nativemodule-arkui-numbervalue.md) | ArkUI_NumberValue | ArkUI在Native侧的数字类型定义。 |
31| [ARKUI_TextPickerRangeContent](capi-arkui-nativemodule-arkui-textpickerrangecontent.md) | ARKUI_TextPickerRangeContent | 定义单列滑动数据选择器支持的图片资源结构体。 |
32| [ARKUI_TextPickerCascadeRangeContent](capi-arkui-nativemodule-arkui-textpickercascaderangecontent.md) | ARKUI_TextPickerCascadeRangeContent | 定义多列联动滑动数据选择器的结构体。 |
33| [ArkUI_ColorStop](capi-arkui-nativemodule-arkui-colorstop.md) | ArkUI_ColorStop | 定义渐变色结构。 |
34| [ArkUI_Rect](capi-arkui-nativemodule-arkui-rect.md) | ArkUI_Rect | 定义遮罩屏蔽区域的范围结构体。 |
35| [ArkUI_IntSize](capi-arkui-nativemodule-arkui-intsize.md) | ArkUI_IntSize | 尺寸类型,用于描述组件的宽高。 |
36| [ArkUI_IntOffset](capi-arkui-nativemodule-arkui-intoffset.md) | ArkUI_IntOffset | 位置,用于描述组件的位置。 |
37| [ArkUI_Margin](capi-arkui-nativemodule-arkui-margin.md) | ArkUI_Margin | 外边距属性,用于描述组件的外边距属性。 |
38| [ArkUI_TranslationOptions](capi-arkui-nativemodule-arkui-translationoptions.md) | ArkUI_TranslationOptions | 定义组件转场时的平移效果对象。 |
39| [ArkUI_ScaleOptions](capi-arkui-nativemodule-arkui-scaleoptions.md) | ArkUI_ScaleOptions | 定义组件转场时的缩放效果对象。 |
40| [ArkUI_RotationOptions](capi-arkui-nativemodule-arkui-rotationoptions.md) | ArkUI_RotationOptions | 定义组件转场时的旋转效果对象。 |
41| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md) | ArkUI_LayoutConstraint | 约束尺寸,组件布局时,进行尺寸范围限制。 |
42| [ArkUI_DrawContext](capi-arkui-nativemodule-arkui-drawcontext.md) | ArkUI_DrawContext | 定义组件绘制上下文类型结构。 |
43| [ArkUI_Node*](capi-arkui-nativemodule-arkui-node8h.md) | ArkUI_NodeHandle | 定义ArkUI native组件实例对象指针定义。 |
44| [ArkUI_NativeDialog*](capi-arkui-nativemodule-arkui-nativedialog8h.md) | ArkUI_NativeDialogHandle | 定义ArkUI在Native侧的自定义弹窗控制器对象指针。 |
45| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md) | ArkUI_WaterFlowSectionOption | 定义FlowItem分组配置信息。 |
46| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md) | ArkUI_ListItemSwipeActionItem | 定义ListItemSwipeActionOption方法内Item的配置信息。 |
47| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md) | ArkUI_ListItemSwipeActionOption | 定义ListItemSwipeActionOption方法的配置信息。 |
48| [ArkUI_Context*](capi-arkui-nativemodule-arkui-context8h.md) | ArkUI_ContextHandle | 定义ArkUI native UI的上下文实例对象指针定义。 |
49| [ArkUI_NodeContent*](capi-arkui-nativemodule-arkui-nodecontent8h.md) | ArkUI_NodeContentHandle | 定义ArkUI NodeContent实例在Native侧的实例对象指针定义。 |
50| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md) | ArkUI_AlignmentRuleOption | 指定设置在相对容器中子组件的对齐规则。 |
51| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md) | ArkUI_GuidelineOption | guideLine参数,用于定义guideline的id、方向和位置。 |
52| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md) | ArkUI_BarrierOption | barrier参数,用于定义barrier的id、方向和生成时所依赖的组件。 |
53| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md) | ArkUI_ImageAnimatorFrameInfo | 定义图片帧信息。 |
54| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md) | ArkUI_ListChildrenMainSize | 定义List的ChildrenMainSize类信息。 |
55| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md) | ArkUI_ProgressLinearStyleOption | 定义线性进度条样式。 |
56| [ArkUI_CustomProperty](capi-arkui-nativemodule-arkui-customproperty.md) | ArkUI_CustomProperty | 定义自定义属性的CustomProperty类信息。 |
57| [ArkUI_HostWindowInfo](capi-arkui-nativemodule-arkui-hostwindowinfo.md) | ArkUI_HostWindowInfo | 定义窗口属性的HostWindowInfo类信息。 |
58| [ArkUI_ActiveChildrenInfo](capi-arkui-nativemodule-arkui-activechildreninfo.md) | ArkUI_ActiveChildrenInfo | 定义ActiveChildrenInfo类信息。 |
59| [ArkUI_CrossLanguageOption](capi-arkui-nativemodule-arkui-crosslanguageoption.md) | ArkUI_CrossLanguageOption | 定义跨语言配置项。 |
60| [AbilityBase_Want](capi-arkui-nativemodule-abilitybase-want.md) | AbilityBase_Want | 声明want。 |
61| [ArkUI_EmbeddedComponentOption](capi-arkui-nativemodule-arkui-embeddedcomponentoption.md) | ArkUI_EmbeddedComponentOption | 为EmbeddedComponent定义EmbeddedComponentOption。 |
62| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md) | ArkUI_AccessibilityState | 定义组件无障碍状态。 |
63| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md) | ArkUI_AccessibilityValue | 定义组件无障碍信息值。 |
64| [ArkUI_SystemFontStyleEvent](capi-arkui-nativemodule-arkui-systemfontstyleevent.md) | ArkUI_SystemFontStyleEvent | 系统字体变更事件定义。 |
65| [ArkUI_CustomSpanMeasureInfo](capi-arkui-nativemodule-arkui-customspanmeasureinfo.md) | ArkUI_CustomSpanMeasureInfo | 自定义段落组件的测量信息。 |
66| [ArkUI_CustomSpanMetrics](capi-arkui-nativemodule-arkui-customspanmetrics.md) | ArkUI_CustomSpanMetrics | 自定义段落组件的度量指标。 |
67| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md) | ArkUI_CustomSpanDrawInfo | 自定义段落组件的绘制信息。 |
68| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md) | ArkUI_SwiperIndicator | 定义 Swiper 组件的导航指示器风格。 |
69| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md) | ArkUI_SwiperDigitIndicator | 定义 Swiper 组件的数字导航指示器风格。 |
70| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md) | ArkUI_SwiperArrowStyle | 定义 Swiper 组件的导航箭头风格。 |
71| [ArkUI_StyledString_Descriptor](capi-arkui-nativemodule-arkui-styledstring-descriptor.md) | ArkUI_StyledString_Descriptor | 定义文本组件支持的属性字符串的数据对象。 |
72| [ArkUI_SnapshotOptions](capi-arkui-nativemodule-arkui-snapshotoptions.md) | ArkUI_SnapshotOptions | 定义截图的可选项。 |
73| [ArkUI_TextPickerRangeContentArray](capi-arkui-nativemodule-arkui-textpickerrangecontentarray.md) | ArkUI_TextPickerRangeContentArray | 定义文本选择器的数据选择列表。 |
74| [ArkUI_TextCascadePickerRangeContentArray](capi-arkui-nativemodule-arkui-textcascadepickerrangecontentarray.md) | ArkUI_TextCascadePickerRangeContentArray | 定义多列联动数据选择器的多列联动数据选择列表。 |
75| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md) | ArkUI_VisibleAreaEventOptions | 可见区域变化监听的参数。 |
76
77### 枚举
78
79| 名称                                                                  | typedef关键字                      | 描述                                |
80|---------------------------------------------------------------------|---------------------------------|-----------------------------------|
81| [ArkUI_Alignment](#arkui_alignment)                                 | ArkUI_Alignment                 | 定义布局对齐枚举值。                        |
82| [ArkUI_ImageRepeat](#arkui_imagerepeat)                             | ArkUI_ImageRepeat               | 定义图片重复铺设枚举值。                      |
83| [ArkUI_FontStyle](#arkui_fontstyle)                                 | ArkUI_FontStyle                 | 定义字体样式枚举值。                        |
84| [ArkUI_FontWeight](#arkui_fontweight)                               | ArkUI_FontWeight                | 定义字体粗细/字重枚举值。                     |
85| [ArkUI_TextAlignment](#arkui_textalignment)                         | ArkUI_TextAlignment             | 定义字体水平对齐样式枚举值。                    |
86| [ArkUI_TextVerticalAlignment](#arkui_textverticalalignment)         | ArkUI_TextVerticalAlignment     | 定义文本垂直对齐样式枚举值。                    |
87| [ArkUI_EnterKeyType](#arkui_enterkeytype)                           | ArkUI_EnterKeyType              | 定义单行文本输入法回车键类型枚举值。                |
88| [ArkUI_TextInputType](#arkui_textinputtype)                         | ArkUI_TextInputType             | 定义单行文本输入法类型枚举值。                   |
89| [ArkUI_TextAreaType](#arkui_textareatype)                           | ArkUI_TextAreaType              | 定义多行文本输入法类型枚举值。                   |
90| [ArkUI_CancelButtonStyle](#arkui_cancelbuttonstyle)                 | ArkUI_CancelButtonStyle         | 定义清除按钮样式枚举值。                      |
91| [ArkUI_XComponentType](#arkui_xcomponenttype)                       | ArkUI_XComponentType            | 定义XComponent类型枚举值。                |
92| [ArkUI_ProgressType](#arkui_progresstype)                           | ArkUI_ProgressType              | 定义进度条类型枚举值。                       |
93| [ArkUI_TextDecorationType](#arkui_textdecorationtype)               | ArkUI_TextDecorationType        | 定义装饰线类型枚举值。                       |
94| [ArkUI_TextDecorationStyle](#arkui_textdecorationstyle)             | ArkUI_TextDecorationStyle       | 定义装饰线样式枚举值。                       |
95| [ArkUI_TextCase](#arkui_textcase)                                   | ArkUI_TextCase                  | 定义文本大小写枚举值。                       |
96| [ArkUI_CopyOptions](#arkui_copyoptions)                             | ArkUI_CopyOptions               | 定义文本复制粘贴模式枚举值。                    |
97| [ArkUI_ShadowType](#arkui_shadowtype)                               | ArkUI_ShadowType                | 定义阴影类型枚举值。                        |
98| [ArkUI_DatePickerMode](#arkui_datepickermode)                       | ArkUI_DatePickerMode            | 定义日期选择器列显示模式的枚举值。                 |
99| [ArkUI_TextPickerRangeType](#arkui_textpickerrangetype)             | ArkUI_TextPickerRangeType       | 定义滑动选择文本选择器输入类型。                  |
100| [ArkUI_AccessibilityCheckedState](#arkui_accessibilitycheckedstate) | ArkUI_AccessibilityCheckedState | 定义无障碍复选框状态类型枚举值。                  |
101| [ArkUI_AccessibilityActionType](#arkui_accessibilityactiontype)     | ArkUI_AccessibilityActionType   | 定义无障碍操作类型。                        |
102| [ArkUI_EdgeEffect](#arkui_edgeeffect)                               | ArkUI_EdgeEffect                | 定义边缘滑动效果枚举值。                      |
103| [ArkUI_EffectEdge](#arkui_effectedge)                               | ArkUI_EffectEdge                | 定义边缘效果生效边缘的方向枚举值。                 |
104| [ArkUI_ScrollDirection](#arkui_scrolldirection)                     | ArkUI_ScrollDirection           | 定义Scroll组件排列方向枚举值。                |
105| [ArkUI_ScrollSnapAlign](#arkui_scrollsnapalign)                     | ArkUI_ScrollSnapAlign           | 定义列表项滚动结束对齐效果枚举值。                 |
106| [ArkUI_ScrollBarDisplayMode](#arkui_scrollbardisplaymode)           | ArkUI_ScrollBarDisplayMode      | 定义滚动条状态枚举值。                       |
107| [ArkUI_Axis](#arkui_axis)                                           | ArkUI_Axis                      | 定义滚动方向和List组件排列方向枚举值。             |
108| [ArkUI_StickyStyle](#arkui_stickystyle)                             | ArkUI_StickyStyle               | 定义列表是否吸顶和吸底枚举值。                   |
109| [ArkUI_ContentClipMode](#arkui_contentclipmode)                     | ArkUI_ContentClipMode           | 定义滚动容器的内容层裁剪区域枚举值。                |
110| [ArkUI_WaterFlowLayoutMode](#arkui_waterflowlayoutmode)             | ArkUI_WaterFlowLayoutMode       | 定义WaterFlow组件布局模式枚举值。             |
111| [ArkUI_BorderStyle](#arkui_borderstyle)                             | ArkUI_BorderStyle               | 边框线条样式枚举值。                        |
112| [ArkUI_HitTestMode](#arkui_hittestmode)                             | ArkUI_HitTestMode               | 触摸测试控制枚举值。                        |
113| [ArkUI_ShadowStyle](#arkui_shadowstyle)                             | ArkUI_ShadowStyle               | 阴影效果枚举值。                          |
114| [ArkUI_AnimationCurve](#arkui_animationcurve)                       | ArkUI_AnimationCurve            | 动画曲线枚举值。                          |
115| [ArkUI_SwiperArrow](#arkui_swiperarrow)                             | ArkUI_SwiperArrow               | Swiper导航点箭头枚举值。                   |
116| [ArkUI_SwiperNestedScrollMode](#arkui_swipernestedscrollmode)       | ArkUI_SwiperNestedScrollMode    | Swiper组件和父组件的嵌套滚动模式。              |
117| [ArkUI_PageFlipMode](#arkui_pageflipmode)                           | ArkUI_PageFlipMode              | Swiper组件鼠标滚轮翻页模式。                 |
118| [ArkUI_SwiperAnimationMode](#arkui_swiperanimationmode)             | ArkUI_SwiperAnimationMode       | Swiper组件跳转到目标index的动画模式。          |
119| [ArkUI_AccessibilityMode](#arkui_accessibilitymode)                 | ArkUI_AccessibilityMode         | 定义无障碍辅助服务模式。                      |
120| [ArkUI_TextCopyOptions](#arkui_textcopyoptions)                     | ArkUI_TextCopyOptions           | 定义组件支持设置文本是否可复制粘贴。                |
121| [ArkUI_TextHeightAdaptivePolicy](#arkui_textheightadaptivepolicy)   | ArkUI_TextHeightAdaptivePolicy  | 定义文本自适应高度的方式。                     |
122| [ArkUI_ScrollNestedMode](#arkui_scrollnestedmode)                   | ArkUI_ScrollNestedMode          | 定义嵌套滚动选项。                         |
123| [ArkUI_ScrollEdge](#arkui_scrolledge)                               | ArkUI_ScrollEdge                | 定义滚动到的边缘位置。                       |
124| [ArkUI_ScrollAlignment](#arkui_scrollalignment)                     | ArkUI_ScrollAlignment           | 滚动到具体item时的对齐方式。                  |
125| [ArkUI_ScrollState](#arkui_scrollstate)                             | ArkUI_ScrollState               | 定义当前滚动状态。                         |
126| [ArkUI_SliderBlockStyle](#arkui_sliderblockstyle)                   | ArkUI_SliderBlockStyle          | 定义滑块形状。                           |
127| [ArkUI_SliderDirection](#arkui_sliderdirection)                     | ArkUI_SliderDirection           | 定义滑动条滑动方向。                        |
128| [ArkUI_SliderStyle](#arkui_sliderstyle)                             | ArkUI_SliderStyle               | 定义滑块与滑轨显示样式。                      |
129| [ArkUI_CheckboxShape](#arkui_checkboxshape)                         | ArkUI_CheckboxShape             | 定义CheckBox组件形状。                   |
130| [ArkUI_AnimationPlayMode](#arkui_animationplaymode)                 | ArkUI_AnimationPlayMode         | 定义动画播放模式。                         |
131| [ArkUI_ImageSize](#arkui_imagesize)                                 | ArkUI_ImageSize                 | 定义图片宽高样式。                         |
132| [ArkUI_AdaptiveColor](#arkui_adaptivecolor)                         | ArkUI_AdaptiveColor             | 定义取色模式。                           |
133| [ArkUI_ColorMode](#arkui_colormode)                                 | ArkUI_ColorMode                 | 定义深浅色模式。                          |
134| [ArkUI_SystemColorMode](#arkui_systemcolormode)                     | ArkUI_SystemColorMode           | 定义系统深浅色模式。                        |
135| [ArkUI_BlurStyle](#arkui_blurstyle)                                 | ArkUI_BlurStyle                 | 定义背景模糊样式。                         |
136| [ArkUI_BlurStyleActivePolicy](#arkui_blurstyleactivepolicy)         | ArkUI_BlurStyleActivePolicy     | 定义背景模糊激活策略。                       |
137| [ArkUI_VerticalAlignment](#arkui_verticalalignment)                 | ArkUI_VerticalAlignment         | 定义垂直对齐方式。                         |
138| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment)             | ArkUI_HorizontalAlignment       | 定义语言方向对齐方式。                       |
139| [ArkUI_TextOverflow](#arkui_textoverflow)                           | ArkUI_TextOverflow              | 定义文本超长时的显示方式。                     |
140| [ArkUI_ImageSpanAlignment](#arkui_imagespanalignment)               | ArkUI_ImageSpanAlignment        | 定义图片基于文本的对齐方式。                    |
141| [ArkUI_ObjectFit](#arkui_objectfit)                                 | ArkUI_ObjectFit                 | 定义image填充效果。ImageSpanAlignment    |
142| [ArkUI_ImageInterpolation](#arkui_imageinterpolation)               | ArkUI_ImageInterpolation        | 定义图片插值效果。                         |
143| [ArkUI_BlendMode](#arkui_blendmode)                                 | ArkUI_BlendMode                 | 混合模式枚举值。                          |
144| [ArkUI_Direction](#arkui_direction)                                 | ArkUI_Direction                 | 设置容器元素内主轴方向上的布局枚举值。               |
145| [ArkUI_ItemAlignment](#arkui_itemalignment)                         | ArkUI_ItemAlignment             | 设置子组件在父容器交叉轴的对齐格式枚举值。             |
146| [ArkUI_ColorStrategy](#arkui_colorstrategy)                         | ArkUI_ColorStrategy             | 前景色枚举值。                           |
147| [ArkUI_FlexAlignment](#arkui_flexalignment)                         | ArkUI_FlexAlignment             | 定义垂直方向对齐方式。                       |
148| [ArkUI_FlexDirection](#arkui_flexdirection)                         | ArkUI_FlexDirection             | 定义Flex容器的主轴方向。                    |
149| [ArkUI_FlexWrap](#arkui_flexwrap)                                   | ArkUI_FlexWrap                  | 定义Flex行列布局模式模式。                   |
150| [ArkUI_Visibility](#arkui_visibility)                               | ArkUI_Visibility                | 控制组件的显隐枚举值。                       |
151| [ArkUI_CalendarAlignment](#arkui_calendaralignment)                 | ArkUI_CalendarAlignment         | 日历选择器与入口组件对齐方式。                   |
152| [ArkUI_MaskType](#arkui_masktype)                                   | ArkUI_MaskType                  | 遮罩类型枚举。                           |
153| [ArkUI_ClipType](#arkui_cliptype)                                   | ArkUI_ClipType                  | 裁剪类型枚举。                           |
154| [ArkUI_ShapeType](#arkui_shapetype)                                 | ArkUI_ShapeType                 | 自定义形状。                            |
155| [ArkUI_LinearGradientDirection](#arkui_lineargradientdirection)     | ArkUI_LinearGradientDirection   | 定义渐变方向结构。                         |
156| [ArkUI_WordBreak](#arkui_wordbreak)                                 | ArkUI_WordBreak                 | 定义文本断行规则。                         |
157| [ArkUI_EllipsisMode](#arkui_ellipsismode)                           | ArkUI_EllipsisMode              | 定义文本省略位置。                         |
158| [ArkUI_ImageRenderMode](#arkui_imagerendermode)                     | ArkUI_ImageRenderMode           | 定义图片渲染模式。                         |
159| [ArkUI_TransitionEdge](#arkui_transitionedge)                       | ArkUI_TransitionEdge            | 定义转场从边缘滑入和滑出的效果。                  |
160| [ArkUI_FinishCallbackType](#arkui_finishcallbacktype)               | ArkUI_FinishCallbackType        | 在动画中定义onFinish回调的类型。              |
161| [ArkUI_ListItemAlignment](#arkui_listitemalignment)                 | ArkUI_ListItemAlignment         | 交叉轴方向的布局方式。                       |
162| [ArkUI_BlendApplyType](#arkui_blendapplytype)                       | ArkUI_BlendApplyType            | 指定的混合模式应用于视图的内容选项.                |
163| [ArkUI_LengthMetricUnit](#arkui_lengthmetricunit)                   | ArkUI_LengthMetricUnit          | 定义组件的单位模式。                        |
164| [ArkUI_TextInputContentType](#arkui_textinputcontenttype)           | ArkUI_TextInputContentType      | 定义自动填充类型。                         |
165| [ArkUI_BarrierDirection](#arkui_barrierdirection)                   | ArkUI_BarrierDirection          | 定义屏障线的方向。                         |
166| [ArkUI_RelativeLayoutChainStyle](#arkui_relativelayoutchainstyle)   | ArkUI_RelativeLayoutChainStyle  | 定义链的风格。                           |
167| [ArkUI_TextInputStyle](#arkui_textinputstyle)                       | ArkUI_TextInputStyle            | 定义输入框风格。                          |
168| [ArkUI_KeyboardAppearance](#arkui_keyboardappearance)               | ArkUI_KeyboardAppearance        | 定义输入框拉起的键盘样式。                     |
169| [ArkUI_TextDataDetectorType](#arkui_textdatadetectortype)           | ArkUI_TextDataDetectorType      | 定义文本识别的实体类型。                      |
170| [ArkUI_ButtonType](#arkui_buttontype)                               | ArkUI_ButtonType                | 定义按钮样式枚举值。                        |
171| [ArkUI_RenderFit](#arkui_renderfit)                                 | ArkUI_RenderFit   | 定义动画终态内容大小与位置的枚举值。 |
172| [ArkUI_SwiperIndicatorType](#arkui_swiperindicatortype)             | ArkUI_SwiperIndicatorType       | 定义 Swiper 组件的导航指示器类型。             |
173| [ArkUI_AnimationDirection](#arkui_animationdirection)               | ArkUI_AnimationDirection        | 动画播放模式。                           |
174| [ArkUI_ListItemSwipeActionState](#arkui_listitemswipeactionstate)   | ArkUI_ListItemSwipeActionState  | 定义 Listitem 组件SwipeAction方法的显隐模式。 |
175| [ArkUI_ListItemSwipeEdgeEffect](#arkui_listitemswipeedgeeffect)     | ArkUI_ListItemSwipeEdgeEffect   | 定义 Listitem 组件SwipeAction方法的滚动模式。 |
176| [ArkUI_AnimationStatus](#arkui_animationstatus)                     | ArkUI_AnimationStatus           | 定义帧动画的播放状态。                       |
177| [ArkUI_AnimationFillMode](#arkui_animationfillmode)                 | ArkUI_AnimationFillMode         | 定义帧动画组件在动画开始前和结束后的状态。             |
178| [ArkUI_ErrorCode](#arkui_errorcode)                                 | ArkUI_ErrorCode                 | 定义错误码枚举值。                         |
179| [ArkUI_ScrollSource](#arkui_scrollsource)                           | ArkUI_ScrollSource              | 定义滚动来源枚举值。                        |
180| [ArkUI_SafeAreaType](#arkui_safeareatype)                           | ArkUI_SafeAreaType              | 定义扩展安全区域的枚举值。                     |
181| [ArkUI_SafeAreaEdge](#arkui_safeareaedge)                           | ArkUI_SafeAreaEdge              | 定义扩展安全区域的方向的枚举值。                  |
182| [ArkUI_FocusMove](#arkui_focusmove)                                 | ArkUI_FocusMove                 | 定义焦点移动方向的枚举值。                     |
183| [ArkUI_ListItemGroupArea](#arkui_listitemgrouparea)                 | ArkUI_ListItemGroupArea         | 定义 ListItemGroup 组件区域。            |
184| [ArkUI_KeyboardAvoidMode](#arkui_keyboardavoidmode)                 | ArkUI_KeyboardAvoidMode         | 键盘避让模式。                           |
185| [ArkUI_HoverModeAreaType](#arkui_hovermodeareatype)                 | ArkUI_HoverModeAreaType         | 悬停态显示区域。                          |
186| [ArkUI_ExpandMode](#arkui_expandmode)                               | ArkUI_ExpandMode                | 定义子节点展开模式枚举值。                     |
187| [ArkUI_NavDestinationState](#arkui_navdestinationstate)             | ArkUI_NavDestinationState       | 定义NavDestination组件的状态。            |
188| [ArkUI_RouterPageState](#arkui_routerpagestate)                     | ArkUI_RouterPageState           | 定义Router Page的状态。                 |
189| [ArkUI_UIState](#arkui_uistate)                                     | ArkUI_UIState                   | 组件的UI状态枚举,用于处理状态样式。               |
190| [ArkUI_FocusWrapMode](#arkui_focuswrapmode)                         | ArkUI_FocusWrapMode             | 组件走焦换行规则。                         |
191| [ArkUI_EdgeDirection](#arkui_edgedirection)                         | ArkUI_EdgeDirection             | 定义矩形边方向。                         |
192| [ArkUI_CornerDirection](#arkui_cornerdirection)                     | ArkUI_CornerDirection           | 定义角度方向。                         |
193
194### 函数
195
196| 名称 | 描述 |
197| -- | -- |
198| [ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create()](#oh_arkui_layoutconstraint_create) | 创建约束尺寸。 |
199| [ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_copy) | 约束尺寸深拷贝。 |
200| [void* OH_ArkUI_LayoutConstraint_Dispose(ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_dispose) | 销毁约束尺寸指针。 |
201| [int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_getmaxwidth) | 通过约束尺寸获取最大宽度,单位为px。 |
202| [int32_t OH_ArkUI_LayoutConstraint_GetMinWidth(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_getminwidth) | 通过约束尺寸获取最小宽度,单位为px。 |
203| [int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_getmaxheight) | 通过约束尺寸获取最大高度,单位为px。 |
204| [int32_t OH_ArkUI_LayoutConstraint_GetMinHeight(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_getminheight) | 通过约束尺寸获取最小高度,单位为px。 |
205| [int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_getpercentreferencewidth) | 通过约束尺寸获取宽度百分比基准,单位为px。 |
206| [int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight(const ArkUI_LayoutConstraint* Constraint)](#oh_arkui_layoutconstraint_getpercentreferenceheight) | 通过约束尺寸获取高度百分比基准,单位为px。 |
207| [void OH_ArkUI_LayoutConstraint_SetMaxWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)](#oh_arkui_layoutconstraint_setmaxwidth) | 设置最大宽度。 |
208| [void OH_ArkUI_LayoutConstraint_SetMinWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)](#oh_arkui_layoutconstraint_setminwidth) | 设置最小宽度。 |
209| [void OH_ArkUI_LayoutConstraint_SetMaxHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)](#oh_arkui_layoutconstraint_setmaxheight) | 设置最大高度。 |
210| [void OH_ArkUI_LayoutConstraint_SetMinHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)](#oh_arkui_layoutconstraint_setminheight) | 设置最小高度。 |
211| [void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)](#oh_arkui_layoutconstraint_setpercentreferencewidth) | 设置宽度百分比基准。 |
212| [void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)](#oh_arkui_layoutconstraint_setpercentreferenceheight) | 设置高度百分比基准。 |
213| [void* OH_ArkUI_DrawContext_GetCanvas(ArkUI_DrawContext* context)](#oh_arkui_drawcontext_getcanvas) | 获取绘制canvas指针,可以转换为图形库的OH_Drawing_Canvas指针进行绘制。 |
214| [ArkUI_IntSize OH_ArkUI_DrawContext_GetSize(ArkUI_DrawContext* context)](#oh_arkui_drawcontext_getsize) | 获取可绘制区域大小。 |
215| [ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create()](#oh_arkui_waterflowsectionoption_create) | 创建FlowItem分组配置信息。 |
216| [void OH_ArkUI_WaterFlowSectionOption_Dispose(ArkUI_WaterFlowSectionOption* option)](#oh_arkui_waterflowsectionoption_dispose) | 销毁FlowItem分组配置信息指针。 |
217| [void OH_ArkUI_WaterFlowSectionOption_SetSize(ArkUI_WaterFlowSectionOption* option, int32_t size)](#oh_arkui_waterflowsectionoption_setsize) | 设置FlowItem分组配置信息数组长度。 |
218| [int32_t OH_ArkUI_WaterFlowSectionOption_GetSize(ArkUI_WaterFlowSectionOption* option)](#oh_arkui_waterflowsectionoption_getsize) | 获取FlowItem分组配置信息数组长度。 |
219| [void OH_ArkUI_WaterFlowSectionOption_SetItemCount(ArkUI_WaterFlowSectionOption* option, int32_t index, int32_t itemCount)](#oh_arkui_waterflowsectionoption_setitemcount) | 设置分组中FlowItem数量。 |
220| [int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount(ArkUI_WaterFlowSectionOption* option, int32_t index)](#oh_arkui_waterflowsectionoption_getitemcount) | 通过FlowItem分组配置信息获取对应索引下的FlowItem数量。 |
221| [void OH_ArkUI_WaterFlowSectionOption_SetCrossCount(ArkUI_WaterFlowSectionOption* option, int32_t index, int32_t crossCount)](#oh_arkui_waterflowsectionoption_setcrosscount) | 设置布局栅格,纵向布局时为列数,横向布局时为行数。 |
222| [int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount(ArkUI_WaterFlowSectionOption* option, int32_t index)](#oh_arkui_waterflowsectionoption_getcrosscount) | 通过FlowItem分组配置信息获取对应索引下的布局栅格数。 |
223| [void OH_ArkUI_WaterFlowSectionOption_SetColumnGap(ArkUI_WaterFlowSectionOption* option, int32_t index, float columnGap)](#oh_arkui_waterflowsectionoption_setcolumngap) | 设置分组的列间距。 |
224| [float OH_ArkUI_WaterFlowSectionOption_GetColumnGap(ArkUI_WaterFlowSectionOption* option, int32_t index)](#oh_arkui_waterflowsectionoption_getcolumngap) | 通过FlowItem分组配置信息获取对应索引下的分组的列间距。 |
225| [void OH_ArkUI_WaterFlowSectionOption_SetRowGap(ArkUI_WaterFlowSectionOption* option, int32_t index, float rowGap)](#oh_arkui_waterflowsectionoption_setrowgap) | 设置分组的行间距。 |
226| [float OH_ArkUI_WaterFlowSectionOption_GetRowGap(ArkUI_WaterFlowSectionOption* option, int32_t index)](#oh_arkui_waterflowsectionoption_getrowgap) | 通过FlowItem分组配置信息获取对应索引下的分组的行间距。 |
227| [void OH_ArkUI_WaterFlowSectionOption_SetMargin(ArkUI_WaterFlowSectionOption* option, int32_t index,float marginTop, float marginRight, float marginBottom, float marginLeft)](#oh_arkui_waterflowsectionoption_setmargin) | 设置分组的外边距。 |
228| [ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin(ArkUI_WaterFlowSectionOption* option, int32_t index)](#oh_arkui_waterflowsectionoption_getmargin) | 通过FlowItem分组配置信息获取对应索引下的分组的外边距。 |
229| [void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex (ArkUI_WaterFlowSectionOption* option, int32_t index, float(\*callback)(int32_t itemIndex))](#oh_arkui_waterflowsectionoption_registergetitemmainsizecallbackbyindex) | 通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。 |
230| [void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData (ArkUI_WaterFlowSectionOption* option, int32_t index, void* userData, float (\*callback)(int32_t itemIndex, void* userData))](#oh_arkui_waterflowsectionoption_registergetitemmainsizecallbackbyindexwithuserdata) | 通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。 |
231| [ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create(int32_t size)](#oh_arkui_guidelineoption_create) | 创建RelativeContainer容器内的辅助线信息。 |
232| [void OH_ArkUI_GuidelineOption_Dispose(ArkUI_GuidelineOption* guideline)](#oh_arkui_guidelineoption_dispose) | 销毁辅助线信息。 |
233| [void OH_ArkUI_GuidelineOption_SetId(ArkUI_GuidelineOption* guideline, const char* value, int32_t index)](#oh_arkui_guidelineoption_setid) | 设置辅助线的Id。 |
234| [void OH_ArkUI_GuidelineOption_SetDirection(ArkUI_GuidelineOption* guideline, ArkUI_Axis value, int32_t index)](#oh_arkui_guidelineoption_setdirection) | 设置辅助线的方向。 |
235| [void OH_ArkUI_GuidelineOption_SetPositionStart(ArkUI_GuidelineOption* guideline, float value, int32_t index)](#oh_arkui_guidelineoption_setpositionstart) | 设置距离容器左侧或者顶部的距离。 |
236| [void OH_ArkUI_GuidelineOption_SetPositionEnd(ArkUI_GuidelineOption* guideline, float value, int32_t index)](#oh_arkui_guidelineoption_setpositionend) | 设置距离容器右侧或者底部的距离。 |
237| [const char* OH_ArkUI_GuidelineOption_GetId(ArkUI_GuidelineOption* guideline, int32_t index)](#oh_arkui_guidelineoption_getid) | 获取辅助线的Id。 |
238| [ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection(ArkUI_GuidelineOption* guideline, int32_t index)](#oh_arkui_guidelineoption_getdirection) | 获取辅助线的方向。 |
239| [float OH_ArkUI_GuidelineOption_GetPositionStart(ArkUI_GuidelineOption* guideline, int32_t index)](#oh_arkui_guidelineoption_getpositionstart) | 获取距离容器左侧或者顶部的距离。 |
240| [float OH_ArkUI_GuidelineOption_GetPositionEnd(ArkUI_GuidelineOption* guideline, int32_t index)](#oh_arkui_guidelineoption_getpositionend) | 获取距离容器右侧或者底部的距离。 |
241| [ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create(int32_t size)](#oh_arkui_barrieroption_create) | 创建RelativeContainer容器内的屏障信息。 |
242| [void OH_ArkUI_BarrierOption_Dispose(ArkUI_BarrierOption* barrierStyle)](#oh_arkui_barrieroption_dispose) | 销毁屏障信息。 |
243| [void OH_ArkUI_BarrierOption_SetId(ArkUI_BarrierOption* barrierStyle, const char* value, int32_t index)](#oh_arkui_barrieroption_setid) | 设置屏障的Id。 |
244| [void OH_ArkUI_BarrierOption_SetDirection(ArkUI_BarrierOption* barrierStyle, ArkUI_BarrierDirection value, int32_t index)](#oh_arkui_barrieroption_setdirection) | 设置屏障的方向。 |
245| [void OH_ArkUI_BarrierOption_SetReferencedId(ArkUI_BarrierOption* barrierStyle, const char* value, int32_t index)](#oh_arkui_barrieroption_setreferencedid) | 设置屏障的依赖的组件。 |
246| [const char* OH_ArkUI_BarrierOption_GetId(ArkUI_BarrierOption* barrierStyle, int32_t index)](#oh_arkui_barrieroption_getid) | 获取屏障的Id。 |
247| [ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection(ArkUI_BarrierOption* barrierStyle, int32_t index)](#oh_arkui_barrieroption_getdirection) | 获取屏障的方向。 |
248| [const char* OH_ArkUI_BarrierOption_GetReferencedId(ArkUI_BarrierOption* barrierStyle, int32_t index , int32_t referencedIndex)](#oh_arkui_barrieroption_getreferencedid) | 获取屏障的依赖的组件。 |
249| [int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize(ArkUI_BarrierOption* barrierStyle, int32_t index)](#oh_arkui_barrieroption_getreferencedidsize) | 获取屏障的依赖的组件的个数。 |
250| [ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create()](#oh_arkui_alignmentruleoption_create) | 创建相对容器中子组件的对齐规则信息。 |
251| [void OH_ArkUI_AlignmentRuleOption_Dispose(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_dispose) | 销毁相对容器中子组件的对齐规则信息。 |
252| [void OH_ArkUI_AlignmentRuleOption_SetStart(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_HorizontalAlignment alignment)](#oh_arkui_alignmentruleoption_setstart) | 设置左对齐参数。 |
253| [void OH_ArkUI_AlignmentRuleOption_SetEnd(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_HorizontalAlignment alignment)](#oh_arkui_alignmentruleoption_setend) | 设置右对齐参数。 |
254| [void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_HorizontalAlignment alignment)](#oh_arkui_alignmentruleoption_setcenterhorizontal) | 设置横向居中对齐方式的参数。 |
255| [void OH_ArkUI_AlignmentRuleOption_SetTop(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_VerticalAlignment alignment)](#oh_arkui_alignmentruleoption_settop) | 设置顶部对齐的参数。 |
256| [void OH_ArkUI_AlignmentRuleOption_SetBottom(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_VerticalAlignment alignment)](#oh_arkui_alignmentruleoption_setbottom) | 设置底部对齐的参数。 |
257| [void OH_ArkUI_AlignmentRuleOption_SetCenterVertical(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_VerticalAlignment alignment)](#oh_arkui_alignmentruleoption_setcentervertical) | 设置纵向居中对齐方式的参数。 |
258| [void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal(ArkUI_AlignmentRuleOption* option, float horizontal)](#oh_arkui_alignmentruleoption_setbiashorizontal) | 设置组件在锚点约束下的水平方向上偏移参数。 |
259| [void OH_ArkUI_AlignmentRuleOption_SetBiasVertical(ArkUI_AlignmentRuleOption* option, float vertical)](#oh_arkui_alignmentruleoption_setbiasvertical) | 设置组件在锚点约束下的垂直方向上偏移参数。 |
260| [const char* OH_ArkUI_AlignmentRuleOption_GetStartId(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getstartid) | 获取左对齐参数的Id。 |
261| [ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getstartalignment) | 获取左对齐参数的对齐方式。 |
262| [const char* OH_ArkUI_AlignmentRuleOption_GetEndId(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getendid) | 获取右对齐参数。 |
263| [ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getendalignment) | 获取右对齐参数。 |
264| [const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getcenteridhorizontal) | 获取横向居中对齐方式的参数。 |
265| [ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getcenteralignmenthorizontal) | 获取横向居中对齐方式的参数。 |
266| [const char* OH_ArkUI_AlignmentRuleOption_GetTopId(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_gettopid) | 获取顶部对齐的参数。 |
267| [ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_gettopalignment) | 获取顶部对齐的参数。 |
268| [const char* OH_ArkUI_AlignmentRuleOption_GetBottomId(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getbottomid) | 获取底部对齐的参数。 |
269| [ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getbottomalignment) | 获取底部对齐的参数。 |
270| [const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getcenteridvertical) | 获取纵向居中对齐方式的参数。 |
271| [ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getcenteralignmentvertical) | 获取纵向居中对齐方式的参数。 |
272| [float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getbiashorizontal) | 获取水平方向上的bias值。 |
273| [float OH_ArkUI_AlignmentRuleOption_GetBiasVertical(ArkUI_AlignmentRuleOption* option)](#oh_arkui_alignmentruleoption_getbiasvertical) | 获取垂直方向上的bias值。 |
274| [ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create(ArkUI_SwiperIndicatorType type)](#oh_arkui_swiperindicator_create) | 创建 Swiper 组件的导航指示器。 |
275| [void OH_ArkUI_SwiperIndicator_Dispose(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_dispose) | 销毁Swiper组件的导航指示器指针。 |
276| [void OH_ArkUI_SwiperIndicator_SetStartPosition(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setstartposition) | 设置导航点距离 Swiper 组件左边的距离。 |
277| [float OH_ArkUI_SwiperIndicator_GetStartPosition(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getstartposition) | 获取导航点距离 Swiper 组件左边的距离。 |
278| [void OH_ArkUI_SwiperIndicator_SetTopPosition(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_settopposition) | 设置导航点距离 Swiper 组件顶部的距离。 |
279| [float OH_ArkUI_SwiperIndicator_GetTopPosition(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_gettopposition) | 获取导航点距离 Swiper 组件顶部的距离。 |
280| [void OH_ArkUI_SwiperIndicator_SetEndPosition(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setendposition) | 设置导航点距离 Swiper 组件右边的距离。 |
281| [float OH_ArkUI_SwiperIndicator_GetEndPosition(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getendposition) | 获取导航点距离 Swiper 组件右边的距离。 |
282| [void OH_ArkUI_SwiperIndicator_SetBottomPosition(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setbottomposition) | 设置导航点距离 Swiper 组件底部的距离。 |
283| [float OH_ArkUI_SwiperIndicator_GetBottomPosition(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getbottomposition) | 获取导航点距离 Swiper 组件底部的距离。 |
284| [void OH_ArkUI_SwiperIndicator_SetIgnoreSizeOfBottom(ArkUI_SwiperIndicator* indicator, int32_t ignoreSize)](#oh_arkui_swiperindicator_setignoresizeofbottom) | 设置OH_ArkUI_SwiperIndicator_SetBottomPosition是否忽略导航点大小。 |
285| [int32_t OH_ArkUI_SwiperIndicator_GetIgnoreSizeOfBottom(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getignoresizeofbottom) | 获取OH_ArkUI_SwiperIndicator_SetBottomPosition是否忽略导航点大小。 |
286| [void OH_ArkUI_SwiperIndicator_SetItemWidth(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setitemwidth) | 设置 Swiper 组件圆点导航指示器的宽。 |
287| [float OH_ArkUI_SwiperIndicator_GetItemWidth(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getitemwidth) | 获取 Swiper 组件圆点导航指示器的宽。 |
288| [void OH_ArkUI_SwiperIndicator_SetItemHeight(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setitemheight) | 设置 Swiper 组件圆点导航指示器的高。 |
289| [float OH_ArkUI_SwiperIndicator_GetItemHeight(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getitemheight) | 获取 Swiper 组件圆点导航指示器的高。 |
290| [void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setselecteditemwidth) | 设置被选中的 Swiper 组件圆点导航指示器的宽。 |
291| [float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getselecteditemwidth) | 获取被选中 Swiper 组件圆点导航指示器的宽。 |
292| [void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight(ArkUI_SwiperIndicator* indicator, float value)](#oh_arkui_swiperindicator_setselecteditemheight) | 设置被选中的 Swiper 组件圆点导航指示器的高。 |
293| [float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getselecteditemheight) | 获取被选中 Swiper 组件圆点导航指示器的高。 |
294| [void OH_ArkUI_SwiperIndicator_SetMask(ArkUI_SwiperIndicator* indicator, int32_t mask)](#oh_arkui_swiperindicator_setmask) | 设置是否显示 Swiper 组件圆点导航指示器的蒙版样式。 |
295| [int32_t OH_ArkUI_SwiperIndicator_GetMask(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getmask) | 获取是否显示 Swiper 组件圆点导航指示器的蒙版样式。 |
296| [void OH_ArkUI_SwiperIndicator_SetColor(ArkUI_SwiperIndicator* indicator, uint32_t color)](#oh_arkui_swiperindicator_setcolor) | 设置 Swiper 组件圆点导航指示器的颜色。 |
297| [uint32_t OH_ArkUI_SwiperIndicator_GetColor(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getcolor) | 获取 Swiper 组件圆点导航指示器的颜色。 |
298| [void OH_ArkUI_SwiperIndicator_SetSelectedColor(ArkUI_SwiperIndicator* indicator, uint32_t selectedColor)](#oh_arkui_swiperindicator_setselectedcolor) | 设置被选中 Swiper 组件圆点导航指示器的颜色。 |
299| [uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getselectedcolor) | 获取被选中 Swiper 组件圆点导航指示器的颜色。 |
300| [int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount(ArkUI_SwiperIndicator* indicator, int32_t maxDisplayCount)](#oh_arkui_swiperindicator_setmaxdisplaycount) | 设置圆点导航点指示器样式下,导航点显示个数的最大值。 |
301| [int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getmaxdisplaycount) | 获取圆点导航点指示器样式下,导航点显示个数的最大值。 |
302| [ArkUI_SwiperDigitIndicator *OH_ArkUI_SwiperDigitIndicator_Create()](#oh_arkui_swiperdigitindicator_create) | 创建 Swiper 组件的数字导航指示器。 |
303| [void OH_ArkUI_SwiperDigitIndicator_Destroy(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_destroy) | 销毁Swiper组件的数字导航指示器指针。 |
304| [void OH_ArkUI_SwiperDigitIndicator_SetStartPosition(ArkUI_SwiperDigitIndicator* indicator, float value)](#oh_arkui_swiperdigitindicator_setstartposition) | 设置数字导航指示器距离 Swiper 组件左边的距离,在从右至左显示的语言模式下,设置其距离 Swiper 组件右边的距离。 |
305| [float OH_ArkUI_SwiperDigitIndicator_GetStartPosition(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getstartposition) | 获取数字导航指示器距离 Swiper 组件左边的距离,在从右至左显示的语言模式下,获取其距离 Swiper 组件右边的距离。 |
306| [void OH_ArkUI_SwiperDigitIndicator_SetTopPosition(ArkUI_SwiperDigitIndicator* indicator, float value)](#oh_arkui_swiperdigitindicator_settopposition) | 设置数字导航指示器距离 Swiper 组件顶部的距离。 |
307| [float OH_ArkUI_SwiperDigitIndicator_GetTopPosition(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_gettopposition) | 获取数字导航指示器距离 Swiper 组件顶部的距离。 |
308| [void OH_ArkUI_SwiperDigitIndicator_SetEndPosition(ArkUI_SwiperDigitIndicator* indicator, float value)](#oh_arkui_swiperdigitindicator_setendposition) | 设置数字导航指示器距离 Swiper 组件右边的距离,在从右至左显示的语言模式下,设置其距离 Swiper 组件左边的距离。 |
309| [float OH_ArkUI_SwiperDigitIndicator_GetEndPosition(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getendposition) | 获取数字导航指示器距离 Swiper 组件右边的距离,在从右至左显示的语言模式下,获取其距离 Swiper 组件左边的距离。 |
310| [void OH_ArkUI_SwiperDigitIndicator_SetBottomPosition(ArkUI_SwiperDigitIndicator* indicator, float value)](#oh_arkui_swiperdigitindicator_setbottomposition) | 设置数字导航指示器距离 Swiper 组件底部的距离。 |
311| [float OH_ArkUI_SwiperDigitIndicator_GetBottomPosition(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getbottomposition) | 获取数字导航指示器距离 Swiper 组件底部的距离。 |
312| [void OH_ArkUI_SwiperDigitIndicator_SetFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t color)](#oh_arkui_swiperdigitindicator_setfontcolor) | 设置 Swiper 组件数字导航指示器字体颜色。 |
313| [uint32_t OH_ArkUI_SwiperDigitIndicator_GetFontColor(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getfontcolor) | 获取 Swiper 组件数字导航指示器字体颜色。 |
314| [void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t selectedColor)](#oh_arkui_swiperdigitindicator_setselectedfontcolor) | 设置被选中 Swiper 组件数字导航指示器字体颜色。 |
315| [uint32_t OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getselectedfontcolor) | 获取被选中 Swiper 组件数字导航指示器字体颜色。 |
316| [void OH_ArkUI_SwiperDigitIndicator_SetFontSize(ArkUI_SwiperDigitIndicator* indicator, float size)](#oh_arkui_swiperdigitindicator_setfontsize) | 设置 Swiper 组件数字导航指示器字体大小。 |
317| [float OH_ArkUI_SwiperDigitIndicator_GetFontSize(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getfontsize) | 获取 Swiper 组件数字导航指示器字体大小。 |
318| [void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator, float size)](#oh_arkui_swiperdigitindicator_setselectedfontsize) | 设置被选中 Swiper 组件数字导航指示器字体大小。 |
319| [float OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getselectedfontsize) | 获取被选中 Swiper 组件数字导航指示器字体大小。 |
320| [void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight fontWeight)](#oh_arkui_swiperdigitindicator_setfontweight) | 设置 Swiper 组件数字导航指示器字体粗细属性。 |
321| [ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getfontweight) | 获取 Swiper 组件数字导航指示器字体粗细属性。 |
322| [void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight selectedFontWeight)](#oh_arkui_swiperdigitindicator_setselectedfontweight) | 设置被选中 Swiper 组件数字导航指示器字体粗细属性。 |
323| [ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getselectedfontweight) | 获取被选中 Swiper 组件数字导航指示器字体粗细属性。 |
324| [ArkUI_SwiperArrowStyle *OH_ArkUI_SwiperArrowStyle_Create()](#oh_arkui_swiperarrowstyle_create) | 创建 Swiper 组件的导航箭头。 |
325| [void OH_ArkUI_SwiperArrowStyle_Destroy(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_destroy) | 销毁 Swiper 组件的导航箭头指针。 |
326| [void OH_ArkUI_SwiperArrowStyle_SetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle, int32_t showBackground)](#oh_arkui_swiperarrowstyle_setshowbackground) | 设置 Swiper 组件导航箭头底板是否显示。 |
327| [int32_t OH_ArkUI_SwiperArrowStyle_GetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_getshowbackground) | 获取 Swiper 组件导航箭头底板是否显示。 |
328| [void OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle, int32_t showSidebarMiddle)](#oh_arkui_swiperarrowstyle_setshowsidebarmiddle) | 设置 Swiper 组件导航箭头显示位置。 |
329| [int32_t OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_getshowsidebarmiddle) | 获取 Swiper 组件导航箭头显示位置。 |
330| [void OH_ArkUI_SwiperArrowStyle_SetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle, float backgroundSize)](#oh_arkui_swiperarrowstyle_setbackgroundsize) | 设置 Swiper 组件导航箭头底板大小。 |
331| [float OH_ArkUI_SwiperArrowStyle_GetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_getbackgroundsize) | 获取 Swiper 组件导航箭头底板大小。 |
332| [void OH_ArkUI_SwiperArrowStyle_SetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t backgroundColor)](#oh_arkui_swiperarrowstyle_setbackgroundcolor) | 设置 Swiper 组件导航箭头底板颜色。 |
333| [uint32_t OH_ArkUI_SwiperArrowStyle_GetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_getbackgroundcolor) | 获取 Swiper 组件导航箭头底板颜色。 |
334| [void OH_ArkUI_SwiperArrowStyle_SetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle, float arrowSize)](#oh_arkui_swiperarrowstyle_setarrowsize) | 设置 Swiper 组件导航箭头大小。 |
335| [float OH_ArkUI_SwiperArrowStyle_GetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_getarrowsize) | 获取 Swiper 组件导航箭头大小。 |
336| [void OH_ArkUI_SwiperArrowStyle_SetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t arrowColor)](#oh_arkui_swiperarrowstyle_setarrowcolor) | 设置 Swiper 组件导航箭头颜色。 |
337| [uint32_t OH_ArkUI_SwiperArrowStyle_GetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle)](#oh_arkui_swiperarrowstyle_getarrowcolor) | 获取 Swiper 组件导航箭头颜色。 |
338| [void OH_ArkUI_SwiperIndicator_SetSpace(ArkUI_SwiperIndicator* indicator, float space)](#oh_arkui_swiperindicator_setspace) | 设置导航点间距。 |
339| [float OH_ArkUI_SwiperIndicator_GetSpace(ArkUI_SwiperIndicator* indicator)](#oh_arkui_swiperindicator_getspace) | 获取导航点间距。 |
340| [void OH_ArkUI_SwiperDigitIndicator_SetIgnoreSizeOfBottom(ArkUI_SwiperDigitIndicator* indicator, int32_t ignoreSize)](#oh_arkui_swiperdigitindicator_setignoresizeofbottom) | 设置OH_ArkUI_SwiperDigitIndicator_SetBottomPosition是否忽略导航点大小。 |
341| [int32_t OH_ArkUI_SwiperDigitIndicator_GetIgnoreSizeOfBottom(ArkUI_SwiperDigitIndicator* indicator)](#oh_arkui_swiperdigitindicator_getignoresizeofbottom) | 获取OH_ArkUI_SwiperDigitIndicator_SetBottomPosition是否忽略导航点大小。 |
342| [ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create()](#oh_arkui_listitemswipeactionitem_create) | 创建ListItemSwipeActionItem接口设置的配置项。 |
343| [void OH_ArkUI_ListItemSwipeActionItem_Dispose(ArkUI_ListItemSwipeActionItem* item)](#oh_arkui_listitemswipeactionitem_dispose) | 销毁ListItemSwipeActionItem实例。 |
344| [void OH_ArkUI_ListItemSwipeActionItem_SetContent(ArkUI_ListItemSwipeActionItem* item, ArkUI_NodeHandle node)](#oh_arkui_listitemswipeactionitem_setcontent) | 设置ListItemSwipeActionItem的布局内容。 |
345| [void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance(ArkUI_ListItemSwipeActionItem* item, float distance)](#oh_arkui_listitemswipeactionitem_setactionareadistance) | 设置组件长距离滑动删除距离阈值。 |
346| [float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance(ArkUI_ListItemSwipeActionItem* item)](#oh_arkui_listitemswipeactionitem_getactionareadistance) | 获取组件长距离滑动删除距离阈值。 |
347| [void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea(ArkUI_ListItemSwipeActionItem* item, void (\*callback)())](#oh_arkui_listitemswipeactionitem_setonenteractionarea) | 设置滑动条目进入删除区域时调用的事件。 |
348| [void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData (ArkUI_ListItemSwipeActionItem* item,void* userData, void (\*callback)(void* userData))](#oh_arkui_listitemswipeactionitem_setonenteractionareawithuserdata) | 设置滑动条目进入删除区域时调用的事件。 |
349| [void OH_ArkUI_ListItemSwipeActionItem_SetOnAction(ArkUI_ListItemSwipeActionItem* item, void (\*callback)())](#oh_arkui_listitemswipeactionitem_setonaction) | 设置组件进入长距删除区后删除ListItem时调用的事件。 |
350| [void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData(ArkUI_ListItemSwipeActionItem* item,void* userData, void (\*callback)(void* userData))](#oh_arkui_listitemswipeactionitem_setonactionwithuserdata) | 设置组件进入长距删除区后删除ListItem时调用的事件。 |
351| [void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea(ArkUI_ListItemSwipeActionItem* item, void (\*callback)())](#oh_arkui_listitemswipeactionitem_setonexitactionarea) | 设置滑动条目退出删除区域时调用的事件。 |
352| [void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData (ArkUI_ListItemSwipeActionItem* item,void* userData, void (\*callback)(void* userData))](#oh_arkui_listitemswipeactionitem_setonexitactionareawithuserdata) | 设置滑动条目退出删除区域时调用的事件。 |
353| [void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange (ArkUI_ListItemSwipeActionItem* item,void (\*callback)(ArkUI_ListItemSwipeActionState swipeActionState))](#oh_arkui_listitemswipeactionitem_setonstatechange) | 设置列表项滑动状态变化时候触发的事件。 |
354| [void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData (ArkUI_ListItemSwipeActionItem* item,void* userData, void (\*callback)(ArkUI_ListItemSwipeActionState swipeActionState, void* userData))](#oh_arkui_listitemswipeactionitem_setonstatechangewithuserdata) | 设置列表项滑动状态变化时候触发的事件。 |
355| [ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create()](#oh_arkui_listitemswipeactionoption_create) | 创建ListItemSwipeActionOption接口设置的配置项。 |
356| [void OH_ArkUI_ListItemSwipeActionOption_Dispose(ArkUI_ListItemSwipeActionOption* option)](#oh_arkui_listitemswipeactionoption_dispose) | 销毁ListItemSwipeActionOption实例。 |
357| [void OH_ArkUI_ListItemSwipeActionOption_SetStart(ArkUI_ListItemSwipeActionOption* option, ArkUI_ListItemSwipeActionItem* item)](#oh_arkui_listitemswipeactionoption_setstart) | 设置ListItemSwipeActionItem的左侧(垂直布局)或上方(横向布局)布局内容。 |
358| [void OH_ArkUI_ListItemSwipeActionOption_SetEnd(ArkUI_ListItemSwipeActionOption* option, ArkUI_ListItemSwipeActionItem* item)](#oh_arkui_listitemswipeactionoption_setend) | 设置ListItemSwipeActionItem的右侧(垂直布局)或下方(横向布局)布局内容。 |
359| [void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect(ArkUI_ListItemSwipeActionOption* option, ArkUI_ListItemSwipeEdgeEffect edgeEffect)](#oh_arkui_listitemswipeactionoption_setedgeeffect) | 设置滑动效果。 |
360| [int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect(ArkUI_ListItemSwipeActionOption* option)](#oh_arkui_listitemswipeactionoption_getedgeeffect) | 获取滑动效果。 |
361| [void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange(ArkUI_ListItemSwipeActionOption* option, void (\*callback)(float offset))](#oh_arkui_listitemswipeactionoption_setonoffsetchange) | 滑动操作偏移量更改时调用的事件。 |
362| [void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData (ArkUI_ListItemSwipeActionOption* option, void* userData, void (\*callback)(float offset, void* userData))](#oh_arkui_listitemswipeactionoption_setonoffsetchangewithuserdata) | 滑动操作偏移量更改时调用的事件。 |
363| [ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create(void)](#oh_arkui_accessibilitystate_create) | 创建无障碍状态。 |
364| [void OH_ArkUI_AccessibilityState_Dispose(ArkUI_AccessibilityState* state)](#oh_arkui_accessibilitystate_dispose) | 销毁无障碍状态指针。 |
365| [void OH_ArkUI_AccessibilityState_SetDisabled(ArkUI_AccessibilityState* state, int32_t isDisabled)](#oh_arkui_accessibilitystate_setdisabled) | 设置无障碍状态是否禁用。 |
366| [int32_t OH_ArkUI_AccessibilityState_IsDisabled(ArkUI_AccessibilityState* state)](#oh_arkui_accessibilitystate_isdisabled) | 获取无障碍状态是否禁用。 |
367| [void OH_ArkUI_AccessibilityState_SetSelected(ArkUI_AccessibilityState* state, int32_t isSelected)](#oh_arkui_accessibilitystate_setselected) | 设置无障碍状态是否选中。 |
368| [int32_t OH_ArkUI_AccessibilityState_IsSelected(ArkUI_AccessibilityState* state)](#oh_arkui_accessibilitystate_isselected) | 获取无障碍状态是否选中。 |
369| [void OH_ArkUI_AccessibilityState_SetCheckedState(ArkUI_AccessibilityState* state, int32_t checkedState)](#oh_arkui_accessibilitystate_setcheckedstate) | 设置无障碍状态复选框状态。 |
370| [int32_t OH_ArkUI_AccessibilityState_GetCheckedState(ArkUI_AccessibilityState* state)](#oh_arkui_accessibilitystate_getcheckedstate) | 获取无障碍状态复选框状态。 |
371| [ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create(void)](#oh_arkui_accessibilityvalue_create) | 创建无障碍信息。 |
372| [void OH_ArkUI_AccessibilityValue_Dispose(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_dispose) | 销毁无障碍信息指针。 |
373| [void OH_ArkUI_AccessibilityValue_SetMin(ArkUI_AccessibilityValue* value, int32_t min)](#oh_arkui_accessibilityvalue_setmin) | 设置无障碍最小值信息。 |
374| [int32_t OH_ArkUI_AccessibilityValue_GetMin(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_getmin) | 获取无障碍最小值信息。 |
375| [void OH_ArkUI_AccessibilityValue_SetMax(ArkUI_AccessibilityValue* value, int32_t max)](#oh_arkui_accessibilityvalue_setmax) | 设置无障碍最大值信息。 |
376| [int32_t OH_ArkUI_AccessibilityValue_GetMax(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_getmax) | 获取无障碍最大值信息。 |
377| [void OH_ArkUI_AccessibilityValue_SetCurrent(ArkUI_AccessibilityValue* value, int32_t current)](#oh_arkui_accessibilityvalue_setcurrent) | 设置无障碍当前值信息。 |
378| [int32_t OH_ArkUI_AccessibilityValue_GetCurrent(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_getcurrent) | 获取无障碍当前值信息。 |
379| [void OH_ArkUI_AccessibilityValue_SetRangeMin(ArkUI_AccessibilityValue* value, int32_t rangeMin)](#oh_arkui_accessibilityvalue_setrangemin) | 设置范围组件的无障碍最小值信息。 |
380| [int32_t OH_ArkUI_AccessibilityValue_GetRangeMin(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_getrangemin) | 获取范围组件的无障碍最小值信息。 |
381| [void OH_ArkUI_AccessibilityValue_SetRangeMax(ArkUI_AccessibilityValue* value, int32_t rangeMax)](#oh_arkui_accessibilityvalue_setrangemax) | 设置范围组件的无障碍最大值信息。 |
382| [int32_t OH_ArkUI_AccessibilityValue_GetRangeMax(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_getrangemax) | 获取范围组件的无障碍最大值信息。 |
383| [void OH_ArkUI_AccessibilityValue_SetRangeCurrent(ArkUI_AccessibilityValue* value, int32_t rangeCurrent)](#oh_arkui_accessibilityvalue_setrangecurrent) | 用于设置范围组件的无障碍当前值信息。 |
384| [int32_t OH_ArkUI_AccessibilityValue_GetRangeCurrent(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_getrangecurrent) | 用于获取范围组件的无障碍当前值信息。 |
385| [void OH_ArkUI_AccessibilityValue_SetText(ArkUI_AccessibilityValue* value, const char* text)](#oh_arkui_accessibilityvalue_settext) | 设置无障碍文本描述信息。 |
386| [const char* OH_ArkUI_AccessibilityValue_GetText(ArkUI_AccessibilityValue* value)](#oh_arkui_accessibilityvalue_gettext) | 获取无障碍文本描述信息。 |
387| [ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString(char* src)](#oh_arkui_imageanimatorframeinfo_createfromstring) | 使用图片路径创建帧图片信息,图片格式为svg,png和jpg。 |
388| [ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor(ArkUI_DrawableDescriptor* drawable)](#oh_arkui_imageanimatorframeinfo_createfromdrawabledescriptor) | 使用 DrawableDescriptor 对象创建帧图片信息,图片格式为Resource和PixelMap。 |
389| [void OH_ArkUI_ImageAnimatorFrameInfo_Dispose(ArkUI_ImageAnimatorFrameInfo* imageInfo)](#oh_arkui_imageanimatorframeinfo_dispose) | 销毁帧图片对象指针。 |
390| [void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t width)](#oh_arkui_imageanimatorframeinfo_setwidth) | 设置图片宽度。 |
391| [int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth(ArkUI_ImageAnimatorFrameInfo* imageInfo)](#oh_arkui_imageanimatorframeinfo_getwidth) | 获取图片宽度。 |
392| [void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t height)](#oh_arkui_imageanimatorframeinfo_setheight) | 设置图片高度。 |
393| [int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight(ArkUI_ImageAnimatorFrameInfo* imageInfo)](#oh_arkui_imageanimatorframeinfo_getheight) | 获取图片高度。 |
394| [void OH_ArkUI_ImageAnimatorFrameInfo_SetTop(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t top)](#oh_arkui_imageanimatorframeinfo_settop) | 设置图片相对于组件左上角的纵向坐标。 |
395| [int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop(ArkUI_ImageAnimatorFrameInfo* imageInfo)](#oh_arkui_imageanimatorframeinfo_gettop) | 获取图片相对于组件左上角的纵向坐标。 |
396| [void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t left)](#oh_arkui_imageanimatorframeinfo_setleft) | 设置图片相对于组件左上角的横向坐标。 |
397| [int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft(ArkUI_ImageAnimatorFrameInfo* imageInfo)](#oh_arkui_imageanimatorframeinfo_getleft) | 获取图片相对于组件左上角的横向坐标。 |
398| [void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t duration)](#oh_arkui_imageanimatorframeinfo_setduration) | 设置图片的播放时长。 |
399| [int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration(ArkUI_ImageAnimatorFrameInfo* imageInfo)](#oh_arkui_imageanimatorframeinfo_getduration) | 获取图片的播放时长。 |
400| [ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create()](#oh_arkui_listchildrenmainsizeoption_create) | 创建ListChildrenMainSize接口设置的配置项。 |
401| [void OH_ArkUI_ListChildrenMainSizeOption_Dispose(ArkUI_ListChildrenMainSize* option)](#oh_arkui_listchildrenmainsizeoption_dispose) | 销毁ListChildrenMainSize实例。 |
402| [int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize(ArkUI_ListChildrenMainSize* option, float defaultMainSize)](#oh_arkui_listchildrenmainsizeoption_setdefaultmainsize) | 设置List组件的ChildrenMainSizeOption默认大小。 |
403| [float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize(ArkUI_ListChildrenMainSize* option)](#oh_arkui_listchildrenmainsizeoption_getdefaultmainsize) | 获取List组件的ChildrenMainSizeOption默认大小。 |
404| [void OH_ArkUI_ListChildrenMainSizeOption_Resize(ArkUI_ListChildrenMainSize* option, int32_t totalSize)](#oh_arkui_listchildrenmainsizeoption_resize) | 重置List组件的ChildrenMainSizeOption的数组大小。 |
405| [int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice(ArkUI_ListChildrenMainSize* option, int32_t index, int32_t deleteCount, int32_t addCount)](#oh_arkui_listchildrenmainsizeoption_splice) | 对List组件的ChildrenMainSizeOption数组操作大小调整。 |
406| [int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize(ArkUI_ListChildrenMainSize* option, int32_t index, float mainSize)](#oh_arkui_listchildrenmainsizeoption_updatesize) | 更新List组件的ChildrenMainSizeOption数组的值。 |
407| [float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize(ArkUI_ListChildrenMainSize* option, int32_t index)](#oh_arkui_listchildrenmainsizeoption_getmainsize) | 获取List组件的ChildrenMainSizeOption数组的值。 |
408| [ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create(void)](#oh_arkui_customspanmeasureinfo_create) | 创建自定义段落组件测量信息。 |
409| [void OH_ArkUI_CustomSpanMeasureInfo_Dispose(ArkUI_CustomSpanMeasureInfo* info)](#oh_arkui_customspanmeasureinfo_dispose) | 销毁自定义段落组件测量信息。 |
410| [float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize(ArkUI_CustomSpanMeasureInfo* info)](#oh_arkui_customspanmeasureinfo_getfontsize) | 获取自定义段落组件的父节点Text的字体大小。 |
411| [ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create(void)](#oh_arkui_customspanmetrics_create) | 创建自定义段落组件度量信息。 |
412| [void OH_ArkUI_CustomSpanMetrics_Dispose(ArkUI_CustomSpanMetrics* metrics)](#oh_arkui_customspanmetrics_dispose) | 销毁自定义段落组件度量信息。 |
413| [int32_t OH_ArkUI_CustomSpanMetrics_SetWidth(ArkUI_CustomSpanMetrics* metrics, float width)](#oh_arkui_customspanmetrics_setwidth) | 设置自定义段落组件的宽度。 |
414| [int32_t OH_ArkUI_CustomSpanMetrics_SetHeight(ArkUI_CustomSpanMetrics* metrics, float height)](#oh_arkui_customspanmetrics_setheight) | 设置自定义段落组件的高度。 |
415| [ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create(void)](#oh_arkui_customspandrawinfo_create) | 创建自定义段落组件绘制信息。 |
416| [void OH_ArkUI_CustomSpanDrawInfo_Dispose(ArkUI_CustomSpanDrawInfo* info)](#oh_arkui_customspandrawinfo_dispose) | 销毁自定义段落组件绘制信息。 |
417| [float OH_ArkUI_CustomSpanDrawInfo_GetXOffset(ArkUI_CustomSpanDrawInfo* info)](#oh_arkui_customspandrawinfo_getxoffset) | 获取自定义段落组件相对于挂载组件的x轴偏移值。 |
418| [float OH_ArkUI_CustomSpanDrawInfo_GetLineTop(ArkUI_CustomSpanDrawInfo* info)](#oh_arkui_customspandrawinfo_getlinetop) | 获取自定义段落组件相对于挂载组件的上边距。 |
419| [float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom(ArkUI_CustomSpanDrawInfo* info)](#oh_arkui_customspandrawinfo_getlinebottom) | 获取自定义段落组件相对于挂载组件的下边距。 |
420| [float OH_ArkUI_CustomSpanDrawInfo_GetBaseline(ArkUI_CustomSpanDrawInfo* info)](#oh_arkui_customspandrawinfo_getbaseline) | 获取自定义段落组件相对于挂载组件的基线偏移量。 |
421| [void OH_ArkUI_CustomProperty_Destroy(ArkUI_CustomProperty* handle)](#oh_arkui_customproperty_destroy) | 销毁CustomProperty实例。 |
422| [const char* OH_ArkUI_CustomProperty_GetStringValue(ArkUI_CustomProperty* handle)](#oh_arkui_customproperty_getstringvalue) | 获取自定义属性value信息。 |
423| [const char* OH_ArkUI_HostWindowInfo_GetName(ArkUI_HostWindowInfo* info)](#oh_arkui_hostwindowinfo_getname) | 获取HostWindowInfo对象中的窗口名称。 |
424| [void OH_ArkUI_HostWindowInfo_Destroy(ArkUI_HostWindowInfo* info)](#oh_arkui_hostwindowinfo_destroy) | 销毁HostWindowInfo对象。 |
425| [void OH_ArkUI_ActiveChildrenInfo_Destroy(ArkUI_ActiveChildrenInfo* handle)](#oh_arkui_activechildreninfo_destroy) | 销毁ActiveChildrenInfo实例。 |
426| [ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex(ArkUI_ActiveChildrenInfo* handle, int32_t index)](#oh_arkui_activechildreninfo_getnodebyindex) | 获取ActiveChildrenInfo结构体的下标为index的子节点。 |
427| [int32_t OH_ArkUI_ActiveChildrenInfo_GetCount(ArkUI_ActiveChildrenInfo* handle)](#oh_arkui_activechildreninfo_getcount) | 获取ActiveChildrenInfo结构体内的节点数量。 |
428| [ArkUI_ProgressLinearStyleOption* OH_ArkUI_ProgressLinearStyleOption_Create(void)](#oh_arkui_progresslinearstyleoption_create) | 创建线性进度条样式信息。 |
429| [void OH_ArkUI_ProgressLinearStyleOption_Destroy(ArkUI_ProgressLinearStyleOption* option)](#oh_arkui_progresslinearstyleoption_destroy) | 销毁线性进度条样式信息。 |
430| [void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled)](#oh_arkui_progresslinearstyleoption_setsmootheffectenabled) | 设置进度平滑动效的开关。 |
431| [void OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled)](#oh_arkui_progresslinearstyleoption_setscaneffectenabled) | 设置扫光效果的开关。 |
432| [void OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth(ArkUI_ProgressLinearStyleOption* option, float strokeWidth)](#oh_arkui_progresslinearstyleoption_setstrokewidth) | 设置进度条宽度。 |
433| [void OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius(ArkUI_ProgressLinearStyleOption* option, float strokeRadius)](#oh_arkui_progresslinearstyleoption_setstrokeradius) | 设置进度条圆角半径。 |
434| [bool OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option)](#oh_arkui_progresslinearstyleoption_getsmootheffectenabled) | 获取进度平滑动效的开关信息。 |
435| [bool OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option)](#oh_arkui_progresslinearstyleoption_getscaneffectenabled) | 获取扫光效果的开关信息。 |
436| [float OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth(ArkUI_ProgressLinearStyleOption* option)](#oh_arkui_progresslinearstyleoption_getstrokewidth) | 获取进度条宽度。 |
437| [float OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius(ArkUI_ProgressLinearStyleOption* option)](#oh_arkui_progresslinearstyleoption_getstrokeradius) | 获取进度条圆角半径值。 |
438| [ArkUI_SnapshotOptions* OH_ArkUI_CreateSnapshotOptions()](#oh_arkui_createsnapshotoptions) | 创建一个截图选项,当返回值不再使用时必须通过[OH_ArkUI_DestroySnapshotOptions()](#oh_arkui_destroysnapshotoptions)释放。 |
439| [void OH_ArkUI_DestroySnapshotOptions(ArkUI_SnapshotOptions* snapshotOptions)](#oh_arkui_destroysnapshotoptions) | 销毁截图选项指针。 |
440| [int32_t OH_ArkUI_SnapshotOptions_SetScale(ArkUI_SnapshotOptions* snapshotOptions, float scale)](#oh_arkui_snapshotoptions_setscale) | 配置截图选项中的缩放属性。 |
441| [ArkUI_CrossLanguageOption* OH_ArkUI_CrossLanguageOption_Create(void)](#oh_arkui_crosslanguageoption_create) | 创建跨语言配置项实例。 |
442| [void OH_ArkUI_CrossLanguageOption_Destroy(ArkUI_CrossLanguageOption* option)](#oh_arkui_crosslanguageoption_destroy) | 销毁跨语言配置项实例。 |
443| [void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageOption* option, bool enabled)](#oh_arkui_crosslanguageoption_setattributesettingstatus) | 设置配置项中是否允许跨语言修改属性。 |
444| [bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option)](#oh_arkui_crosslanguageoption_getattributesettingstatus) | 获取配置项中是否允许跨语言修改属性。 |
445| [ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create()](#oh_arkui_visibleareaeventoptions_create) | 创建可见区域变化监听的参数。 |
446| [void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option)](#oh_arkui_visibleareaeventoptions_dispose) | 销毁可见区域变化监听的参数。 |
447| [int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size)](#oh_arkui_visibleareaeventoptions_setratios) | 设置阈值数组。 |
448| [int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions *option, int32_t value)](#oh_arkui_visibleareaeventoptions_setexpectedupdateinterval) | 设置预期更新间隔,单位为ms。定义了开发者期望的更新间隔。 |
449| [int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t* size)](#oh_arkui_visibleareaeventoptions_getratios) | 获取阈值数组。 |
450| [int32_t OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions* option)](#oh_arkui_visibleareaeventoptions_getexpectedupdateinterval) | 获取预期更新间隔。 |
451| [ArkUI_TextPickerRangeContentArray* OH_ArkUI_TextPickerRangeContentArray_Create(int32_t length)](#oh_arkui_textpickerrangecontentarray_create) | 创建TextPickerRangeContent数组的对象。 |
452| [void OH_ArkUI_TextPickerRangeContentArray_SetIconAtIndex(ArkUI_TextPickerRangeContentArray* handle, char* icon, int32_t index)](#oh_arkui_textpickerrangecontentarray_seticonatindex) | 指定TextPickerRangeContent数组指定位置的icon数据。 |
453| [void OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex(ArkUI_TextPickerRangeContentArray* handle, char* text, int32_t index)](#oh_arkui_textpickerrangecontentarray_settextatindex) | 指定TextPickerRangeContent数组指定位置的text数据。 |
454| [void OH_ArkUI_TextPickerRangeContentArray_Destroy(ArkUI_TextPickerRangeContentArray* handle)](#oh_arkui_textpickerrangecontentarray_destroy) | 删除TextPickerRangeContent数组对象。 |
455| [ArkUI_TextCascadePickerRangeContentArray* OH_ArkUI_TextCascadePickerRangeContentArray_Create(int32_t length)](#oh_arkui_textcascadepickerrangecontentarray_create) | 删除TextCascadePickerRangeContent数组对象。 |
456| [void OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex (ArkUI_TextCascadePickerRangeContentArray* handle, char* text, int32_t index)](#oh_arkui_textcascadepickerrangecontentarray_settextatindex) | 指定TextCascadePickerRangeContent数组指定位置的text数据。 |
457| [void OH_ArkUI_TextCascadePickerRangeContentArray_SetChildAtIndex (ArkUI_TextCascadePickerRangeContentArray* handle, ArkUI_TextCascadePickerRangeContentArray* child, int32_t index)](#oh_arkui_textcascadepickerrangecontentarray_setchildatindex) | 指定TextCascadePickerRangeContent数组指定位置的child数据。 |
458| [void OH_ArkUI_TextCascadePickerRangeContentArray_Destroy (ArkUI_TextCascadePickerRangeContentArray* handle)](#oh_arkui_textcascadepickerrangecontentarray_destroy) | 删除TextCascadePickerRangeContent数组对象。 |
459| [ArkUI_EmbeddedComponentOption* OH_ArkUI_EmbeddedComponentOption_Create()](#oh_arkui_embeddedcomponentoption_create) | 创建EmbeddedComponent组件选项的对象。 |
460| [void OH_ArkUI_EmbeddedComponentOption_Dispose(ArkUI_EmbeddedComponentOption* option)](#oh_arkui_embeddedcomponentoption_dispose) | 删除EmbeddedComponent组件选项的对象。 |
461| [void OH_ArkUI_EmbeddedComponentOption_SetOnError (ArkUI_EmbeddedComponentOption* option, void (\*callback)(int32_t code, const char* name, const char* message))](#oh_arkui_embeddedcomponentoption_setonerror) | 设置EmbeddedComponent组件的onError回调。EmbeddedComponent组件在运行过程中发生异常时触发本回调。 |
462| [void OH_ArkUI_EmbeddedComponentOption_SetOnTerminated (ArkUI_EmbeddedComponentOption* option, void (\*callback)(int32_t code, AbilityBase_Want* want))](#oh_arkui_embeddedcomponentoption_setonterminated) | 设置EmbeddedComponent组件的onTerminated回调。EmbeddedComponent组件正常退出时触发本回调。 |
463
464## 枚举类型说明
465
466### ArkUI_Alignment
467
468```
469enum ArkUI_Alignment
470```
471
472**描述:**
473
474
475定义布局对齐枚举值。
476
477**起始版本:** 12
478
479| 枚举项 | 描述 |
480| -- | -- |
481| ARKUI_ALIGNMENT_TOP_START = 0 | 顶部起始。 |
482| ARKUI_ALIGNMENT_TOP | 顶部居中。 |
483| ARKUI_ALIGNMENT_TOP_END | 顶部尾端。 |
484| ARKUI_ALIGNMENT_START | 起始端纵向居中。 |
485| ARKUI_ALIGNMENT_CENTER | 横向和纵向居中。 |
486| ARKUI_ALIGNMENT_END | 尾端纵向居中。 |
487| ARKUI_ALIGNMENT_BOTTOM_START | 底部起始端。 |
488| ARKUI_ALIGNMENT_BOTTOM | 底部横向居中。 |
489| ARKUI_ALIGNMENT_BOTTOM_END | 底部尾端。 |
490
491### ArkUI_ImageRepeat
492
493```
494enum ArkUI_ImageRepeat
495```
496
497**描述:**
498
499
500定义图片重复铺设枚举值。
501
502**起始版本:** 12
503
504| 枚举项 | 描述 |
505| -- | -- |
506| ARKUI_IMAGE_REPEAT_NONE = 0 | 不重复。 |
507| ARKUI_IMAGE_REPEAT_X | 在X轴方向重复。 |
508| ARKUI_IMAGE_REPEAT_Y | 在Y轴方向重复。 |
509| ARKUI_IMAGE_REPEAT_XY | 在X轴和Y轴方向重复。 |
510
511### ArkUI_FontStyle
512
513```
514enum ArkUI_FontStyle
515```
516
517**描述:**
518
519
520定义字体样式枚举值。
521
522**起始版本:** 12
523
524| 枚举项 | 描述 |
525| -- | -- |
526| ARKUI_FONT_STYLE_NORMAL = 0 | 标准字体样式。 |
527| ARKUI_FONT_STYLE_ITALIC | 斜体字体样式。 |
528
529### ArkUI_FontWeight
530
531```
532enum ArkUI_FontWeight
533```
534
535**描述:**
536
537
538定义字体粗细/字重枚举值。
539
540**起始版本:** 12
541
542| 枚举项 | 描述 |
543| -- | -- |
544| ARKUI_FONT_WEIGHT_W100 = 0 | 100 |
545| ARKUI_FONT_WEIGHT_W200 | 200 |
546| ARKUI_FONT_WEIGHT_W300 | 300 |
547| ARKUI_FONT_WEIGHT_W400 | 400 |
548| ARKUI_FONT_WEIGHT_W500 | 500 |
549| ARKUI_FONT_WEIGHT_W600 | 600 |
550| ARKUI_FONT_WEIGHT_W700 | 700 |
551| ARKUI_FONT_WEIGHT_W800 | 800 |
552| ARKUI_FONT_WEIGHT_W900 | 900 |
553| ARKUI_FONT_WEIGHT_BOLD | 字体较粗。 |
554| ARKUI_FONT_WEIGHT_NORMAL | 字体粗细正常。 |
555| ARKUI_FONT_WEIGHT_BOLDER | 字体非常粗。 |
556| ARKUI_FONT_WEIGHT_LIGHTER | 字体较细。 |
557| ARKUI_FONT_WEIGHT_MEDIUM | 字体粗细适中。 |
558| ARKUI_FONT_WEIGHT_REGULAR | 字体粗细正常。 |
559
560### ArkUI_TextAlignment
561
562```
563enum ArkUI_TextAlignment
564```
565
566**描述:**
567
568
569定义字体水平对齐样式枚举值。
570
571**起始版本:** 12
572
573| 枚举项 | 描述 |
574| -- | -- |
575| ARKUI_TEXT_ALIGNMENT_START = 0 | 水平对齐首部。 |
576| ARKUI_TEXT_ALIGNMENT_CENTER | 水平居中对齐。 |
577| ARKUI_TEXT_ALIGNMENT_END | 水平对齐尾部。 |
578| ARKUI_TEXT_ALIGNMENT_JUSTIFY | 双端对齐。 |
579
580### ArkUI_TextVerticalAlignment
581
582```
583enum ArkUI_TextVerticalAlignment
584```
585
586**描述:**
587
588
589定义文本垂直对齐样式枚举值。
590
591**起始版本:** 20
592
593| 枚举项 | 描述 |
594| -- | -- |
595| ARKUI_TEXT_VERTICAL_ALIGNMENT_BASELINE = 0 | 基线对齐。 |
596| ARKUI_TEXT_VERTICAL_ALIGNMENT_BOTTOM | 底部对齐。 |
597| ARKUI_TEXT_VERTICAL_ALIGNMENT_CENTER | 居中对齐。 |
598| ARKUI_TEXT_VERTICAL_ALIGNMENT_TOP | 顶部对齐。 |
599
600### ArkUI_EnterKeyType
601
602```
603enum ArkUI_EnterKeyType
604```
605
606**描述:**
607
608
609定义单行文本输入法回车键类型枚举值。
610
611**起始版本:** 12
612
613| 枚举项 | 描述 |
614| -- | -- |
615| ARKUI_ENTER_KEY_TYPE_GO = 2 | 显示为开始样式。 |
616| ARKUI_ENTER_KEY_TYPE_SEARCH = 3 | 显示为搜索样式。 |
617| ARKUI_ENTER_KEY_TYPE_SEND | 显示为发送样式。 |
618| ARKUI_ENTER_KEY_TYPE_NEXT | 显示为下一个样式。 |
619| ARKUI_ENTER_KEY_TYPE_DONE | 显示为完成样式。 |
620| ARKUI_ENTER_KEY_TYPE_PREVIOUS | 显示为上一个样式。 |
621| ARKUI_ENTER_KEY_TYPE_NEW_LINE | 显示为换行样式。 |
622
623### ArkUI_TextInputType
624
625```
626enum ArkUI_TextInputType
627```
628
629**描述:**
630
631
632定义单行文本输入法类型枚举值。
633
634**起始版本:** 12
635
636| 枚举项 | 描述                       |
637| -- |--------------------------|
638| ARKUI_TEXTINPUT_TYPE_NORMAL = 0 | 基本输入模式。                  |
639| ARKUI_TEXTINPUT_TYPE_NUMBER = 2 | 纯数字模式。                   |
640| ARKUI_TEXTINPUT_TYPE_PHONE_NUMBER = 3 | 电话号码输入模式。                |
641| ARKUI_TEXTINPUT_TYPE_EMAIL = 5 | 邮箱地址输入模式。                |
642| ARKUI_TEXTINPUT_TYPE_PASSWORD = 7 | 密码输入模式。                  |
643| ARKUI_TEXTINPUT_TYPE_NUMBER_PASSWORD = 8 | 纯数字密码输入模式。               |
644| ARKUI_TEXTINPUT_TYPE_SCREEN_LOCK_PASSWORD = 9 | 锁屏应用密码输入模式。              |
645| ARKUI_TEXTINPUT_TYPE_USER_NAME = 10 | 用户名输入模式。                 |
646| ARKUI_TEXTINPUT_TYPE_NEW_PASSWORD = 11 | 新密码输入模式。                 |
647| ARKUI_TEXTINPUT_TYPE_NUMBER_DECIMAL = 12 | 带小数点的数字输入模式。             |
648| ARKUI_TEXTINPUT_TYPE_ONE_TIME_CODE = 14 | 验证码输入模式。<br>**起始版本:** 20 |
649
650### ArkUI_TextAreaType
651
652```
653enum ArkUI_TextAreaType
654```
655
656**描述:**
657
658
659定义多行文本输入法类型枚举值。
660
661**起始版本:** 12
662
663| 枚举项 | 描述 |
664| -- | -- |
665| ARKUI_TEXTAREA_TYPE_NORMAL = 0 | 基本输入模式。 |
666| ARKUI_TEXTAREA_TYPE_NUMBER = 2 | 纯数字模式。 |
667| ARKUI_TEXTAREA_TYPE_PHONE_NUMBER = 3 | 电话号码输入模式。 |
668| ARKUI_TEXTAREA_TYPE_EMAIL = 5 | 邮箱地址输入模式。 |
669| ARKUI_TEXTAREA_TYPE_ONE_TIME_CODE = 14 | 验证码输入模式。<br>**起始版本:** 20 |
670
671### ArkUI_CancelButtonStyle
672
673```
674enum ArkUI_CancelButtonStyle
675```
676
677**描述:**
678
679
680定义清除按钮样式枚举值。
681
682**起始版本:** 12
683
684| 枚举项 | 描述 |
685| -- | -- |
686| ARKUI_CANCELBUTTON_STYLE_CONSTANT = 0 | 清除按钮常显样式。 |
687| ARKUI_CANCELBUTTON_STYLE_INVISIBLE | 清除按钮常隐样式。 |
688| ARKUI_CANCELBUTTON_STYLE_INPUT | 清除按钮输入样式。 |
689
690### ArkUI_XComponentType
691
692```
693enum ArkUI_XComponentType
694```
695
696**描述:**
697
698
699定义XComponent类型枚举值。
700
701**起始版本:** 12
702
703| 枚举项 | 描述 |
704| -- | -- |
705| ARKUI_XCOMPONENT_TYPE_SURFACE = 0 | 用于EGL/OpenGLES和媒体数据写入,开发者定制绘制内容单独显示在屏幕上。 |
706| ARKUI_XCOMPONENT_TYPE_TEXTURE = 2 | 用于EGL/OpenGLES和媒体数据写入,开发者定制绘制内容和XComponent组件内容合成后展示在屏幕上。 |
707
708### ArkUI_ProgressType
709
710```
711enum ArkUI_ProgressType
712```
713
714**描述:**
715
716
717定义进度条类型枚举值。
718
719**起始版本:** 12
720
721| 枚举项 | 描述 |
722| -- | -- |
723| ARKUI_PROGRESS_TYPE_LINEAR = 0 | 线性样式。 |
724| ARKUI_PROGRESS_TYPE_RING | 环形无刻度样式。 |
725| ARKUI_PROGRESS_TYPE_ECLIPSE | 圆形样式。 |
726| ARKUI_PROGRESS_TYPE_SCALE_RING | 环形有刻度样式。 |
727| ARKUI_PROGRESS_TYPE_CAPSULE | 胶囊样式。 |
728
729### ArkUI_TextDecorationType
730
731```
732enum ArkUI_TextDecorationType
733```
734
735**描述:**
736
737
738定义装饰线类型枚举值。
739
740**起始版本:** 12
741
742| 枚举项 | 描述 |
743| -- | -- |
744| ARKUI_TEXT_DECORATION_TYPE_NONE = 0 | 不使用装饰线。 |
745| ARKUI_TEXT_DECORATION_TYPE_UNDERLINE | 文字下划线修饰。 |
746| ARKUI_TEXT_DECORATION_TYPE_OVERLINE | 文字上划线修饰。 |
747| ARKUI_TEXT_DECORATION_TYPE_LINE_THROUGH | 穿过文本的修饰线。 |
748
749### ArkUI_TextDecorationStyle
750
751```
752enum ArkUI_TextDecorationStyle
753```
754
755**描述:**
756
757
758定义装饰线样式枚举值。
759
760**起始版本:** 12
761
762| 枚举项 | 描述 |
763| -- | -- |
764| ARKUI_TEXT_DECORATION_STYLE_SOLID = 0 | 单实线。 |
765| ARKUI_TEXT_DECORATION_STYLE_DOUBLE | 双实线。 |
766| ARKUI_TEXT_DECORATION_STYLE_DOTTED | 点线。 |
767| ARKUI_TEXT_DECORATION_STYLE_DASHED | 虚线。 |
768| ARKUI_TEXT_DECORATION_STYLE_WAVY | 波浪线。 |
769
770### ArkUI_TextCase
771
772```
773enum ArkUI_TextCase
774```
775
776**描述:**
777
778
779定义文本大小写枚举值。
780
781**起始版本:** 12
782
783| 枚举项 | 描述 |
784| -- | -- |
785| ARKUI_TEXT_CASE_NORMAL = 0 | 保持原有大小写。 |
786| ARKUI_TEXT_CASE_LOWER | 文本全小写。 |
787| ARKUI_TEXT_CASE_UPPER | 文本全大写。 |
788
789### ArkUI_CopyOptions
790
791```
792enum ArkUI_CopyOptions
793```
794
795**描述:**
796
797
798定义文本复制粘贴模式枚举值。
799
800**起始版本:** 12
801
802| 枚举项 | 描述 |
803| -- | -- |
804| ARKUI_COPY_OPTIONS_NONE = 0 | 不支持复制。 |
805| ARKUI_COPY_OPTIONS_IN_APP | 支持应用内复制。 |
806| ARKUI_COPY_OPTIONS_LOCAL_DEVICE | 支持设备内复制。 |
807| ARKUI_COPY_OPTIONS_CROSS_DEVICE | 支持跨设备复制。 |
808
809### ArkUI_ShadowType
810
811```
812enum ArkUI_ShadowType
813```
814
815**描述:**
816
817
818定义阴影类型枚举值。
819
820**起始版本:** 12
821
822| 枚举项 | 描述 |
823| -- | -- |
824| ARKUI_SHADOW_TYPE_COLOR = 0 | 颜色。 |
825| ARKUI_SHADOW_TYPE_BLUR | 模糊。 |
826
827### ArkUI_DatePickerMode
828
829```
830enum ArkUI_DatePickerMode
831```
832
833**描述:**
834
835
836定义日期选择器列显示模式的枚举值。
837
838**起始版本:** 18
839
840| 枚举项 | 描述 |
841| -- | -- |
842| ARKUI_DATEPICKER_MODE_DATE = 0 | 默认值。日期列显示年、月、日三列。 |
843| ARKUI_DATEPICKER_YEAR_AND_MONTH = 1 | 日期列显示年、月二列。 |
844| ARKUI_DATEPICKER_MONTH_AND_DAY = 2 | 日期列显示月、日二列。 |
845
846### ArkUI_TextPickerRangeType
847
848```
849enum ArkUI_TextPickerRangeType
850```
851
852**描述:**
853
854
855定义滑动选择文本选择器输入类型。
856
857**起始版本:** 12
858
859| 枚举项 | 描述 |
860| -- | -- |
861| ARKUI_TEXTPICKER_RANGETYPE_SINGLE = 0 | 单列数据选择器。 |
862| ARKUI_TEXTPICKER_RANGETYPE_MULTI | 多列数据选择器。 |
863| ARKUI_TEXTPICKER_RANGETYPE_RANGE_CONTENT | 支持图片资源的单列数据选择器。 |
864| ARKUI_TEXTPICKER_RANGETYPE_CASCADE_RANGE_CONTENT | 支持联动的多列数据选择器。 |
865
866### ArkUI_AccessibilityCheckedState
867
868```
869enum ArkUI_AccessibilityCheckedState
870```
871
872**描述:**
873
874
875定义无障碍复选框状态类型枚举值。
876
877**起始版本:** 12
878
879| 枚举项 | 描述 |
880| -- | -- |
881| ARKUI_ACCESSIBILITY_UNCHECKED = 0 | 复选框未被选中。 |
882| ARKUI_ACCESSIBILITY_CHECKED | 复选框被选中。 |
883
884### ArkUI_AccessibilityActionType
885
886```
887enum ArkUI_AccessibilityActionType
888```
889
890**描述:**
891
892
893定义无障碍操作类型。
894
895**起始版本:** 12
896
897| 枚举项 | 描述 |
898| -- | -- |
899| ARKUI_ACCESSIBILITY_ACTION_CLICK = 1 << 0 | 点击操作。 |
900| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK = 1 << 1 | 长按操作。 |
901| ARKUI_ACCESSIBILITY_ACTION_CUT = 1 << 2 | 剪切操作。 |
902| ARKUI_ACCESSIBILITY_ACTION_COPY = 1 << 3 | 复制操作。 |
903| ARKUI_ACCESSIBILITY_ACTION_PASTE = 1 << 4 | 粘贴操作。 |
904
905### ArkUI_EdgeEffect
906
907```
908enum ArkUI_EdgeEffect
909```
910
911**描述:**
912
913
914定义边缘滑动效果枚举值。
915
916**起始版本:** 12
917
918| 枚举项 | 描述 |
919| -- | -- |
920| ARKUI_EDGE_EFFECT_SPRING = 0 | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 |
921| ARKUI_EDGE_EFFECT_FADE | 阴影效果,滑动到边缘后会有圆弧状的阴影。 |
922| ARKUI_EDGE_EFFECT_NONE | 滑动到边缘后无效果。 |
923
924### ArkUI_EffectEdge
925
926```
927enum ArkUI_EffectEdge
928```
929
930**描述:**
931
932
933定义边缘效果生效边缘的方向枚举值。
934
935**起始版本:** 18
936
937| 枚举项 | 描述                    |
938| -- |-----------------------|
939| ARKUI_EFFECT_EDGE_START = 1 | 起始边生效。                |
940| ARKUI_EFFECT_EDGE_END = 2 | 末尾边生效。                |
941
942### ArkUI_ScrollDirection
943
944```
945enum ArkUI_ScrollDirection
946```
947
948**描述:**
949
950
951定义Scroll组件排列方向枚举值。
952
953**起始版本:** 12
954
955| 枚举项 | 描述 |
956| -- | -- |
957| ARKUI_SCROLL_DIRECTION_VERTICAL = 0 | 仅支持竖直方向滚动。 |
958| ARKUI_SCROLL_DIRECTION_HORIZONTAL | 仅支持水平方向滚动。 |
959| ARKUI_SCROLL_DIRECTION_NONE = 3 | 禁止滚动。 |
960| ARKUI_SCROLL_DIRECTION_FREE = 4 | 自由滚动。<br>**起始版本:** 20 |
961
962### ArkUI_ScrollSnapAlign
963
964```
965enum ArkUI_ScrollSnapAlign
966```
967
968**描述:**
969
970
971定义列表项滚动结束对齐效果枚举值。
972
973**起始版本:** 12
974
975| 枚举项 | 描述 |
976| -- | -- |
977| ARKUI_SCROLL_SNAP_ALIGN_NONE = 0 | 默认无项目滚动对齐效果。 |
978| ARKUI_SCROLL_SNAP_ALIGN_START | 视图中的第一项将在列表的开头对齐。 |
979| ARKUI_SCROLL_SNAP_ALIGN_CENTER | 视图中的中间项将在列表中心对齐。 |
980| ARKUI_SCROLL_SNAP_ALIGN_END | 视图中的最后一项将在列表末尾对齐。 |
981
982### ArkUI_ScrollBarDisplayMode
983
984```
985enum ArkUI_ScrollBarDisplayMode
986```
987
988**描述:**
989
990
991定义滚动条状态枚举值。
992
993**起始版本:** 12
994
995| 枚举项 | 描述 |
996| -- | -- |
997| ARKUI_SCROLL_BAR_DISPLAY_MODE_OFF = 0 | 不显示。 |
998| ARKUI_SCROLL_BAR_DISPLAY_MODE_AUTO | 按需显示(触摸时显示,2s后消失)。 |
999| ARKUI_SCROLL_BAR_DISPLAY_MODE_ON | 常驻显示。 |
1000
1001### ArkUI_Axis
1002
1003```
1004enum ArkUI_Axis
1005```
1006
1007**描述:**
1008
1009
1010定义滚动方向和List组件排列方向枚举值。
1011
1012**起始版本:** 12
1013
1014| 枚举项 | 描述 |
1015| -- | -- |
1016| ARKUI_AXIS_VERTICAL = 0 | 仅支持竖直方向滚动。 |
1017| ARKUI_AXIS_HORIZONTAL | 仅支持水平方向滚动。 |
1018
1019### ArkUI_StickyStyle
1020
1021```
1022enum ArkUI_StickyStyle
1023```
1024
1025**描述:**
1026
1027
1028定义列表是否吸顶和吸底枚举值。
1029
1030**起始版本:** 12
1031
1032| 枚举项 | 描述 |
1033| -- | -- |
1034| ARKUI_STICKY_STYLE_NONE = 0 | ListItemGroup的header不吸顶,footer不吸底。 |
1035| ARKUI_STICKY_STYLE_HEADER = 1 | ListItemGroup的header吸顶,footer不吸底。 |
1036| ARKUI_STICKY_STYLE_FOOTER = 2 | ListItemGroup的footer吸底,header不吸顶。 |
1037| ARKUI_STICKY_STYLE_BOTH = 3 | ListItemGroup的footer吸底,header吸顶。 |
1038
1039### ArkUI_ContentClipMode
1040
1041```
1042enum ArkUI_ContentClipMode
1043```
1044
1045**描述:**
1046
1047
1048定义滚动容器的内容层裁剪区域枚举值。
1049
1050**起始版本:** 18
1051
1052| 枚举项 | 描述 |
1053| -- | -- |
1054| ARKUI_CONTENT_CLIP_MODE_CONTENT_ONLY = 0 | 按内容区裁剪。 |
1055| ARKUI_CONTENT_CLIP_MODE_BOUNDARY | 按组件区域裁剪。 |
1056| ARKUI_CONTENT_CLIP_MODE_SAFE_AREA | 按组件配置的SafeArea区域裁剪。 |
1057
1058### ArkUI_WaterFlowLayoutMode
1059
1060```
1061enum ArkUI_WaterFlowLayoutMode
1062```
1063
1064**描述:**
1065
1066
1067定义WaterFlow组件布局模式枚举值。
1068
1069**起始版本:** 18
1070
1071| 枚举项 | 描述 |
1072| -- | -- |
1073| ARKUI_WATER_FLOW_LAYOUT_MODE_ALWAYS_TOP_DOWN = 0 | 从上到下布局。列数切换场景需要从第一个FlowItem开始布局到当前显示的FlowItem。 |
1074| ARKUI_WATER_FLOW_LAYOUT_MODE_SLIDING_WINDOW | 移动窗口布局。列数切换场景只重新布局当前显示范围到FlowItem,手指向下滑动再布局从上方进入显示范围的FlowItem。 |
1075
1076### ArkUI_BorderStyle
1077
1078```
1079enum ArkUI_BorderStyle
1080```
1081
1082**描述:**
1083
1084
1085边框线条样式枚举值。
1086
1087**起始版本:** 12
1088
1089| 枚举项 | 描述 |
1090| -- | -- |
1091| ARKUI_BORDER_STYLE_SOLID = 0 | 显示为一条实线。 |
1092| ARKUI_BORDER_STYLE_DASHED | 显示为一系列短的方形虚线。 |
1093| ARKUI_BORDER_STYLE_DOTTED | 显示为一系列圆点。 |
1094
1095### ArkUI_HitTestMode
1096
1097```
1098enum ArkUI_HitTestMode
1099```
1100
1101**描述:**
1102
1103
1104触摸测试控制枚举值。
1105
1106**起始版本:** 12
1107
1108| 枚举项 | 描述                                                     |
1109| -- |--------------------------------------------------------|
1110| ARKUI_HIT_TEST_MODE_DEFAULT = 0 | 默认触摸测试效果。                                              |
1111| ARKUI_HIT_TEST_MODE_BLOCK | 自身响应触摸测试。                                              |
1112| ARKUI_HIT_TEST_MODE_TRANSPARENT | 自身和子节点都响应触摸测试。                                         |
1113| ARKUI_HIT_TEST_MODE_NONE | 自身不响应触摸测试。                                             |
1114| ARKUI_HIT_TEST_MODE_BLOCK_HIERARCHY | 阻止所有优先级较低的兄弟节点和父节点参与触摸测试,自身和子节点响应触摸测试。<br>**起始版本:** 20 |
1115| ARKUI_HIT_TEST_MODE_BLOCK_DESCENDANTS | 自身不响应触摸测试,并且所有的后代(孩子,孙子等)也不响应触摸测试。<br>**起始版本:** 20                     |
1116
1117### ArkUI_ShadowStyle
1118
1119```
1120enum ArkUI_ShadowStyle
1121```
1122
1123**描述:**
1124
1125
1126阴影效果枚举值。
1127
1128**起始版本:** 12
1129
1130| 枚举项 | 描述 |
1131| -- | -- |
1132| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_XS = 0 | 超小阴影。 |
1133| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_SM | 小阴影。 |
1134| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_MD | 中阴影。 |
1135| ARKUI_SHADOW_STYLE_OUTER_DEFAULT_LG | 大阴影。 |
1136| ARKUI_SHADOW_STYLE_OUTER_FLOATING_SM | 浮动小阴影。 |
1137| ARKUI_SHADOW_STYLE_OUTER_FLOATING_MD | 浮动中阴影。 |
1138
1139### ArkUI_AnimationCurve
1140
1141```
1142enum ArkUI_AnimationCurve
1143```
1144
1145**描述:**
1146
1147
1148动画曲线枚举值。
1149
1150**起始版本:** 12
1151
1152| 枚举项 | 描述 |
1153| -- | -- |
1154| ARKUI_CURVE_LINEAR = 0 | 动画从头到尾的速度都是相同。 |
1155| ARKUI_CURVE_EASE | 动画以低速开始,然后加快,在结束前变慢。 |
1156| ARKUI_CURVE_EASE_IN | 动画以低速开始。 |
1157| ARKUI_CURVE_EASE_OUT | 动画以低速结束。 |
1158| ARKUI_CURVE_EASE_IN_OUT | 动画以低速开始和结束。 |
1159| ARKUI_CURVE_FAST_OUT_SLOW_IN | 动画标准曲线。 |
1160| ARKUI_CURVE_LINEAR_OUT_SLOW_IN | 动画减速曲线。 |
1161| ARKUI_CURVE_FAST_OUT_LINEAR_IN | 动画加速曲线。 |
1162| ARKUI_CURVE_EXTREME_DECELERATION | 动画急缓曲线。 |
1163| ARKUI_CURVE_SHARP | 动画锐利曲线。 |
1164| ARKUI_CURVE_RHYTHM | 动画节奏曲线。 |
1165| ARKUI_CURVE_SMOOTH | 动画平滑曲线。 |
1166| ARKUI_CURVE_FRICTION | 动画阻尼曲线。 |
1167
1168### ArkUI_SwiperArrow
1169
1170```
1171enum ArkUI_SwiperArrow
1172```
1173
1174**描述:**
1175
1176
1177Swiper导航点箭头枚举值。
1178
1179**起始版本:** 12
1180
1181| 枚举项 | 描述 |
1182| -- | -- |
1183| ARKUI_SWIPER_ARROW_HIDE = 0 | 不显示swiper中导航点箭头。 |
1184| ARKUI_SWIPER_ARROW_SHOW | 显示swiper中导航点箭头。 |
1185| ARKUI_SWIPER_ARROW_SHOW_ON_HOVER | 在hover状态下显示swiper中导航点箭头。 |
1186
1187### ArkUI_SwiperNestedScrollMode
1188
1189```
1190enum ArkUI_SwiperNestedScrollMode
1191```
1192
1193**描述:**
1194
1195
1196Swiper组件和父组件的嵌套滚动模式。
1197
1198**起始版本:** 12
1199
1200| 枚举项 | 描述 |
1201| -- | -- |
1202| ARKUI_SWIPER_NESTED_SRCOLL_SELF_ONLY = 0 | Swiper只自身滚动,不与父组件联动。 |
1203| ARKUI_SWIPER_NESTED_SRCOLL_SELF_FIRST | Swiper自身先滚动,自身滚动到边缘以后父组件滚动。父组件滚动到边缘以后,如果父组件有边缘效果,则父组件触发边缘效果,否则Swiper触发边缘效果。 |
1204
1205### ArkUI_PageFlipMode
1206
1207```
1208enum ArkUI_PageFlipMode
1209```
1210
1211**描述:**
1212
1213
1214Swiper组件鼠标滚轮翻页模式。
1215
1216**起始版本:** 15
1217
1218| 枚举项 | 描述 |
1219| -- | -- |
1220| ARKUI_PAGE_FLIP_MODE_CONTINUOUS = 0 | 鼠标滚轮连续滚动时翻多页,根据鼠标事件上报次数确定。 |
1221| ARKUI_PAGE_FLIP_MODE_SINGLE | 一次翻页动画结束前不响应其他鼠标滚轮事件。 |
1222
1223### ArkUI_SwiperAnimationMode
1224
1225```
1226enum ArkUI_SwiperAnimationMode
1227```
1228
1229**描述:**
1230
1231
1232Swiper组件跳转到目标index的动画模式。
1233
1234**起始版本:** 15
1235
1236| 枚举项 | 描述 |
1237| -- | -- |
1238| ARKUI_SWIPER_NO_ANIMATION = 0 | 无动画跳转到目标index。 |
1239| ARKUI_SWIPER_DEFAULT_ANIMATION = 1 | 做动画跳转到目标index。 |
1240| ARKUI_SWIPER_FAST_ANIMATION = 2 | 先无动画跳转到目标附近再做动画跳转到目标index。 |
1241
1242### ArkUI_AccessibilityMode
1243
1244```
1245enum ArkUI_AccessibilityMode
1246```
1247
1248**描述:**
1249
1250
1251定义无障碍辅助服务模式。
1252
1253**起始版本:** 12
1254
1255| 枚举项 | 描述 |
1256| -- | -- |
1257| ARKUI_ACCESSIBILITY_MODE_AUTO = 0 | 根据组件不同会转换为“enabled”或者“disabled”。 |
1258| ARKUI_ACCESSIBILITY_MODE_ENABLED | 当前组件可被无障碍辅助服务所识别。 |
1259| ARKUI_ACCESSIBILITY_MODE_DISABLED | 当前组件不可被无障碍辅助服务所识别。 |
1260| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS | 当前组件及其所有子组件不可被无障碍辅助服务所识别。 |
1261
1262### ArkUI_TextCopyOptions
1263
1264```
1265enum ArkUI_TextCopyOptions
1266```
1267
1268**描述:**
1269
1270
1271定义组件支持设置文本是否可复制粘贴。
1272
1273**起始版本:** 12
1274
1275| 枚举项 | 描述 |
1276| -- | -- |
1277| ARKUI_TEXT_COPY_OPTIONS_NONE = 0 | 不支持复制。 |
1278| ARKUI_TEXT_COPY_OPTIONS_IN_APP | 支持应用内复制。 |
1279| ARKUI_TEXT_COPY_OPTIONS_LOCAL_DEVICE | 支持设备内复制。 |
1280| ARKUI_TEXT_COPY_OPTIONS_CROSS_DEVICE | 支持跨设备复制。 |
1281
1282### ArkUI_TextHeightAdaptivePolicy
1283
1284```
1285enum ArkUI_TextHeightAdaptivePolicy
1286```
1287
1288**描述:**
1289
1290
1291定义文本自适应高度的方式。
1292
1293**起始版本:** 12
1294
1295| 枚举项 | 描述 |
1296| -- | -- |
1297| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST = 0 | 设置文本高度自适应方式为以MaxLines优先。 |
1298| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST | 设置文本高度自适应方式为以缩小字体优先。 |
1299| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST | 设置文本高度自适应方式为以布局约束(高度)优先。 |
1300
1301### ArkUI_ScrollNestedMode
1302
1303```
1304enum ArkUI_ScrollNestedMode
1305```
1306
1307**描述:**
1308
1309
1310定义嵌套滚动选项。
1311
1312**起始版本:** 12
1313
1314| 枚举项 | 描述 |
1315| -- | -- |
1316| ARKUI_SCROLL_NESTED_MODE_SELF_ONLY = 0 | 只自身滚动,不与父组件联动。 |
1317| ARKUI_SCROLL_NESTED_MODE_SELF_FIRST | 自身先滚动,自身滚动到边缘以后父组件滚动。父组件滚动到边缘以后 |
1318| ARKUI_SCROLL_NESTED_MODE_PARENT_FIRST | 父组件先滚动,父组件滚动到边缘以后自身滚动。 |
1319| ARKUI_SCROLL_NESTED_MODE_PARALLEL | 自身和父组件同时滚动,自身和父组件都到达边缘以后 |
1320
1321### ArkUI_ScrollEdge
1322
1323```
1324enum ArkUI_ScrollEdge
1325```
1326
1327**描述:**
1328
1329
1330定义滚动到的边缘位置。
1331
1332**起始版本:** 12
1333
1334| 枚举项 | 描述 |
1335| -- | -- |
1336| ARKUI_SCROLL_EDGE_TOP = 0 | 竖直方向上边缘。 |
1337| ARKUI_SCROLL_EDGE_BOTTOM | 竖直方向下边缘。 |
1338| ARKUI_SCROLL_EDGE_START | 水平方向起始位置。 |
1339| ARKUI_SCROLL_EDGE_END | 水平方向末尾位置。 |
1340
1341### ArkUI_ScrollAlignment
1342
1343```
1344enum ArkUI_ScrollAlignment
1345```
1346
1347**描述:**
1348
1349
1350滚动到具体item时的对齐方式。
1351
1352**起始版本:** 12
1353
1354| 枚举项 | 描述 |
1355| -- | -- |
1356| ARKUI_SCROLL_ALIGNMENT_START = 0 | 首部对齐。指定item首部与容器首部对齐。 |
1357| ARKUI_SCROLL_ALIGNMENT_CENTER | 居中对齐。指定item主轴方向居中对齐于容器。 |
1358| ARKUI_SCROLL_ALIGNMENT_END | 尾部对齐。指定item尾部与容器尾部对齐。 |
1359| ARKUI_SCROLL_ALIGNMENT_AUTO | 自动对齐。若指定item完全处于显示区,不做调整。否则依照滑动距离最短的原则,将指定item首部对齐或尾部对齐于容器,使指定item完全处于显示区。 |
1360
1361### ArkUI_ScrollState
1362
1363```
1364enum ArkUI_ScrollState
1365```
1366
1367**描述:**
1368
1369
1370定义当前滚动状态。
1371
1372**起始版本:** 12
1373
1374| 枚举项 | 描述 |
1375| -- | -- |
1376| ARKUI_SCROLL_STATE_IDLE = 0 | 空闲状态。使用控制器提供的方法控制滚动时触发,拖动滚动条滚动时触发。 |
1377| ARKUI_SCROLL_STATE_SCROLL | 滚动状态。使用手指拖动容器滚动时触发。 |
1378| ARKUI_SCROLL_STATE_FLING | 惯性滚动状态。快速划动松手后进行惯性滚动和划动到边缘回弹时触发。 |
1379
1380### ArkUI_SliderBlockStyle
1381
1382```
1383enum ArkUI_SliderBlockStyle
1384```
1385
1386**描述:**
1387
1388
1389定义滑块形状。
1390
1391**起始版本:** 12
1392
1393| 枚举项 | 描述 |
1394| -- | -- |
1395| ARKUI_SLIDER_BLOCK_STYLE_DEFAULT = 0 | 使用默认滑块(圆形)。 |
1396| ARKUI_SLIDER_BLOCK_STYLE_IMAGE | 使用图片资源作为滑块。 |
1397| ARKUI_SLIDER_BLOCK_STYLE_SHAPE | 使用自定义形状作为滑块。 |
1398
1399### ArkUI_SliderDirection
1400
1401```
1402enum ArkUI_SliderDirection
1403```
1404
1405**描述:**
1406
1407
1408定义滑动条滑动方向。
1409
1410**起始版本:** 12
1411
1412| 枚举项 | 描述 |
1413| -- | -- |
1414| ARKUI_SLIDER_DIRECTION_VERTICAL = 0 | 方向为纵向。 |
1415| ARKUI_SLIDER_DIRECTION_HORIZONTAL | 方向为横向。 |
1416
1417### ArkUI_SliderStyle
1418
1419```
1420enum ArkUI_SliderStyle
1421```
1422
1423**描述:**
1424
1425
1426定义滑块与滑轨显示样式。
1427
1428**起始版本:** 12
1429
1430| 枚举项 | 描述 |
1431| -- | -- |
1432| ARKUI_SLIDER_STYLE_OUT_SET = 0 | 滑块在滑轨上。 |
1433| ARKUI_SLIDER_STYLE_IN_SET | 滑块在滑轨内。 |
1434| ARKUI_SLIDER_STYLE_NONE | 无滑块。 |
1435
1436### ArkUI_CheckboxShape
1437
1438```
1439enum ArkUI_CheckboxShape
1440```
1441
1442**描述:**
1443
1444
1445定义CheckBox组件形状。
1446
1447**起始版本:** 12
1448
1449| 枚举项 | 描述 |
1450| -- | -- |
1451| ArkUI_CHECKBOX_SHAPE_CIRCLE = 0 | 圆形。 |
1452| ArkUI_CHECKBOX_SHAPE_ROUNDED_SQUARE | 圆角方形。 |
1453
1454### ArkUI_AnimationPlayMode
1455
1456```
1457enum ArkUI_AnimationPlayMode
1458```
1459
1460**描述:**
1461
1462
1463定义动画播放模式。
1464
1465**起始版本:** 12
1466
1467| 枚举项 | 描述 |
1468| -- | -- |
1469| ARKUI_ANIMATION_PLAY_MODE_NORMAL = 0 | 动画正向播放。 |
1470| ARKUI_ANIMATION_PLAY_MODE_REVERSE | 动画反向播放。 |
1471| ARKUI_ANIMATION_PLAY_MODE_ALTERNATE | 动画在奇数次(1、3、5...)正向播放,在偶数次(2、4、6...)反向播放。 |
1472| ARKUI_ANIMATION_PLAY_MODE_ALTERNATE_REVERSE | 动画在奇数次(1、3、5...)反向播放,在偶数次(2、4、6...)正向播放。 |
1473
1474### ArkUI_ImageSize
1475
1476```
1477enum ArkUI_ImageSize
1478```
1479
1480**描述:**
1481
1482
1483定义图片宽高样式。
1484
1485**起始版本:** 12
1486
1487| 枚举项 | 描述 |
1488| -- | -- |
1489| ARKUI_IMAGE_SIZE_AUTO = 0 | 保持原图的比例不变。 |
1490| ARKUI_IMAGE_SIZE_COVER | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。 |
1491| ARKUI_IMAGE_SIZE_CONTAIN | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。 |
1492
1493### ArkUI_AdaptiveColor
1494
1495```
1496enum ArkUI_AdaptiveColor
1497```
1498
1499**描述:**
1500
1501
1502定义取色模式。
1503
1504**起始版本:** 12
1505
1506| 枚举项 | 描述 |
1507| -- | -- |
1508| ARKUI_ADAPTIVE_COLOR_DEFAULT = 0 | 不使用取色模糊。 |
1509| ARKUI_ADAPTIVE_COLOR_AVERAGE | 使用取色模糊。 |
1510
1511### ArkUI_ColorMode
1512
1513```
1514enum ArkUI_ColorMode
1515```
1516
1517**描述:**
1518
1519
1520定义深浅色模式。
1521
1522**起始版本:** 12
1523
1524| 枚举项 | 描述 |
1525| -- | -- |
1526| ARKUI_COLOR_MODE_SYSTEM = 0 | 跟随系统深浅色模式。 |
1527| ARKUI_COLOR_MODE_LIGHT | 固定使用浅色模式。 |
1528| ARKUI_COLOR_MODE_DARK | 固定使用深色模式。 |
1529
1530### ArkUI_SystemColorMode
1531
1532```
1533enum ArkUI_SystemColorMode
1534```
1535
1536**描述:**
1537
1538
1539定义系统深浅色模式。
1540
1541**起始版本:** 12
1542
1543| 枚举项 | 描述 |
1544| -- | -- |
1545| ARKUI_SYSTEM_COLOR_MODE_LIGHT = 0 | 浅色模式。 |
1546| ARKUI_SYSTEM_COLOR_MODE_DARK | 深色模式。 |
1547
1548### ArkUI_BlurStyle
1549
1550```
1551enum ArkUI_BlurStyle
1552```
1553
1554**描述:**
1555
1556
1557定义背景模糊样式。
1558
1559**起始版本:** 12
1560
1561| 枚举项 | 描述 |
1562| -- | -- |
1563| ARKUI_BLUR_STYLE_THIN = 0 | 轻薄材质模糊。 |
1564| ARKUI_BLUR_STYLE_REGULAR | 普通厚度材质模糊。 |
1565| ARKUI_BLUR_STYLE_THICK | 厚材质模糊。 |
1566| ARKUI_BLUR_STYLE_BACKGROUND_THIN | 近距景深模糊。 |
1567| ARKUI_BLUR_STYLE_BACKGROUND_REGULAR | 中距景深模糊。 |
1568| ARKUI_BLUR_STYLE_BACKGROUND_THICK | 远距景深模糊。 |
1569| ARKUI_BLUR_STYLE_BACKGROUND_ULTRA_THICK | 超远距景深模糊。 |
1570| ARKUI_BLUR_STYLE_NONE | 关闭模糊。 |
1571| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THIN | 组件超轻薄材质模糊。 |
1572| ARKUI_BLUR_STYLE_COMPONENT_THIN | 组件轻薄材质模糊。 |
1573| ARKUI_BLUR_STYLE_COMPONENT_REGULAR | 组件普通材质模糊。 |
1574| ARKUI_BLUR_STYLE_COMPONENT_THICK | 组件厚材质模糊。 |
1575| ARKUI_BLUR_STYLE_COMPONENT_ULTRA_THICK | 组件超厚材质模糊。 |
1576
1577### ArkUI_BlurStyleActivePolicy
1578
1579```
1580enum ArkUI_BlurStyleActivePolicy
1581```
1582
1583**描述:**
1584
1585
1586定义背景模糊激活策略。
1587
1588**起始版本:** 19
1589
1590| 枚举项 | 描述 |
1591| -- | -- |
1592| ARKUI_BLUR_STYLE_ACTIVE_POLICY_FOLLOWS_WINDOW_ACTIVE_STATE = 0 | 模糊效果跟随窗口焦点状态变化,非焦点不模糊,焦点模糊。 |
1593| ARKUI_BLUR_STYLE_ACTIVE_POLICY_ALWAYS_ACTIVE | 一直有模糊效果。 |
1594| ARKUI_BLUR_STYLE_ACTIVE_POLICY_ALWAYS_INACTIVE | 一直无模糊效果。 |
1595
1596### ArkUI_VerticalAlignment
1597
1598```
1599enum ArkUI_VerticalAlignment
1600```
1601
1602**描述:**
1603
1604
1605定义垂直对齐方式。
1606
1607**起始版本:** 12
1608
1609| 枚举项 | 描述 |
1610| -- | -- |
1611| ARKUI_VERTICAL_ALIGNMENT_TOP = 0 | 顶部对齐。 |
1612| ARKUI_VERTICAL_ALIGNMENT_CENTER | 居中对齐,默认对齐方式。 |
1613| ARKUI_VERTICAL_ALIGNMENT_BOTTOM | 底部对齐。 |
1614
1615### ArkUI_HorizontalAlignment
1616
1617```
1618enum ArkUI_HorizontalAlignment
1619```
1620
1621**描述:**
1622
1623
1624定义语言方向对齐方式。
1625
1626**起始版本:** 12
1627
1628| 枚举项 | 描述 |
1629| -- | -- |
1630| ARKUI_HORIZONTAL_ALIGNMENT_START = 0 | 按照语言方向起始端对齐。 |
1631| ARKUI_HORIZONTAL_ALIGNMENT_CENTER | 居中对齐,默认对齐方式。 |
1632| ARKUI_HORIZONTAL_ALIGNMENT_END | 按照语言方向末端对齐。 |
1633
1634### ArkUI_TextOverflow
1635
1636```
1637enum ArkUI_TextOverflow
1638```
1639
1640**描述:**
1641
1642
1643定义文本超长时的显示方式。
1644
1645**起始版本:** 12
1646
1647| 枚举项 | 描述 |
1648| -- | -- |
1649| ARKUI_TEXT_OVERFLOW_NONE = 0 | 文本超长时不裁剪显示。 |
1650| ARKUI_TEXT_OVERFLOW_CLIP | 文本超长时进行裁剪显示。 |
1651| ARKUI_TEXT_OVERFLOW_ELLIPSIS | 文本超长时显示不下的文本用省略号代替。 |
1652| ARKUI_TEXT_OVERFLOW_MARQUEE | 文本超长时以跑马灯的方式展示。 |
1653
1654### ArkUI_ImageSpanAlignment
1655
1656```
1657enum ArkUI_ImageSpanAlignment
1658```
1659
1660**描述:**
1661
1662
1663定义图片基于文本的对齐方式。
1664
1665**起始版本:** 12
1666
1667| 枚举项 | 描述                                 |
1668| -- |------------------------------------|
1669| ARKUI_IMAGE_SPAN_ALIGNMENT_BASELINE = 0 | 图片下边沿与文本BaseLine对齐。                |
1670| ARKUI_IMAGE_SPAN_ALIGNMENT_BOTTOM | 图片下边沿与文本下边沿对齐。                     |
1671| ARKUI_IMAGE_SPAN_ALIGNMENT_CENTER | 图片中间与文本中间对齐。                       |
1672| ARKUI_IMAGE_SPAN_ALIGNMENT_TOP | 图片上边沿与文本上边沿对齐。                     |
1673| ARKUI_IMAGE_SPAN_ALIGNMENT_FOLLOW_PARAGRAPH | 图片对齐方式跟随Text组件对齐方式。<br>**起始版本:** 20 |
1674
1675### ArkUI_ObjectFit
1676
1677```
1678enum ArkUI_ObjectFit
1679```
1680
1681**描述:**
1682
1683
1684定义image填充效果。ImageSpanAlignment
1685
1686**起始版本:** 12
1687
1688| 枚举项 | 描述 |
1689| -- | -- |
1690| ARKUI_OBJECT_FIT_CONTAIN = 0 | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。 |
1691| ARKUI_OBJECT_FIT_COVER | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。 |
1692| ARKUI_OBJECT_FIT_AUTO | 自适应显示。 |
1693| ARKUI_OBJECT_FIT_FILL | 不保持宽高比进行放大缩小,使得图片充满显示边界。 |
1694| ARKUI_OBJECT_FIT_SCALE_DOWN | 保持宽高比显示,图片缩小或者保持不变。 |
1695| ARKUI_OBJECT_FIT_NONE | 保持原有尺寸显示。 |
1696| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_START | 图片大小不变,在image组件中顶部起始端对齐。 |
1697| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP | 图片大小不变,在image组件中顶部横向居中对齐。 |
1698| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_TOP_END | 图片大小不变,在image组件中顶部尾端对齐。 |
1699| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_START | 图片大小不变,在image组件中起始端纵向居中对齐。 |
1700| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_CENTER | 图片大小不变,在image组件中横向和纵向居中对齐。 |
1701| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_END | 图片大小不变,在image组件中尾端纵向居中对齐。 |
1702| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_START | 图片大小不变,在image组件中底部起始端对齐。 |
1703| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM | 图片大小不变,在image组件中底部横向居中对齐。 |
1704| ARKUI_OBJECT_FIT_NONE_AND_ALIGN_BOTTOM_END | 图片大小不变,在image组件中底部尾端对齐。 |
1705
1706### ArkUI_ImageInterpolation
1707
1708```
1709enum ArkUI_ImageInterpolation
1710```
1711
1712**描述:**
1713
1714
1715定义图片插值效果。
1716
1717**起始版本:** 12
1718
1719| 枚举项 | 描述 |
1720| -- | -- |
1721| ARKUI_IMAGE_INTERPOLATION_NONE = 0 | 不使用图片插值。 |
1722| ARKUI_IMAGE_INTERPOLATION_LOW | 低图片插值。 |
1723| ARKUI_IMAGE_INTERPOLATION_MEDIUM | 中图片插值。 |
1724| ARKUI_IMAGE_INTERPOLATION_HIGH | 高图片插值,插值质量最高。 |
1725
1726### ArkUI_BlendMode
1727
1728```
1729enum ArkUI_BlendMode
1730```
1731
1732**描述:**
1733
1734
1735混合模式枚举值。
1736
1737**起始版本:** 12
1738
1739| 枚举项 | 描述 |
1740| -- | -- |
1741| ARKUI_BLEND_MODE_NONE = 0 | 将上层图像直接覆盖到下层图像上,不进行任何混合操作。 |
1742| ARKUI_BLEND_MODE_CLEAR | 将源像素覆盖的目标像素清除为完全透明。 |
1743| ARKUI_BLEND_MODE_SRC | r = s,只显示源像素。 |
1744| ARKUI_BLEND_MODE_DST | r = d,只显示目标像素。 |
1745| ARKUI_BLEND_MODE_SRC_OVER | r = s + (1 - sa) * d,将源像素按照透明度进行混合,覆盖在目标像素上。 |
1746| ARKUI_BLEND_MODE_DST_OVER | r = d + (1 - da) * s,将目标像素按照透明度进行混合,覆盖在源像素上。 |
1747| ARKUI_BLEND_MODE_SRC_IN | r = s * da,只显示源像素中与目标像素重叠的部分。 |
1748| ARKUI_BLEND_MODE_DST_IN | r = d * sa,只显示目标像素中与源像素重叠的部分。 |
1749| ARKUI_BLEND_MODE_SRC_OUT | r = s * (1 - da),只显示源像素中与目标像素不重叠的部分。 |
1750| ARKUI_BLEND_MODE_DST_OUT | r = d * (1 - sa),只显示目标像素中与源像素不重叠的部分。 |
1751| ARKUI_BLEND_MODE_SRC_ATOP | r = s * da + d * (1 - sa),在源像素和目标像素重叠的地方绘制源像素,在源像素和目标像素不重叠的地方绘制目标像素。 |
1752| ARKUI_BLEND_MODE_DST_ATOP | r = d * sa + s * (1 - da),在源像素和目标像素重叠的地方绘制目标像素,在源像素和目标像素不重叠的地方绘制源像素。 |
1753| ARKUI_BLEND_MODE_XOR | r = s * (1 - da) + d * (1 - sa),只显示源像素与目标像素不重叠的部分。 |
1754| ARKUI_BLEND_MODE_PLUS | r = min(s + d, 1),将源像素值与目标像素值相加,并将结果作为新的像素值。 |
1755| ARKUI_BLEND_MODE_MODULATE | r = s * d,将源像素与目标像素进行乘法运算,并将结果作为新的像素值。 |
1756| ARKUI_BLEND_MODE_SCREEN | r = s + d - s * d,将两个图像的像素值相加,然后减去它们的乘积来实现混合。 |
1757| ARKUI_BLEND_MODE_OVERLAY | 根据目标像素来决定使用MULTIPLY混合模式还是SCREEN混合模式。 |
1758| ARKUI_BLEND_MODE_DARKEN | rc = s + d - max(s * da, d * sa), ra = kSrcOver,当两个颜色重叠时,较暗的颜色会覆盖较亮的颜色。 |
1759| ARKUI_BLEND_MODE_LIGHTEN | rc = s + d - min(s * da, d * sa), ra = kSrcOver,将源图像和目标图像中的像素进行比较,选取两者中较亮的像素作为最终的混合结果。|
1760| ARKUI_BLEND_MODE_COLOR_DODGE | 使目标像素变得更亮来反映源像素。 |
1761| ARKUI_BLEND_MODE_COLOR_BURN | 使目标像素变得更暗来反映源像素。 |
1762| ARKUI_BLEND_MODE_HARD_LIGHT | 根据源像素的值来决定目标像素变得更亮或者更暗。根据源像素来决定使用MULTIPLY混合模式还是SCREEN混合模式。 |
1763| ARKUI_BLEND_MODE_SOFT_LIGHT | 根据源像素来决定使用LIGHTEN混合模式还是DARKEN混合模式。 |
1764| ARKUI_BLEND_MODE_DIFFERENCE | rc = s + d - 2 * (min(s * da, d * sa)), ra = kSrcOver,对比源像素和目标像素,亮度更高的像素减去亮度更低的像素,产生高对比度的效果。 |
1765| ARKUI_BLEND_MODE_EXCLUSION | rc = s + d - two(s * d), ra = kSrcOver,对比源像素和目标像素,亮度更高的像素减去亮度更低的像素,产生柔和的效果。 |
1766| ARKUI_BLEND_MODE_MULTIPLY | r = s * (1 - da) + d * (1 - sa) + s * d,将源图像与目标图像进行乘法混合,得到一张新的图像。 |
1767| ARKUI_BLEND_MODE_HUE | 保留源图像的亮度和饱和度,但会使用目标图像的色调来替换源图像的色调。 |
1768| ARKUI_BLEND_MODE_SATURATION | 保留目标像素的亮度和色调,但会使用源像素的饱和度来替换目标像素的饱和度。 |
1769| ARKUI_BLEND_MODE_COLOR | 保留源像素的饱和度和色调,但会使用目标像素的亮度来替换源像素的亮度。 |
1770| ARKUI_BLEND_MODE_LUMINOSITY | 保留目标像素的色调和饱和度,但会用源像素的亮度替换目标像素的亮度。 |
1771
1772### ArkUI_Direction
1773
1774```
1775enum ArkUI_Direction
1776```
1777
1778**描述:**
1779
1780
1781设置容器元素内主轴方向上的布局枚举值。
1782
1783**起始版本:** 12
1784
1785| 枚举项 | 描述 |
1786| -- | -- |
1787| ARKUI_DIRECTION_LTR = 0 | 元素从左到右布局。 |
1788| ARKUI_DIRECTION_RTL | 元素从右到左布局。 |
1789| ARKUI_DIRECTION_AUTO = 3 | 使用系统默认布局方向。 |
1790
1791### ArkUI_ItemAlignment
1792
1793```
1794enum ArkUI_ItemAlignment
1795```
1796
1797**描述:**
1798
1799
1800设置子组件在父容器交叉轴的对齐格式枚举值。
1801
1802**起始版本:** 12
1803
1804| 枚举项 | 描述 |
1805| -- | -- |
1806| ARKUI_ITEM_ALIGNMENT_AUTO = 0 | 使用Flex容器中默认配置。 |
1807| ARKUI_ITEM_ALIGNMENT_START | 元素在Flex容器中,交叉轴方向首部对齐。 |
1808| ARKUI_ITEM_ALIGNMENT_CENTER | 元素在Flex容器中,交叉轴方向居中对齐。 |
1809| ARKUI_ITEM_ALIGNMENT_END | 元素在Flex容器中,交叉轴方向底部对齐。 |
1810| ARKUI_ITEM_ALIGNMENT_STRETCH | 元素在Flex容器中,交叉轴方向拉伸填充。 |
1811| ARKUI_ITEM_ALIGNMENT_BASELINE | 元素在Flex容器中,交叉轴方向文本基线对齐。 |
1812
1813### ArkUI_ColorStrategy
1814
1815```
1816enum ArkUI_ColorStrategy
1817```
1818
1819**描述:**
1820
1821
1822前景色枚举值。
1823
1824**起始版本:** 12
1825
1826| 枚举项 | 描述 |
1827| -- | -- |
1828| ARKUI_COLOR_STRATEGY_INVERT = 0 | 前景色为控件背景色的反色。 |
1829| ARKUI_COLOR_STRATEGY_AVERAGE | 控件背景阴影色为控件背景阴影区域的平均色。 |
1830| ARKUI_COLOR_STRATEGY_PRIMARY | 控件背景阴影色为控件背景阴影区域的主色。 |
1831
1832### ArkUI_FlexAlignment
1833
1834```
1835enum ArkUI_FlexAlignment
1836```
1837
1838**描述:**
1839
1840
1841定义垂直方向对齐方式。
1842
1843**起始版本:** 12
1844
1845| 枚举项 | 描述 |
1846| -- | -- |
1847| ARKUI_FLEX_ALIGNMENT_START = 1 | 主轴方向首端对齐。 |
1848| ARKUI_FLEX_ALIGNMENT_CENTER = 2 | 主轴方向中心对齐。 |
1849| ARKUI_FLEX_ALIGNMENT_END = 3 | 主轴方向尾部对齐。 |
1850| ARKUI_FLEX_ALIGNMENT_SPACE_BETWEEN = 6 | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同,第一个元素行首对齐,最后的元素行尾对齐。 |
1851| ARKUI_FLEX_ALIGNMENT_SPACE_AROUND = 7 | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同,第一个元素到行首的距离时相邻元素间距离的一半。 |
1852| ARKUI_FLEX_ALIGNMENT_SPACE_EVENLY = 8 | Flex主轴方向均匀分配弹性元素,相邻元素之间距离、第一个元素到行首的距离和最后的元素到行尾的距离均相等。 |
1853
1854### ArkUI_FlexDirection
1855
1856```
1857enum ArkUI_FlexDirection
1858```
1859
1860**描述:**
1861
1862
1863定义Flex容器的主轴方向。
1864
1865**起始版本:** 12
1866
1867| 枚举项 | 描述 |
1868| -- | -- |
1869| ARKUI_FLEX_DIRECTION_ROW = 0 | 主轴与行方向一致。 |
1870| ARKUI_FLEX_DIRECTION_COLUMN | 主轴与列方向一致。 |
1871| ARKUI_FLEX_DIRECTION_ROW_REVERSE | 主轴与行方向相反。 |
1872| ARKUI_FLEX_DIRECTION_COLUMN_REVERSE | 主轴与列方向相反。 |
1873
1874### ArkUI_FlexWrap
1875
1876```
1877enum ArkUI_FlexWrap
1878```
1879
1880**描述:**
1881
1882
1883定义Flex行列布局模式模式。
1884
1885**起始版本:** 12
1886
1887| 枚举项 | 描述 |
1888| -- | -- |
1889| ARKUI_FLEX_WRAP_NO_WRAP = 0 | 单行/单列布局,子项不能超出容器。 |
1890| ARKUI_FLEX_WRAP_WRAP | 多行/多列布局,子项允许超出容器。 |
1891| ARKUI_FLEX_WRAP_WRAP_REVERSE | 反向多行/多列布局,子项允许超出容器。 |
1892
1893### ArkUI_Visibility
1894
1895```
1896enum ArkUI_Visibility
1897```
1898
1899**描述:**
1900
1901
1902控制组件的显隐枚举值。
1903
1904**起始版本:** 12
1905
1906| 枚举项 | 描述 |
1907| -- | -- |
1908| ARKUI_VISIBILITY_VISIBLE = 0 | 显示。 |
1909| ARKUI_VISIBILITY_HIDDEN | 隐藏,但参与布局进行占位。 |
1910| ARKUI_VISIBILITY_NONE | 隐藏,但不参与布局,不进行占位。 |
1911
1912### ArkUI_CalendarAlignment
1913
1914```
1915enum ArkUI_CalendarAlignment
1916```
1917
1918**描述:**
1919
1920
1921日历选择器与入口组件对齐方式。
1922
1923**起始版本:** 12
1924
1925| 枚举项 | 描述 |
1926| -- | -- |
1927| ARKUI_CALENDAR_ALIGNMENT_START = 0 | 选择器和入口组件左对齐方式。 |
1928| ARKUI_CALENDAR_ALIGNMENT_CENTER | 选择器和入口组件居中对齐方式。 |
1929| ARKUI_CALENDAR_ALIGNMENT_END | 选择器和入口组件右对齐方式。 |
1930
1931### ArkUI_MaskType
1932
1933```
1934enum ArkUI_MaskType
1935```
1936
1937**描述:**
1938
1939
1940遮罩类型枚举。
1941
1942**起始版本:** 12
1943
1944| 枚举项 | 描述 |
1945| -- | -- |
1946| ARKUI_MASK_TYPE_RECTANGLE = 0 | 矩形类型。 |
1947| ARKUI_MASK_TYPE_CIRCLE | 圆形类型。 |
1948| ARKUI_MASK_TYPE_ELLIPSE | 椭圆形类型。 |
1949| ARKUI_MASK_TYPE_PATH | 路径类型。 |
1950| ARKUI_MASK_TYPE_PROGRESS | 进度类型。 |
1951
1952### ArkUI_ClipType
1953
1954```
1955enum ArkUI_ClipType
1956```
1957
1958**描述:**
1959
1960
1961裁剪类型枚举。
1962
1963**起始版本:** 12
1964
1965| 枚举项 | 描述 |
1966| -- | -- |
1967| ARKUI_CLIP_TYPE_RECTANGLE = 0 | 矩形类型。 |
1968| ARKUI_CLIP_TYPE_CIRCLE | 圆形类型。 |
1969| ARKUI_CLIP_TYPE_ELLIPSE | 椭圆形类型。 |
1970| ARKUI_CLIP_TYPE_PATH | 路径类型。 |
1971
1972### ArkUI_ShapeType
1973
1974```
1975enum ArkUI_ShapeType
1976```
1977
1978**描述:**
1979
1980
1981自定义形状。
1982
1983**起始版本:** 12
1984
1985| 枚举项 | 描述 |
1986| -- | -- |
1987| ARKUI_SHAPE_TYPE_RECTANGLE = 0 | 矩形类型。 |
1988| ARKUI_SHAPE_TYPE_CIRCLE | 圆形类型。 |
1989| ARKUI_SHAPE_TYPE_ELLIPSE | 椭圆形类型。 |
1990| ARKUI_SHAPE_TYPE_PATH | 路径类型。 |
1991
1992### ArkUI_LinearGradientDirection
1993
1994```
1995enum ArkUI_LinearGradientDirection
1996```
1997
1998**描述:**
1999
2000
2001定义渐变方向结构。
2002
2003**起始版本:** 12
2004
2005| 枚举项 | 描述 |
2006| -- | -- |
2007| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT = 0 | 向左渐变。 |
2008| ARKUI_LINEAR_GRADIENT_DIRECTION_TOP | 向上渐变。 |
2009| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT | 向右渐变。 |
2010| ARKUI_LINEAR_GRADIENT_DIRECTION_BOTTOM | 向下渐变。 |
2011| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_TOP | 向左上渐变。 |
2012| ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM | 向左下渐变。 |
2013| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_TOP | 向右上渐变。 |
2014| ARKUI_LINEAR_GRADIENT_DIRECTION_RIGHT_BOTTOM | 向右下渐变。 |
2015| ARKUI_LINEAR_GRADIENT_DIRECTION_NONE | 不渐变。 |
2016| ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM | 自定义渐变方向. |
2017
2018### ArkUI_WordBreak
2019
2020```
2021enum ArkUI_WordBreak
2022```
2023
2024**描述:**
2025
2026
2027定义文本断行规则。
2028
2029**起始版本:** 12
2030
2031| 枚举项 | 描述 |
2032| -- | -- |
2033| ARKUI_WORD_BREAK_NORMAL = 0 | CJK(中文、日文、韩文)文本可以在任意2个字符间断行,而Non-CJK文本(如英文等)只能在空白符处断行。 |
2034| ARKUI_WORD_BREAK_BREAK_ALL | 对于Non-CJK的文本,可在任意2个字符间断行。CJK(中文、日文、韩文)文本可以在任意2个字符间断行。 |
2035| ARKUI_WORD_BREAK_BREAK_WORD | 对于Non-CJK的文本可在任意2个字符间断行,一行文本中有断行破发点(如空白符)时,优先按破发点换行。对于CJK的文本,换行效果与NORMAL效果保持一致。 |
2036| ARKUI_WORD_BREAK_HYPHENATION | 对于Non-CJK的文本,可以按照音节断行。对于CJK的文本,换行效果与NORMAL效果保持一致。<br>**起始版本:** 18 |
2037
2038### ArkUI_EllipsisMode
2039
2040```
2041enum ArkUI_EllipsisMode
2042```
2043
2044**描述:**
2045
2046
2047定义文本省略位置。
2048
2049**起始版本:** 12
2050
2051| 枚举项 | 描述 |
2052| -- | -- |
2053| ARKUI_ELLIPSIS_MODE_START = 0 | 省略行首内容。 |
2054| ARKUI_ELLIPSIS_MODE_CENTER | 省略行中内容。 |
2055| ARKUI_ELLIPSIS_MODE_END | 省略行末内容。 |
2056
2057### ArkUI_ImageRenderMode
2058
2059```
2060enum ArkUI_ImageRenderMode
2061```
2062
2063**描述:**
2064
2065
2066定义图片渲染模式。
2067
2068**起始版本:** 12
2069
2070| 枚举项 | 描述 |
2071| -- | -- |
2072| ARKUI_IMAGE_RENDER_MODE_ORIGINAL = 0 | 原色渲染模式。 |
2073| ARKUI_IMAGE_RENDER_MODE_TEMPLATE | 黑白渲染模式。 |
2074
2075### ArkUI_TransitionEdge
2076
2077```
2078enum ArkUI_TransitionEdge
2079```
2080
2081**描述:**
2082
2083
2084定义转场从边缘滑入和滑出的效果。
2085
2086**起始版本:** 12
2087
2088| 枚举项 | 描述 |
2089| -- | -- |
2090| ARKUI_TRANSITION_EDGE_TOP = 0 | 窗口的上边缘。 |
2091| ARKUI_TRANSITION_EDGE_BOTTOM | 窗口的下边缘。 |
2092| ARKUI_TRANSITION_EDGE_START | 窗口的左边缘。 |
2093| ARKUI_TRANSITION_EDGE_END | 窗口的右边缘。 |
2094
2095### ArkUI_FinishCallbackType
2096
2097```
2098enum ArkUI_FinishCallbackType
2099```
2100
2101**描述:**
2102
2103
2104在动画中定义onFinish回调的类型。
2105
2106**起始版本:** 12
2107
2108| 枚举项 | 描述 |
2109| -- | -- |
2110| ARKUI_FINISH_CALLBACK_REMOVED = 0 | 当整个动画结束并立即删除时,将触发回调。 |
2111| ARKUI_FINISH_CALLBACK_LOGICALLY | 当动画在逻辑上处于下降状态,但可能仍处于其长尾状态时,将触发回调。 |
2112
2113### ArkUI_ListItemAlignment
2114
2115```
2116enum ArkUI_ListItemAlignment
2117```
2118
2119**描述:**
2120
2121
2122交叉轴方向的布局方式。
2123
2124**起始版本:** 12
2125
2126| 枚举项 | 描述 |
2127| -- | -- |
2128| ARKUI_LIST_ITEM_ALIGNMENT_START = 0 | ListItem在List中,交叉轴方向首部对齐。 |
2129| ARKUI_LIST_ITEM_ALIGNMENT_CENTER | ListItem在List中,交叉轴方向居中对齐。 |
2130| ARKUI_LIST_ITEM_ALIGNMENT_END | ListItem在List中,交叉轴方向尾部对齐。 |
2131
2132### ArkUI_BlendApplyType
2133
2134```
2135enum ArkUI_BlendApplyType
2136```
2137
2138**描述:**
2139
2140
2141指定的混合模式应用于视图的内容选项.
2142
2143**起始版本:** 12
2144
2145| 枚举项 | 描述 |
2146| -- | -- |
2147| BLEND_APPLY_TYPE_FAST = 0 | 在目标图像上按顺序混合视图的内容. |
2148| BLEND_APPLY_TYPE_OFFSCREEN | 将此组件和子组件内容绘制到离屏画布上,然后整体进行混合. |
2149
2150### ArkUI_LengthMetricUnit
2151
2152```
2153enum ArkUI_LengthMetricUnit
2154```
2155
2156**描述:**
2157
2158
2159定义组件的单位模式。
2160
2161**起始版本:** 12
2162
2163| 枚举项 | 描述 |
2164| -- | -- |
2165| ARKUI_LENGTH_METRIC_UNIT_DEFAULT = -1 | 默认,字体类单位为FP,非字体类单位为VP。 |
2166| ARKUI_LENGTH_METRIC_UNIT_PX = 0 | 单位为PX。 |
2167| ARKUI_LENGTH_METRIC_UNIT_VP | 单位为VP。 |
2168| ARKUI_LENGTH_METRIC_UNIT_FP | 单位为FP。 |
2169
2170### ArkUI_TextInputContentType
2171
2172```
2173enum ArkUI_TextInputContentType
2174```
2175
2176**描述:**
2177
2178
2179定义自动填充类型。
2180
2181**起始版本:** 12
2182
2183| 枚举项 | 描述 |
2184| -- | -- |
2185| ARKUI_TEXTINPUT_CONTENT_TYPE_USER_NAME = 0 | 【用户名】在已启用密码保险箱的情况下,支持用户名的自动保存和自动填充。 |
2186| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSWORD | 【密码】在已启用密码保险箱的情况下,支持密码的自动保存和自动填充。 |
2187| ARKUI_TEXTINPUT_CONTENT_TYPE_NEW_PASSWORD | 【新密码】在已启用密码保险箱的情况下,支持自动生成新密码。 |
2188| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_STREET_ADDRESS | 【详细地址】在已启用情景化自动填充的情况下,支持详细地址的自动保存和自动填充。 |
2189| ARKUI_TEXTINPUT_CONTENT_TYPE_HOUSE_NUMBER | 【门牌号】在已启用情景化自动填充的情况下,支持门牌号的自动保存和自动填充。 |
2190| ARKUI_TEXTINPUT_CONTENT_TYPE_DISTRICT_ADDRESS | 【区/县】在已启用情景化自动填充的情况下,支持区/县的自动保存和自动填充。 |
2191| ARKUI_TEXTINPUT_CONTENT_TYPE_CITY_ADDRESS | 【市】在已启用情景化自动填充的情况下,支持市的自动保存和自动填充。 |
2192| ARKUI_TEXTINPUT_CONTENT_TYPE_PROVINCE_ADDRESS | 【省】在已启用情景化自动填充的情况下,支持省的自动保存和自动填充。 |
2193| ARKUI_TEXTINPUT_CONTENT_TYPE_COUNTRY_ADDRESS | 【国家】在已启用情景化自动填充的情况下,支持国家的自动保存和自动填充。 |
2194| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FULL_NAME | 【姓名】在已启用情景化自动填充的情况下,支持姓名的自动保存和自动填充。 |
2195| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_LAST_NAME | 【姓氏】在已启用情景化自动填充的情况下,支持姓氏的自动保存和自动填充。 |
2196| ARKUI_TEXTINPUT_CONTENT_TYPE_PERSON_FIRST_NAME | 【名字】在已启用情景化自动填充的情况下,支持名字的自动保存和自动填充。 |
2197| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_NUMBER | 【手机号】在已启用情景化自动填充的情况下,支持手机号的自动保存和自动填充。 |
2198| ARKUI_TEXTINPUT_CONTENT_TYPE_PHONE_COUNTRY_CODE | 【国家代码】在已启用情景化自动填充的情况下,支持国家代码的自动保存和自动填充。 |
2199| ARKUI_TEXTINPUT_CONTENT_TYPE_FULL_PHONE_NUMBER | 【包含国家代码的手机号】在已启用情景化自动填充的情况下,支持包含国家代码的手机号的自动保存和自动填充。 |
2200| ARKUI_TEXTINPUT_CONTENT_EMAIL_ADDRESS | 【邮箱地址】在已启用情景化自动填充的情况下,支持邮箱地址的自动保存和自动填充。 |
2201| ARKUI_TEXTINPUT_CONTENT_TYPE_BANK_CARD_NUMBER | 【银行卡号】在已启用情景化自动填充的情况下,支持银行卡号的自动保存和自动填充。 |
2202| ARKUI_TEXTINPUT_CONTENT_TYPE_ID_CARD_NUMBER | 【身份证号】在已启用情景化自动填充的情况下,支持身份证号的自动保存和自动填充。 |
2203| ARKUI_TEXTINPUT_CONTENT_TYPE_NICKNAME | 【昵称】在已启用情景化自动填充的情况下,支持昵称的自动保存和自动填充。 |
2204| ARKUI_TEXTINPUT_CONTENT_TYPE_DETAIL_INFO_WITHOUT_STREET | 【无街道地址】在已启用情景化自动填充的情况下,支持无街道地址的自动保存和自动填充。 |
2205| ARKUI_TEXTINPUT_CONTENT_TYPE_FORMAT_ADDRESS | 【标准地址】在已启用情景化自动填充的情况下,支持标准地址的自动保存和自动填充。 |
2206| ARKUI_TEXTINPUT_CONTENT_TYPE_PASSPORT_NUMBER | 【护照号】在已启用情景化自动填充的情况下,支持护照号的自动保存和自动填充。<br>**起始版本:** 18 |
2207| ARKUI_TEXTINPUT_CONTENT_TYPE_VALIDITY | 【护照有效期】在已启用情景化自动填充的情况下,支持护照有效期的自动保存和自动填充。<br>**起始版本:** 18 |
2208| ARKUI_TEXTINPUT_CONTENT_TYPE_ISSUE_AT | 【护照签发地】在已启用情景化自动填充的情况下,支持护照签发地的自动保存和自动填充。<br>**起始版本:** 18 |
2209| ARKUI_TEXTINPUT_CONTENT_TYPE_ORGANIZATION | 【发票抬头名称】在已启用情景化自动填充的情况下,支持发票抬头名称的自动保存和自动填充。<br>**起始版本:** 18 |
2210| ARKUI_TEXTINPUT_CONTENT_TYPE_TAX_ID | 【税号】在已启用情景化自动填充的情况下,支持税号的自动保存和自动填充。<br>**起始版本:** 18 |
2211| ARKUI_TEXTINPUT_CONTENT_TYPE_ADDRESS_CITY_AND_STATE | 【所在地区】在已启用情景化自动填充的情况下,支持所在地区的自动保存和自动填充。<br>**起始版本:** 18 |
2212| ARKUI_TEXTINPUT_CONTENT_TYPE_FLIGHT_NUMBER | 【航班号】暂不支持自动保存和自动填充。<br>**起始版本:** 18 |
2213| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_NUMBER | 【驾驶证号】暂不支持自动保存和自动填充。<br>**起始版本:** 18 |
2214| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_FILE_NUMBER | 【驾驶证档案编号】暂不支持自动保存和自动填充。<br>**起始版本:** 18 |
2215| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_PLATE | 【车牌号】在已启用情景化自动填充的情况下,支持车牌号的自动保存和自动填充。<br>**起始版本:** 18 |
2216| ARKUI_TEXTINPUT_CONTENT_TYPE_ENGINE_NUMBER | 【行驶证发动机号】暂不支持自动保存和自动填充。<br>**起始版本:** 18 |
2217| ARKUI_TEXTINPUT_CONTENT_TYPE_LICENSE_CHASSIS_NUMBER | 【车牌识别号】暂不支持自动保存和自动填充。<br>**起始版本:** 18 |
2218
2219### ArkUI_BarrierDirection
2220
2221```
2222enum ArkUI_BarrierDirection
2223```
2224
2225**描述:**
2226
2227
2228定义屏障线的方向。
2229
2230**起始版本:** 12
2231
2232| 枚举项 | 描述 |
2233| -- | -- |
2234| ARKUI_BARRIER_DIRECTION_START = 0 | 屏障在其所有referencedId的最左侧。 |
2235| ARKUI_BARRIER_DIRECTION_END | 屏障在其所有referencedId的最右侧。 |
2236| ARKUI_BARRIER_DIRECTION_TOP | 屏障在其所有referencedId的最上方。 |
2237| ARKUI_BARRIER_DIRECTION_BOTTOM | 屏障在其所有referencedId的最下方。 |
2238
2239### ArkUI_RelativeLayoutChainStyle
2240
2241```
2242enum ArkUI_RelativeLayoutChainStyle
2243```
2244
2245**描述:**
2246
2247
2248定义链的风格。
2249
2250**起始版本:** 12
2251
2252| 枚举项 | 描述 |
2253| -- | -- |
2254| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD = 0 | 组件在约束锚点间均匀分布。 |
2255| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_SPREAD_INSIDE | 除首尾2个子组件的其他组件在约束锚点间均匀分布。 |
2256| ARKUI_RELATIVE_LAYOUT_CHAIN_STYLE_PACKED | 链内子组件无间隙。 |
2257
2258### ArkUI_TextInputStyle
2259
2260```
2261enum ArkUI_TextInputStyle
2262```
2263
2264**描述:**
2265
2266
2267定义输入框风格。
2268
2269**起始版本:** 12
2270
2271| 枚举项 | 描述 |
2272| -- | -- |
2273| ARKUI_TEXTINPUT_STYLE_DEFAULT = 0 | 默认风格,光标宽1.5vp,光标高度与文本选中底板高度和字体大小相关。 |
2274| ARKUI_TEXTINPUT_STYLE_INLINE | 内联输入风格。文本选中底板高度与输入框高度相同。 |
2275
2276### ArkUI_KeyboardAppearance
2277
2278```
2279enum ArkUI_KeyboardAppearance
2280```
2281
2282**描述:**
2283
2284
2285定义输入框拉起的键盘样式。
2286
2287**起始版本:** 15
2288
2289| 枚举项 | 描述 |
2290| -- | -- |
2291| ARKUI_KEYBOARD_APPEARANCE_NONE_IMMERSIVE = 0 | 默认模式,不使用沉浸式样式。 |
2292| ARKUI_KEYBOARD_APPEARANCE_IMMERSIVE = 1 | 沉浸式模式,由系统决定采用的样式。 |
2293| ARKUI_KEYBOARD_APPEARANCE_LIGHT_IMMERSIVE = 2 | 浅色沉浸式样式。 |
2294| ARKUI_KEYBOARD_APPEARANCE_DARK_IMMERSIVE = 3 | 深色沉浸式样式。 |
2295
2296### ArkUI_TextDataDetectorType
2297
2298```
2299enum ArkUI_TextDataDetectorType
2300```
2301
2302**描述:**
2303
2304
2305定义文本识别的实体类型。
2306
2307**起始版本:** 12
2308
2309| 枚举项 | 描述 |
2310| -- | -- |
2311| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER = 0 | 电话号码。 |
2312| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL | 链接。 |
2313| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL | 邮箱。 |
2314| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS | 地址。 |
2315
2316### ArkUI_ButtonType
2317
2318```
2319enum ArkUI_ButtonType
2320```
2321
2322**描述:**
2323
2324
2325定义按钮样式枚举值。
2326
2327**起始版本:** 12
2328
2329| 枚举项 | 描述                      |
2330| -- |-------------------------|
2331| ARKUI_BUTTON_TYPE_NORMAL = 0 | 普通按钮,默认不带圆角。            |
2332| ARKUI_BUTTON_TYPE_CAPSULE | 胶囊型按钮,圆角默认为高度的一半。       |
2333| ARKUI_BUTTON_TYPE_CIRCLE | 圆形按钮。                   |
2334| ARKUI_BUTTON_ROUNDED_RECTANGLE = 8 | 圆角矩形按钮。<br>**起始版本:** 19 |
2335
2336### ArkUI_RenderFit
2337
2338```
2339enum ArkUI_RenderFit
2340```
2341
2342**描述:**
2343
2344
2345定义动画终态内容大小与位置的枚举值。
2346
2347**起始版本:** 12
2348
2349| 枚举项 | 描述 |
2350| -- | -- |
2351| ARKUI_RENDER_FIT_CENTER = 0 | 保持动画终态的内容大小,并且内容始终与组件保持中心对齐。 |
2352| ARKUI_RENDER_FIT_TOP | 保持动画终态的内容大小,并且内容始终与组件保持顶部中心对齐。 |
2353| ARKUI_RENDER_FIT_BOTTOM | 保持动画终态的内容大小,并且内容始终与组件保持底部中心对齐。 |
2354| ARKUI_RENDER_FIT_LEFT | 保持动画终态的内容大小,并且内容始终与组件保持左侧对齐。 |
2355| ARKUI_RENDER_FIT_RIGHT | 保持动画终态的内容大小,并且内容始终与组件保持右侧对齐。 |
2356| ARKUI_RENDER_FIT_TOP_LEFT | 保持动画终态的内容大小,并且内容始终与组件保持左上角对齐。 |
2357| ARKUI_RENDER_FIT_TOP_RIGHT | 保持动画终态的内容大小,并且内容始终与组件保持右上角对齐。 |
2358| ARKUI_RENDER_FIT_BOTTOM_LEFT | 保持动画终态的内容大小,并且内容始终与组件保持左下角对齐。 |
2359| ARKUI_RENDER_FIT_BOTTOM_RIGHT | 保持动画终态的内容大小,并且内容始终与组件保持右下角对齐。 |
2360| ARKUI_RENDER_FIT_RESIZE_FILL | 不考虑动画终态内容的宽高比,并且内容始终缩放到组件的大小。 |
2361| ARKUI_RENDER_FIT_RESIZE_CONTAIN | 保持动画终态内容的宽高比进行缩小或放大,使内容完整显示在组件内,且与组件保持中心对齐。 |
2362| ARKUI_RENDER_FIT_RESIZE_CONTAIN_TOP_LEFT | 保持动画终态内容的宽高比进行缩小或放大,使内容完整显示在组件内。当组件宽方向有剩余时,内容与组件保持左侧对齐,当组件高方向有剩余时,内容与组件保持顶部对齐。 |
2363| ARKUI_RENDER_FIT_RESIZE_CONTAIN_BOTTOM_RIGHT | 保持动画终态内容的宽高比进行缩小或放大,使内容完整显示在组件内。当组件宽方向有剩余时,内容与组件保持右侧对齐,当组件高方向有剩余时,内容与组件保持底部对齐。 |
2364| ARKUI_RENDER_FIT_RESIZE_COVER | 保持动画终态内容的宽高比进行缩小或放大,使内容两边都大于或等于组件两边,且与组件保持中心对齐,显示内容的中间部分。 |
2365| ARKUI_RENDER_FIT_RESIZE_COVER_TOP_LEFT | 保持动画终态内容的宽高比进行缩小或放大,使内容的两边都恰好大于或等于组件两边。当内容宽方向有剩余时,内容与组件保持左侧对齐,显示内容的左侧部分。当内容高方向有剩余时,内容与组件保持顶部对齐,显示内容的顶侧部分。 |
2366| ARKUI_RENDER_FIT_RESIZE_COVER_BOTTOM_RIGHT | 保持动画终态内容的宽高比进行缩小或放大,使内容的两边都恰好大于或等于组件两边。当内容宽方向有剩余时,内容与组件保持右侧对齐,显示内容的右侧部分。当内容高方向有剩余时,内容与组件保持底部对齐,显示内容的底侧部分。 |
2367
2368### ArkUI_SwiperIndicatorType
2369
2370```
2371enum ArkUI_SwiperIndicatorType
2372```
2373
2374**描述:**
2375
2376
2377定义 Swiper 组件的导航指示器类型。
2378
2379**起始版本:** 12
2380
2381| 枚举项 | 描述 |
2382| -- | -- |
2383| ARKUI_SWIPER_INDICATOR_TYPE_DOT | 圆点指示器类型。 |
2384| ARKUI_SWIPER_INDICATOR_TYPE_DIGIT | 数字指示器类型。 |
2385
2386### ArkUI_AnimationDirection
2387
2388```
2389enum ArkUI_AnimationDirection
2390```
2391
2392**描述:**
2393
2394
2395动画播放模式。
2396
2397**起始版本:** 12
2398
2399| 枚举项 | 描述 |
2400| -- | -- |
2401| ARKUI_ANIMATION_DIRECTION_NORMAL = 0 | 动画正向循环播放。 |
2402| ARKUI_ANIMATION_DIRECTION_REVERSE | 动画反向循环播放。 |
2403| ARKUI_ANIMATION_DIRECTION_ALTERNATE | 动画交替循环播放,奇数次正向播放,偶数次反向播放。 |
2404| ARKUI_ANIMATION_DIRECTION_ALTERNATE_REVERSE | 动画反向交替循环播放,奇数次反向播放,偶数次正向播放。 |
2405
2406### ArkUI_ListItemSwipeActionState
2407
2408```
2409enum ArkUI_ListItemSwipeActionState
2410```
2411
2412**描述:**
2413
2414
2415定义 Listitem 组件SwipeAction方法的显隐模式。
2416
2417**起始版本:** 12
2418
2419| 枚举项 | 描述 |
2420| -- | -- |
2421| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_COLLAPSED = 0 | 收起状态,当ListItem与主轴方向相反滑动时操作项处于隐藏状态。 |
2422| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_EXPANDED | 收起状态,当ListItem与主轴方向相反滑动时操作项处于显示状态。 |
2423| ARKUI_LIST_ITEM_SWIPE_ACTION_STATE_ACTIONING | 长距离状态,当ListItem进入长距删除区后删除ListItem的状态。 |
2424
2425### ArkUI_ListItemSwipeEdgeEffect
2426
2427```
2428enum ArkUI_ListItemSwipeEdgeEffect
2429```
2430
2431**描述:**
2432
2433
2434定义 Listitem 组件SwipeAction方法的滚动模式。
2435
2436**起始版本:** 12
2437
2438| 枚举项 | 描述 |
2439| -- | -- |
2440| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING = 0 | ListItem划动距离超过划出组件大小后可以继续划动。 |
2441| ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_NONE | ListItem划动距离不能超过划出组件大小。 |
2442
2443### ArkUI_AnimationStatus
2444
2445```
2446enum ArkUI_AnimationStatus
2447```
2448
2449**描述:**
2450
2451
2452定义帧动画的播放状态。
2453
2454**起始版本:** 12
2455
2456| 枚举项 | 描述 |
2457| -- | -- |
2458| ARKUI_ANIMATION_STATUS_INITIAL | 动画初始状态。 |
2459| ARKUI_ANIMATION_STATUS_RUNNING | 动画处于播放状态。 |
2460| ARKUI_ANIMATION_STATUS_PAUSED | 动画处于暂停状态。 |
2461| ARKUI_ANIMATION_STATUS_STOPPED | 动画处于停止状态。 |
2462
2463### ArkUI_AnimationFillMode
2464
2465```
2466enum ArkUI_AnimationFillMode
2467```
2468
2469**描述:**
2470
2471
2472定义帧动画组件在动画开始前和结束后的状态。
2473
2474**起始版本:** 12
2475
2476| 枚举项 | 描述 |
2477| -- | -- |
2478| ARKUI_ANIMATION_FILL_MODE_NONE | 动画未执行时不会将任何样式应用于目标,动画播放完成之后恢复初始默认状态。 |
2479| ARKUI_ANIMATION_FILL_MODE_FORWARDS | 目标将保留动画执行期间最后一个关键帧的状态。 |
2480| ARKUI_ANIMATION_FILL_MODE_BACKWARDS | 动画将在应用于目标时立即应用第一个关键帧中定义的值,并在delay期间保留此值。 |
2481| ARKUI_ANIMATION_FILL_MODE_BOTH | 动画将遵循Forwards和Backwards的规则,从而在两个方向上扩展动画属性。 |
2482
2483### ArkUI_ErrorCode
2484
2485```
2486enum ArkUI_ErrorCode
2487```
2488
2489**描述:**
2490
2491
2492定义错误码枚举值。
2493
2494**起始版本:** 12
2495
2496| 枚举项 | 描述 |
2497| -- | -- |
2498| ARKUI_ERROR_CODE_NO_ERROR = 0 | 无错误。 |
2499| ARKUI_ERROR_CODE_PARAM_INVALID = 401 | 参数错误。 |
2500| ARKUI_ERROR_CODE_CAPI_INIT_ERROR = 500 |  接口初始化错误。<br>**起始版本:** 18 |
2501| ARKUI_ERROR_CODE_INTERNAL_ERROR = 100001 |  出现内部错误,例如内部环境错误导致失败,或者由于内部执行失败导致操作失败。<br>**起始版本:** 15 |
2502| ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID = 103501 |  当前XComponent状态异常,方法调用失败。错误码的详细介绍请参见[XComponent组件错误码](../apis-arkui/errorcode-xcomponent.md)。<br>**起始版本:** 19 |
2503| ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED = 106102 | 组件不支持特定的属性或者事件。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。 |
2504| ARKUI_ERROR_CODE_ARKTS_NODE_NOT_SUPPORTED = 106103 | 对应的操作不支持ArkTS创建的节点。错误码的详细介绍请参见[自定义节点错误码](../apis-arkui/errorcode-node.md)。 |
2505| ARKUI_ERROR_CODE_ADAPTER_NOT_BOUND = 106104 | 懒加载适配器未绑定到组件上。 |
2506| ARKUI_ERROR_CODE_ADAPTER_EXIST = 106105 | 适配器已存在。 |
2507| ARKUI_ERROR_CODE_CHILD_NODE_EXIST = 106106 | 对应节点已存在子节点,无法添加适配器。 |
2508| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INDEX_OUT_OF_RANGE = 106107 | 组件事件中参数长度超限。错误码的详细介绍请参见[106107-参数下标越界](../apis-arkui/errorcode-nodeadapter.md#106107-参数下标越界)。 |
2509| ARKUI_ERROR_CODE_NODE_EVENT_PARAM_INVALID = 106108 | 组件事件中不存在该数据。错误码的详细介绍请参见[106108-数据不存在](../apis-arkui/errorcode-nodeadapter.md#106108-数据不存在)。 |
2510| ARKUI_ERROR_CODE_NODE_EVENT_NO_RETURN = 106109 | 组件事件不支持返回值。错误码的详细介绍请参见[106109-不支持返回值](../apis-arkui/errorcode-nodeadapter.md#106109-不支持返回值)。 |
2511| ARKUI_ERROR_CODE_NODE_INDEX_INVALID = 106200 | 传入的索引值非法。<br/>错误码的详细介绍请参见[导航错误码](../apis-arkui/errorcode-router.md#106200-传入的索引值非法)。 |
2512| ARKUI_ERROR_CODE_GET_INFO_FAILED = 106201 | 查询路由导航信息失败。<br/>错误码的详细介绍请参见[导航错误码](../apis-arkui/errorcode-router.md#106201-查询路由导航信息失败)。 |
2513| ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR = 106202 | 传入的buffer size异常。<br/>错误码的详细介绍请参见[导航错误码](../apis-arkui/errorcode-router.md#106202-传入的buffer-size异常)。 |
2514| ARKUI_ERROR_CODE_NODE_NOT_ON_MAIN_TREE = 106203 |  传入的节点未挂载到组件树上。错误码的详细介绍请参见[自定义节点错误码](../apis-arkui/errorcode-node.md)。<br>**起始版本:** 16 |
2515| ARKUI_ERROR_CODE_NOT_CUSTOM_NODE = 106401 |  当前节点不是自定义节点。错误码的详细介绍请参见[渲染节点错误码](../apis-arkui/errorcode-node-render.md)。<br>**起始版本:** 20 |
2516| ARKUI_ERROR_CODE_CHILD_EXISTED = 106402 |  当前节点已存在子节点。错误码的详细介绍请参见[渲染节点错误码](../apis-arkui/errorcode-node-render.md)。<br>**起始版本:** 20 |
2517| ARKUI_ERROR_CODE_RENDER_PARENT_EXISTED = 106403 |  当前渲染节点存在父组件。错误码的详细介绍请参见[渲染节点错误码](../apis-arkui/errorcode-node-render.md)。<br>**起始版本:** 20 |
2518| ARKUI_ERROR_CODE_RENDER_CHILD_NOT_EXIST = 106404 |  未找到对应的渲染子节点。错误码的详细介绍请参见[渲染节点错误码](../apis-arkui/errorcode-node-render.md)。<br>**起始版本:** 20 |
2519| ARKUI_ERROR_CODE_PARAM_OUT_OF_RANGE = 106405 |  参数值超出范围。错误码的详细介绍请参见[渲染节点错误码](../apis-arkui/errorcode-node-render.md)。<br>**起始版本:** 20 |
2520| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE = 150001 |  当前节点无法获得焦点。错误码的详细介绍请参见[焦点错误码](../apis-arkui/errorcode-focus.md#150001-节点无法获得焦点)。<br>**起始版本:** 15 |
2521| ARKUI_ERROR_CODE_FOCUS_NON_FOCUSABLE_ANCESTOR = 150002 |  当前节点对应的祖先节点中存在无法获焦节点。错误码的详细介绍请参见[焦点错误码](../apis-arkui/errorcode-focus.md#150002-祖先节点无法获得焦点)。<br>**起始版本:** 15 |
2522| ARKUI_ERROR_CODE_FOCUS_NON_EXISTENT = 150003 |  当前节点不存在。错误码的详细介绍请参见[焦点错误码](../apis-arkui/errorcode-focus.md#150003-节点不存在)。<br>**起始版本:** 15 |
2523| ARKUI_ERROR_CODE_COMPONENT_SNAPSHOT_TIMEOUT = 160002 |  截图超时。错误码的详细介绍请参见[截图错误码](../apis-arkui/errorcode-snapshot.md)。<br>**起始版本:** 15 |
2524| ARKUI_ERROR_CODE_NON_SCROLLABLE_CONTAINER = 180001 | 非滚动类容器。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。 |
2525| ARKUI_ERROR_CODE_BUFFER_SIZE_NOT_ENOUGH = 180002 | 存储区大小不足。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。 |
2526| ARKUI_ERROR_CODE_NOT_CLONED_POINTER_EVENT = 180003 |  该事件不是克隆事件。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。<br>**起始版本:** 15 |
2527| ARKUI_ERROR_CODE_POST_CLONED_COMPONENT_STATUS_ABNORMAL = 180004 |  组件状态异常。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。<br>**起始版本:** 15 |
2528| ARKUI_ERROR_CODE_POST_CLONED_NO_COMPONENT_HIT_TO_RESPOND_TO_THE_EVENT = 180005 |  未命中可响应事件的组件。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。<br>**起始版本:** 15 |
2529| ARKUI_ERROR_INPUT_EVENT_TYPE_NOT_SUPPORTED = 180006 |  接口不支持此输入事件类型。<br>**起始版本:** 20 |
2530| ARKUI_ERROR_CODE_INVALID_STYLED_STRING = 180101 |  无效的属性字符串。错误码的详细介绍请参见[属性字符串错误码](../apis-arkui/errorcode-styled-string.md)。<br>**起始版本:** 14 |
2531| ARKUI_ERROR_CODE_UI_CONTEXT_INVALID = 190001 |  无效的UIContext对象。错误码的详细介绍请参见[UI上下文错误码](../apis-arkui/errorcode-uicontext.md)。<br>**起始版本:** 18 |
2532| ARKUI_ERROR_CODE_CALLBACK_INVALID = 190002 |  无效的回调函数。错误码的详细介绍请参见[UI上下文错误码](../apis-arkui/errorcode-uicontext.md)。<br>**起始版本:** 18 |
2533| ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED = 180102 |  不支持手势识别器类型。错误码的详细介绍请参见[交互事件错误码](../apis-arkui/errorcode-event.md)。<br>**起始版本:** 18 |
2534| ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED = 190004 |  当前阶段不允许该操作。错误码的详细介绍请参见[拖拽事件错误码](../apis-arkui/errorcode-drag-event.md)。<br>**起始版本:** 19 |
2535
2536### ArkUI_ScrollSource
2537
2538```
2539enum ArkUI_ScrollSource
2540```
2541
2542**描述:**
2543
2544
2545定义滚动来源枚举值。
2546
2547**起始版本:** 12
2548
2549| 枚举项 | 描述 |
2550| -- | -- |
2551| ARKUI_SCROLL_SOURCE_DRAG = 0 | 手指拖动。 |
2552| ARKUI_SCROLL_SOURCE_FLING | 手指拖动后的惯性滚动。 |
2553| ARKUI_SCROLL_SOURCE_EDGE_EFFECT | 在过界时执行EdgeEffect.Spring边缘特效。 |
2554| ARKUI_SCROLL_SOURCE_OTHER_USER_INPUT | 除了拖动以外的其他用户输入,如鼠标滚轮、键盘事件等。 |
2555| ARKUI_SCROLL_SOURCE_SCROLL_BAR | 拖动滚动条。 |
2556| ARKUI_SCROLL_SOURCE_SCROLL_BAR_FLING | 拖动滚动条后的惯性滚动。 |
2557| ARKUI_SCROLL_SOURCE_SCROLLER | 滚动控制器引起的无动画的滚动。 |
2558| ARKUI_SCROLL_SOURCE_ANIMATION | 滚动控制器引起的带动画的滚动。 |
2559
2560### ArkUI_SafeAreaType
2561
2562```
2563enum ArkUI_SafeAreaType
2564```
2565
2566**描述:**
2567
2568
2569定义扩展安全区域的枚举值。
2570
2571**起始版本:** 12
2572
2573| 枚举项 | 描述 |
2574| -- | -- |
2575| ARKUI_SAFE_AREA_TYPE_SYSTEM = 1 | 系统默认非安全区域,包括状态栏、导航栏。 |
2576| ARKUI_SAFE_AREA_TYPE_CUTOUT = 1 << 1 | 设备的非安全区域,例如刘海屏或挖孔屏区域。 |
2577| ARKUI_SAFE_AREA_TYPE_KEYBOARD = 1 << 2 | 软键盘区域。 |
2578
2579### ArkUI_SafeAreaEdge
2580
2581```
2582enum ArkUI_SafeAreaEdge
2583```
2584
2585**描述:**
2586
2587
2588定义扩展安全区域的方向的枚举值。
2589
2590**起始版本:** 12
2591
2592| 枚举项 | 描述 |
2593| -- | -- |
2594| ARKUI_SAFE_AREA_EDGE_TOP = 1 | 上方区域。 |
2595| ARKUI_SAFE_AREA_EDGE_BOTTOM = 1 << 1 | 下方区域。 |
2596| ARKUI_SAFE_AREA_EDGE_START = 1 << 2 | 前部区域。 |
2597| ARKUI_SAFE_AREA_EDGE_END = 1 << 3 | 尾部区域。 |
2598
2599### ArkUI_FocusMove
2600
2601```
2602enum ArkUI_FocusMove
2603```
2604
2605**描述:**
2606
2607
2608定义焦点移动方向的枚举值。
2609
2610**起始版本:** 18
2611
2612| 枚举项 | 描述 |
2613| -- | -- |
2614| ARKUI_FOCUS_MOVE_FORWARD = 0 | 向前移动焦点。 |
2615| ARKUI_FOCUS_MOVE_BACKWARD | 向后移动焦点。 |
2616| ARKUI_FOCUS_MOVE_UP | 向上移动焦点。 |
2617| ARKUI_FOCUS_MOVE_DOWN | 向下移动焦点。 |
2618| ARKUI_FOCUS_MOVE_LEFT | 向左移动焦点。 |
2619| ARKUI_FOCUS_MOVE_RIGHT | 向右移动焦点。 |
2620
2621### ArkUI_ListItemGroupArea
2622
2623```
2624enum ArkUI_ListItemGroupArea
2625```
2626
2627**描述:**
2628
2629
2630定义 ListItemGroup 组件区域。
2631
2632**起始版本:** 15
2633
2634| 枚举项 | 描述 |
2635| -- | -- |
2636| ARKUI_LIST_ITEM_GROUP_AREA_OUTSIDE = 0 | ListItemGroup区域外。 |
2637| ARKUI_LIST_ITEM_SWIPE_AREA_NONE | ListItemGroup没有header、footer和ListItem时的区域。 |
2638| ARKUI_LIST_ITEM_SWIPE_AREA_ITEM | ListItemGroup的ListItem区域。 |
2639| ARKUI_LIST_ITEM_SWIPE_AREA_HEADER | ListItemGroup的header区域。 |
2640| ARKUI_LIST_ITEM_SWIPE_AREA_FOOTER | ListItemGroup的footer区域。 |
2641
2642### ArkUI_KeyboardAvoidMode
2643
2644```
2645enum ArkUI_KeyboardAvoidMode
2646```
2647
2648**描述:**
2649
2650
2651键盘避让模式。
2652
2653**起始版本:** 15
2654
2655| 枚举项 | 描述 |
2656| -- | -- |
2657| ARKUI_KEYBOARD_AVOID_MODE_DEFAULT = 0 | 默认避让软键盘并在到达极限高度之后进行高度压缩。 |
2658| ARKUI_KEYBOARD_AVOID_MODE_NONE | 不避让键盘。 |
2659
2660### ArkUI_HoverModeAreaType
2661
2662```
2663enum ArkUI_HoverModeAreaType
2664```
2665
2666**描述:**
2667
2668
2669悬停态显示区域。
2670
2671**起始版本:** 15
2672
2673| 枚举项 | 描述 |
2674| -- | -- |
2675| ARKUI_HOVER_MODE_AREA_TYPE_TOP = 0 | 上半屏。 |
2676| ARKUI_HOVER_MODE_AREA_TYPE_BOTTOM | 下半屏。 |
2677
2678### ArkUI_ExpandMode
2679
2680```
2681enum ArkUI_ExpandMode
2682```
2683
2684**描述:**
2685
2686
2687定义子节点展开模式枚举值。
2688
2689**起始版本:** 15
2690
2691| 枚举项 | 描述 |
2692| -- | -- |
2693| ARKUI_NOT_EXPAND = 0 | 不展开。 |
2694| ARKUI_EXPAND = 1 | 展开。 |
2695| ARKUI_LAZY_EXPAND = 2 | 懒展开,按需展开当前节点的子节点。 |
2696
2697### ArkUI_NavDestinationState
2698
2699```
2700enum ArkUI_NavDestinationState
2701```
2702
2703**描述:**
2704
2705
2706定义NavDestination组件的状态。
2707
2708**起始版本:** 12
2709
2710| 枚举项 | 描述 |
2711| -- | -- |
2712| ARKUI_NAV_DESTINATION_STATE_ON_SHOW = 0 | NavDestination组件显示。 |
2713| ARKUI_NAV_DESTINATION_STATE_ON_HIDE = 1 | NavDestination组件隐藏。 |
2714| ARKUI_NAV_DESTINATION_STATE_ON_APPEAR = 2 | NavDestination从组件树上挂载。 |
2715| ARKUI_NAV_DESTINATION_STATE_ON_DISAPPEAR = 3 | NavDestination从组件树上卸载。 |
2716| ARKUI_NAV_DESTINATION_STATE_ON_WILL_SHOW = 4 | NavDestination组件显示之前。 |
2717| ARKUI_NAV_DESTINATION_STATE_ON_WILL_HIDE = 5 | NavDestination组件隐藏之前。 |
2718| ARKUI_NAV_DESTINATION_STATE_ON_WILL_APPEAR = 6 | NavDestination挂载到组件树之前。 |
2719| ARKUI_NAV_DESTINATION_STATE_ON_WILL_DISAPPEAR = 7 | NavDestination从组件树上卸载之前。 |
2720| ARKUI_NAV_DESTINATION_STATE_ON_BACK_PRESS = 100 | NavDestination从组件返回。 |
2721
2722### ArkUI_RouterPageState
2723
2724```
2725enum ArkUI_RouterPageState
2726```
2727
2728**描述:**
2729
2730
2731定义Router Page的状态。
2732
2733**起始版本:** 12
2734
2735| 枚举项 | 描述 |
2736| -- | -- |
2737| ARKUI_ROUTER_PAGE_STATE_ABOUT_TO_APPEAR = 0 | Router Page即将创建。 |
2738| ARKUI_ROUTER_PAGE_STATE_ABOUT_TO_DISAPPEAR = 1 | Router Page即将销毁。 |
2739| ARKUI_ROUTER_PAGE_STATE_ON_SHOW = 2 | Router Page显示。 |
2740| ARKUI_ROUTER_PAGE_STATE_ON_HIDE = 3 | Router Page隐藏。 |
2741| ARKUI_ROUTER_PAGE_STATE_ON_BACK_PRESS = 4 | Router Page返回时。 |
2742
2743### ArkUI_UIState
2744
2745```
2746enum ArkUI_UIState
2747```
2748
2749**描述:**
2750
2751
2752组件的UI状态枚举,用于处理状态样式。
2753
2754**起始版本:** 20
2755
2756| 枚举项 | 描述 |
2757| -- | -- |
2758| UI_STATE_NORMAL = 0 | 正常状态。 |
2759| UI_STATE_PRESSED = 1 << 0 | 按压状态。 |
2760| UI_STATE_FOCUSED = 1 << 1 | 获焦状态。 |
2761| UI_STATE_DISABLED = 1 << 2 | 禁用状态。 |
2762| UI_STATE_SELECTED = 1 << 3 | 选中状态,此状态仅由某些特定类型的组件支持,分别是Checkbox、Radio、Toggle、List、Grid和MenuItem。 |
2763
2764### ArkUI_FocusWrapMode
2765
2766```
2767enum ArkUI_FocusWrapMode
2768```
2769
2770**描述:**
2771
2772
2773组件走焦换行规则。
2774
2775**起始版本:** 20
2776
2777| 枚举项 | 描述 |
2778| -- | -- |
2779| ARKUI_FOCUS_WRAP_MODE_DEFAULT = 0 | 默认规则,使用方向键走焦不换行。 |
2780| ARKUI_FOCUS_WRAP_WITH_ARROW = 1 | 使用方向键走焦自动换行。 |
2781
2782### ArkUI_EdgeDirection
2783
2784```
2785enum ArkUI_EdgeDirection
2786```
2787
2788**描述:**
2789
2790
2791定义矩形边方向。
2792
2793**起始版本:** 20
2794
2795| 枚举项 | 描述 |
2796| -- | -- |
2797| ARKUI_EDGE_DIRECTION_ALL = 0 | 设置四个方向的内容。 |
2798| ARKUI_EDGE_DIRECTION_LEFT = 1 << 0 | 设置左侧方向内容。 |
2799| ARKUI_EDGE_DIRECTION_RIGHT = 1 << 1 | 设置右侧方向内容。 |
2800| ARKUI_EDGE_DIRECTION_TOP = 1 << 2 | 设置上侧方向内容。 |
2801| ARKUI_EDGE_DIRECTION_BOTTOM = 1 << 3 | 设置下侧方向内容。 |
2802
2803### ArkUI_CornerDirection
2804
2805```
2806enum ArkUI_CornerDirection
2807```
2808
2809**描述:**
2810
2811
2812定义角度方向。
2813
2814**起始版本:** 20
2815
2816| 枚举项 | 描述 |
2817| -- | -- |
2818| ARKUI_CORNER_DIRECTION_ALL = 0 | 设置四个角度方向的内容。 |
2819| ARKUI_CORNER_DIRECTION_TOP_LEFT = 1 << 0 | 设置左上侧方向内容。 |
2820| ARKUI_CORNER_DIRECTION_TOP_RIGHT = 1 << 1 | 设置右上侧方向内容。 |
2821| ARKUI_CORNER_DIRECTION_BOTTOM_LEFT = 1 << 2 | 设置左下侧方向内容。 |
2822| ARKUI_CORNER_DIRECTION_BOTTOM_RIGHT = 1 << 3 | 设置右下侧方向容。 |
2823
2824## 函数说明
2825
2826### OH_ArkUI_LayoutConstraint_Create()
2827
2828```
2829ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create()
2830```
2831
2832**描述:**
2833
2834
2835创建约束尺寸。
2836
2837**起始版本:** 12
2838
2839**返回:**
2840
2841| 类型                          | 说明 |
2842|-----------------------------| -- |
2843| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* | 创建约束尺寸的对象指针。 |
2844
2845### OH_ArkUI_LayoutConstraint_Copy()
2846
2847```
2848ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy(const ArkUI_LayoutConstraint* Constraint)
2849```
2850
2851**描述:**
2852
2853
2854约束尺寸深拷贝。
2855
2856**起始版本:** 12
2857
2858
2859**参数:**
2860
2861| 参数项 | 描述 |
2862| -- | -- |
2863| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
2864
2865**返回:**
2866
2867| 类型                          | 说明 |
2868|-----------------------------| -- |
2869| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* | 新的约束尺寸指针。 |
2870
2871### OH_ArkUI_LayoutConstraint_Dispose()
2872
2873```
2874void* OH_ArkUI_LayoutConstraint_Dispose(ArkUI_LayoutConstraint* Constraint)
2875```
2876
2877**描述:**
2878
2879
2880销毁约束尺寸指针。
2881
2882**起始版本:** 12
2883
2884
2885**参数:**
2886
2887| 参数项 | 描述 |
2888| -- | -- |
2889| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
2890
2891**返回:**
2892
2893| 类型                          | 说明 |
2894|-----------------------------| -- |
2895| void* | 空指针。 |
2896
2897### OH_ArkUI_LayoutConstraint_GetMaxWidth()
2898
2899```
2900int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth(const ArkUI_LayoutConstraint* Constraint)
2901```
2902
2903**描述:**
2904
2905
2906通过约束尺寸获取最大宽度,单位为px。
2907
2908**起始版本:** 12
2909
2910
2911**参数:**
2912
2913| 参数项 | 描述 |
2914| -- | -- |
2915| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
2916
2917**返回:**
2918
2919| 类型 | 说明 |
2920| -- | -- |
2921| int32_t | 最大宽度。 |
2922
2923### OH_ArkUI_LayoutConstraint_GetMinWidth()
2924
2925```
2926int32_t OH_ArkUI_LayoutConstraint_GetMinWidth(const ArkUI_LayoutConstraint* Constraint)
2927```
2928
2929**描述:**
2930
2931
2932通过约束尺寸获取最小宽度,单位为px。
2933
2934**起始版本:** 12
2935
2936
2937**参数:**
2938
2939| 参数项 | 描述 |
2940| -- | -- |
2941| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
2942
2943**返回:**
2944
2945| 类型 | 说明 |
2946| -- | -- |
2947| int32_t | 最小宽度。 |
2948
2949### OH_ArkUI_LayoutConstraint_GetMaxHeight()
2950
2951```
2952int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight(const ArkUI_LayoutConstraint* Constraint)
2953```
2954
2955**描述:**
2956
2957
2958通过约束尺寸获取最大高度,单位为px。
2959
2960**起始版本:** 12
2961
2962
2963**参数:**
2964
2965| 参数项 | 描述 |
2966| -- | -- |
2967| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
2968
2969**返回:**
2970
2971| 类型 | 说明 |
2972| -- | -- |
2973| int32_t | 最大高度。 |
2974
2975### OH_ArkUI_LayoutConstraint_GetMinHeight()
2976
2977```
2978int32_t OH_ArkUI_LayoutConstraint_GetMinHeight(const ArkUI_LayoutConstraint* Constraint)
2979```
2980
2981**描述:**
2982
2983
2984通过约束尺寸获取最小高度,单位为px。
2985
2986**起始版本:** 12
2987
2988
2989**参数:**
2990
2991| 参数项 | 描述 |
2992| -- | -- |
2993| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
2994
2995**返回:**
2996
2997| 类型 | 说明 |
2998| -- | -- |
2999| int32_t | 最小高度。 |
3000
3001### OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth()
3002
3003```
3004int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth(const ArkUI_LayoutConstraint* Constraint)
3005```
3006
3007**描述:**
3008
3009
3010通过约束尺寸获取宽度百分比基准,单位为px。
3011
3012**起始版本:** 12
3013
3014
3015**参数:**
3016
3017| 参数项 | 描述 |
3018| -- | -- |
3019| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3020
3021**返回:**
3022
3023| 类型 | 说明 |
3024| -- | -- |
3025| int32_t | 宽度百分比基准。 |
3026
3027### OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight()
3028
3029```
3030int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight(const ArkUI_LayoutConstraint* Constraint)
3031```
3032
3033**描述:**
3034
3035
3036通过约束尺寸获取高度百分比基准,单位为px。
3037
3038**起始版本:** 12
3039
3040
3041**参数:**
3042
3043| 参数项 | 描述 |
3044| -- | -- |
3045| [const ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3046
3047**返回:**
3048
3049| 类型 | 说明 |
3050| -- | -- |
3051| int32_t | 高度百分比基准。 |
3052
3053### OH_ArkUI_LayoutConstraint_SetMaxWidth()
3054
3055```
3056void OH_ArkUI_LayoutConstraint_SetMaxWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)
3057```
3058
3059**描述:**
3060
3061
3062设置最大宽度。
3063
3064**起始版本:** 12
3065
3066
3067**参数:**
3068
3069| 参数项 | 描述 |
3070| -- | -- |
3071| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3072| int32_t value | 最大宽度,单位为px。 |
3073
3074### OH_ArkUI_LayoutConstraint_SetMinWidth()
3075
3076```
3077void OH_ArkUI_LayoutConstraint_SetMinWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)
3078```
3079
3080**描述:**
3081
3082
3083设置最小宽度。
3084
3085**起始版本:** 12
3086
3087
3088**参数:**
3089
3090| 参数项 | 描述 |
3091| -- | -- |
3092| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3093| int32_t value | 最小宽度,单位为px。 |
3094
3095### OH_ArkUI_LayoutConstraint_SetMaxHeight()
3096
3097```
3098void OH_ArkUI_LayoutConstraint_SetMaxHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)
3099```
3100
3101**描述:**
3102
3103
3104设置最大高度。
3105
3106**起始版本:** 12
3107
3108
3109**参数:**
3110
3111| 参数项 | 描述 |
3112| -- | -- |
3113| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3114| int32_t value | 最大高度,单位为px。 |
3115
3116### OH_ArkUI_LayoutConstraint_SetMinHeight()
3117
3118```
3119void OH_ArkUI_LayoutConstraint_SetMinHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)
3120```
3121
3122**描述:**
3123
3124
3125设置最小高度。
3126
3127**起始版本:** 12
3128
3129
3130**参数:**
3131
3132| 参数项 | 描述 |
3133| -- | -- |
3134| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3135| int32_t value | 最小高度,单位为px。 |
3136
3137### OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth()
3138
3139```
3140void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)
3141```
3142
3143**描述:**
3144
3145
3146设置宽度百分比基准。
3147
3148**起始版本:** 12
3149
3150
3151**参数:**
3152
3153| 参数项 | 描述 |
3154| -- | -- |
3155| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3156| int32_t value | 宽度百分比基准,单位为px。 |
3157
3158### OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight()
3159
3160```
3161void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)
3162```
3163
3164**描述:**
3165
3166
3167设置高度百分比基准。
3168
3169**起始版本:** 12
3170
3171
3172**参数:**
3173
3174| 参数项 | 描述 |
3175| -- | -- |
3176| [ArkUI_LayoutConstraint](capi-arkui-nativemodule-arkui-layoutconstraint.md)* Constraint | 约束尺寸。 |
3177| int32_t value | 高度百分比基准,单位为px。 |
3178
3179### OH_ArkUI_DrawContext_GetCanvas()
3180
3181```
3182void* OH_ArkUI_DrawContext_GetCanvas(ArkUI_DrawContext* context)
3183```
3184
3185**描述:**
3186
3187
3188获取绘制canvas指针,可以转换为图形库的OH_Drawing_Canvas指针进行绘制。
3189
3190**起始版本:** 12
3191
3192
3193**参数:**
3194
3195| 参数项 | 描述 |
3196| -- | -- |
3197| [ArkUI_DrawContext](capi-arkui-nativemodule-arkui-drawcontext.md)* context | 绘制上下文。 |
3198
3199**返回:**
3200
3201| 类型 | 说明 |
3202| -- | -- |
3203| void* | 用于绘制的canvas指针。 |
3204
3205### OH_ArkUI_DrawContext_GetSize()
3206
3207```
3208ArkUI_IntSize OH_ArkUI_DrawContext_GetSize(ArkUI_DrawContext* context)
3209```
3210
3211**描述:**
3212
3213
3214获取可绘制区域大小。
3215
3216**起始版本:** 12
3217
3218
3219**参数:**
3220
3221| 参数项 | 描述 |
3222| -- | -- |
3223| [ArkUI_DrawContext](capi-arkui-nativemodule-arkui-drawcontext.md)* context | 绘制上下文。 |
3224
3225**返回:**
3226
3227| 类型 | 说明 |
3228| -- | -- |
3229| [ArkUI_IntSize](capi-arkui-nativemodule-arkui-intsize.md) | 可绘制区域大小。 |
3230
3231### OH_ArkUI_WaterFlowSectionOption_Create()
3232
3233```
3234ArkUI_WaterFlowSectionOption* OH_ArkUI_WaterFlowSectionOption_Create()
3235```
3236
3237**描述:**
3238
3239
3240创建FlowItem分组配置信息。
3241
3242**起始版本:** 12
3243
3244**返回:**
3245
3246| 类型                                | 说明 |
3247|-----------------------------------| -- |
3248| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* | FlowItem分组配置信息。 |
3249
3250### OH_ArkUI_WaterFlowSectionOption_Dispose()
3251
3252```
3253void OH_ArkUI_WaterFlowSectionOption_Dispose(ArkUI_WaterFlowSectionOption* option)
3254```
3255
3256**描述:**
3257
3258
3259销毁FlowItem分组配置信息指针。
3260
3261**起始版本:** 12
3262
3263
3264**参数:**
3265
3266| 参数项 | 描述 |
3267| -- | -- |
3268| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3269
3270### OH_ArkUI_WaterFlowSectionOption_SetSize()
3271
3272```
3273void OH_ArkUI_WaterFlowSectionOption_SetSize(ArkUI_WaterFlowSectionOption* option,int32_t size)
3274```
3275
3276**描述:**
3277
3278
3279设置FlowItem分组配置信息数组长度。
3280
3281**起始版本:** 12
3282
3283
3284**参数:**
3285
3286| 参数项 | 描述 |
3287| -- | -- |
3288| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3289| int32_t size | 数组长度。 |
3290
3291### OH_ArkUI_WaterFlowSectionOption_GetSize()
3292
3293```
3294int32_t OH_ArkUI_WaterFlowSectionOption_GetSize(ArkUI_WaterFlowSectionOption* option)
3295```
3296
3297**描述:**
3298
3299
3300获取FlowItem分组配置信息数组长度。
3301
3302**起始版本:** 12
3303
3304
3305**参数:**
3306
3307| 参数项 | 描述 |
3308| -- | -- |
3309| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3310
3311**返回:**
3312
3313| 类型 | 说明 |
3314| -- | -- |
3315| int32_t | 数组长度。如果返回-1,则返回失败。失败的原因可能是option参数异常,如空指针。 |
3316
3317### OH_ArkUI_WaterFlowSectionOption_SetItemCount()
3318
3319```
3320void OH_ArkUI_WaterFlowSectionOption_SetItemCount(ArkUI_WaterFlowSectionOption* option,int32_t index, int32_t itemCount)
3321```
3322
3323**描述:**
3324
3325
3326设置分组中FlowItem数量。
3327
3328**起始版本:** 12
3329
3330
3331**参数:**
3332
3333| 参数项 | 描述 |
3334| -- | -- |
3335| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3336| int32_t index | 分组配置信息数组索引值。 |
3337| int32_t itemCount | 分组中FlowItem数量。 |
3338
3339### OH_ArkUI_WaterFlowSectionOption_GetItemCount()
3340
3341```
3342int32_t OH_ArkUI_WaterFlowSectionOption_GetItemCount(ArkUI_WaterFlowSectionOption* option, int32_t index)
3343```
3344
3345**描述:**
3346
3347
3348通过FlowItem分组配置信息获取对应索引下的FlowItem数量。
3349
3350**起始版本:** 12
3351
3352
3353**参数:**
3354
3355| 参数项 | 描述 |
3356| -- | -- |
3357| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3358| int32_t index | 分组配置信息数组索引值。 |
3359
3360**返回:**
3361
3362| 类型 | 说明 |
3363| -- | -- |
3364| int32_t | 分组中FlowItem数量。 |
3365
3366### OH_ArkUI_WaterFlowSectionOption_SetCrossCount()
3367
3368```
3369void OH_ArkUI_WaterFlowSectionOption_SetCrossCount(ArkUI_WaterFlowSectionOption* option,int32_t index, int32_t crossCount)
3370```
3371
3372**描述:**
3373
3374
3375设置布局栅格,纵向布局时为列数,横向布局时为行数。
3376
3377**起始版本:** 12
3378
3379
3380**参数:**
3381
3382| 参数项 | 描述 |
3383| -- | -- |
3384| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3385| int32_t index | 分组配置信息数组索引值。 |
3386| int32_t crossCount | 布局栅格数量。 |
3387
3388### OH_ArkUI_WaterFlowSectionOption_GetCrossCount()
3389
3390```
3391int32_t OH_ArkUI_WaterFlowSectionOption_GetCrossCount(ArkUI_WaterFlowSectionOption* option, int32_t index)
3392```
3393
3394**描述:**
3395
3396
3397通过FlowItem分组配置信息获取对应索引下的布局栅格数。
3398
3399**起始版本:** 12
3400
3401
3402**参数:**
3403
3404| 参数项 | 描述 |
3405| -- | -- |
3406| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3407| int32_t index | 分组配置信息数组索引值。 |
3408
3409**返回:**
3410
3411| 类型 | 说明 |
3412| -- | -- |
3413| int32_t | 布局栅格数量。 |
3414
3415### OH_ArkUI_WaterFlowSectionOption_SetColumnGap()
3416
3417```
3418void OH_ArkUI_WaterFlowSectionOption_SetColumnGap(ArkUI_WaterFlowSectionOption* option,int32_t index, float columnGap)
3419```
3420
3421**描述:**
3422
3423
3424设置分组的列间距。
3425
3426**起始版本:** 12
3427
3428
3429**参数:**
3430
3431| 参数项 | 描述 |
3432| -- | -- |
3433| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3434| int32_t index | 分组配置信息数组索引值。 |
3435| float columnGap | 列间距。 |
3436
3437### OH_ArkUI_WaterFlowSectionOption_GetColumnGap()
3438
3439```
3440float OH_ArkUI_WaterFlowSectionOption_GetColumnGap(ArkUI_WaterFlowSectionOption* option, int32_t index)
3441```
3442
3443**描述:**
3444
3445
3446通过FlowItem分组配置信息获取对应索引下的分组的列间距。
3447
3448**起始版本:** 12
3449
3450
3451**参数:**
3452
3453| 参数项 | 描述 |
3454| -- | -- |
3455| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3456| int32_t index | 分组配置信息数组索引值。 |
3457
3458**返回:**
3459
3460| 类型 | 说明 |
3461| -- | -- |
3462| float | 列间距。 |
3463
3464### OH_ArkUI_WaterFlowSectionOption_SetRowGap()
3465
3466```
3467void OH_ArkUI_WaterFlowSectionOption_SetRowGap(ArkUI_WaterFlowSectionOption* option,int32_t index, float rowGap)
3468```
3469
3470**描述:**
3471
3472
3473设置分组的行间距。
3474
3475**起始版本:** 12
3476
3477
3478**参数:**
3479
3480| 参数项 | 描述 |
3481| -- | -- |
3482| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3483| int32_t index | 分组配置信息数组索引值。 |
3484| float rowGap | 行间距。 |
3485
3486### OH_ArkUI_WaterFlowSectionOption_GetRowGap()
3487
3488```
3489float OH_ArkUI_WaterFlowSectionOption_GetRowGap(ArkUI_WaterFlowSectionOption* option, int32_t index)
3490```
3491
3492**描述:**
3493
3494
3495通过FlowItem分组配置信息获取对应索引下的分组的行间距。
3496
3497**起始版本:** 12
3498
3499
3500**参数:**
3501
3502| 参数项 | 描述 |
3503| -- | -- |
3504| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3505| int32_t index | 分组配置信息数组索引值。 |
3506
3507**返回:**
3508
3509| 类型 | 说明 |
3510| -- | -- |
3511| float | 行间距。 |
3512
3513### OH_ArkUI_WaterFlowSectionOption_SetMargin()
3514
3515```
3516void OH_ArkUI_WaterFlowSectionOption_SetMargin(ArkUI_WaterFlowSectionOption* option, int32_t index,float marginTop, float marginRight, float marginBottom, float marginLeft)
3517```
3518
3519**描述:**
3520
3521
3522设置分组的外边距。
3523
3524**起始版本:** 12
3525
3526
3527**参数:**
3528
3529| 参数项 | 描述 |
3530| -- | -- |
3531| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3532| int32_t index | 分组配置信息数组索引值。 |
3533| float marginTop | FlowItem上外边距。 |
3534| float marginRight | FlowItem右外边距。 |
3535| float marginBottom | FlowItem下外边距。 |
3536| float marginLeft | FlowItem左外边距。 |
3537
3538### OH_ArkUI_WaterFlowSectionOption_GetMargin()
3539
3540```
3541ArkUI_Margin OH_ArkUI_WaterFlowSectionOption_GetMargin(ArkUI_WaterFlowSectionOption* option, int32_t index)
3542```
3543
3544**描述:**
3545
3546
3547通过FlowItem分组配置信息获取对应索引下的分组的外边距。
3548
3549**起始版本:** 12
3550
3551
3552**参数:**
3553
3554| 参数项 | 描述 |
3555| -- | -- |
3556| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3557| int32_t index | 分组配置信息数组索引值。 |
3558
3559**返回:**
3560
3561| 类型 | 说明 |
3562| -- | -- |
3563| [ArkUI_Margin](capi-arkui-nativemodule-arkui-margin.md) | 外边距。 |
3564
3565### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex()
3566
3567```
3568void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndex(ArkUI_WaterFlowSectionOption* option,int32_t index, float(*callback)(int32_t itemIndex))
3569```
3570
3571**描述:**
3572
3573
3574通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。
3575
3576**起始版本:** 12
3577
3578
3579**参数:**
3580
3581| 参数项                                            | 描述 |
3582|------------------------------------------------| -- |
3583| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3584| int32_t index                                  | 分组配置信息数组索引值。 |
3585| callback                                       | 根据index获取指定Item的主轴大小。itemIndex:FlowItem索引值。 |
3586
3587### OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData()
3588
3589```
3590void OH_ArkUI_WaterFlowSectionOption_RegisterGetItemMainSizeCallbackByIndexWithUserData(ArkUI_WaterFlowSectionOption* option, int32_t index, void* userData,float (*callback)(int32_t itemIndex, void* userData))
3591```
3592
3593**描述:**
3594
3595
3596通过FlowItem分组配置信息根据flowItemIndex获取指定Item的主轴大小。
3597
3598**起始版本:** 12
3599
3600
3601**参数:**
3602
3603| 参数项 | 描述 |
3604| -- | -- |
3605| [ArkUI_WaterFlowSectionOption](capi-arkui-nativemodule-arkui-waterflowsectionoption.md)* option | FlowItem分组配置信息。 |
3606| int32_t index | 分组配置信息数组索引值。 |
3607|  void* userData | FlowItem自定义数据。 |
3608| callback | 根据index获取指定Item的主轴大小。itemIndex:FlowItem索引值。 |
3609
3610### OH_ArkUI_GuidelineOption_Create()
3611
3612```
3613ArkUI_GuidelineOption* OH_ArkUI_GuidelineOption_Create(int32_t size)
3614```
3615
3616**描述:**
3617
3618
3619创建RelativeContainer容器内的辅助线信息。
3620
3621**起始版本:** 12
3622
3623
3624**参数:**
3625
3626| 参数项 | 描述 |
3627| -- | -- |
3628| int32_t size | 辅助线数量。 |
3629
3630**返回:**
3631
3632| 类型                         | 说明 |
3633|----------------------------| -- |
3634| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* | 辅助线信息。 |
3635
3636### OH_ArkUI_GuidelineOption_Dispose()
3637
3638```
3639void OH_ArkUI_GuidelineOption_Dispose(ArkUI_GuidelineOption* guideline)
3640```
3641
3642**描述:**
3643
3644
3645销毁辅助线信息。
3646
3647**起始版本:** 12
3648
3649
3650**参数:**
3651
3652| 参数项 | 描述 |
3653| -- | -- |
3654| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3655
3656### OH_ArkUI_GuidelineOption_SetId()
3657
3658```
3659void OH_ArkUI_GuidelineOption_SetId(ArkUI_GuidelineOption* guideline, const char* value, int32_t index)
3660```
3661
3662**描述:**
3663
3664
3665设置辅助线的Id。
3666
3667**起始版本:** 12
3668
3669
3670**参数:**
3671
3672| 参数项 | 描述 |
3673| -- | -- |
3674| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3675| const char* value | id,必须是唯一的并且不可与容器内组件重名。 |
3676| int32_t index | 辅助线索引值。 |
3677
3678### OH_ArkUI_GuidelineOption_SetDirection()
3679
3680```
3681void OH_ArkUI_GuidelineOption_SetDirection(ArkUI_GuidelineOption* guideline, ArkUI_Axis value, int32_t index)
3682```
3683
3684**描述:**
3685
3686
3687设置辅助线的方向。
3688
3689**起始版本:** 12
3690
3691
3692**参数:**
3693
3694| 参数项 | 描述 |
3695| -- | -- |
3696| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3697| [ArkUI_Axis](capi-native-type-h.md#arkui_axis) value | 方向。 |
3698| int32_t index | 辅助线索引值。 |
3699
3700### OH_ArkUI_GuidelineOption_SetPositionStart()
3701
3702```
3703void OH_ArkUI_GuidelineOption_SetPositionStart(ArkUI_GuidelineOption* guideline, float value, int32_t index)
3704```
3705
3706**描述:**
3707
3708
3709设置距离容器左侧或者顶部的距离。
3710
3711**起始版本:** 12
3712
3713
3714**参数:**
3715
3716| 参数项 | 描述 |
3717| -- | -- |
3718| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3719| float value | 距离容器左侧或者顶部的距离。 |
3720| int32_t index | 辅助线索引值。 |
3721
3722### OH_ArkUI_GuidelineOption_SetPositionEnd()
3723
3724```
3725void OH_ArkUI_GuidelineOption_SetPositionEnd(ArkUI_GuidelineOption* guideline, float value, int32_t index)
3726```
3727
3728**描述:**
3729
3730
3731设置距离容器右侧或者底部的距离。
3732
3733**起始版本:** 12
3734
3735
3736**参数:**
3737
3738| 参数项 | 描述 |
3739| -- | -- |
3740| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3741| float value | 距离容器右侧或者底部的距离。 |
3742| int32_t index | 辅助线索引值。 |
3743
3744### OH_ArkUI_GuidelineOption_GetId()
3745
3746```
3747const char* OH_ArkUI_GuidelineOption_GetId(ArkUI_GuidelineOption* guideline, int32_t index)
3748```
3749
3750**描述:**
3751
3752
3753获取辅助线的Id。
3754
3755**起始版本:** 12
3756
3757
3758**参数:**
3759
3760| 参数项 | 描述 |
3761| -- | -- |
3762| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3763| int32_t index | 辅助线索引值。 |
3764
3765**返回:**
3766
3767| 类型 | 说明 |
3768| -- | -- |
3769| const char* | Id。 |
3770
3771### OH_ArkUI_GuidelineOption_GetDirection()
3772
3773```
3774ArkUI_Axis OH_ArkUI_GuidelineOption_GetDirection(ArkUI_GuidelineOption* guideline, int32_t index)
3775```
3776
3777**描述:**
3778
3779
3780获取辅助线的方向。
3781
3782**起始版本:** 12
3783
3784
3785**参数:**
3786
3787| 参数项 | 描述 |
3788| -- | -- |
3789| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3790| int32_t index | 辅助线索引值。 |
3791
3792**返回:**
3793
3794| 类型 | 说明 |
3795| -- | -- |
3796| [ArkUI_Axis](capi-native-type-h.md#arkui_axis) | 方向。 |
3797
3798### OH_ArkUI_GuidelineOption_GetPositionStart()
3799
3800```
3801float OH_ArkUI_GuidelineOption_GetPositionStart(ArkUI_GuidelineOption* guideline, int32_t index)
3802```
3803
3804**描述:**
3805
3806
3807获取辅助线距离容器左侧或者顶部的距离。
3808
3809**起始版本:** 12
3810
3811
3812**参数:**
3813
3814| 参数项 | 描述 |
3815| -- | -- |
3816| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3817| int32_t index | 辅助线索引值。 |
3818
3819**返回:**
3820
3821| 类型 | 说明 |
3822| -- | -- |
3823| float | 辅助线距离容器左侧或者顶部的距离。单位为vp。 |
3824
3825### OH_ArkUI_GuidelineOption_GetPositionEnd()
3826
3827```
3828float OH_ArkUI_GuidelineOption_GetPositionEnd(ArkUI_GuidelineOption* guideline, int32_t index)
3829```
3830
3831**描述:**
3832
3833
3834获取辅助线距离容器右侧或者底部的距离。
3835
3836**起始版本:** 12
3837
3838
3839**参数:**
3840
3841| 参数项 | 描述 |
3842| -- | -- |
3843| [ArkUI_GuidelineOption](capi-arkui-nativemodule-arkui-guidelineoption.md)* guideline | 辅助线信息。 |
3844| int32_t index | 辅助线索引值。 |
3845
3846**返回:**
3847
3848| 类型 | 说明 |
3849| -- | -- |
3850| float | 辅助线距离容器右侧或者底部的距离。单位为vp。 |
3851
3852### OH_ArkUI_BarrierOption_Create()
3853
3854```
3855ArkUI_BarrierOption* OH_ArkUI_BarrierOption_Create(int32_t size)
3856```
3857
3858**描述:**
3859
3860
3861创建RelativeContainer容器内的屏障信息。
3862
3863**起始版本:** 12
3864
3865
3866**参数:**
3867
3868| 参数项 | 描述 |
3869| -- | -- |
3870| int32_t size | 屏障数量。 |
3871
3872**返回:**
3873
3874| 类型                       | 说明 |
3875|--------------------------| -- |
3876| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* | 屏障信息。 |
3877
3878### OH_ArkUI_BarrierOption_Dispose()
3879
3880```
3881void OH_ArkUI_BarrierOption_Dispose(ArkUI_BarrierOption* barrierStyle)
3882```
3883
3884**描述:**
3885
3886
3887销毁屏障信息。
3888
3889**起始版本:** 12
3890
3891
3892**参数:**
3893
3894| 参数项 | 描述 |
3895| -- | -- |
3896| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 屏障信息。 |
3897
3898### OH_ArkUI_BarrierOption_SetId()
3899
3900```
3901void OH_ArkUI_BarrierOption_SetId(ArkUI_BarrierOption* barrierStyle, const char* value, int32_t index)
3902```
3903
3904**描述:**
3905
3906
3907设置屏障的Id。
3908
3909**起始版本:** 12
3910
3911
3912**参数:**
3913
3914| 参数项 | 描述 |
3915| -- | -- |
3916| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 屏障信息。 |
3917| const char* value | id,必须是唯一的并且不可与容器内组件重名。 |
3918| int32_t index | 屏障索引值。 |
3919
3920### OH_ArkUI_BarrierOption_SetDirection()
3921
3922```
3923void OH_ArkUI_BarrierOption_SetDirection(ArkUI_BarrierOption* barrierStyle, ArkUI_BarrierDirection value, int32_t index)
3924```
3925
3926**描述:**
3927
3928
3929设置屏障的方向。
3930
3931**起始版本:** 12
3932
3933
3934**参数:**
3935
3936| 参数项 | 描述 |
3937| -- | -- |
3938| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 屏障信息。 |
3939| [ArkUI_BarrierDirection](capi-native-type-h.md#arkui_barrierdirection) value | 方向。 |
3940| int32_t index | 屏障索引值。 |
3941
3942### OH_ArkUI_BarrierOption_SetReferencedId()
3943
3944```
3945void OH_ArkUI_BarrierOption_SetReferencedId(ArkUI_BarrierOption* barrierStyle, const char* value, int32_t index)
3946```
3947
3948**描述:**
3949
3950
3951设置屏障的依赖的组件。
3952
3953**起始版本:** 12
3954
3955
3956**参数:**
3957
3958| 参数项 | 描述 |
3959| -- | -- |
3960| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 屏障信息。 |
3961| const char* value | 依赖的组件的Id。 |
3962| int32_t index | 屏障索引值。 |
3963
3964### OH_ArkUI_BarrierOption_GetId()
3965
3966```
3967const char* OH_ArkUI_BarrierOption_GetId(ArkUI_BarrierOption* barrierStyle, int32_t index)
3968```
3969
3970**描述:**
3971
3972
3973获取屏障的Id。
3974
3975**起始版本:** 12
3976
3977
3978**参数:**
3979
3980| 参数项 | 描述 |
3981| -- | -- |
3982| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 辅助线信息。 |
3983| int32_t index | 辅助线索引值。 |
3984
3985**返回:**
3986
3987| 类型 | 说明 |
3988| -- | -- |
3989| const char* | 屏障的Id。 |
3990
3991### OH_ArkUI_BarrierOption_GetDirection()
3992
3993```
3994ArkUI_BarrierDirection OH_ArkUI_BarrierOption_GetDirection(ArkUI_BarrierOption* barrierStyle, int32_t index)
3995```
3996
3997**描述:**
3998
3999
4000获取屏障的方向。
4001
4002**起始版本:** 12
4003
4004
4005**参数:**
4006
4007| 参数项 | 描述 |
4008| -- | -- |
4009| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 辅助线信息。 |
4010| int32_t index | 辅助线索引值。 |
4011
4012**返回:**
4013
4014| 类型 | 说明 |
4015| -- | -- |
4016| [ArkUI_BarrierDirection](capi-native-type-h.md#arkui_barrierdirection) | 屏障的方向。 |
4017
4018### OH_ArkUI_BarrierOption_GetReferencedId()
4019
4020```
4021const char* OH_ArkUI_BarrierOption_GetReferencedId(ArkUI_BarrierOption* barrierStyle, int32_t index , int32_t referencedIndex)
4022```
4023
4024**描述:**
4025
4026
4027获取屏障的依赖的组件。
4028
4029**起始版本:** 12
4030
4031
4032**参数:**
4033
4034| 参数项 | 描述 |
4035| -- | -- |
4036| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 辅助线信息。 |
4037| int32_t index | 辅助线索引值。 |
4038| int32_t referencedIndex | 依赖的组件Id索引值。 |
4039
4040**返回:**
4041
4042| 类型 | 说明 |
4043| -- | -- |
4044| const char* | 屏障的依赖的组件。 |
4045
4046### OH_ArkUI_BarrierOption_GetReferencedIdSize()
4047
4048```
4049int32_t OH_ArkUI_BarrierOption_GetReferencedIdSize(ArkUI_BarrierOption* barrierStyle, int32_t index)
4050```
4051
4052**描述:**
4053
4054
4055获取屏障的依赖的组件的个数。
4056
4057**起始版本:** 12
4058
4059
4060**参数:**
4061
4062| 参数项 | 描述 |
4063| -- | -- |
4064| [ArkUI_BarrierOption](capi-arkui-nativemodule-arkui-barrieroption.md)* barrierStyle | 辅助线信息。 |
4065| int32_t index | 辅助线索引值。 |
4066
4067**返回:**
4068
4069| 类型 | 说明 |
4070| -- | -- |
4071| int32_t | 屏障的依赖的组件的个数。 |
4072
4073### OH_ArkUI_AlignmentRuleOption_Create()
4074
4075```
4076ArkUI_AlignmentRuleOption* OH_ArkUI_AlignmentRuleOption_Create()
4077```
4078
4079**描述:**
4080
4081
4082创建相对容器中子组件的对齐规则信息。
4083
4084**起始版本:** 12
4085
4086**返回:**
4087
4088| 类型                             | 说明 |
4089|--------------------------------| -- |
4090| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* | 对齐规则信息。 |
4091
4092### OH_ArkUI_AlignmentRuleOption_Dispose()
4093
4094```
4095void OH_ArkUI_AlignmentRuleOption_Dispose(ArkUI_AlignmentRuleOption* option)
4096```
4097
4098**描述:**
4099
4100
4101销毁相对容器中子组件的对齐规则信息。
4102
4103**起始版本:** 12
4104
4105
4106**参数:**
4107
4108| 参数项 | 描述 |
4109| -- | -- |
4110| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4111
4112### OH_ArkUI_AlignmentRuleOption_SetStart()
4113
4114```
4115void OH_ArkUI_AlignmentRuleOption_SetStart(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_HorizontalAlignment alignment)
4116```
4117
4118**描述:**
4119
4120
4121设置左对齐参数。
4122
4123**起始版本:** 12
4124
4125
4126**参数:**
4127
4128| 参数项                                                                                       | 描述 |
4129|-------------------------------------------------------------------------------------------| -- |
4130| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4131| const char* id                                                                            | 锚点的组件的id值。 |
4132| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment                         | 相对于锚点组件的对齐方式。 |
4133
4134### OH_ArkUI_AlignmentRuleOption_SetEnd()
4135
4136```
4137void OH_ArkUI_AlignmentRuleOption_SetEnd(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_HorizontalAlignment alignment)
4138```
4139
4140**描述:**
4141
4142
4143设置右对齐参数。
4144
4145**起始版本:** 12
4146
4147
4148**参数:**
4149
4150| 参数项 | 描述 |
4151| -- | -- |
4152| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4153| const char* id | 锚点的组件的id值。 |
4154| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment | 相对于锚点组件的对齐方式。 |
4155
4156### OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal()
4157
4158```
4159void OH_ArkUI_AlignmentRuleOption_SetCenterHorizontal(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_HorizontalAlignment alignment)
4160```
4161
4162**描述:**
4163
4164
4165设置横向居中对齐方式的参数。
4166
4167**起始版本:** 12
4168
4169
4170**参数:**
4171
4172| 参数项 | 描述 |
4173| -- | -- |
4174| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4175| const char* id | 锚点的组件的id值。 |
4176| [ArkUI_HorizontalAlignment](#arkui_horizontalalignment) alignment | 相对于锚点组件的对齐方式 |
4177
4178### OH_ArkUI_AlignmentRuleOption_SetTop()
4179
4180```
4181void OH_ArkUI_AlignmentRuleOption_SetTop(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_VerticalAlignment alignment)
4182```
4183
4184**描述:**
4185
4186
4187设置顶部对齐的参数。
4188
4189**起始版本:** 12
4190
4191
4192**参数:**
4193
4194| 参数项                                                                                       | 描述 |
4195|-------------------------------------------------------------------------------------------| -- |
4196| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4197| const char* id                                                                            | 锚点的组件的id值。 |
4198| [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment                             | 相对于锚点组件的对齐方式 |
4199
4200### OH_ArkUI_AlignmentRuleOption_SetBottom()
4201
4202```
4203void OH_ArkUI_AlignmentRuleOption_SetBottom(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_VerticalAlignment alignment)
4204```
4205
4206**描述:**
4207
4208
4209设置底部对齐的参数。
4210
4211**起始版本:** 12
4212
4213
4214**参数:**
4215
4216| 参数项 | 描述 |
4217| -- | -- |
4218| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4219| const char* id | 锚点的组件的id值。 |
4220| [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment | 相对于锚点组件的对齐方式 |
4221
4222### OH_ArkUI_AlignmentRuleOption_SetCenterVertical()
4223
4224```
4225void OH_ArkUI_AlignmentRuleOption_SetCenterVertical(ArkUI_AlignmentRuleOption* option, const char* id, ArkUI_VerticalAlignment alignment)
4226```
4227
4228**描述:**
4229
4230
4231设置纵向居中对齐方式的参数。
4232
4233**起始版本:** 12
4234
4235
4236**参数:**
4237
4238| 参数项 | 描述 |
4239| -- | -- |
4240| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4241| const char* id | 锚点的组件的id值。 |
4242| [ArkUI_VerticalAlignment](#arkui_verticalalignment) alignment | 相对于锚点组件的对齐方式。 |
4243
4244### OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal()
4245
4246```
4247void OH_ArkUI_AlignmentRuleOption_SetBiasHorizontal(ArkUI_AlignmentRuleOption* option, float horizontal)
4248```
4249
4250**描述:**
4251
4252
4253设置组件在锚点约束下的水平方向上偏移参数。
4254
4255**起始版本:** 12
4256
4257
4258**参数:**
4259
4260| 参数项 | 描述 |
4261| -- | -- |
4262| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4263| float horizontal | 水平方向上的bias值。 |
4264
4265### OH_ArkUI_AlignmentRuleOption_SetBiasVertical()
4266
4267```
4268void OH_ArkUI_AlignmentRuleOption_SetBiasVertical(ArkUI_AlignmentRuleOption* option, float vertical)
4269```
4270
4271**描述:**
4272
4273
4274设置组件在锚点约束下的垂直方向上偏移参数。
4275
4276**起始版本:** 12
4277
4278
4279**参数:**
4280
4281| 参数项 | 描述 |
4282| -- | -- |
4283| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4284| float vertical | 垂直方向上的bias值。 |
4285
4286### OH_ArkUI_AlignmentRuleOption_GetStartId()
4287
4288```
4289const char* OH_ArkUI_AlignmentRuleOption_GetStartId(ArkUI_AlignmentRuleOption* option)
4290```
4291
4292**描述:**
4293
4294
4295获取左对齐参数的Id。
4296
4297**起始版本:** 12
4298
4299
4300**参数:**
4301
4302| 参数项 | 描述 |
4303| -- | -- |
4304| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4305
4306**返回:**
4307
4308| 类型 | 说明 |
4309| -- | -- |
4310| const char* | 锚点的组件的id值。 |
4311
4312### OH_ArkUI_AlignmentRuleOption_GetStartAlignment()
4313
4314```
4315ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetStartAlignment(ArkUI_AlignmentRuleOption* option)
4316```
4317
4318**描述:**
4319
4320
4321获取左对齐参数的对齐方式。
4322
4323**起始版本:** 12
4324
4325
4326**参数:**
4327
4328| 参数项 | 描述 |
4329| -- | -- |
4330| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4331
4332**返回:**
4333
4334| 类型 | 说明 |
4335| -- | -- |
4336| [ArkUI_HorizontalAlignment](capi-native-type-h.md#arkui_horizontalalignment) | 参数的对齐方式。 |
4337
4338### OH_ArkUI_AlignmentRuleOption_GetEndId()
4339
4340```
4341const char* OH_ArkUI_AlignmentRuleOption_GetEndId(ArkUI_AlignmentRuleOption* option)
4342```
4343
4344**描述:**
4345
4346
4347获取右对齐参数。
4348
4349**起始版本:** 12
4350
4351
4352**参数:**
4353
4354| 参数项 | 描述 |
4355| -- | -- |
4356| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4357
4358**返回:**
4359
4360| 类型 | 说明 |
4361| -- | -- |
4362| const char* | 右对齐参数id。 |
4363
4364### OH_ArkUI_AlignmentRuleOption_GetEndAlignment()
4365
4366```
4367ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetEndAlignment(ArkUI_AlignmentRuleOption* option)
4368```
4369
4370**描述:**
4371
4372
4373获取右对齐参数。
4374
4375**起始版本:** 12
4376
4377
4378**参数:**
4379
4380| 参数项 | 描述 |
4381| -- | -- |
4382| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4383
4384**返回:**
4385
4386| 类型 | 说明 |
4387| -- | -- |
4388| [ArkUI_HorizontalAlignment](capi-native-type-h.md#arkui_horizontalalignment) | 右对齐参数的对齐方式。 |
4389
4390### OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal()
4391
4392```
4393const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdHorizontal(ArkUI_AlignmentRuleOption* option)
4394```
4395
4396**描述:**
4397
4398
4399获取横向居中对齐方式的参数。
4400
4401**起始版本:** 12
4402
4403
4404**参数:**
4405
4406| 参数项 | 描述 |
4407| -- | -- |
4408| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4409
4410**返回:**
4411
4412| 类型 | 说明 |
4413| -- | -- |
4414| const char* | 横向居中对齐方式的参数的id。 |
4415
4416### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal()
4417
4418```
4419ArkUI_HorizontalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentHorizontal(ArkUI_AlignmentRuleOption* option)
4420```
4421
4422**描述:**
4423
4424
4425获取横向居中对齐方式的参数。
4426
4427**起始版本:** 12
4428
4429
4430**参数:**
4431
4432| 参数项 | 描述 |
4433| -- | -- |
4434| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4435
4436**返回:**
4437
4438| 类型 | 说明 |
4439| -- | -- |
4440| [ArkUI_HorizontalAlignment](capi-native-type-h.md#arkui_horizontalalignment) | 横向居中对齐方式的参数的对齐方式。 |
4441
4442### OH_ArkUI_AlignmentRuleOption_GetTopId()
4443
4444```
4445const char* OH_ArkUI_AlignmentRuleOption_GetTopId(ArkUI_AlignmentRuleOption* option)
4446```
4447
4448**描述:**
4449
4450
4451获取顶部对齐的参数。
4452
4453**起始版本:** 12
4454
4455
4456**参数:**
4457
4458| 参数项 | 描述 |
4459| -- | -- |
4460| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4461
4462**返回:**
4463
4464| 类型 | 说明 |
4465| -- | -- |
4466| const char* | 顶部对齐的参数id。 |
4467
4468### OH_ArkUI_AlignmentRuleOption_GetTopAlignment()
4469
4470```
4471ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetTopAlignment(ArkUI_AlignmentRuleOption* option)
4472```
4473
4474**描述:**
4475
4476
4477获取顶部对齐的参数。
4478
4479**起始版本:** 12
4480
4481
4482**参数:**
4483
4484| 参数项 | 描述 |
4485| -- | -- |
4486| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4487
4488**返回:**
4489
4490| 类型 | 说明 |
4491| -- | -- |
4492| [ArkUI_VerticalAlignment](capi-native-type-h.md#arkui_verticalalignment) | 顶部对齐的参数的对齐方式。 |
4493
4494### OH_ArkUI_AlignmentRuleOption_GetBottomId()
4495
4496```
4497const char* OH_ArkUI_AlignmentRuleOption_GetBottomId(ArkUI_AlignmentRuleOption* option)
4498```
4499
4500**描述:**
4501
4502
4503获取底部对齐的参数。
4504
4505**起始版本:** 12
4506
4507
4508**参数:**
4509
4510| 参数项 | 描述 |
4511| -- | -- |
4512| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4513
4514**返回:**
4515
4516| 类型 | 说明 |
4517| -- | -- |
4518| const char* | 底部对齐的参数的id。 |
4519
4520### OH_ArkUI_AlignmentRuleOption_GetBottomAlignment()
4521
4522```
4523ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetBottomAlignment(ArkUI_AlignmentRuleOption* option)
4524```
4525
4526**描述:**
4527
4528
4529获取底部对齐的参数。
4530
4531**起始版本:** 12
4532
4533
4534**参数:**
4535
4536| 参数项 | 描述 |
4537| -- | -- |
4538| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4539
4540**返回:**
4541
4542| 类型 | 说明 |
4543| -- | -- |
4544| [ArkUI_VerticalAlignment](capi-native-type-h.md#arkui_verticalalignment) | 底部对齐的参数的对齐方式。 |
4545
4546### OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical()
4547
4548```
4549const char* OH_ArkUI_AlignmentRuleOption_GetCenterIdVertical(ArkUI_AlignmentRuleOption* option)
4550```
4551
4552**描述:**
4553
4554
4555获取纵向居中对齐方式的参数。
4556
4557**起始版本:** 12
4558
4559
4560**参数:**
4561
4562| 参数项 | 描述 |
4563| -- | -- |
4564| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4565
4566**返回:**
4567
4568| 类型 | 说明 |
4569| -- | -- |
4570| const char* | 纵向居中对齐方式的参数的id。 |
4571
4572### OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical()
4573
4574```
4575ArkUI_VerticalAlignment OH_ArkUI_AlignmentRuleOption_GetCenterAlignmentVertical(ArkUI_AlignmentRuleOption* option)
4576```
4577
4578**描述:**
4579
4580
4581获取纵向居中对齐方式的参数。
4582
4583**起始版本:** 12
4584
4585
4586**参数:**
4587
4588| 参数项 | 描述 |
4589| -- | -- |
4590| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4591
4592**返回:**
4593
4594| 类型 | 说明 |
4595| -- | -- |
4596| [ArkUI_VerticalAlignment](capi-native-type-h.md#arkui_verticalalignment) | 纵向居中对齐方式的参数的对齐方式。 |
4597
4598### OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal()
4599
4600```
4601float OH_ArkUI_AlignmentRuleOption_GetBiasHorizontal(ArkUI_AlignmentRuleOption* option)
4602```
4603
4604**描述:**
4605
4606
4607获取水平方向上的bias值。
4608
4609**起始版本:** 12
4610
4611
4612**参数:**
4613
4614| 参数项 | 描述 |
4615| -- | -- |
4616| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4617
4618**返回:**
4619
4620| 类型 | 说明 |
4621| -- | -- |
4622| float | 水平方向上的bias值。 |
4623
4624### OH_ArkUI_AlignmentRuleOption_GetBiasVertical()
4625
4626```
4627float OH_ArkUI_AlignmentRuleOption_GetBiasVertical(ArkUI_AlignmentRuleOption* option)
4628```
4629
4630**描述:**
4631
4632
4633获取垂直方向上的bias值。
4634
4635**起始版本:** 12
4636
4637
4638**参数:**
4639
4640| 参数项 | 描述 |
4641| -- | -- |
4642| [ArkUI_AlignmentRuleOption](capi-arkui-nativemodule-arkui-alignmentruleoption.md)* option | 相对容器中子组件的对齐规则信息。 |
4643
4644**返回:**
4645
4646| 类型 | 说明 |
4647| -- | -- |
4648| float | 垂直方向上的bias值。 |
4649
4650### OH_ArkUI_SwiperIndicator_Create()
4651
4652```
4653ArkUI_SwiperIndicator* OH_ArkUI_SwiperIndicator_Create(ArkUI_SwiperIndicatorType type)
4654```
4655
4656**描述:**
4657
4658
4659创建 Swiper 组件的导航指示器。
4660
4661**起始版本:** 12
4662
4663
4664**参数:**
4665
4666| 参数项 | 描述 |
4667| -- | -- |
4668| [ArkUI_SwiperIndicatorType](capi-native-type-h.md#arkui_swiperindicatortype) type | 导航指示器的类型。 |
4669
4670**返回:**
4671
4672| 类型                         | 说明 |
4673|----------------------------| -- |
4674| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* | 导航指示器对象指针。 |
4675
4676### OH_ArkUI_SwiperIndicator_Dispose()
4677
4678```
4679void OH_ArkUI_SwiperIndicator_Dispose(ArkUI_SwiperIndicator* indicator)
4680```
4681
4682**描述:**
4683
4684
4685销毁Swiper组件的导航指示器指针。
4686
4687**起始版本:** 12
4688
4689
4690**参数:**
4691
4692| 参数项 | 描述 |
4693| -- | -- |
4694| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4695
4696### OH_ArkUI_SwiperIndicator_SetStartPosition()
4697
4698```
4699void OH_ArkUI_SwiperIndicator_SetStartPosition(ArkUI_SwiperIndicator* indicator, float value)
4700```
4701
4702**描述:**
4703
4704
4705设置导航点距离 Swiper 组件左边的距离。
4706
4707**起始版本:** 12
4708
4709
4710**参数:**
4711
4712| 参数项 | 描述 |
4713| -- | -- |
4714| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4715| float value | 导航点距离Swiper组件左边的距离。默认值:0,单位:vp。 |
4716
4717### OH_ArkUI_SwiperIndicator_GetStartPosition()
4718
4719```
4720float OH_ArkUI_SwiperIndicator_GetStartPosition(ArkUI_SwiperIndicator* indicator)
4721```
4722
4723**描述:**
4724
4725
4726获取导航点距离 Swiper 组件左边的距离。
4727
4728**起始版本:** 12
4729
4730
4731**参数:**
4732
4733| 参数项 | 描述 |
4734| -- | -- |
4735| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4736
4737**返回:**
4738
4739| 类型 | 说明 |
4740| -- | -- |
4741| float | 导航点距离Swiper组件左边的距离。单位:vp。 |
4742
4743### OH_ArkUI_SwiperIndicator_SetTopPosition()
4744
4745```
4746void OH_ArkUI_SwiperIndicator_SetTopPosition(ArkUI_SwiperIndicator* indicator, float value)
4747```
4748
4749**描述:**
4750
4751
4752设置导航点距离 Swiper 组件顶部的距离。
4753
4754**起始版本:** 12
4755
4756
4757**参数:**
4758
4759| 参数项 | 描述 |
4760| -- | -- |
4761| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4762| float value | 导航点距离Swiper组件顶部的距离。默认值:0,单位:vp。 |
4763
4764### OH_ArkUI_SwiperIndicator_GetTopPosition()
4765
4766```
4767float OH_ArkUI_SwiperIndicator_GetTopPosition(ArkUI_SwiperIndicator* indicator)
4768```
4769
4770**描述:**
4771
4772
4773获取导航点距离 Swiper 组件顶部的距离。
4774
4775**起始版本:** 12
4776
4777
4778**参数:**
4779
4780| 参数项 | 描述 |
4781| -- | -- |
4782| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4783
4784**返回:**
4785
4786| 类型 | 说明 |
4787| -- | -- |
4788| float | 导航点距离Swiper组件顶部的距离。单位:vp。 |
4789
4790### OH_ArkUI_SwiperIndicator_SetEndPosition()
4791
4792```
4793void OH_ArkUI_SwiperIndicator_SetEndPosition(ArkUI_SwiperIndicator* indicator, float value)
4794```
4795
4796**描述:**
4797
4798
4799设置导航点距离 Swiper 组件右边的距离。
4800
4801**起始版本:** 12
4802
4803
4804**参数:**
4805
4806| 参数项 | 描述 |
4807| -- | -- |
4808| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4809| float value | 导航点距离Swiper组件右边的距离。默认值:0,单位:vp。 |
4810
4811### OH_ArkUI_SwiperIndicator_GetEndPosition()
4812
4813```
4814float OH_ArkUI_SwiperIndicator_GetEndPosition(ArkUI_SwiperIndicator* indicator)
4815```
4816
4817**描述:**
4818
4819
4820获取导航点距离 Swiper 组件右边的距离。
4821
4822**起始版本:** 12
4823
4824
4825**参数:**
4826
4827| 参数项 | 描述 |
4828| -- | -- |
4829| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4830
4831**返回:**
4832
4833| 类型 | 说明 |
4834| -- | -- |
4835| float | 导航点距离Swiper组件右边的距离。单位:vp。 |
4836
4837### OH_ArkUI_SwiperIndicator_SetBottomPosition()
4838
4839```
4840void OH_ArkUI_SwiperIndicator_SetBottomPosition(ArkUI_SwiperIndicator* indicator, float value)
4841```
4842
4843**描述:**
4844
4845
4846设置导航点距离 Swiper 组件底部的距离。
4847
4848**起始版本:** 12
4849
4850
4851**参数:**
4852
4853| 参数项 | 描述 |
4854| -- | -- |
4855| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4856| float value | 导航点距离Swiper组件底部的距离。默认值:0,单位:vp。 |
4857
4858### OH_ArkUI_SwiperIndicator_GetBottomPosition()
4859
4860```
4861float OH_ArkUI_SwiperIndicator_GetBottomPosition(ArkUI_SwiperIndicator* indicator)
4862```
4863
4864**描述:**
4865
4866
4867获取导航点距离 Swiper 组件底部的距离。
4868
4869**起始版本:** 12
4870
4871
4872**参数:**
4873
4874| 参数项 | 描述 |
4875| -- | -- |
4876| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4877
4878**返回:**
4879
4880| 类型 | 说明 |
4881| -- | -- |
4882| float | 导航点距离Swiper组件底部的距离。单位:vp。 |
4883
4884### OH_ArkUI_SwiperIndicator_SetIgnoreSizeOfBottom()
4885
4886```
4887void OH_ArkUI_SwiperIndicator_SetIgnoreSizeOfBottom(ArkUI_SwiperIndicator* indicator, int32_t ignoreSize)
4888```
4889
4890**描述:**
4891
4892
4893设置OH_ArkUI_SwiperIndicator_SetBottomPosition是否忽略导航点大小。
4894
4895**起始版本:** 19
4896
4897
4898**参数:**
4899
4900| 参数项 | 描述 |
4901| -- | -- |
4902| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4903| int32_t ignoreSize | 是否忽略导航点大小。1表示忽略导航点大小,0表示不忽略,默认值0。 |
4904
4905### OH_ArkUI_SwiperIndicator_GetIgnoreSizeOfBottom()
4906
4907```
4908int32_t OH_ArkUI_SwiperIndicator_GetIgnoreSizeOfBottom(ArkUI_SwiperIndicator* indicator)
4909```
4910
4911**描述:**
4912
4913
4914获取OH_ArkUI_SwiperIndicator_SetBottomPosition是否忽略导航点大小。
4915
4916**起始版本:** 19
4917
4918
4919**参数:**
4920
4921| 参数项 | 描述 |
4922| -- | -- |
4923| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4924
4925**返回:**
4926
4927| 类型 | 说明 |
4928| -- | -- |
4929| int32_t | 是否忽略导航点大小。 |
4930
4931### OH_ArkUI_SwiperIndicator_SetItemWidth()
4932
4933```
4934void OH_ArkUI_SwiperIndicator_SetItemWidth(ArkUI_SwiperIndicator* indicator, float value)
4935```
4936
4937**描述:**
4938
4939
4940设置 Swiper 组件圆点导航指示器的宽。
4941
4942**起始版本:** 12
4943
4944
4945**参数:**
4946
4947| 参数项 | 描述 |
4948| -- | -- |
4949| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4950| float value | 圆点导航指示器的宽。默认值:12,单位:vp。 |
4951
4952### OH_ArkUI_SwiperIndicator_GetItemWidth()
4953
4954```
4955float OH_ArkUI_SwiperIndicator_GetItemWidth(ArkUI_SwiperIndicator* indicator)
4956```
4957
4958**描述:**
4959
4960
4961获取 Swiper 组件圆点导航指示器的宽。
4962
4963**起始版本:** 12
4964
4965
4966**参数:**
4967
4968| 参数项 | 描述 |
4969| -- | -- |
4970| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4971
4972**返回:**
4973
4974| 类型 | 说明 |
4975| -- | -- |
4976| float | 圆点导航指示器的宽。单位:vp。 |
4977
4978### OH_ArkUI_SwiperIndicator_SetItemHeight()
4979
4980```
4981void OH_ArkUI_SwiperIndicator_SetItemHeight(ArkUI_SwiperIndicator* indicator, float value)
4982```
4983
4984**描述:**
4985
4986
4987设置 Swiper 组件圆点导航指示器的高。
4988
4989**起始版本:** 12
4990
4991
4992**参数:**
4993
4994| 参数项 | 描述 |
4995| -- | -- |
4996| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
4997| float value | 圆点导航指示器的高。默认值:6,单位:vp。 |
4998
4999### OH_ArkUI_SwiperIndicator_GetItemHeight()
5000
5001```
5002float OH_ArkUI_SwiperIndicator_GetItemHeight(ArkUI_SwiperIndicator* indicator)
5003```
5004
5005**描述:**
5006
5007
5008获取 Swiper 组件圆点导航指示器的高。
5009
5010**起始版本:** 12
5011
5012
5013**参数:**
5014
5015| 参数项 | 描述 |
5016| -- | -- |
5017| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5018
5019**返回:**
5020
5021| 类型 | 说明 |
5022| -- | -- |
5023| float | 圆点导航指示器的高。单位:vp。 |
5024
5025### OH_ArkUI_SwiperIndicator_SetSelectedItemWidth()
5026
5027```
5028void OH_ArkUI_SwiperIndicator_SetSelectedItemWidth(ArkUI_SwiperIndicator* indicator, float value)
5029```
5030
5031**描述:**
5032
5033
5034设置被选中的 Swiper 组件圆点导航指示器的宽。
5035
5036**起始版本:** 12
5037
5038
5039**参数:**
5040
5041| 参数项 | 描述 |
5042| -- | -- |
5043| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5044| float value | 圆点导航指示器的宽。默认值:12,单位:vp。 |
5045
5046### OH_ArkUI_SwiperIndicator_GetSelectedItemWidth()
5047
5048```
5049float OH_ArkUI_SwiperIndicator_GetSelectedItemWidth(ArkUI_SwiperIndicator* indicator)
5050```
5051
5052**描述:**
5053
5054
5055获取被选中 Swiper 组件圆点导航指示器的宽。
5056
5057**起始版本:** 12
5058
5059
5060**参数:**
5061
5062| 参数项 | 描述 |
5063| -- | -- |
5064| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5065
5066**返回:**
5067
5068| 类型 | 说明 |
5069| -- | -- |
5070| float | 圆点导航指示器的宽。单位:vp。 |
5071
5072### OH_ArkUI_SwiperIndicator_SetSelectedItemHeight()
5073
5074```
5075void OH_ArkUI_SwiperIndicator_SetSelectedItemHeight(ArkUI_SwiperIndicator* indicator, float value)
5076```
5077
5078**描述:**
5079
5080
5081设置被选中的 Swiper 组件圆点导航指示器的高。
5082
5083**起始版本:** 12
5084
5085
5086**参数:**
5087
5088| 参数项 | 描述 |
5089| -- | -- |
5090| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5091| float value | 圆点导航指示器的高。默认值:6,单位:vp。 |
5092
5093### OH_ArkUI_SwiperIndicator_GetSelectedItemHeight()
5094
5095```
5096float OH_ArkUI_SwiperIndicator_GetSelectedItemHeight(ArkUI_SwiperIndicator* indicator)
5097```
5098
5099**描述:**
5100
5101
5102获取被选中 Swiper 组件圆点导航指示器的高。
5103
5104**起始版本:** 12
5105
5106
5107**参数:**
5108
5109| 参数项 | 描述 |
5110| -- | -- |
5111| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5112
5113**返回:**
5114
5115| 类型 | 说明 |
5116| -- | -- |
5117| float | 圆点导航指示器的高。单位:vp。 |
5118
5119### OH_ArkUI_SwiperIndicator_SetMask()
5120
5121```
5122void OH_ArkUI_SwiperIndicator_SetMask(ArkUI_SwiperIndicator* indicator, int32_t mask)
5123```
5124
5125**描述:**
5126
5127
5128设置是否显示 Swiper 组件圆点导航指示器的蒙版样式。
5129
5130**起始版本:** 12
5131
5132
5133**参数:**
5134
5135| 参数项 | 描述 |
5136| -- | -- |
5137| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5138| int32_t mask | 是否显示蒙版样式,1 表示显示,0 表示不显示。 |
5139
5140### OH_ArkUI_SwiperIndicator_GetMask()
5141
5142```
5143int32_t OH_ArkUI_SwiperIndicator_GetMask(ArkUI_SwiperIndicator* indicator)
5144```
5145
5146**描述:**
5147
5148
5149获取是否显示 Swiper 组件圆点导航指示器的蒙版样式。
5150
5151**起始版本:** 12
5152
5153
5154**参数:**
5155
5156| 参数项 | 描述 |
5157| -- | -- |
5158| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5159
5160**返回:**
5161
5162| 类型 | 说明 |
5163| -- | -- |
5164| int32_t | mask 1 表示显示圆点导航指示器的蒙版样式,0 表示不显示。 |
5165
5166### OH_ArkUI_SwiperIndicator_SetColor()
5167
5168```
5169void OH_ArkUI_SwiperIndicator_SetColor(ArkUI_SwiperIndicator* indicator, uint32_t color)
5170```
5171
5172**描述:**
5173
5174
5175设置 Swiper 组件圆点导航指示器的颜色。
5176
5177**起始版本:** 12
5178
5179
5180**参数:**
5181
5182| 参数项 | 描述 |
5183| -- | -- |
5184| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5185| uint32_t color | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。 |
5186
5187### OH_ArkUI_SwiperIndicator_GetColor()
5188
5189```
5190uint32_t OH_ArkUI_SwiperIndicator_GetColor(ArkUI_SwiperIndicator* indicator)
5191```
5192
5193**描述:**
5194
5195
5196获取 Swiper 组件圆点导航指示器的颜色。
5197
5198**起始版本:** 12
5199
5200
5201**参数:**
5202
5203| 参数项 | 描述 |
5204| -- | -- |
5205| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5206
5207**返回:**
5208
5209| 类型 | 说明 |
5210| -- | -- |
5211| uint32_t | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。 |
5212
5213### OH_ArkUI_SwiperIndicator_SetSelectedColor()
5214
5215```
5216void OH_ArkUI_SwiperIndicator_SetSelectedColor(ArkUI_SwiperIndicator* indicator, uint32_t selectedColor)
5217```
5218
5219**描述:**
5220
5221
5222设置被选中 Swiper 组件圆点导航指示器的颜色。
5223
5224**起始版本:** 12
5225
5226
5227**参数:**
5228
5229| 参数项 | 描述 |
5230| -- | -- |
5231| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5232| uint32_t selectedColor | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。 |
5233
5234### OH_ArkUI_SwiperIndicator_GetSelectedColor()
5235
5236```
5237uint32_t OH_ArkUI_SwiperIndicator_GetSelectedColor(ArkUI_SwiperIndicator* indicator)
5238```
5239
5240**描述:**
5241
5242
5243获取被选中 Swiper 组件圆点导航指示器的颜色。
5244
5245**起始版本:** 12
5246
5247
5248**参数:**
5249
5250| 参数项 | 描述 |
5251| -- | -- |
5252| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5253
5254**返回:**
5255
5256| 类型 | 说明 |
5257| -- | -- |
5258| uint32_t | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。 |
5259
5260### OH_ArkUI_SwiperIndicator_SetMaxDisplayCount()
5261
5262```
5263int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount(ArkUI_SwiperIndicator* indicator, int32_t maxDisplayCount)
5264```
5265
5266**描述:**
5267
5268
5269设置圆点导航点指示器样式下,导航点显示个数的最大值。
5270
5271**起始版本:** 12
5272
5273
5274**参数:**
5275
5276| 参数项 | 描述 |
5277| -- | -- |
5278| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5279| int32_t maxDisplayCount | 导航点显示个数最大值,有效取值范围[6, 9]。 |
5280
5281**返回:**
5282
5283| 类型 | 说明 |
5284| -- | -- |
5285| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 如果maxDisplayCount设置范围错误, 返回错误码。 |
5286
5287### OH_ArkUI_SwiperIndicator_GetMaxDisplayCount()
5288
5289```
5290int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount(ArkUI_SwiperIndicator* indicator)
5291```
5292
5293**描述:**
5294
5295
5296获取圆点导航点指示器样式下,导航点显示个数的最大值。
5297
5298**起始版本:** 12
5299
5300
5301**参数:**
5302
5303| 参数项 | 描述 |
5304| -- | -- |
5305| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
5306
5307**返回:**
5308
5309| 类型 | 说明 |
5310| -- | -- |
5311| int32_t | 导航点显示个数最大值,有效取值范围[6, 9]。 |
5312
5313### OH_ArkUI_SwiperDigitIndicator_Create()
5314
5315```
5316ArkUI_SwiperDigitIndicator *OH_ArkUI_SwiperDigitIndicator_Create()
5317```
5318
5319**描述:**
5320
5321
5322创建 Swiper 组件的数字导航指示器。
5323
5324**起始版本:** 19
5325
5326**返回:**
5327
5328| 类型                               | 说明 |
5329|----------------------------------| -- |
5330| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md) * | 数字导航指示器对象指针。 |
5331
5332### OH_ArkUI_SwiperDigitIndicator_Destroy()
5333
5334```
5335void OH_ArkUI_SwiperDigitIndicator_Destroy(ArkUI_SwiperDigitIndicator* indicator)
5336```
5337
5338**描述:**
5339
5340
5341销毁Swiper组件的数字导航指示器指针。
5342
5343**起始版本:** 19
5344
5345
5346**参数:**
5347
5348| 参数项 | 描述 |
5349| -- | -- |
5350| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5351
5352### OH_ArkUI_SwiperDigitIndicator_SetStartPosition()
5353
5354```
5355void OH_ArkUI_SwiperDigitIndicator_SetStartPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
5356```
5357
5358**描述:**
5359
5360
5361设置数字导航指示器距离 Swiper 组件左边的距离,在从右至左显示的语言模式下,设置其距离 Swiper 组件右边的距离。
5362
5363**起始版本:** 19
5364
5365
5366**参数:**
5367
5368| 参数项 | 描述 |
5369| -- | -- |
5370| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5371| float value | 数字导航指示器距离Swiper组件左边的距离,在从右至左显示的语言模式下,其距离Swiper组件右边的距离。默认值:0,单位:vp。 |
5372
5373### OH_ArkUI_SwiperDigitIndicator_GetStartPosition()
5374
5375```
5376float OH_ArkUI_SwiperDigitIndicator_GetStartPosition(ArkUI_SwiperDigitIndicator* indicator)
5377```
5378
5379**描述:**
5380
5381
5382获取数字导航指示器距离 Swiper 组件左边的距离,在从右至左显示的语言模式下,获取其距离 Swiper 组件右边的距离。
5383
5384**起始版本:** 19
5385
5386
5387**参数:**
5388
5389| 参数项 | 描述 |
5390| -- | -- |
5391| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5392
5393**返回:**
5394
5395| 类型 | 说明 |
5396| -- | -- |
5397| float | 数字导航指示器距离Swiper组件左边的距离,在从右至左显示的语言模式下,其距离Swiper组件右边的距离。单位:vp。 |
5398
5399### OH_ArkUI_SwiperDigitIndicator_SetTopPosition()
5400
5401```
5402void OH_ArkUI_SwiperDigitIndicator_SetTopPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
5403```
5404
5405**描述:**
5406
5407
5408设置数字导航指示器距离 Swiper 组件顶部的距离。
5409
5410**起始版本:** 19
5411
5412
5413**参数:**
5414
5415| 参数项 | 描述 |
5416| -- | -- |
5417| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5418| float value | 数字导航指示器距离Swiper组件顶部的距离。默认值:0,单位:vp。 |
5419
5420### OH_ArkUI_SwiperDigitIndicator_GetTopPosition()
5421
5422```
5423float OH_ArkUI_SwiperDigitIndicator_GetTopPosition(ArkUI_SwiperDigitIndicator* indicator)
5424```
5425
5426**描述:**
5427
5428
5429获取数字导航指示器距离 Swiper 组件顶部的距离。
5430
5431**起始版本:** 19
5432
5433
5434**参数:**
5435
5436| 参数项 | 描述 |
5437| -- | -- |
5438| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5439
5440**返回:**
5441
5442| 类型 | 说明 |
5443| -- | -- |
5444| float | 数字导航指示器距离Swiper组件顶部的距离。单位:vp。 |
5445
5446### OH_ArkUI_SwiperDigitIndicator_SetEndPosition()
5447
5448```
5449void OH_ArkUI_SwiperDigitIndicator_SetEndPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
5450```
5451
5452**描述:**
5453
5454
5455设置数字导航指示器距离 Swiper 组件右边的距离,在从右至左显示的语言模式下,设置其距离 Swiper 组件左边的距离。
5456
5457**起始版本:** 19
5458
5459
5460**参数:**
5461
5462| 参数项 | 描述 |
5463| -- | -- |
5464| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5465| float value | 数字导航指示器距离Swiper组件右边的距离,在从右至左显示的语言模式下,其距离Swiper组件左边的距离。默认值:0,单位:vp。 |
5466
5467### OH_ArkUI_SwiperDigitIndicator_GetEndPosition()
5468
5469```
5470float OH_ArkUI_SwiperDigitIndicator_GetEndPosition(ArkUI_SwiperDigitIndicator* indicator)
5471```
5472
5473**描述:**
5474
5475
5476获取数字导航指示器距离 Swiper 组件右边的距离,在从右至左显示的语言模式下,获取其距离 Swiper 组件左边的距离。
5477
5478**起始版本:** 19
5479
5480
5481**参数:**
5482
5483| 参数项 | 描述 |
5484| -- | -- |
5485| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5486
5487**返回:**
5488
5489| 类型 | 说明 |
5490| -- | -- |
5491| float | 数字导航指示器距离Swiper组件右边的距离,在从右至左显示的语言模式下,其距离Swiper组件左边的距离。单位:vp。 |
5492
5493### OH_ArkUI_SwiperDigitIndicator_SetBottomPosition()
5494
5495```
5496void OH_ArkUI_SwiperDigitIndicator_SetBottomPosition(ArkUI_SwiperDigitIndicator* indicator, float value)
5497```
5498
5499**描述:**
5500
5501
5502设置数字导航指示器距离 Swiper 组件底部的距离。
5503
5504**起始版本:** 19
5505
5506
5507**参数:**
5508
5509| 参数项 | 描述 |
5510| -- | -- |
5511| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5512| float value | 数字导航指示器距离Swiper组件底部的距离。默认值:0,单位:vp。 |
5513
5514### OH_ArkUI_SwiperDigitIndicator_GetBottomPosition()
5515
5516```
5517float OH_ArkUI_SwiperDigitIndicator_GetBottomPosition(ArkUI_SwiperDigitIndicator* indicator)
5518```
5519
5520**描述:**
5521
5522
5523获取数字导航指示器距离 Swiper 组件底部的距离。
5524
5525**起始版本:** 19
5526
5527
5528**参数:**
5529
5530| 参数项 | 描述 |
5531| -- | -- |
5532| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5533
5534**返回:**
5535
5536| 类型 | 说明 |
5537| -- | -- |
5538| float | 数字导航指示器距离Swiper组件底部的距离。单位:vp。 |
5539
5540### OH_ArkUI_SwiperDigitIndicator_SetFontColor()
5541
5542```
5543void OH_ArkUI_SwiperDigitIndicator_SetFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t color)
5544```
5545
5546**描述:**
5547
5548
5549设置 Swiper 组件数字导航指示器字体颜色。
5550
5551**起始版本:** 19
5552
5553
5554**参数:**
5555
5556| 参数项 | 描述 |
5557| -- | -- |
5558| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5559| uint32_t color | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。默认值:0xFF182431。 |
5560
5561### OH_ArkUI_SwiperDigitIndicator_GetFontColor()
5562
5563```
5564uint32_t OH_ArkUI_SwiperDigitIndicator_GetFontColor(ArkUI_SwiperDigitIndicator* indicator)
5565```
5566
5567**描述:**
5568
5569
5570获取 Swiper 组件数字导航指示器字体颜色。
5571
5572**起始版本:** 19
5573
5574
5575**参数:**
5576
5577| 参数项 | 描述 |
5578| -- | -- |
5579| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5580
5581**返回:**
5582
5583| 类型 | 说明 |
5584| -- | -- |
5585| uint32_t | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。 |
5586
5587### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor()
5588
5589```
5590void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t selectedColor)
5591```
5592
5593**描述:**
5594
5595
5596设置被选中 Swiper 组件数字导航指示器字体颜色。
5597
5598**起始版本:** 19
5599
5600
5601**参数:**
5602
5603| 参数项 | 描述 |
5604| -- | -- |
5605| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5606| uint32_t selectedColor | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。默认值:0xFF182431。 |
5607
5608### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor()
5609
5610```
5611uint32_t OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator)
5612```
5613
5614**描述:**
5615
5616
5617获取被选中 Swiper 组件数字导航指示器字体颜色。
5618
5619**起始版本:** 19
5620
5621
5622**参数:**
5623
5624| 参数项 | 描述 |
5625| -- | -- |
5626| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5627
5628**返回:**
5629
5630| 类型 | 说明 |
5631| -- | -- |
5632| uint32_t | 颜色类型,0xargb格式,形如 0xFFFF0000 表示红色。 |
5633
5634### OH_ArkUI_SwiperDigitIndicator_SetFontSize()
5635
5636```
5637void OH_ArkUI_SwiperDigitIndicator_SetFontSize(ArkUI_SwiperDigitIndicator* indicator, float size)
5638```
5639
5640**描述:**
5641
5642
5643设置 Swiper 组件数字导航指示器字体大小。
5644
5645**起始版本:** 19
5646
5647
5648**参数:**
5649
5650| 参数项 | 描述 |
5651| -- | -- |
5652| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5653| float size | 字体大小数值,单位为fp。 |
5654
5655### OH_ArkUI_SwiperDigitIndicator_GetFontSize()
5656
5657```
5658float OH_ArkUI_SwiperDigitIndicator_GetFontSize(ArkUI_SwiperDigitIndicator* indicator)
5659```
5660
5661**描述:**
5662
5663
5664获取 Swiper 组件数字导航指示器字体大小。
5665
5666**起始版本:** 19
5667
5668
5669**参数:**
5670
5671| 参数项 | 描述 |
5672| -- | -- |
5673| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5674
5675**返回:**
5676
5677| 类型 | 说明 |
5678| -- | -- |
5679| float | 字体大小数值,单位为fp。 |
5680
5681### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize()
5682
5683```
5684void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator, float size)
5685```
5686
5687**描述:**
5688
5689
5690设置被选中 Swiper 组件数字导航指示器字体大小。
5691
5692**起始版本:** 19
5693
5694
5695**参数:**
5696
5697| 参数项 | 描述 |
5698| -- | -- |
5699| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5700| float size | 字体大小数值,单位为fp。 |
5701
5702### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize()
5703
5704```
5705float OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator)
5706```
5707
5708**描述:**
5709
5710
5711获取被选中 Swiper 组件数字导航指示器字体大小。
5712
5713**起始版本:** 19
5714
5715
5716**参数:**
5717
5718| 参数项 | 描述 |
5719| -- | -- |
5720| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5721
5722**返回:**
5723
5724| 类型 | 说明 |
5725| -- | -- |
5726| float | 字体大小数值,单位为fp。 |
5727
5728### OH_ArkUI_SwiperDigitIndicator_SetFontWeight()
5729
5730```
5731void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight fontWeight)
5732```
5733
5734**描述:**
5735
5736
5737设置 Swiper 组件数字导航指示器字体粗细属性。
5738
5739**起始版本:** 19
5740
5741
5742**参数:**
5743
5744| 参数项 | 描述 |
5745| -- | -- |
5746| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md) *indicator | 数字导航指示器对象指针。 |
5747| [ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight) fontWeight | 字体粗细样式[ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight)。 |
5748
5749### OH_ArkUI_SwiperDigitIndicator_GetFontWeight()
5750
5751```
5752ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator)
5753```
5754
5755**描述:**
5756
5757
5758获取 Swiper 组件数字导航指示器字体粗细属性。
5759
5760**起始版本:** 19
5761
5762
5763**参数:**
5764
5765| 参数项 | 描述 |
5766| -- | -- |
5767| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5768
5769**返回:**
5770
5771| 类型 | 说明 |
5772| -- | -- |
5773| [ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight) | 字体粗细样式[ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight)。 |
5774
5775### OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight()
5776
5777```
5778void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight selectedFontWeight)
5779```
5780
5781**描述:**
5782
5783
5784设置被选中 Swiper 组件数字导航指示器字体粗细属性。
5785
5786**起始版本:** 19
5787
5788
5789**参数:**
5790
5791| 参数项 | 描述 |
5792| -- | -- |
5793| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md) *indicator | 数字导航指示器对象指针。 |
5794| [ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight) selectedFontWeight | 字体粗细样式[ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight)。 |
5795
5796### OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight()
5797
5798```
5799ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator)
5800```
5801
5802**描述:**
5803
5804
5805获取被选中 Swiper 组件数字导航指示器字体粗细属性。
5806
5807**起始版本:** 19
5808
5809
5810**参数:**
5811
5812| 参数项 | 描述 |
5813| -- | -- |
5814| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 数字导航指示器对象指针。 |
5815
5816**返回:**
5817
5818| 类型 | 说明 |
5819| -- | -- |
5820| [ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight) | 字体粗细样式[ArkUI_FontWeight](capi-native-type-h.md#arkui_fontweight)。 |
5821
5822### OH_ArkUI_SwiperArrowStyle_Create()
5823
5824```
5825ArkUI_SwiperArrowStyle *OH_ArkUI_SwiperArrowStyle_Create()
5826```
5827
5828**描述:**
5829
5830
5831创建 Swiper 组件的导航箭头。
5832
5833**起始版本:** 19
5834
5835**返回:**
5836
5837| 类型                           | 说明 |
5838|------------------------------| -- |
5839| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md) * | 导航箭头对象指针。 |
5840
5841### OH_ArkUI_SwiperArrowStyle_Destroy()
5842
5843```
5844void OH_ArkUI_SwiperArrowStyle_Destroy(ArkUI_SwiperArrowStyle* arrowStyle)
5845```
5846
5847**描述:**
5848
5849
5850销毁 Swiper 组件的导航箭头指针。
5851
5852**起始版本:** 19
5853
5854
5855**参数:**
5856
5857| 参数项 | 描述 |
5858| -- | -- |
5859| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5860
5861### OH_ArkUI_SwiperArrowStyle_SetShowBackground()
5862
5863```
5864void OH_ArkUI_SwiperArrowStyle_SetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle, int32_t showBackground)
5865```
5866
5867**描述:**
5868
5869
5870设置 Swiper 组件导航箭头底板是否显示。
5871
5872**起始版本:** 19
5873
5874
5875**参数:**
5876
5877| 参数项 | 描述 |
5878| -- | -- |
5879| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5880| int32_t showBackground | 导航箭头底板是否显示,0:不显示,1:显示,默认值:0。 |
5881
5882### OH_ArkUI_SwiperArrowStyle_GetShowBackground()
5883
5884```
5885int32_t OH_ArkUI_SwiperArrowStyle_GetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle)
5886```
5887
5888**描述:**
5889
5890
5891获取 Swiper 组件导航箭头底板是否显示。
5892
5893**起始版本:** 19
5894
5895
5896**参数:**
5897
5898| 参数项 | 描述 |
5899| -- | -- |
5900| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5901
5902**返回:**
5903
5904| 类型 | 说明 |
5905| -- | -- |
5906| int32_t | 导航箭头底板是否显示,0:不显示,1:显示。 |
5907
5908### OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle()
5909
5910```
5911void OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle, int32_t showSidebarMiddle)
5912```
5913
5914**描述:**
5915
5916
5917设置 Swiper 组件导航箭头显示位置。
5918
5919**起始版本:** 19
5920
5921
5922**参数:**
5923
5924| 参数项 | 描述 |
5925| -- | -- |
5926| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5927| int32_t showSidebarMiddle | 导航箭头显示位置,0:显示在导航指示器两侧,1:显示在Swiper组件两侧,默认值:0。 |
5928
5929### OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle()
5930
5931```
5932int32_t OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle)
5933```
5934
5935**描述:**
5936
5937
5938获取 Swiper 组件导航箭头显示位置。
5939
5940**起始版本:** 19
5941
5942
5943**参数:**
5944
5945| 参数项 | 描述 |
5946| -- | -- |
5947| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5948
5949**返回:**
5950
5951| 类型 | 说明 |
5952| -- | -- |
5953| int32_t | 导航箭头显示位置,0:显示在导航指示器两侧,1:显示在Swiper组件两侧。 |
5954
5955### OH_ArkUI_SwiperArrowStyle_SetBackgroundSize()
5956
5957```
5958void OH_ArkUI_SwiperArrowStyle_SetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle, float backgroundSize)
5959```
5960
5961**描述:**
5962
5963
5964设置 Swiper 组件导航箭头底板大小。
5965
5966**起始版本:** 19
5967
5968
5969**参数:**
5970
5971| 参数项 | 描述 |
5972| -- | -- |
5973| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5974| float backgroundSize | 导航箭头底板大小,单位:vp。默认值:显示在导航指示器两侧24vp,显示在Swiper两侧32vp。 |
5975
5976### OH_ArkUI_SwiperArrowStyle_GetBackgroundSize()
5977
5978```
5979float OH_ArkUI_SwiperArrowStyle_GetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle)
5980```
5981
5982**描述:**
5983
5984
5985获取 Swiper 组件导航箭头底板大小。
5986
5987**起始版本:** 19
5988
5989
5990**参数:**
5991
5992| 参数项 | 描述 |
5993| -- | -- |
5994| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
5995
5996**返回:**
5997
5998| 类型 | 说明 |
5999| -- | -- |
6000| float | 导航箭头底板大小,单位:vp。 |
6001
6002### OH_ArkUI_SwiperArrowStyle_SetBackgroundColor()
6003
6004```
6005void OH_ArkUI_SwiperArrowStyle_SetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t backgroundColor)
6006```
6007
6008**描述:**
6009
6010
6011设置 Swiper 组件导航箭头底板颜色。
6012
6013**起始版本:** 19
6014
6015
6016**参数:**
6017
6018| 参数项 | 描述 |
6019| -- | -- |
6020| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
6021| uint32_t backgroundColor | 导航箭头底板颜色,0xargb格式,形如 0xFFFF0000 表示红色。默认值:显示在导航指示器两侧为0x00000000,显示在Swiper两侧为0x19182431。 |
6022
6023### OH_ArkUI_SwiperArrowStyle_GetBackgroundColor()
6024
6025```
6026uint32_t OH_ArkUI_SwiperArrowStyle_GetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle)
6027```
6028
6029**描述:**
6030
6031
6032获取 Swiper 组件导航箭头底板颜色。
6033
6034**起始版本:** 19
6035
6036
6037**参数:**
6038
6039| 参数项 | 描述 |
6040| -- | -- |
6041| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
6042
6043**返回:**
6044
6045| 类型 | 说明 |
6046| -- | -- |
6047| uint32_t | 导航箭头底板颜色,0xargb格式,形如 0xFFFF0000 表示红色。 |
6048
6049### OH_ArkUI_SwiperArrowStyle_SetArrowSize()
6050
6051```
6052void OH_ArkUI_SwiperArrowStyle_SetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle, float arrowSize)
6053```
6054
6055**描述:**
6056
6057
6058设置 Swiper 组件导航箭头大小。
6059
6060**起始版本:** 19
6061
6062
6063**参数:**
6064
6065| 参数项 | 描述 |
6066| -- | -- |
6067| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
6068| float arrowSize | 导航箭头大小,单位:vp。默认值:显示在导航指示器两侧18vp,显示在Swiper两侧24vp。显示导航箭头底板时,arrowSize固定为backgroundSize的3/4。 |
6069
6070### OH_ArkUI_SwiperArrowStyle_GetArrowSize()
6071
6072```
6073float OH_ArkUI_SwiperArrowStyle_GetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle)
6074```
6075
6076**描述:**
6077
6078
6079获取 Swiper 组件导航箭头大小。
6080
6081**起始版本:** 19
6082
6083
6084**参数:**
6085
6086| 参数项 | 描述 |
6087| -- | -- |
6088| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
6089
6090**返回:**
6091
6092| 类型 | 说明 |
6093| -- | -- |
6094| float | 导航箭头大小,单位:vp。 |
6095
6096### OH_ArkUI_SwiperArrowStyle_SetArrowColor()
6097
6098```
6099void OH_ArkUI_SwiperArrowStyle_SetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t arrowColor)
6100```
6101
6102**描述:**
6103
6104
6105设置 Swiper 组件导航箭头颜色。
6106
6107**起始版本:** 19
6108
6109
6110**参数:**
6111
6112| 参数项 | 描述 |
6113| -- | -- |
6114| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
6115| uint32_t arrowColor | 导航箭头颜色,0xargb格式,形如 0xFFFF0000 表示红色。 |
6116
6117### OH_ArkUI_SwiperArrowStyle_GetArrowColor()
6118
6119```
6120uint32_t OH_ArkUI_SwiperArrowStyle_GetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle)
6121```
6122
6123**描述:**
6124
6125
6126获取 Swiper 组件导航箭头颜色。
6127
6128**起始版本:** 19
6129
6130
6131**参数:**
6132
6133| 参数项 | 描述 |
6134| -- | -- |
6135| [ArkUI_SwiperArrowStyle](capi-arkui-nativemodule-arkui-swiperarrowstyle.md)* arrowStyle | 导航箭头对象指针。 |
6136
6137**返回:**
6138
6139| 类型 | 说明 |
6140| -- | -- |
6141| uint32_t | 导航箭头颜色,0xargb格式,形如 0xFFFF0000 表示红色。 |
6142
6143### OH_ArkUI_SwiperIndicator_SetSpace()
6144
6145```
6146void OH_ArkUI_SwiperIndicator_SetSpace(ArkUI_SwiperIndicator* indicator, float space)
6147```
6148
6149**描述:**
6150
6151
6152设置导航点间距。
6153
6154**起始版本:** 19
6155
6156
6157**参数:**
6158
6159| 参数项 | 描述 |
6160| -- | -- |
6161| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
6162| float space | 导航点间距。默认值:8,单位:vp。 |
6163
6164### OH_ArkUI_SwiperIndicator_GetSpace()
6165
6166```
6167float OH_ArkUI_SwiperIndicator_GetSpace(ArkUI_SwiperIndicator* indicator)
6168```
6169
6170**描述:**
6171
6172
6173获取导航点间距。
6174
6175**起始版本:** 19
6176
6177
6178**参数:**
6179
6180| 参数项 | 描述 |
6181| -- | -- |
6182| [ArkUI_SwiperIndicator](capi-arkui-nativemodule-arkui-swiperindicator.md)* indicator | 导航指示器对象指针。 |
6183
6184**返回:**
6185
6186| 类型 | 说明 |
6187| -- | -- |
6188| float | 导航点间距。单位:vp。 |
6189
6190### OH_ArkUI_SwiperDigitIndicator_SetIgnoreSizeOfBottom()
6191
6192```
6193void OH_ArkUI_SwiperDigitIndicator_SetIgnoreSizeOfBottom(ArkUI_SwiperDigitIndicator* indicator, int32_t ignoreSize)
6194```
6195
6196**描述:**
6197
6198
6199设置OH_ArkUI_SwiperDigitIndicator_SetBottomPosition是否忽略导航点大小。
6200
6201**起始版本:** 19
6202
6203
6204**参数:**
6205
6206| 参数项 | 描述 |
6207| -- | -- |
6208| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 导航指示器对象指针。 |
6209| int32_t ignoreSize | 是否忽略导航点大小。1表示忽略导航点大小,0表示不忽略,默认值0。 |
6210
6211### OH_ArkUI_SwiperDigitIndicator_GetIgnoreSizeOfBottom()
6212
6213```
6214int32_t OH_ArkUI_SwiperDigitIndicator_GetIgnoreSizeOfBottom(ArkUI_SwiperDigitIndicator* indicator)
6215```
6216
6217**描述:**
6218
6219
6220获取OH_ArkUI_SwiperDigitIndicator_SetBottomPosition是否忽略导航点大小。
6221
6222**起始版本:** 19
6223
6224
6225**参数:**
6226
6227| 参数项 | 描述 |
6228| -- | -- |
6229| [ArkUI_SwiperDigitIndicator](capi-arkui-nativemodule-arkui-swiperdigitindicator.md)* indicator | 导航指示器对象指针。 |
6230
6231**返回:**
6232
6233| 类型 | 说明 |
6234| -- | -- |
6235| int32_t | 是否忽略导航点大小。 |
6236
6237### OH_ArkUI_ListItemSwipeActionItem_Create()
6238
6239```
6240ArkUI_ListItemSwipeActionItem* OH_ArkUI_ListItemSwipeActionItem_Create()
6241```
6242
6243**描述:**
6244
6245
6246创建ListItemSwipeActionItem接口设置的配置项。
6247
6248**起始版本:** 12
6249
6250**返回:**
6251
6252| 类型                                 | 说明 |
6253|------------------------------------| -- |
6254| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* | ListItemSwipeActionItem配置项实例。 |
6255
6256### OH_ArkUI_ListItemSwipeActionItem_Dispose()
6257
6258```
6259void OH_ArkUI_ListItemSwipeActionItem_Dispose(ArkUI_ListItemSwipeActionItem* item)
6260```
6261
6262**描述:**
6263
6264
6265销毁ListItemSwipeActionItem实例。
6266
6267**起始版本:** 12
6268
6269
6270**参数:**
6271
6272| 参数项 | 描述 |
6273| -- | -- |
6274| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | 要销毁的ListItemSwipeActionItem实例。 |
6275
6276### OH_ArkUI_ListItemSwipeActionItem_SetContent()
6277
6278```
6279void OH_ArkUI_ListItemSwipeActionItem_SetContent(ArkUI_ListItemSwipeActionItem* item, ArkUI_NodeHandle node)
6280```
6281
6282**描述:**
6283
6284
6285设置ListItemSwipeActionItem的布局内容。
6286
6287**起始版本:** 12
6288
6289
6290**参数:**
6291
6292| 参数项 | 描述 |
6293| -- | -- |
6294| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6295| [ArkUI_NodeHandle](capi-arkui-nativemodule-arkui-node8h.md) node | 布局信息。 |
6296
6297### OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance()
6298
6299```
6300void OH_ArkUI_ListItemSwipeActionItem_SetActionAreaDistance(ArkUI_ListItemSwipeActionItem* item, float distance)
6301```
6302
6303**描述:**
6304
6305
6306设置组件长距离滑动删除距离阈值。
6307
6308**起始版本:** 12
6309
6310
6311**参数:**
6312
6313| 参数项 | 描述 |
6314| -- | -- |
6315| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6316| float distance | 组件长距离滑动删除距离阈值。 |
6317
6318### OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance()
6319
6320```
6321float OH_ArkUI_ListItemSwipeActionItem_GetActionAreaDistance(ArkUI_ListItemSwipeActionItem* item)
6322```
6323
6324**描述:**
6325
6326
6327获取组件长距离滑动删除距离阈值。
6328
6329**起始版本:** 12
6330
6331
6332**参数:**
6333
6334| 参数项 | 描述 |
6335| -- | -- |
6336| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6337
6338**返回:**
6339
6340| 类型 | 说明 |
6341| -- | -- |
6342| float | 组件长距离滑动删除距离阈值。异常时返回值:0。 |
6343
6344### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea()
6345
6346```
6347void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionArea(ArkUI_ListItemSwipeActionItem* item, void (*callback)())
6348```
6349
6350**描述:**
6351
6352
6353设置滑动条目进入删除区域时调用的事件。
6354
6355**起始版本:** 12
6356
6357
6358**参数:**
6359
6360| 参数项                                     | 描述 |
6361|-----------------------------------------| -- |
6362| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6363| callback                                | 回调事件。 |
6364
6365### OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData()
6366
6367```
6368void OH_ArkUI_ListItemSwipeActionItem_SetOnEnterActionAreaWithUserData(ArkUI_ListItemSwipeActionItem* item,void* userData, void (*callback)(void* userData))
6369```
6370
6371**描述:**
6372
6373
6374设置滑动条目进入删除区域时调用的事件。
6375
6376**起始版本:** 12
6377
6378
6379**参数:**
6380
6381| 参数项 | 描述 |
6382| -- | -- |
6383| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6384| void* userData | 用户自定义数据。 |
6385| callback | 回调事件。 |
6386
6387### OH_ArkUI_ListItemSwipeActionItem_SetOnAction()
6388
6389```
6390void OH_ArkUI_ListItemSwipeActionItem_SetOnAction(ArkUI_ListItemSwipeActionItem* item, void (*callback)())
6391```
6392
6393**描述:**
6394
6395
6396设置组件进入长距删除区后删除ListItem时调用的事件。
6397
6398**起始版本:** 12
6399
6400
6401**参数:**
6402
6403| 参数项 | 描述 |
6404| -- | -- |
6405| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6406| callback | 回调事件。 |
6407
6408### OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData()
6409
6410```
6411void OH_ArkUI_ListItemSwipeActionItem_SetOnActionWithUserData(ArkUI_ListItemSwipeActionItem* item,void* userData, void (*callback)(void* userData))
6412```
6413
6414**描述:**
6415
6416
6417设置组件进入长距删除区后删除ListItem时调用的事件。
6418
6419**起始版本:** 12
6420
6421
6422**参数:**
6423
6424| 参数项 | 描述 |
6425| -- | -- |
6426| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6427| void* userData | 用户自定义数据。 |
6428| callback | 回调事件。 |
6429
6430### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea()
6431
6432```
6433void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionArea(ArkUI_ListItemSwipeActionItem* item, void (*callback)())
6434```
6435
6436**描述:**
6437
6438
6439设置滑动条目退出删除区域时调用的事件。
6440
6441**起始版本:** 12
6442
6443
6444**参数:**
6445
6446| 参数项 | 描述 |
6447| -- | -- |
6448| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6449| callback | 回调事件。 |
6450
6451### OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData()
6452
6453```
6454void OH_ArkUI_ListItemSwipeActionItem_SetOnExitActionAreaWithUserData(ArkUI_ListItemSwipeActionItem* item,void* userData, void (*callback)(void* userData))
6455```
6456
6457**描述:**
6458
6459
6460设置滑动条目退出删除区域时调用的事件。
6461
6462**起始版本:** 12
6463
6464
6465**参数:**
6466
6467| 参数项 | 描述 |
6468| -- | -- |
6469| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6470| void* userData | 用户自定义数据。 |
6471| callback | 回调事件。 |
6472
6473### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange()
6474
6475```
6476void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChange(ArkUI_ListItemSwipeActionItem* item,void (*callback)(ArkUI_ListItemSwipeActionState swipeActionState))
6477```
6478
6479**描述:**
6480
6481
6482设置列表项滑动状态变化时候触发的事件。
6483
6484**起始版本:** 12
6485
6486
6487**参数:**
6488
6489| 参数项 | 描述 |
6490| -- | -- |
6491| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6492| callback | 回调事件。swipeActionState 变化后的状态。 |
6493
6494### OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData()
6495
6496```
6497void OH_ArkUI_ListItemSwipeActionItem_SetOnStateChangeWithUserData(ArkUI_ListItemSwipeActionItem* item,void* userData, void (*callback)(ArkUI_ListItemSwipeActionState swipeActionState, void* userData))
6498```
6499
6500**描述:**
6501
6502
6503设置列表项滑动状态变化时候触发的事件。
6504
6505**起始版本:** 12
6506
6507
6508**参数:**
6509
6510| 参数项 | 描述 |
6511| -- | -- |
6512| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | ListItemSwipeActionItem实例。 |
6513|  void* userData | 用户自定义数据。 |
6514| callback | 回调事件。swipeActionState 变化后的状态。 |
6515
6516### OH_ArkUI_ListItemSwipeActionOption_Create()
6517
6518```
6519ArkUI_ListItemSwipeActionOption* OH_ArkUI_ListItemSwipeActionOption_Create()
6520```
6521
6522**描述:**
6523
6524
6525创建ListItemSwipeActionOption接口设置的配置项。
6526
6527**起始版本:** 12
6528
6529**返回:**
6530
6531| 类型                                   | 说明 |
6532|--------------------------------------| -- |
6533| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* | ListItemSwipeActionOption配置项实例。 |
6534
6535### OH_ArkUI_ListItemSwipeActionOption_Dispose()
6536
6537```
6538void OH_ArkUI_ListItemSwipeActionOption_Dispose(ArkUI_ListItemSwipeActionOption* option)
6539```
6540
6541**描述:**
6542
6543
6544销毁ListItemSwipeActionOption实例。
6545
6546**起始版本:** 12
6547
6548
6549**参数:**
6550
6551| 参数项 | 描述 |
6552| -- | -- |
6553| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | 要销毁的ListItemSwipeActionOption实例。 |
6554
6555### OH_ArkUI_ListItemSwipeActionOption_SetStart()
6556
6557```
6558void OH_ArkUI_ListItemSwipeActionOption_SetStart(ArkUI_ListItemSwipeActionOption* option, ArkUI_ListItemSwipeActionItem* item)
6559```
6560
6561**描述:**
6562
6563
6564设置ListItemSwipeActionItem的左侧(垂直布局)或上方(横向布局)布局内容。
6565
6566**起始版本:** 12
6567
6568
6569**参数:**
6570
6571| 参数项 | 描述 |
6572| -- | -- |
6573| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | ListItemSwipeActionItem实例。 |
6574| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | 布局信息。 |
6575
6576### OH_ArkUI_ListItemSwipeActionOption_SetEnd()
6577
6578```
6579void OH_ArkUI_ListItemSwipeActionOption_SetEnd(ArkUI_ListItemSwipeActionOption* option,ArkUI_ListItemSwipeActionItem* item)
6580```
6581
6582**描述:**
6583
6584
6585设置ListItemSwipeActionItem的右侧(垂直布局)或下方(横向布局)布局内容。
6586
6587**起始版本:** 12
6588
6589
6590**参数:**
6591
6592| 参数项 | 描述 |
6593| -- | -- |
6594| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | ListItemSwipeActionItem实例。 |
6595| [ArkUI_ListItemSwipeActionItem](capi-arkui-nativemodule-arkui-listitemswipeactionitem.md)* item | 布局信息。 |
6596
6597### OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect()
6598
6599```
6600void OH_ArkUI_ListItemSwipeActionOption_SetEdgeEffect(ArkUI_ListItemSwipeActionOption* option,ArkUI_ListItemSwipeEdgeEffect edgeEffect)
6601```
6602
6603**描述:**
6604
6605
6606设置滑动效果。
6607
6608**起始版本:** 12
6609
6610
6611**参数:**
6612
6613| 参数项 | 描述 |
6614| -- | -- |
6615| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | ListItemSwipeActionItem实例。 |
6616| [ArkUI_ListItemSwipeEdgeEffect](capi-native-type-h.md#arkui_listitemswipeedgeeffect) edgeEffect | 滑动效果。 |
6617
6618### OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect()
6619
6620```
6621int32_t OH_ArkUI_ListItemSwipeActionOption_GetEdgeEffect(ArkUI_ListItemSwipeActionOption* option)
6622```
6623
6624**描述:**
6625
6626
6627获取滑动效果。
6628
6629**起始版本:** 12
6630
6631
6632**参数:**
6633
6634| 参数项 | 描述 |
6635| -- | -- |
6636| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | ListItemSwipeActionItem实例。 |
6637
6638**返回:**
6639
6640| 类型 | 说明 |
6641| -- | -- |
6642| int32_t | 滑动效果。默认返回值:ARKUI_LIST_ITEM_SWIPE_EDGE_EFFECT_SPRING。 |
6643
6644### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange()
6645
6646```
6647void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChange(ArkUI_ListItemSwipeActionOption* option,void (*callback)(float offset))
6648```
6649
6650**描述:**
6651
6652
6653滑动操作偏移量更改时调用的事件。
6654
6655**起始版本:** 12
6656
6657
6658**参数:**
6659
6660| 参数项 | 描述 |
6661| -- | -- |
6662| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | ListItemSwipeActionItem实例。 |
6663| callback | 回调事件。offset 滑动偏移量。 |
6664
6665### OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData()
6666
6667```
6668void OH_ArkUI_ListItemSwipeActionOption_SetOnOffsetChangeWithUserData(ArkUI_ListItemSwipeActionOption* option,void* userData, void (*callback)(float offset, void* userData))
6669```
6670
6671**描述:**
6672
6673
6674滑动操作偏移量更改时调用的事件。
6675
6676**起始版本:** 12
6677
6678
6679**参数:**
6680
6681| 参数项 | 描述 |
6682| -- | -- |
6683| [ArkUI_ListItemSwipeActionOption](capi-arkui-nativemodule-arkui-listitemswipeactionoption.md)* option | ListItemSwipeActionItem实例。 |
6684|  void* userData | 用户自定义数据。 |
6685| callback | 回调事件。offset 滑动偏移量。 |
6686
6687### OH_ArkUI_AccessibilityState_Create()
6688
6689```
6690ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create(void)
6691```
6692
6693**描述:**
6694
6695
6696创建无障碍状态。
6697
6698**起始版本:** 12
6699
6700**返回:**
6701
6702| 类型                            | 说明 |
6703|-------------------------------| -- |
6704| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* | 无障碍状态对象指针。如果对象返回空指针,表示创建失败,失败的可能原因是应用地址空间满。 |
6705
6706### OH_ArkUI_AccessibilityState_Dispose()
6707
6708```
6709void OH_ArkUI_AccessibilityState_Dispose(ArkUI_AccessibilityState* state)
6710```
6711
6712**描述:**
6713
6714
6715销毁无障碍状态指针。
6716
6717**起始版本:** 12
6718
6719
6720**参数:**
6721
6722| 参数项 | 描述 |
6723| -- | -- |
6724| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6725
6726### OH_ArkUI_AccessibilityState_SetDisabled()
6727
6728```
6729void OH_ArkUI_AccessibilityState_SetDisabled(ArkUI_AccessibilityState* state, int32_t isDisabled)
6730```
6731
6732**描述:**
6733
6734
6735设置无障碍状态是否禁用。
6736
6737**起始版本:** 12
6738
6739
6740**参数:**
6741
6742| 参数项 | 描述 |
6743| -- | -- |
6744| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6745| int32_t isDisabled | 无障碍状态是否禁用, 1表示禁用,0表示不禁用,默认为0。 |
6746
6747### OH_ArkUI_AccessibilityState_IsDisabled()
6748
6749```
6750int32_t OH_ArkUI_AccessibilityState_IsDisabled(ArkUI_AccessibilityState* state)
6751```
6752
6753**描述:**
6754
6755
6756获取无障碍状态是否禁用。
6757
6758**起始版本:** 12
6759
6760
6761**参数:**
6762
6763| 参数项 | 描述 |
6764| -- | -- |
6765| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6766
6767**返回:**
6768
6769| 类型 | 说明 |
6770| -- | -- |
6771| int32_t | 是否禁用, 1表示禁用,0表示未禁用,默认为0;<br>         若state为空,返回默认值。 |
6772
6773### OH_ArkUI_AccessibilityState_SetSelected()
6774
6775```
6776void OH_ArkUI_AccessibilityState_SetSelected(ArkUI_AccessibilityState* state, int32_t isSelected)
6777```
6778
6779**描述:**
6780
6781
6782设置无障碍状态是否选中。
6783
6784**起始版本:** 12
6785
6786
6787**参数:**
6788
6789| 参数项 | 描述 |
6790| -- | -- |
6791| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6792| int32_t isSelected | 是否被选中, 1表示选中,0表示未选中,默认为0。 |
6793
6794### OH_ArkUI_AccessibilityState_IsSelected()
6795
6796```
6797int32_t OH_ArkUI_AccessibilityState_IsSelected(ArkUI_AccessibilityState* state)
6798```
6799
6800**描述:**
6801
6802
6803获取无障碍状态是否选中。
6804
6805**起始版本:** 12
6806
6807
6808**参数:**
6809
6810| 参数项 | 描述 |
6811| -- | -- |
6812| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6813
6814**返回:**
6815
6816| 类型 | 说明 |
6817| -- | -- |
6818| int32_t | 是否被选中, 1表示选中,0表示未选中,默认为0;<br>         若state为空,返回默认值。 |
6819
6820### OH_ArkUI_AccessibilityState_SetCheckedState()
6821
6822```
6823void OH_ArkUI_AccessibilityState_SetCheckedState(ArkUI_AccessibilityState* state, int32_t checkedState)
6824```
6825
6826**描述:**
6827
6828
6829设置无障碍状态复选框状态。
6830
6831**起始版本:** 12
6832
6833
6834**参数:**
6835
6836| 参数项 | 描述 |
6837| -- | -- |
6838| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6839| int32_t checkedState | 复选框状态,参数类型[ArkUI_AccessibilityCheckedState](capi-native-type-h.md#arkui_accessibilitycheckedstate), 默认值:ARKUI_ACCESSIBILITY_UNCHECKED。 |
6840
6841### OH_ArkUI_AccessibilityState_GetCheckedState()
6842
6843```
6844int32_t OH_ArkUI_AccessibilityState_GetCheckedState(ArkUI_AccessibilityState* state)
6845```
6846
6847**描述:**
6848
6849
6850获取无障碍状态复选框状态。
6851
6852**起始版本:** 12
6853
6854
6855**参数:**
6856
6857| 参数项 | 描述 |
6858| -- | -- |
6859| [ArkUI_AccessibilityState](capi-arkui-nativemodule-arkui-accessibilitystate.md)* state | 无障碍状态对象指针。 |
6860
6861**返回:**
6862
6863| 类型 | 说明 |
6864| -- | -- |
6865| int32_t | 复选框状态,参数类型[ArkUI_AccessibilityCheckedState](capi-native-type-h.md#arkui_accessibilitycheckedstate), 默认值:ARKUI_ACCESSIBILITY_UNCHECKED;<br>         若函数参数异常,返回默认值。 |
6866
6867### OH_ArkUI_AccessibilityValue_Create()
6868
6869```
6870ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create(void)
6871```
6872
6873**描述:**
6874
6875
6876创建无障碍信息。
6877
6878**起始版本:** 12
6879
6880**返回:**
6881
6882| 类型                            | 说明 |
6883|-------------------------------| -- |
6884| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* | 无障碍信息对象指针。 |
6885
6886### OH_ArkUI_AccessibilityValue_Dispose()
6887
6888```
6889void OH_ArkUI_AccessibilityValue_Dispose(ArkUI_AccessibilityValue* value)
6890```
6891
6892**描述:**
6893
6894
6895销毁无障碍信息指针。
6896
6897**起始版本:** 12
6898
6899
6900**参数:**
6901
6902| 参数项                                                                                    | 描述 |
6903|----------------------------------------------------------------------------------------| -- |
6904| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
6905
6906### OH_ArkUI_AccessibilityValue_SetMin()
6907
6908```
6909void OH_ArkUI_AccessibilityValue_SetMin(ArkUI_AccessibilityValue* value, int32_t min)
6910```
6911
6912**描述:**
6913
6914
6915设置无障碍最小值信息。
6916
6917**起始版本:** 12
6918
6919
6920**参数:**
6921
6922| 参数项 | 描述 |
6923| -- | -- |
6924| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
6925| int32_t min | 基于范围组件的最小值, 默认为-1。 |
6926
6927### OH_ArkUI_AccessibilityValue_GetMin()
6928
6929```
6930int32_t OH_ArkUI_AccessibilityValue_GetMin(ArkUI_AccessibilityValue* value)
6931```
6932
6933**描述:**
6934
6935
6936获取无障碍最小值信息。
6937
6938**起始版本:** 12
6939
6940
6941**参数:**
6942
6943| 参数项 | 描述 |
6944| -- | -- |
6945| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
6946
6947**返回:**
6948
6949| 类型 | 说明 |
6950| -- | -- |
6951| int32_t | 基于范围组件的最小值, 默认为-1;<br>         若函数参数异常,返回-1。 |
6952
6953### OH_ArkUI_AccessibilityValue_SetMax()
6954
6955```
6956void OH_ArkUI_AccessibilityValue_SetMax(ArkUI_AccessibilityValue* value, int32_t max)
6957```
6958
6959**描述:**
6960
6961
6962设置无障碍最大值信息。
6963
6964**起始版本:** 12
6965
6966
6967**参数:**
6968
6969| 参数项 | 描述 |
6970| -- | -- |
6971| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
6972| int32_t max | 基于范围组件的最大值, 默认为-1。 |
6973
6974### OH_ArkUI_AccessibilityValue_GetMax()
6975
6976```
6977int32_t OH_ArkUI_AccessibilityValue_GetMax(ArkUI_AccessibilityValue* value)
6978```
6979
6980**描述:**
6981
6982
6983获取无障碍最大值信息。
6984
6985**起始版本:** 12
6986
6987
6988**参数:**
6989
6990| 参数项 | 描述 |
6991| -- | -- |
6992| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
6993
6994**返回:**
6995
6996| 类型 | 说明 |
6997| -- | -- |
6998| int32_t | 基于范围组件的最大值, 默认为-1;<br>         若函数参数异常,返回-1。 |
6999
7000### OH_ArkUI_AccessibilityValue_SetCurrent()
7001
7002```
7003void OH_ArkUI_AccessibilityValue_SetCurrent(ArkUI_AccessibilityValue* value, int32_t current)
7004```
7005
7006**描述:**
7007
7008
7009设置无障碍当前值信息。
7010
7011**起始版本:** 12
7012
7013
7014**参数:**
7015
7016| 参数项 | 描述 |
7017| -- | -- |
7018| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
7019| int32_t current | 基于范围组件的当前值, 默认为-1。 |
7020
7021### OH_ArkUI_AccessibilityValue_GetCurrent()
7022
7023```
7024int32_t OH_ArkUI_AccessibilityValue_GetCurrent(ArkUI_AccessibilityValue* value)
7025```
7026
7027**描述:**
7028
7029
7030获取无障碍当前值信息。
7031
7032**起始版本:** 12
7033
7034
7035**参数:**
7036
7037| 参数项 | 描述 |
7038| -- | -- |
7039| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
7040
7041**返回:**
7042
7043| 类型 | 说明 |
7044| -- | -- |
7045| int32_t | 基于范围组件的当前值, 默认为-1;<br>         若函数参数异常,返回-1。 |
7046
7047### OH_ArkUI_AccessibilityValue_SetRangeMin()
7048
7049```
7050void OH_ArkUI_AccessibilityValue_SetRangeMin(ArkUI_AccessibilityValue* value, int32_t rangeMin)
7051```
7052
7053**描述:**
7054
7055
7056设置范围组件的无障碍最小值信息。
7057
7058**起始版本:** 18
7059
7060
7061**参数:**
7062
7063| 参数项 | 描述 |
7064| -- | -- |
7065| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 需要设置最小值的范围组件无障碍信息对象指针。 |
7066| int32_t rangeMin | 基于范围组件的最小值, 默认为-1。 |
7067
7068### OH_ArkUI_AccessibilityValue_GetRangeMin()
7069
7070```
7071int32_t OH_ArkUI_AccessibilityValue_GetRangeMin(ArkUI_AccessibilityValue* value)
7072```
7073
7074**描述:**
7075
7076
7077获取范围组件的无障碍最小值信息。
7078
7079**起始版本:** 18
7080
7081
7082**参数:**
7083
7084| 参数项 | 描述 |
7085| -- | -- |
7086| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 需要获取最小值的范围组件无障碍信息对象指针。 |
7087
7088**返回:**
7089
7090| 类型 | 说明 |
7091| -- | -- |
7092| int32_t | 基于范围组件的最小值, 默认为-1;<br>         若函数参数异常,返回-1。 |
7093
7094### OH_ArkUI_AccessibilityValue_SetRangeMax()
7095
7096```
7097void OH_ArkUI_AccessibilityValue_SetRangeMax(ArkUI_AccessibilityValue* value, int32_t rangeMax)
7098```
7099
7100**描述:**
7101
7102
7103设置范围组件的无障碍最大值信息。
7104
7105**起始版本:** 18
7106
7107
7108**参数:**
7109
7110| 参数项 | 描述 |
7111| -- | -- |
7112| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 需要设置最大值的范围组件无障碍信息对象指针。 |
7113| int32_t rangeMax | 基于范围组件的最大值, 默认为-1。 |
7114
7115### OH_ArkUI_AccessibilityValue_GetRangeMax()
7116
7117```
7118int32_t OH_ArkUI_AccessibilityValue_GetRangeMax(ArkUI_AccessibilityValue* value)
7119```
7120
7121**描述:**
7122
7123
7124获取范围组件的无障碍最大值信息。
7125
7126**起始版本:** 18
7127
7128
7129**参数:**
7130
7131| 参数项 | 描述 |
7132| -- | -- |
7133| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 需要获取最小值的范围组件无障碍信息对象指针。 |
7134
7135**返回:**
7136
7137| 类型 | 说明 |
7138| -- | -- |
7139| int32_t | 基于范围组件的最大值, 默认为-1;<br>         若函数参数异常,返回-1。 |
7140
7141### OH_ArkUI_AccessibilityValue_SetRangeCurrent()
7142
7143```
7144void OH_ArkUI_AccessibilityValue_SetRangeCurrent(ArkUI_AccessibilityValue* value, int32_t rangeCurrent)
7145```
7146
7147**描述:**
7148
7149
7150用于设置范围组件的无障碍当前值信息。
7151
7152**起始版本:** 18
7153
7154
7155**参数:**
7156
7157| 参数项 | 描述 |
7158| -- | -- |
7159| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 需要设置当前值的范围组件无障碍信息对象指针。 |
7160| int32_t rangeCurrent | 基于范围组件的当前值, 默认为-1。 |
7161
7162### OH_ArkUI_AccessibilityValue_GetRangeCurrent()
7163
7164```
7165int32_t OH_ArkUI_AccessibilityValue_GetRangeCurrent(ArkUI_AccessibilityValue* value)
7166```
7167
7168**描述:**
7169
7170
7171用于获取范围组件的无障碍当前值信息。
7172
7173**起始版本:** 18
7174
7175
7176**参数:**
7177
7178| 参数项 | 描述 |
7179| -- | -- |
7180| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 需要获取当前值的范围组件无障碍信息对象指针。 |
7181
7182**返回:**
7183
7184| 类型 | 说明 |
7185| -- | -- |
7186| int32_t | 基于范围组件的当前值, 默认为-1;<br>         若函数参数异常,返回-1。 |
7187
7188### OH_ArkUI_AccessibilityValue_SetText()
7189
7190```
7191void OH_ArkUI_AccessibilityValue_SetText(ArkUI_AccessibilityValue* value, const char* text)
7192```
7193
7194**描述:**
7195
7196
7197设置无障碍文本描述信息。
7198
7199**起始版本:** 12
7200
7201
7202**参数:**
7203
7204| 参数项 | 描述 |
7205| -- | -- |
7206| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
7207| const char* text | 组件的文本描述信息, 默认为空字符串。 |
7208
7209### OH_ArkUI_AccessibilityValue_GetText()
7210
7211```
7212const char* OH_ArkUI_AccessibilityValue_GetText(ArkUI_AccessibilityValue* value)
7213```
7214
7215**描述:**
7216
7217
7218获取无障碍文本描述信息。
7219
7220**起始版本:** 12
7221
7222
7223**参数:**
7224
7225| 参数项 | 描述 |
7226| -- | -- |
7227| [ArkUI_AccessibilityValue](capi-arkui-nativemodule-arkui-accessibilityvalue.md)* value | 无障碍信息对象指针。 |
7228
7229**返回:**
7230
7231| 类型 | 说明 |
7232| -- | -- |
7233| const char* | 组件的文本描述信息, 默认为空字符串;<br>         若函数参数异常,返回空指针。 |
7234
7235### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString()
7236
7237```
7238ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromString(char* src)
7239```
7240
7241**描述:**
7242
7243
7244使用图片路径创建帧图片信息,图片格式为svg,png和jpg。
7245
7246**起始版本:** 12
7247
7248
7249**参数:**
7250
7251| 参数项 | 描述 |
7252| -- | -- |
7253| char* src | 图片路径。 |
7254
7255**返回:**
7256
7257| 类型                                | 说明 |
7258|-----------------------------------| -- |
7259| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* | 帧图片对象指针。 |
7260
7261### OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor()
7262
7263```
7264ArkUI_ImageAnimatorFrameInfo* OH_ArkUI_ImageAnimatorFrameInfo_CreateFromDrawableDescriptor(ArkUI_DrawableDescriptor* drawable)
7265```
7266
7267**描述:**
7268
7269
7270使用 DrawableDescriptor 对象创建帧图片信息,图片格式为Resource和PixelMap。
7271
7272**起始版本:** 12
7273
7274
7275**参数:**
7276
7277| 参数项 | 描述 |
7278| -- | -- |
7279| [ArkUI_DrawableDescriptor](capi-arkui-nativemodule-arkui-drawabledescriptor.md)* drawable | 使用Resource或PixelMap创建的ArkUI_DrawableDescriptor对象指针。 |
7280
7281**返回:**
7282
7283| 类型 | 说明 |
7284| -- | -- |
7285| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* | 帧图片对象指针。 |
7286
7287### OH_ArkUI_ImageAnimatorFrameInfo_Dispose()
7288
7289```
7290void OH_ArkUI_ImageAnimatorFrameInfo_Dispose(ArkUI_ImageAnimatorFrameInfo* imageInfo)
7291```
7292
7293**描述:**
7294
7295
7296销毁帧图片对象指针。
7297
7298**起始版本:** 12
7299
7300
7301**参数:**
7302
7303| 参数项 | 描述 |
7304| -- | -- |
7305| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7306
7307### OH_ArkUI_ImageAnimatorFrameInfo_SetWidth()
7308
7309```
7310void OH_ArkUI_ImageAnimatorFrameInfo_SetWidth(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t width)
7311```
7312
7313**描述:**
7314
7315
7316设置图片宽度。
7317
7318**起始版本:** 12
7319
7320
7321**参数:**
7322
7323| 参数项 | 描述 |
7324| -- | -- |
7325| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7326| int32_t width | 图片宽度,单位为PX。 |
7327
7328### OH_ArkUI_ImageAnimatorFrameInfo_GetWidth()
7329
7330```
7331int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetWidth(ArkUI_ImageAnimatorFrameInfo* imageInfo)
7332```
7333
7334**描述:**
7335
7336
7337获取图片宽度。
7338
7339**起始版本:** 12
7340
7341
7342**参数:**
7343
7344| 参数项 | 描述 |
7345| -- | -- |
7346| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7347
7348**返回:**
7349
7350| 类型 | 说明 |
7351| -- | -- |
7352| int32_t | 图片宽度,单位为PX,imageInfo为空指针时返回0。 |
7353
7354### OH_ArkUI_ImageAnimatorFrameInfo_SetHeight()
7355
7356```
7357void OH_ArkUI_ImageAnimatorFrameInfo_SetHeight(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t height)
7358```
7359
7360**描述:**
7361
7362
7363设置图片高度。
7364
7365**起始版本:** 12
7366
7367
7368**参数:**
7369
7370| 参数项 | 描述 |
7371| -- | -- |
7372| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7373| int32_t height | 图片高度,单位为PX。 |
7374
7375### OH_ArkUI_ImageAnimatorFrameInfo_GetHeight()
7376
7377```
7378int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetHeight(ArkUI_ImageAnimatorFrameInfo* imageInfo)
7379```
7380
7381**描述:**
7382
7383
7384获取图片高度。
7385
7386**起始版本:** 12
7387
7388
7389**参数:**
7390
7391| 参数项 | 描述 |
7392| -- | -- |
7393| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7394
7395**返回:**
7396
7397| 类型 | 说明 |
7398| -- | -- |
7399| int32_t | 图片高度,单位为PX,imageInfo为空指针时返回0。 |
7400
7401### OH_ArkUI_ImageAnimatorFrameInfo_SetTop()
7402
7403```
7404void OH_ArkUI_ImageAnimatorFrameInfo_SetTop(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t top)
7405```
7406
7407**描述:**
7408
7409
7410设置图片相对于组件左上角的纵向坐标。
7411
7412**起始版本:** 12
7413
7414
7415**参数:**
7416
7417| 参数项 | 描述 |
7418| -- | -- |
7419| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7420| int32_t top | 图片相对于组件左上角的纵向坐标,单位为PX。 |
7421
7422### OH_ArkUI_ImageAnimatorFrameInfo_GetTop()
7423
7424```
7425int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetTop(ArkUI_ImageAnimatorFrameInfo* imageInfo)
7426```
7427
7428**描述:**
7429
7430
7431获取图片相对于组件左上角的纵向坐标。
7432
7433**起始版本:** 12
7434
7435
7436**参数:**
7437
7438| 参数项 | 描述 |
7439| -- | -- |
7440| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7441
7442**返回:**
7443
7444| 类型 | 说明 |
7445| -- | -- |
7446| int32_t | 图片相对于组件左上角的纵向坐标,单位为PX,imageInfo为空指针时返回0。 |
7447
7448### OH_ArkUI_ImageAnimatorFrameInfo_SetLeft()
7449
7450```
7451void OH_ArkUI_ImageAnimatorFrameInfo_SetLeft(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t left)
7452```
7453
7454**描述:**
7455
7456
7457设置图片相对于组件左上角的横向坐标。
7458
7459**起始版本:** 12
7460
7461
7462**参数:**
7463
7464| 参数项 | 描述 |
7465| -- | -- |
7466| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7467| int32_t left | 图片相对于组件左上角的横向坐标,单位为PX。 |
7468
7469### OH_ArkUI_ImageAnimatorFrameInfo_GetLeft()
7470
7471```
7472int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetLeft(ArkUI_ImageAnimatorFrameInfo* imageInfo)
7473```
7474
7475**描述:**
7476
7477
7478获取图片相对于组件左上角的横向坐标。
7479
7480**起始版本:** 12
7481
7482
7483**参数:**
7484
7485| 参数项 | 描述 |
7486| -- | -- |
7487| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7488
7489**返回:**
7490
7491| 类型 | 说明 |
7492| -- | -- |
7493| int32_t | 图片相对于组件左上角的横向坐标,单位为PX,imageInfo为空指针时返回0。 |
7494
7495### OH_ArkUI_ImageAnimatorFrameInfo_SetDuration()
7496
7497```
7498void OH_ArkUI_ImageAnimatorFrameInfo_SetDuration(ArkUI_ImageAnimatorFrameInfo* imageInfo, int32_t duration)
7499```
7500
7501**描述:**
7502
7503
7504设置图片的播放时长。
7505
7506**起始版本:** 12
7507
7508
7509**参数:**
7510
7511| 参数项 | 描述 |
7512| -- | -- |
7513| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7514| int32_t duration | 图片的播放时长,单位为毫秒。 |
7515
7516### OH_ArkUI_ImageAnimatorFrameInfo_GetDuration()
7517
7518```
7519int32_t OH_ArkUI_ImageAnimatorFrameInfo_GetDuration(ArkUI_ImageAnimatorFrameInfo* imageInfo)
7520```
7521
7522**描述:**
7523
7524
7525获取图片的播放时长。
7526
7527**起始版本:** 12
7528
7529
7530**参数:**
7531
7532| 参数项 | 描述 |
7533| -- | -- |
7534| [ArkUI_ImageAnimatorFrameInfo](capi-arkui-nativemodule-arkui-imageanimatorframeinfo.md)* imageInfo | 帧图片对象指针。 |
7535
7536**返回:**
7537
7538| 类型 | 说明 |
7539| -- | -- |
7540| int32_t | 图片的播放时长,单位为毫秒,imageInfo为空指针时返回0。 |
7541
7542### OH_ArkUI_ListChildrenMainSizeOption_Create()
7543
7544```
7545ArkUI_ListChildrenMainSize* OH_ArkUI_ListChildrenMainSizeOption_Create()
7546```
7547
7548**描述:**
7549
7550
7551创建ListChildrenMainSize接口设置的配置项。
7552
7553**起始版本:** 12
7554
7555**返回:**
7556
7557| 类型                              | 说明 |
7558|---------------------------------| -- |
7559| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* | ListChildrenMainSize配置项实例。 |
7560
7561### OH_ArkUI_ListChildrenMainSizeOption_Dispose()
7562
7563```
7564void OH_ArkUI_ListChildrenMainSizeOption_Dispose(ArkUI_ListChildrenMainSize* option)
7565```
7566
7567**描述:**
7568
7569
7570销毁ListChildrenMainSize实例。
7571
7572**起始版本:** 12
7573
7574
7575**参数:**
7576
7577| 参数项 | 描述 |
7578| -- | -- |
7579| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | 要销毁的ListChildrenMainSize实例。 |
7580
7581### OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize()
7582
7583```
7584int32_t OH_ArkUI_ListChildrenMainSizeOption_SetDefaultMainSize(ArkUI_ListChildrenMainSize* option, float defaultMainSize)
7585```
7586
7587**描述:**
7588
7589
7590设置List组件的ChildrenMainSizeOption默认大小。
7591
7592**起始版本:** 12
7593
7594
7595**参数:**
7596
7597| 参数项 | 描述 |
7598| -- | -- |
7599| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | ListChildrenMainSize实例。 |
7600| float defaultMainSize | List下的ListItem的默认大小,单位为vp。 |
7601
7602**返回:**
7603
7604| 类型 | 说明 |
7605| -- | -- |
7606| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。 |
7607
7608### OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize()
7609
7610```
7611float OH_ArkUI_ListChildrenMainSizeOption_GetDefaultMainSize(ArkUI_ListChildrenMainSize* option)
7612```
7613
7614**描述:**
7615
7616
7617获取List组件的ChildrenMainSizeOption默认大小。
7618
7619**起始版本:** 12
7620
7621
7622**参数:**
7623
7624| 参数项 | 描述 |
7625| -- | -- |
7626| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | ListChildrenMainSize实例。 |
7627
7628**返回:**
7629
7630| 类型 | 说明 |
7631| -- | -- |
7632| float | List下的ListItem的默认大小,默认为0,单位为vp,option为空指针时返回-1。 |
7633
7634### OH_ArkUI_ListChildrenMainSizeOption_Resize()
7635
7636```
7637void OH_ArkUI_ListChildrenMainSizeOption_Resize(ArkUI_ListChildrenMainSize* option, int32_t totalSize)
7638```
7639
7640**描述:**
7641
7642
7643重置List组件的ChildrenMainSizeOption的数组大小。
7644
7645**起始版本:** 12
7646
7647
7648**参数:**
7649
7650| 参数项 | 描述 |
7651| -- | -- |
7652| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | ListChildrenMainSize实例。 |
7653| int32_t totalSize | 数组大小。 |
7654
7655### OH_ArkUI_ListChildrenMainSizeOption_Splice()
7656
7657```
7658int32_t OH_ArkUI_ListChildrenMainSizeOption_Splice(ArkUI_ListChildrenMainSize* option, int32_t index, int32_t deleteCount, int32_t addCount)
7659```
7660
7661**描述:**
7662
7663
7664对List组件的ChildrenMainSizeOption数组操作大小调整。
7665
7666**起始版本:** 12
7667
7668
7669**参数:**
7670
7671| 参数项 | 描述 |
7672| -- | -- |
7673| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | ListChildrenMainSize实例。 |
7674| int32_t index | 要修改MainSize的数组起始位置。 |
7675| int32_t deleteCount | 要删除的MainSize数组从index开始的数量。 |
7676| int32_t addCount | 要添加的MainSize数组从index开始的数量。 |
7677
7678**返回:**
7679
7680| 类型 | 说明 |
7681| -- | -- |
7682| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。 |
7683
7684### OH_ArkUI_ListChildrenMainSizeOption_UpdateSize()
7685
7686```
7687int32_t OH_ArkUI_ListChildrenMainSizeOption_UpdateSize(ArkUI_ListChildrenMainSize* option, int32_t index, float mainSize)
7688```
7689
7690**描述:**
7691
7692
7693更新List组件的ChildrenMainSizeOption数组的值。
7694
7695**起始版本:** 12
7696
7697
7698**参数:**
7699
7700| 参数项 | 描述 |
7701| -- | -- |
7702| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | ListChildrenMainSize实例。 |
7703| int32_t index | 要修改MainSize的数组起始位置。 |
7704| float mainSize | 实际修改的值。 |
7705
7706**返回:**
7707
7708| 类型 | 说明 |
7709| -- | -- |
7710| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。 |
7711
7712### OH_ArkUI_ListChildrenMainSizeOption_GetMainSize()
7713
7714```
7715float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize(ArkUI_ListChildrenMainSize* option, int32_t index)
7716```
7717
7718**描述:**
7719
7720
7721获取List组件的ChildrenMainSizeOption数组的值。
7722
7723**起始版本:** 12
7724
7725
7726**参数:**
7727
7728| 参数项 | 描述 |
7729| -- | -- |
7730| [ArkUI_ListChildrenMainSize](capi-arkui-nativemodule-arkui-listchildrenmainsize.md)* option | ListChildrenMainSize实例。 |
7731| int32_t index | 要获取的值的下标位置。 |
7732
7733**返回:**
7734
7735| 类型 | 说明 |
7736| -- | -- |
7737| float | 数组具体位置的值。若函数参数异常,返回-1。 |
7738
7739### OH_ArkUI_CustomSpanMeasureInfo_Create()
7740
7741```
7742ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create(void)
7743```
7744
7745**描述:**
7746
7747
7748创建自定义段落组件测量信息。
7749
7750**起始版本:** 12
7751
7752**返回:**
7753
7754| 类型                               | 说明 |
7755|----------------------------------| -- |
7756| [ArkUI_CustomSpanMeasureInfo](capi-arkui-nativemodule-arkui-customspanmeasureinfo.md)* | CustomSpanMeasureInfo实例。<br> 如果返回空指针,可能是因为内存不足。 |
7757
7758### OH_ArkUI_CustomSpanMeasureInfo_Dispose()
7759
7760```
7761void OH_ArkUI_CustomSpanMeasureInfo_Dispose(ArkUI_CustomSpanMeasureInfo* info)
7762```
7763
7764**描述:**
7765
7766
7767销毁自定义段落组件测量信息。
7768
7769**起始版本:** 12
7770
7771
7772**参数:**
7773
7774| 参数项 | 描述 |
7775| -- | -- |
7776| [ArkUI_CustomSpanMeasureInfo](capi-arkui-nativemodule-arkui-customspanmeasureinfo.md)* info |  自定义段落组件测量信息指针。 |
7777
7778### OH_ArkUI_CustomSpanMeasureInfo_GetFontSize()
7779
7780```
7781float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize(ArkUI_CustomSpanMeasureInfo* info)
7782```
7783
7784**描述:**
7785
7786
7787获取自定义段落组件的父节点Text的字体大小。
7788
7789**起始版本:** 12
7790
7791
7792**参数:**
7793
7794| 参数项 | 描述 |
7795| -- | -- |
7796| [ArkUI_CustomSpanMeasureInfo](capi-arkui-nativemodule-arkui-customspanmeasureinfo.md)* info |  自定义段落组件测量信息指针。 |
7797
7798**返回:**
7799
7800| 类型 | 说明 |
7801| -- | -- |
7802| float | 父节点Text的字体大小。若函数参数异常,返回0.0f。<br> 异常返回原因:传入参数验证失败,参数不能为空。 |
7803
7804### OH_ArkUI_CustomSpanMetrics_Create()
7805
7806```
7807ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create(void)
7808```
7809
7810**描述:**
7811
7812
7813创建自定义段落组件度量信息。
7814
7815**起始版本:** 12
7816
7817**返回:**
7818
7819| 类型                           | 说明 |
7820|------------------------------| -- |
7821| [ArkUI_CustomSpanMetrics](capi-arkui-nativemodule-arkui-customspanmetrics.md)* | CustomSpanMetrics实例。<br> 如果返回空指针,可能是因为内存不足。 |
7822
7823### OH_ArkUI_CustomSpanMetrics_Dispose()
7824
7825```
7826void OH_ArkUI_CustomSpanMetrics_Dispose(ArkUI_CustomSpanMetrics* metrics)
7827```
7828
7829**描述:**
7830
7831
7832销毁自定义段落组件度量信息。
7833
7834**起始版本:** 12
7835
7836
7837**参数:**
7838
7839| 参数项 | 描述 |
7840| -- | -- |
7841| [ArkUI_CustomSpanMetrics](capi-arkui-nativemodule-arkui-customspanmetrics.md)* metrics | CustomSpanMetrics实例。 |
7842
7843### OH_ArkUI_CustomSpanMetrics_SetWidth()
7844
7845```
7846int32_t OH_ArkUI_CustomSpanMetrics_SetWidth(ArkUI_CustomSpanMetrics* metrics, float width)
7847```
7848
7849**描述:**
7850
7851
7852设置自定义段落组件的宽度。
7853
7854**起始版本:** 12
7855
7856
7857**参数:**
7858
7859| 参数项 | 描述 |
7860| -- | -- |
7861| [ArkUI_CustomSpanMetrics](capi-arkui-nativemodule-arkui-customspanmetrics.md)* metrics | CustomSpanMetrics实例。 |
7862| float width | 宽度大小,单位为vp。 |
7863
7864**返回:**
7865
7866| 类型 | 说明 |
7867| -- | -- |
7868| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br>         异常原因:传入参数验证失败,参数不能为空。 |
7869
7870### OH_ArkUI_CustomSpanMetrics_SetHeight()
7871
7872```
7873int32_t OH_ArkUI_CustomSpanMetrics_SetHeight(ArkUI_CustomSpanMetrics* metrics, float height)
7874```
7875
7876**描述:**
7877
7878
7879设置自定义段落组件的高度。
7880
7881**起始版本:** 12
7882
7883
7884**参数:**
7885
7886| 参数项 | 描述 |
7887| -- | -- |
7888| [ArkUI_CustomSpanMetrics](capi-arkui-nativemodule-arkui-customspanmetrics.md)* metrics | CustomSpanMetrics实例。 |
7889| float height | 高度大小,单位为vp。 |
7890
7891**返回:**
7892
7893| 类型 | 说明 |
7894| -- | -- |
7895| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br>         异常原因:传入参数验证失败,参数不能为空。 |
7896
7897### OH_ArkUI_CustomSpanDrawInfo_Create()
7898
7899```
7900ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create(void)
7901```
7902
7903**描述:**
7904
7905
7906创建自定义段落组件绘制信息。
7907
7908**起始版本:** 12
7909
7910**返回:**
7911
7912| 类型                            | 说明 |
7913|-------------------------------| -- |
7914| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md)* | CustomSpanDrawInfo实例。<br> 如果返回空指针,可能是因为内存不足。 |
7915
7916### OH_ArkUI_CustomSpanDrawInfo_Dispose()
7917
7918```
7919void OH_ArkUI_CustomSpanDrawInfo_Dispose(ArkUI_CustomSpanDrawInfo* info)
7920```
7921
7922**描述:**
7923
7924
7925销毁自定义段落组件绘制信息。
7926
7927**起始版本:** 12
7928
7929
7930**参数:**
7931
7932| 参数项 | 描述 |
7933| -- | -- |
7934| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md)* info |  自定义段落组件绘制信息指针。 |
7935
7936### OH_ArkUI_CustomSpanDrawInfo_GetXOffset()
7937
7938```
7939float OH_ArkUI_CustomSpanDrawInfo_GetXOffset(ArkUI_CustomSpanDrawInfo* info)
7940```
7941
7942**描述:**
7943
7944
7945获取自定义段落组件相对于挂载组件的x轴偏移值。
7946
7947**起始版本:** 12
7948
7949
7950**参数:**
7951
7952| 参数项 | 描述 |
7953| -- | -- |
7954| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md)* info |  自定义段落组件绘制信息指针。 |
7955
7956**返回:**
7957
7958| 类型 | 说明 |
7959| -- | -- |
7960| float | x轴偏移值。若函数参数异常,返回0.0f。<br> 异常返回原因:传入参数验证失败,参数不能为空。 |
7961
7962### OH_ArkUI_CustomSpanDrawInfo_GetLineTop()
7963
7964```
7965float OH_ArkUI_CustomSpanDrawInfo_GetLineTop(ArkUI_CustomSpanDrawInfo* info)
7966```
7967
7968**描述:**
7969
7970
7971获取自定义段落组件相对于挂载组件的上边距。
7972
7973**起始版本:** 12
7974
7975
7976**参数:**
7977
7978| 参数项 | 描述 |
7979| -- | -- |
7980| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md)* info |  自定义段落组件绘制信息指针。 |
7981
7982**返回:**
7983
7984| 类型 | 说明 |
7985| -- | -- |
7986| float | 上边距值。若函数参数异常,返回0.0f。<br> 异常返回原因:传入参数验证失败,参数不能为空。 |
7987
7988### OH_ArkUI_CustomSpanDrawInfo_GetLineBottom()
7989
7990```
7991float OH_ArkUI_CustomSpanDrawInfo_GetLineBottom(ArkUI_CustomSpanDrawInfo* info)
7992```
7993
7994**描述:**
7995
7996
7997获取自定义段落组件相对于挂载组件的下边距。
7998
7999**起始版本:** 12
8000
8001
8002**参数:**
8003
8004| 参数项 | 描述 |
8005| -- | -- |
8006| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md)* info |  自定义段落组件绘制信息指针。 |
8007
8008**返回:**
8009
8010| 类型 | 说明 |
8011| -- | -- |
8012| float | 下边距值。若函数参数异常,返回0.0f。<br> 异常返回原因:传入参数验证失败,参数不能为空。 |
8013
8014### OH_ArkUI_CustomSpanDrawInfo_GetBaseline()
8015
8016```
8017float OH_ArkUI_CustomSpanDrawInfo_GetBaseline(ArkUI_CustomSpanDrawInfo* info)
8018```
8019
8020**描述:**
8021
8022
8023获取自定义段落组件相对于挂载组件的基线偏移量。
8024
8025**起始版本:** 12
8026
8027
8028**参数:**
8029
8030| 参数项 | 描述 |
8031| -- | -- |
8032| [ArkUI_CustomSpanDrawInfo](capi-arkui-nativemodule-arkui-customspandrawinfo.md)* info |  自定义段落组件绘制信息指针。 |
8033
8034**返回:**
8035
8036| 类型 | 说明 |
8037| -- | -- |
8038| float | 基线偏移量值。若函数参数异常,返回0.0f。<br> 异常返回原因:传入参数验证失败,参数不能为空。 |
8039
8040### OH_ArkUI_CustomProperty_Destroy()
8041
8042```
8043void OH_ArkUI_CustomProperty_Destroy(ArkUI_CustomProperty* handle)
8044```
8045
8046**描述:**
8047
8048
8049销毁CustomProperty实例。
8050
8051**起始版本:** 14
8052
8053
8054**参数:**
8055
8056| 参数项 | 描述 |
8057| -- | -- |
8058| [ArkUI_CustomProperty](capi-arkui-nativemodule-arkui-customproperty.md)* handle | 要销毁的CustomProperty实例。 |
8059
8060### OH_ArkUI_CustomProperty_GetStringValue()
8061
8062```
8063const char* OH_ArkUI_CustomProperty_GetStringValue(ArkUI_CustomProperty* handle)
8064```
8065
8066**描述:**
8067
8068
8069获取自定义属性value信息。
8070
8071**起始版本:** 14
8072
8073
8074**参数:**
8075
8076| 参数项 | 描述 |
8077| -- | -- |
8078| [ArkUI_CustomProperty](capi-arkui-nativemodule-arkui-customproperty.md)* handle | 自定义属性对象指针。 |
8079
8080**返回:**
8081
8082| 类型 | 说明 |
8083| -- | -- |
8084| const char* | 自定义属性value信息。 |
8085
8086### OH_ArkUI_HostWindowInfo_GetName()
8087
8088```
8089const char* OH_ArkUI_HostWindowInfo_GetName(ArkUI_HostWindowInfo* info)
8090```
8091
8092**描述:**
8093
8094
8095获取HostWindowInfo对象中的窗口名称。
8096
8097**起始版本:** 15
8098
8099
8100**参数:**
8101
8102| 参数项 | 描述 |
8103| -- | -- |
8104| [ArkUI_HostWindowInfo](capi-arkui-nativemodule-arkui-hostwindowinfo.md)* info | HostWindowInfo对象。 |
8105
8106**返回:**
8107
8108| 类型 | 说明 |
8109| -- | -- |
8110| const char* | HostWindowInfo对象中的窗口名称。 |
8111
8112### OH_ArkUI_HostWindowInfo_Destroy()
8113
8114```
8115void OH_ArkUI_HostWindowInfo_Destroy(ArkUI_HostWindowInfo* info)
8116```
8117
8118**描述:**
8119
8120
8121销毁HostWindowInfo对象。
8122
8123**起始版本:** 15
8124
8125
8126**参数:**
8127
8128| 参数项 | 描述 |
8129| -- | -- |
8130| [ArkUI_HostWindowInfo](capi-arkui-nativemodule-arkui-hostwindowinfo.md)* info | 要销毁的HostWindowInfo对象。 |
8131
8132### OH_ArkUI_ActiveChildrenInfo_Destroy()
8133
8134```
8135void OH_ArkUI_ActiveChildrenInfo_Destroy(ArkUI_ActiveChildrenInfo* handle)
8136```
8137
8138**描述:**
8139
8140
8141销毁ActiveChildrenInfo实例。
8142
8143**起始版本:** 14
8144
8145
8146**参数:**
8147
8148| 参数项 | 描述 |
8149| -- | -- |
8150| [ArkUI_ActiveChildrenInfo](capi-arkui-nativemodule-arkui-activechildreninfo.md)* handle | 要销毁的ActiveChildrenInfo实例。 |
8151
8152### OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex()
8153
8154```
8155ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex(ArkUI_ActiveChildrenInfo* handle, int32_t index)
8156```
8157
8158**描述:**
8159
8160
8161获取ActiveChildrenInfo结构体的下标为index的子节点。
8162
8163**起始版本:** 14
8164
8165
8166**参数:**
8167
8168| 参数项 | 描述 |
8169| -- | -- |
8170| [ArkUI_ActiveChildrenInfo](capi-arkui-nativemodule-arkui-activechildreninfo.md)* handle | 要获取信息的ActiveChildrenInfo实例。 |
8171| int32_t index | 子节点的下标。 |
8172
8173**返回:**
8174
8175| 类型 | 说明 |
8176| -- | -- |
8177| [ArkUI_NodeHandle](capi-arkui-nativemodule-arkui-node8h.md) | 下标对应的子节点指针,异常时返回nullptr。 |
8178
8179### OH_ArkUI_ActiveChildrenInfo_GetCount()
8180
8181```
8182int32_t OH_ArkUI_ActiveChildrenInfo_GetCount(ArkUI_ActiveChildrenInfo* handle)
8183```
8184
8185**描述:**
8186
8187
8188获取ActiveChildrenInfo结构体内的节点数量。
8189
8190**起始版本:** 14
8191
8192
8193**参数:**
8194
8195| 参数项 | 描述 |
8196| -- | -- |
8197| [ArkUI_ActiveChildrenInfo](capi-arkui-nativemodule-arkui-activechildreninfo.md)* handle | 要获取信息的ActiveChildrenInfo实例。 |
8198
8199**返回:**
8200
8201| 类型 | 说明 |
8202| -- | -- |
8203| int32_t | 子节点数量,默认值0. |
8204
8205### OH_ArkUI_ProgressLinearStyleOption_Create()
8206
8207```
8208ArkUI_ProgressLinearStyleOption* OH_ArkUI_ProgressLinearStyleOption_Create(void)
8209```
8210
8211**描述:**
8212
8213
8214创建线性进度条样式信息。
8215
8216**起始版本:** 15
8217
8218**返回:**
8219
8220| 类型                                   | 说明 |
8221|--------------------------------------| -- |
8222| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* | ProgressLinearStyleOption实例。<br> 如果返回空指针,可能是因为内存不足。 |
8223
8224### OH_ArkUI_ProgressLinearStyleOption_Destroy()
8225
8226```
8227void OH_ArkUI_ProgressLinearStyleOption_Destroy(ArkUI_ProgressLinearStyleOption* option)
8228```
8229
8230**描述:**
8231
8232
8233销毁线性进度条样式信息。
8234
8235**起始版本:** 15
8236
8237
8238**参数:**
8239
8240| 参数项 | 描述 |
8241| -- | -- |
8242| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8243
8244### OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled()
8245
8246```
8247void OH_ArkUI_ProgressLinearStyleOption_SetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled)
8248```
8249
8250**描述:**
8251
8252
8253设置进度平滑动效的开关。
8254
8255**起始版本:** 15
8256
8257
8258**参数:**
8259
8260| 参数项 | 描述 |
8261| -- | -- |
8262| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8263| bool enabled | 进度平滑动效的开关。开启平滑动效后设置进度,进度会从当前值渐变至设定值,否则进度从当前值突变至设定值。默认值:true。 |
8264
8265### OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled()
8266
8267```
8268void OH_ArkUI_ProgressLinearStyleOption_SetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option, bool enabled)
8269```
8270
8271**描述:**
8272
8273
8274设置扫光效果的开关。
8275
8276**起始版本:** 15
8277
8278
8279**参数:**
8280
8281| 参数项 | 描述 |
8282| -- | -- |
8283| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8284| bool enabled | 扫光效果的开关。默认值:false。 |
8285
8286### OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth()
8287
8288```
8289void OH_ArkUI_ProgressLinearStyleOption_SetStrokeWidth(ArkUI_ProgressLinearStyleOption* option, float strokeWidth)
8290```
8291
8292**描述:**
8293
8294
8295设置进度条宽度。
8296
8297**起始版本:** 15
8298
8299
8300**参数:**
8301
8302| 参数项 | 描述 |
8303| -- | -- |
8304| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8305| float strokeWidth | 进度条宽度值(不支持百分比设置),单位为vp,默认值:4.0vp。 |
8306
8307### OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius()
8308
8309```
8310void OH_ArkUI_ProgressLinearStyleOption_SetStrokeRadius(ArkUI_ProgressLinearStyleOption* option, float strokeRadius)
8311```
8312
8313**描述:**
8314
8315
8316设置进度条圆角半径。
8317
8318**起始版本:** 15
8319
8320
8321**参数:**
8322
8323| 参数项 | 描述 |
8324| -- | -- |
8325| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8326| float strokeRadius | 进度条圆角半径值,单位为vp,取值范围[0, strokeWidth/2]。默认值:strokeWidth/2。 |
8327
8328### OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled()
8329
8330```
8331bool OH_ArkUI_ProgressLinearStyleOption_GetSmoothEffectEnabled(ArkUI_ProgressLinearStyleOption* option)
8332```
8333
8334**描述:**
8335
8336
8337获取进度平滑动效的开关信息。
8338
8339**起始版本:** 15
8340
8341
8342**参数:**
8343
8344| 参数项 | 描述 |
8345| -- | -- |
8346| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8347
8348**返回:**
8349
8350| 类型 | 说明 |
8351| -- | -- |
8352| bool | 是否开启平滑动效。 |
8353
8354### OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled()
8355
8356```
8357bool OH_ArkUI_ProgressLinearStyleOption_GetScanEffectEnabled(ArkUI_ProgressLinearStyleOption* option)
8358```
8359
8360**描述:**
8361
8362
8363获取扫光效果的开关信息。
8364
8365**起始版本:** 15
8366
8367
8368**参数:**
8369
8370| 参数项 | 描述 |
8371| -- | -- |
8372| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8373
8374**返回:**
8375
8376| 类型 | 说明 |
8377| -- | -- |
8378| bool | 是否开启扫光效果。 |
8379
8380### OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth()
8381
8382```
8383float OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth(ArkUI_ProgressLinearStyleOption* option)
8384```
8385
8386**描述:**
8387
8388
8389获取进度条宽度。
8390
8391**起始版本:** 15
8392
8393
8394**参数:**
8395
8396| 参数项 | 描述 |
8397| -- | -- |
8398| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8399
8400**返回:**
8401
8402| 类型 | 说明 |
8403| -- | -- |
8404| float | 进度条宽度值,单位为vp。 |
8405
8406### OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius()
8407
8408```
8409float OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius(ArkUI_ProgressLinearStyleOption* option)
8410```
8411
8412**描述:**
8413
8414
8415获取进度条圆角半径值。
8416
8417**起始版本:** 15
8418
8419
8420**参数:**
8421
8422| 参数项 | 描述 |
8423| -- | -- |
8424| [ArkUI_ProgressLinearStyleOption](capi-arkui-nativemodule-arkui-progresslinearstyleoption.md)* option | 线性进度条样式信息。 |
8425
8426**返回:**
8427
8428| 类型 | 说明 |
8429| -- | -- |
8430| float | 进度条圆角半径值,单位为vp。 |
8431
8432### OH_ArkUI_CreateSnapshotOptions()
8433
8434```
8435ArkUI_SnapshotOptions* OH_ArkUI_CreateSnapshotOptions()
8436```
8437
8438**描述:**
8439
8440
8441创建一个截图选项,当返回值不再使用时必须通过[OH_ArkUI_DestroySnapshotOptions()](#oh_arkui_destroysnapshotoptions)释放。
8442
8443**起始版本:** 15
8444
8445**返回:**
8446
8447| 类型                         | 说明 |
8448|----------------------------| -- |
8449| [ArkUI_SnapshotOptions](capi-arkui-nativemodule-arkui-snapshotoptions.md)* | 返回指向创建的截图选项对象的指针。如果对象返回空指针,则表示创建失败,失败的原因可能是地址空间已满。 |
8450
8451### OH_ArkUI_DestroySnapshotOptions()
8452
8453```
8454void OH_ArkUI_DestroySnapshotOptions(ArkUI_SnapshotOptions* snapshotOptions)
8455```
8456
8457**描述:**
8458
8459
8460销毁截图选项指针。
8461
8462**起始版本:** 15
8463
8464
8465**参数:**
8466
8467| 参数项 | 描述 |
8468| -- | -- |
8469| [ArkUI_SnapshotOptions](capi-arkui-nativemodule-arkui-snapshotoptions.md)* snapshotOptions | 截图选项。 |
8470
8471### OH_ArkUI_SnapshotOptions_SetScale()
8472
8473```
8474int32_t OH_ArkUI_SnapshotOptions_SetScale(ArkUI_SnapshotOptions* snapshotOptions, float scale)
8475```
8476
8477**描述:**
8478
8479
8480配置截图选项中的缩放属性。
8481
8482**起始版本:** 15
8483
8484
8485**参数:**
8486
8487| 参数项 | 描述 |
8488| -- | -- |
8489| [ArkUI_SnapshotOptions](capi-arkui-nativemodule-arkui-snapshotoptions.md)* snapshotOptions | 截图选项。 |
8490| float scale | 缩放值。 |
8491
8492**返回:**
8493
8494| 类型 | 说明 |
8495| -- | -- |
8496| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br>         异常原因:传入参数验证失败,参数不能为空。 |
8497
8498### OH_ArkUI_CrossLanguageOption_Create()
8499
8500```
8501ArkUI_CrossLanguageOption* OH_ArkUI_CrossLanguageOption_Create(void)
8502```
8503
8504**描述:**
8505
8506
8507创建跨语言配置项实例。
8508
8509**起始版本:** 15
8510
8511**返回:**
8512
8513| 类型                             | 说明 |
8514|--------------------------------| -- |
8515| [ArkUI_CrossLanguageOption](capi-arkui-nativemodule-arkui-crosslanguageoption.md)* | 返回跨语言实例。如果对象返回空指针,则表示创建失败,失败的原因可能是地址空间已满。 |
8516
8517### OH_ArkUI_CrossLanguageOption_Destroy()
8518
8519```
8520void OH_ArkUI_CrossLanguageOption_Destroy(ArkUI_CrossLanguageOption* option)
8521```
8522
8523**描述:**
8524
8525
8526销毁跨语言配置项实例。
8527
8528**起始版本:** 15
8529
8530
8531**参数:**
8532
8533| 参数项 | 描述 |
8534| -- | -- |
8535| [ArkUI_CrossLanguageOption](capi-arkui-nativemodule-arkui-crosslanguageoption.md)* option | 要销毁的跨语言配置项实例。 |
8536
8537### OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus()
8538
8539```
8540void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageOption* option, bool enabled)
8541```
8542
8543**描述:**
8544
8545
8546设置配置项中是否允许跨语言修改属性。
8547
8548**起始版本:** 15
8549
8550
8551**参数:**
8552
8553| 参数项 | 描述 |
8554| -- | -- |
8555| [ArkUI_CrossLanguageOption](capi-arkui-nativemodule-arkui-crosslanguageoption.md)* option | 跨语言配置项实例。 |
8556| bool enabled | 是否允许跨语言修改属性。默认值:false。 |
8557
8558### OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus()
8559
8560```
8561bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option)
8562```
8563
8564**描述:**
8565
8566
8567获取配置项中是否允许跨语言修改属性。
8568
8569**起始版本:** 15
8570
8571
8572**参数:**
8573
8574| 参数项 | 描述 |
8575| -- | -- |
8576| [ArkUI_CrossLanguageOption](capi-arkui-nativemodule-arkui-crosslanguageoption.md)* option | 跨语言配置项实例。 |
8577
8578**返回:**
8579
8580| 类型 | 说明 |
8581| -- | -- |
8582| bool | 是否允许跨语言修改属性。 |
8583
8584### OH_ArkUI_VisibleAreaEventOptions_Create()
8585
8586```
8587ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create()
8588```
8589
8590**描述:**
8591
8592
8593创建可见区域变化监听的参数。
8594
8595**起始版本:** 17
8596
8597**返回:**
8598
8599| 类型                                 | 说明 |
8600|------------------------------------| -- |
8601| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md)* | 可见区域变化监听的参数。 |
8602
8603### OH_ArkUI_VisibleAreaEventOptions_Dispose()
8604
8605```
8606void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option)
8607```
8608
8609**描述:**
8610
8611
8612销毁可见区域变化监听的参数。
8613
8614**起始版本:** 17
8615
8616
8617**参数:**
8618
8619| 参数项 | 描述 |
8620| -- | -- |
8621| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md)* option | 需要销毁的实例。 |
8622
8623### OH_ArkUI_VisibleAreaEventOptions_SetRatios()
8624
8625```
8626int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size)
8627```
8628
8629**描述:**
8630
8631
8632设置阈值数组。
8633
8634**起始版本:** 17
8635
8636
8637**参数:**
8638
8639| 参数项 | 描述 |
8640| -- | -- |
8641| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md)* option | 可见区域变化监听的参数实例。 |
8642| float* value | 阈值数组。其中每个元素代表组件可见面积(即组件在屏幕显示区的面积,只计算父组件内的面积,超出父组件部分不会计算)与组件自身面积的比值。每个阈值的取值范围为[0.0, 1.0],如果开发者设置的阈值超出该范围,则会实际取值0.0或1.0。 |
8643| int32_t size | 阈值数组大小。 |
8644
8645**返回:**
8646
8647| 类型 | 说明 |
8648| -- | -- |
8649| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br>         异常原因:传入参数验证失败,参数不能为空。 |
8650
8651### OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval()
8652
8653```
8654int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions *option, int32_t value)
8655```
8656
8657**描述:**
8658
8659
8660设置预期更新间隔,单位为ms。定义了开发者期望的更新间隔。
8661
8662**起始版本:** 17
8663
8664
8665**参数:**
8666
8667| 参数项 | 描述 |
8668| -- | -- |
8669| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md) *option | 可见区域变化监听的参数实例。 |
8670| int32_t value | 预期更新间隔,单位为ms。定义了开发者期望的更新间隔。默认值:1000。 |
8671
8672**返回:**
8673
8674| 类型 | 说明 |
8675| -- | -- |
8676| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br>         异常原因:传入参数验证失败,参数不能为空。 |
8677
8678### OH_ArkUI_VisibleAreaEventOptions_GetRatios()
8679
8680```
8681int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t* size)
8682```
8683
8684**描述:**
8685
8686
8687获取阈值数组。
8688
8689**起始版本:** 17
8690
8691
8692**参数:**
8693
8694| 参数项 | 描述 |
8695| -- | -- |
8696| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md)* option | 可见区域变化监听的参数实例。 |
8697| float* value | 阈值数组。 |
8698| int32_t* size | 阈值数组大小。 |
8699
8700**返回:**
8701
8702| 类型 | 说明 |
8703| -- | -- |
8704| int32_t | 错误码。<br>         [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br>         [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br>         [ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR](capi-native-type-h.md#arkui_errorcode) 数组大小不够。<br>         异常原因:传入参数验证失败,参数不能为空。 |
8705
8706### OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval()
8707
8708```
8709int32_t OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions* option)
8710```
8711
8712**描述:**
8713
8714
8715获取预期更新间隔。
8716
8717**起始版本:** 17
8718
8719
8720**参数:**
8721
8722| 参数项 | 描述 |
8723| -- | -- |
8724| [ArkUI_VisibleAreaEventOptions](capi-arkui-nativemodule-arkui-visibleareaeventoptions.md)* option | 可见区域变化监听的参数实例。 |
8725
8726**返回:**
8727
8728| 类型 | 说明 |
8729| -- | -- |
8730| int32_t | 预期更新间隔,单位为ms。定义了开发者期望的更新间隔。默认值:1000。 |
8731
8732### OH_ArkUI_TextPickerRangeContentArray_Create()
8733
8734```
8735ArkUI_TextPickerRangeContentArray* OH_ArkUI_TextPickerRangeContentArray_Create(int32_t length)
8736```
8737
8738**描述:**
8739
8740
8741创建TextPickerRangeContent数组的对象。
8742
8743**起始版本:** 19
8744
8745
8746**参数:**
8747
8748| 参数项 | 描述 |
8749| -- | -- |
8750| int32_t length | 指定TextPickerRangeContent数组的长度。 |
8751
8752**返回:**
8753
8754| 类型                                     | 说明 |
8755|----------------------------------------| -- |
8756| [ArkUI_TextPickerRangeContentArray](capi-arkui-nativemodule-arkui-textpickerrangecontentarray.md)* | 返回指向TextPickerRangeContent空数组的指针。 |
8757
8758### OH_ArkUI_TextPickerRangeContentArray_SetIconAtIndex()
8759
8760```
8761void OH_ArkUI_TextPickerRangeContentArray_SetIconAtIndex(ArkUI_TextPickerRangeContentArray* handle, char* icon, int32_t index)
8762```
8763
8764**描述:**
8765
8766
8767指定TextPickerRangeContent数组指定位置的icon数据。
8768
8769**起始版本:** 19
8770
8771
8772**参数:**
8773
8774| 参数项 | 描述 |
8775| -- | -- |
8776| [ArkUI_TextPickerRangeContentArray](capi-arkui-nativemodule-arkui-textpickerrangecontentarray.md)* handle | 指向TextPickerRangeContent数组的指针。 |
8777| char* icon | 图片地址。 |
8778| int32_t index | 数组位置,从0开始。 |
8779
8780### OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex()
8781
8782```
8783void OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex(ArkUI_TextPickerRangeContentArray* handle, char* text, int32_t index)
8784```
8785
8786**描述:**
8787
8788
8789指定TextPickerRangeContent数组指定位置的text数据。
8790
8791**起始版本:** 19
8792
8793
8794**参数:**
8795
8796| 参数项 | 描述 |
8797| -- | -- |
8798| [ArkUI_TextPickerRangeContentArray](capi-arkui-nativemodule-arkui-textpickerrangecontentarray.md)* handle | 指向TextPickerRangeContent数组的指针。 |
8799| char* text | 文本内容。 |
8800| int32_t index | 数组位置,从0开始。 |
8801
8802### OH_ArkUI_TextPickerRangeContentArray_Destroy()
8803
8804```
8805void OH_ArkUI_TextPickerRangeContentArray_Destroy(ArkUI_TextPickerRangeContentArray* handle)
8806```
8807
8808**描述:**
8809
8810
8811删除TextPickerRangeContent数组对象。
8812
8813**起始版本:** 19
8814
8815
8816**参数:**
8817
8818| 参数项 | 描述 |
8819| -- | -- |
8820| [ArkUI_TextPickerRangeContentArray](capi-arkui-nativemodule-arkui-textpickerrangecontentarray.md)* handle | 指向TextPickerRangeContent数组的指针。 |
8821
8822### OH_ArkUI_TextCascadePickerRangeContentArray_Create()
8823
8824```
8825ArkUI_TextCascadePickerRangeContentArray* OH_ArkUI_TextCascadePickerRangeContentArray_Create(int32_t length)
8826```
8827
8828**描述:**
8829
8830
8831删除TextCascadePickerRangeContent数组对象。
8832
8833**起始版本:** 19
8834
8835
8836**参数:**
8837
8838| 参数项 | 描述 |
8839| -- | -- |
8840| int32_t length | 指向TextPickerRangeContent数组的长度。 |
8841
8842**返回:**
8843
8844| 类型 | 说明 |
8845| -- | -- |
8846| [ArkUI_TextCascadePickerRangeContentArray](capi-arkui-nativemodule-arkui-textcascadepickerrangecontentarray.md)* | 返回指向TextCascadePickerRangeContent空数组的指针。 |
8847
8848### OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex()
8849
8850```
8851void OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex(ArkUI_TextCascadePickerRangeContentArray* handle, char* text, int32_t index)
8852```
8853
8854**描述:**
8855
8856
8857指定TextCascadePickerRangeContent数组指定位置的text数据。
8858
8859**起始版本:** 19
8860
8861
8862**参数:**
8863
8864| 参数项 | 描述 |
8865| -- | -- |
8866| [ArkUI_TextCascadePickerRangeContentArray](capi-arkui-nativemodule-arkui-textcascadepickerrangecontentarray.md)* handle | 指向TextCascadePickerRangeContentHandle的指针。 |
8867| char* text | 文本内容。 |
8868| int32_t index | 数组位置,从0开始。 |
8869
8870### OH_ArkUI_TextCascadePickerRangeContentArray_SetChildAtIndex()
8871
8872```
8873void OH_ArkUI_TextCascadePickerRangeContentArray_SetChildAtIndex(ArkUI_TextCascadePickerRangeContentArray* handle, ArkUI_TextCascadePickerRangeContentArray* child, int32_t index)
8874```
8875
8876**描述:**
8877
8878
8879指定TextCascadePickerRangeContent数组指定位置的child数据。
8880
8881**起始版本:** 19
8882
8883
8884**参数:**
8885
8886| 参数项 | 描述 |
8887| -- | -- |
8888| [ArkUI_TextCascadePickerRangeContentArray](capi-arkui-nativemodule-arkui-textcascadepickerrangecontentarray.md)* handle | 指向TextCascadePickerRangeContentHandle的指针。 |
8889| [ArkUI_TextCascadePickerRangeContentArray](capi-arkui-nativemodule-arkui-textcascadepickerrangecontentarray.md)* child | 子节点数组指针。 |
8890| int32_t index | 数组位置,从0开始。 |
8891
8892### OH_ArkUI_TextCascadePickerRangeContentArray_Destroy()
8893
8894```
8895void OH_ArkUI_TextCascadePickerRangeContentArray_Destroy(ArkUI_TextCascadePickerRangeContentArray* handle)
8896```
8897
8898**描述:**
8899
8900
8901删除TextCascadePickerRangeContent数组对象。
8902
8903**起始版本:** 19
8904
8905
8906**参数:**
8907
8908| 参数项 | 描述 |
8909| -- | -- |
8910| [ArkUI_TextCascadePickerRangeContentArray](capi-arkui-nativemodule-arkui-textcascadepickerrangecontentarray.md)* handle | 指向TextCascadePickerRangeContentHandle的指针。 |
8911
8912### OH_ArkUI_EmbeddedComponentOption_Create()
8913
8914```
8915ArkUI_EmbeddedComponentOption* OH_ArkUI_EmbeddedComponentOption_Create()
8916```
8917
8918**描述:**
8919
8920
8921创建EmbeddedComponent组件选项的对象。
8922
8923**起始版本:** 20
8924
8925**返回:**
8926
8927| 类型 | 说明 |
8928| -- | -- |
8929| [ArkUI_EmbeddedComponentOption](capi-arkui-nativemodule-arkui-embeddedcomponentoption.md)* | 返回指向EmbeddedComponent组件选项的对象的指针。 |
8930
8931### OH_ArkUI_EmbeddedComponentOption_Dispose()
8932
8933```
8934void OH_ArkUI_EmbeddedComponentOption_Dispose(ArkUI_EmbeddedComponentOption* option)
8935```
8936
8937**描述:**
8938
8939
8940删除EmbeddedComponent组件选项的对象。
8941
8942**起始版本:** 20
8943
8944
8945**参数:**
8946
8947| 参数项 | 描述 |
8948| -- | -- |
8949| [ArkUI_EmbeddedComponentOption](capi-arkui-nativemodule-arkui-embeddedcomponentoption.md)* option | 要销毁的EmbeddedComponent组件选项的对象的指针。 |
8950
8951### OH_ArkUI_EmbeddedComponentOption_SetOnError()
8952
8953```
8954void OH_ArkUI_EmbeddedComponentOption_SetOnError(ArkUI_EmbeddedComponentOption* option, void (*callback)(int32_t code, const char* name, const char* message))
8955```
8956
8957**描述:**
8958
8959
8960设置EmbeddedComponent组件的onError回调。EmbeddedComponent组件在运行过程中发生异常时触发本回调。
8961
8962**起始版本:** 20
8963
8964
8965**参数:**
8966
8967| 参数项 | 描述                           |
8968| -- |------------------------------|
8969| [ArkUI_EmbeddedComponentOption](capi-arkui-nativemodule-arkui-embeddedcomponentoption.md)* option | EmbeddedComponent组件选项的对象的指针。 |
8970| void (\*callback)(int32_t code, const char* name, const char* message) | 开发者自定义回调函数。<br>- code:接口调用失败返回的错误码信息。错误码的详细介绍请参考[UIExtension错误码](errorcode-uiextension.md)。<br>- name:接口调用失败返回的名称信息。<br>- message:接口调用失败返回的详细信息。 |
8971
8972
8973### OH_ArkUI_EmbeddedComponentOption_SetOnTerminated()
8974
8975```
8976void OH_ArkUI_EmbeddedComponentOption_SetOnTerminated(ArkUI_EmbeddedComponentOption* option, void (*callback)(int32_t code, AbilityBase_Want* want))
8977```
8978
8979**描述:**
8980
8981
8982设置EmbeddedComponent组件的onTerminated回调。EmbeddedComponent组件正常退出时触发本回调。
8983
8984**起始版本:** 20
8985
8986
8987**参数:**
8988
8989| 参数项 | 描述                           |
8990| -- |------------------------------|
8991| [ArkUI_EmbeddedComponentOption](capi-arkui-nativemodule-arkui-embeddedcomponentoption.md)* option | EmbeddedComponent组件选项的对象的指针。 |
8992| void (\*callback)(int32_t code, [AbilityBase_Want](capi-arkui-nativemodule-abilitybase-want.md)* want) | 开发者自定义回调函数。<br>- code:被拉起EmbeddedUIExtensionAbility退出时返回的结果码。若Ability通过调用terminateSelfWithResult退出,结果码为Ability设置的值。若Ability通过调用terminateSelf退出,结果码为默认值"0"。<br>- want:被拉起EmbeddedUIExtensionAbility退出时返回的数据。   |
8993
8994
8995
8996