提供NativeModule公共的类型定义。
引用文件: <arkui/native_type.h>
库: libace_ndk.z.so
系统能力: SystemCapability.ArkUI.ArkUI.Full
起始版本: 12
相关模块: ArkUI_NativeModule
相关示例: NativeTypeSample
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| ArkUI_ColorStop | ArkUI_ColorStop | 定义渐变色结构,用于配置组件的渐变效果,支持通过颜色数组与位置数组组合定义多种渐变样式。 |
| ArkUI_NativeDialog | - | 提供ArkUI在Native侧的自定义弹窗控制器对象定义。 |
| ArkUI_NativeDialog* | ArkUI_NativeDialogHandle | 定义ArkUI在Native侧的自定义弹窗控制器对象指针。 |
| ArkUI_GestureCollectInterceptInfo | ArkUI_GestureCollectInterceptInfo | 定义手势收集拦截信息。 |
| ArkUI_CustomProperty | ArkUI_CustomProperty | 定义自定义属性的ArkUI_CustomProperty结构体信息,用于表示组件的自定义属性。通过相关接口,可以为ArkUI组件添加、移除、获取自定义属性,并获取自定义属性的字符串值。 |
| ArkUI_HostWindowInfo | ArkUI_HostWindowInfo | 定义窗口属性的HostWindowInfo类信息。 |
| ArkUI_ActiveChildrenInfo | ArkUI_ActiveChildrenInfo | 定义ArkUI_ActiveChildrenInfo结构体,用于保存内部活跃状态为true的FrameNode子节点信息,支持查询子节点数量和按下标获取子节点。该结构体实例由OH_ArkUI_NodeUtils_GetActiveChildrenInfo生成,使用完毕后必须调用OH_ArkUI_ActiveChildrenInfo_Destroy销毁。 |
| ArkUI_CrossLanguageOption | ArkUI_CrossLanguageOption | 定义跨语言配置项,用于配置目标节点的跨语言访问能力,例如是否允许跨语言修改属性;从API version 26.0.0开始,还可配置节点树跨语言操作状态。 |
| ArkUI_AccessibilityState | ArkUI_AccessibilityState | 定义组件无障碍状态。 |
| ArkUI_AccessibilityValue | ArkUI_AccessibilityValue | 定义组件无障碍信息值。 |
| ArkUI_SystemFontStyleEvent | ArkUI_SystemFontStyleEvent | 系统字体样式变更事件定义,用于在系统字体大小或字体粗细发生变化时,向已注册的系统字体样式变更回调传递事件信息。 |
| ArkUI_SelectionOptions | ArkUI_SelectionOptions | 定义ArkUI中选择操作的配置选项,适用于应用内需要进行选择交互的场景,为开发者提供选择行为的定制能力。 |
| ArkUI_ContentTransitionEffect | ArkUI_ContentTransitionEffect | 内容过渡效果。 |
| ArkUI_SelectedDragPreviewStyle | ArkUI_SelectedDragPreviewStyle | 定义选中状态下文本拖拽预览样式,适用于需要在文本拖拽过程中展示选中状态预览效果的场景,可提升用户的拖拽交互体验。 |
| OH_ArkUI_LinearGradientOptions | OH_ArkUI_LinearGradientOptions | 定义线性渐变效果选项,用于描述UI组件的线性颜色渐变配置,支持设置渐变方向、角度和颜色配置,帮助开发者实现灵活的线性渐变效果,提升UI视觉呈现能力,适用于需要为组件应用线性渐变样式的场景 |
| OH_ArkUI_RadialGradientOptions | OH_ArkUI_RadialGradientOptions | 定义径向渐变选项,适用于UI组件中实现径向渐变效果的场景,可帮助开发者丰富界面的视觉层次。 |
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| ArkUI_CopyOptions | ArkUI_CopyOptions | 定义文本复制粘贴模式枚举值。 |
| ArkUI_AccessibilityCheckedState | ArkUI_AccessibilityCheckedState | 定义无障碍复选框状态类型枚举值。 |
| ArkUI_AccessibilityActionType | ArkUI_AccessibilityActionType | 定义无障碍操作类型。 |
| ArkUI_BorderStyle | ArkUI_BorderStyle | 边框线条样式枚举值。 |
| ArkUI_AccessibilityMode | ArkUI_AccessibilityMode | 定义无障碍辅助服务模式。 |
| ArkUI_AdaptiveColor | ArkUI_AdaptiveColor | 定义取色模式。 |
| ArkUI_ColorMode | ArkUI_ColorMode | 定义深浅色模式。 |
| ArkUI_SystemColorMode | ArkUI_SystemColorMode | 定义系统深浅色模式。 |
| ArkUI_LengthMetricUnit | ArkUI_LengthMetricUnit | 定义组件的单位模式。 |
| ArkUI_SafeAreaType | ArkUI_SafeAreaType | 定义扩展安全区域的枚举值。 |
| ArkUI_KeyboardAvoidMode | ArkUI_KeyboardAvoidMode | 键盘避让模式。 |
| ArkUI_HoverModeAreaType | ArkUI_HoverModeAreaType | 悬停态显示区域。 |
| ArkUI_ExpandMode | ArkUI_ExpandMode | 定义子节点展开模式枚举值。 |
| ArkUI_FocusWrapMode | ArkUI_FocusWrapMode | 组件走焦换行规则。 |
| ArkUI_ItemFillPolicy | ArkUI_ItemFillPolicy | 为不同响应式断点规格指定列数。 |
| ArkUI_EdgeDirection | ArkUI_EdgeDirection | 定义矩形边方向。 |
| ArkUI_CornerDirection | ArkUI_CornerDirection | 定义角度方向。 |
| ArkUI_MenuPolicy | ArkUI_MenuPolicy | 菜单弹出策略。 |
| ArkUI_RenderStrategy | ArkUI_RenderStrategy | 定义组件绘制圆角的模式。 |
| OH_ArkUI_CrossLanguageOperatingStatus | OH_ArkUI_CrossLanguageOperatingStatus | 跨语言配置项的节点树操作状态。 |
| OH_ArkUI_ArcDirection | OH_ArkUI_ArcDirection | 弧形方向类型枚举。 |
| OH_ArkUI_NodeMountPolicy | OH_ArkUI_NodeMountPolicy | 子节点挂载策略类型枚举。 |
| ArkUI_CrownSensitivity | ArkUI_CrownSensitivity | 定义表冠灵敏度枚举值。 |
enum ArkUI_CopyOptions
描述:
定义文本复制粘贴模式枚举值。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_COPY_OPTIONS_NONE = 0 | 不支持复制。 |
| ARKUI_COPY_OPTIONS_IN_APP = 1 | 支持应用内复制。 |
| ARKUI_COPY_OPTIONS_LOCAL_DEVICE = 2 | 支持设备内复制。 |
| ARKUI_COPY_OPTIONS_CROSS_DEVICE = 3 | 支持跨设备复制。 |
enum ArkUI_AccessibilityCheckedState
描述:
定义无障碍复选框状态类型枚举值。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_ACCESSIBILITY_UNCHECKED = 0 | 复选框未被选中。 |
| ARKUI_ACCESSIBILITY_CHECKED = 1 | 复选框被选中。 |
enum ArkUI_AccessibilityActionType
描述:
定义无障碍操作类型。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_ACCESSIBILITY_ACTION_CLICK = 1 << 0 | 点击操作。 |
| ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK = 1 << 1 | 长按操作。 |
| ARKUI_ACCESSIBILITY_ACTION_CUT = 1 << 2 | 剪切操作。 |
| ARKUI_ACCESSIBILITY_ACTION_COPY = 1 << 3 | 复制操作。 |
| ARKUI_ACCESSIBILITY_ACTION_PASTE = 1 << 4 | 粘贴操作。 |
enum ArkUI_BorderStyle
描述:
边框线条样式枚举值。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_BORDER_STYLE_SOLID = 0 | 显示为一条实线,该值为默认值。 |
| ARKUI_BORDER_STYLE_DASHED = 1 | 显示为一系列短的方形虚线。 |
| ARKUI_BORDER_STYLE_DOTTED = 2 | 显示为一系列圆点。 |
enum ArkUI_AccessibilityMode
描述:
定义无障碍辅助服务模式。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_ACCESSIBILITY_MODE_AUTO = 0 | 根据组件不同会转换为“enabled”或者“disabled”。 |
| ARKUI_ACCESSIBILITY_MODE_ENABLED = 1 | 当前组件可被无障碍辅助服务所识别。 |
| ARKUI_ACCESSIBILITY_MODE_DISABLED = 2 | 当前组件不可被无障碍辅助服务所识别。 |
| ARKUI_ACCESSIBILITY_MODE_DISABLED_FOR_DESCENDANTS = 3 | 当前组件及其所有子组件不可被无障碍辅助服务所识别。 |
enum ArkUI_AdaptiveColor
描述:
定义取色模式。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_ADAPTIVE_COLOR_DEFAULT = 0 | 不使用取色模糊。 |
| ARKUI_ADAPTIVE_COLOR_AVERAGE = 1 | 使用取色模糊。 |
enum ArkUI_ColorMode
描述:
定义深浅色模式。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_COLOR_MODE_SYSTEM = 0 | 跟随系统深浅色模式。 |
| ARKUI_COLOR_MODE_LIGHT = 1 | 固定使用浅色模式。 |
| ARKUI_COLOR_MODE_DARK = 2 | 固定使用深色模式。 |
enum ArkUI_SystemColorMode
描述:
定义系统深浅色模式。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_SYSTEM_COLOR_MODE_LIGHT = 0 | 浅色模式。 |
| ARKUI_SYSTEM_COLOR_MODE_DARK = 1 | 深色模式。 |
enum ArkUI_LengthMetricUnit
描述:
定义组件的单位模式。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_LENGTH_METRIC_UNIT_DEFAULT = -1 | 默认,字体类单位为fp,非字体类单位为vp。 |
| ARKUI_LENGTH_METRIC_UNIT_PX = 0 | 单位为px。 |
| ARKUI_LENGTH_METRIC_UNIT_VP = 1 | 单位为vp。 |
| ARKUI_LENGTH_METRIC_UNIT_FP = 2 | 单位为fp。 |
enum ArkUI_CrownSensitivity
描述:
定义表冠灵敏度枚举值。
起始版本: 26.0.0
| 枚举项 | 描述 |
|---|---|
| ARKUI_CROWN_SENSITIVITY_LOW = 0 | 低灵敏度。 |
| ARKUI_CROWN_SENSITIVITY_MEDIUM = 1 | 中等灵敏度。 |
| ARKUI_CROWN_SENSITIVITY_HIGH = 2 | 高灵敏度。 |
enum ArkUI_SafeAreaType
描述:
定义扩展安全区域的枚举值。
起始版本: 12
| 枚举项 | 描述 |
|---|---|
| ARKUI_SAFE_AREA_TYPE_SYSTEM = 1 | 系统默认非安全区域,包括状态栏、导航栏,该值为默认值。 |
| ARKUI_SAFE_AREA_TYPE_CUTOUT = 1 << 1 | 设备的非安全区域,例如刘海屏或挖孔屏区域。 |
| ARKUI_SAFE_AREA_TYPE_KEYBOARD = 1 << 2 | 软键盘区域。 |
enum ArkUI_KeyboardAvoidMode
描述:
键盘避让模式。
起始版本: 15
| 枚举项 | 描述 |
|---|---|
| ARKUI_KEYBOARD_AVOID_MODE_DEFAULT = 0 | 默认避让软键盘并在到达极限高度之后进行高度压缩。 |
| ARKUI_KEYBOARD_AVOID_MODE_NONE = 1 | 不避让键盘。 |
enum ArkUI_HoverModeAreaType
描述:
悬停态显示区域。
起始版本: 15
| 枚举项 | 描述 |
|---|---|
| ARKUI_HOVER_MODE_AREA_TYPE_TOP = 0 | 上半屏。 |
| ARKUI_HOVER_MODE_AREA_TYPE_BOTTOM = 1 | 下半屏。 |
enum ArkUI_ExpandMode
描述:
定义子节点展开模式枚举值。
起始版本: 15
| 枚举项 | 描述 |
|---|---|
| ARKUI_NOT_EXPAND = 0 | 不展开。 |
| ARKUI_EXPAND = 1 | 展开。 |
| ARKUI_LAZY_EXPAND = 2 | 懒展开,按需展开当前节点的子节点,节点展开条件可以参考LazyForEach:数据懒加载。 |
enum ArkUI_FocusWrapMode
描述:
组件走焦换行规则。Grid、List组件默认值为ARKUI_FOCUS_WRAP_MODE_DEFAULT。
起始版本: 20
| 枚举项 | 描述 |
|---|---|
| ARKUI_FOCUS_WRAP_MODE_DEFAULT = 0 | 默认规则,使用方向键走焦不换行。 |
| ARKUI_FOCUS_WRAP_WITH_ARROW = 1 | 使用方向键走焦自动换行。 |
enum ArkUI_ItemFillPolicy
描述:
为不同响应式断点规格指定列数。
起始版本: 22
| 枚举项 | 描述 |
|---|---|
| ARKUI_ITEMFILLPOLICY_NONE = -1 | 没有设置响应式断点规格。 |
| ARKUI_ITEMFILLPOLICY_DEFAULT = 0 | 针对List和Swiper组件:在组件宽度属于sm及更小的断点区间时显示1列,属于md断点区间时显示2列,属于lg及更大的断点区间时显示3列。 针对Grid和WaterFlow组件:在组件宽度属于sm及更小的断点区间时显示2列,属于md断点区间时显示3列,属于lg及更大的断点区间时显示5列。 |
| ARKUI_ITEMFILLPOLICY_SM1MD2LG3 = 1 | 在组件宽度属于sm及更小的断点区间时显示1列,属于md断点区间时显示2列,属于lg及更大的断点区间时显示3列。 |
| ARKUI_ITEMFILLPOLICY_SM2MD3LG5 = 2 | 在组件宽度属于sm及更小的断点区间时显示2列,属于md断点区间时显示3列,属于lg及更大的断点区间时显示5列。 |
enum ArkUI_EdgeDirection
描述:
定义矩形边方向。
起始版本: 20
| 枚举项 | 描述 |
|---|---|
| ARKUI_EDGE_DIRECTION_ALL = 0 | 设置四个方向的内容。 |
| ARKUI_EDGE_DIRECTION_LEFT = 1 << 0 | 设置左侧方向内容。 |
| ARKUI_EDGE_DIRECTION_RIGHT = 1 << 1 | 设置右侧方向内容。 |
| ARKUI_EDGE_DIRECTION_TOP = 1 << 2 | 设置上侧方向内容。 |
| ARKUI_EDGE_DIRECTION_BOTTOM = 1 << 3 | 设置下侧方向内容。 |
enum ArkUI_CornerDirection
描述:
定义角度方向。
起始版本: 20
| 枚举项 | 描述 |
|---|---|
| ARKUI_CORNER_DIRECTION_ALL = 0 | 设置四个角度方向的内容。 |
| ARKUI_CORNER_DIRECTION_TOP_LEFT = 1 << 0 | 设置左上侧方向内容。 |
| ARKUI_CORNER_DIRECTION_TOP_RIGHT = 1 << 1 | 设置右上侧方向内容。 |
| ARKUI_CORNER_DIRECTION_BOTTOM_LEFT = 1 << 2 | 设置左下侧方向内容。 |
| ARKUI_CORNER_DIRECTION_BOTTOM_RIGHT = 1 << 3 | 设置右下侧方向容。 |
enum ArkUI_RenderStrategy
描述:
定义组件绘制圆角的模式。
起始版本: 23
| 枚举项 | 描述 |
|---|---|
| ARKUI_RENDERSTRATEGY_FAST = 0 | 在线绘制模式。 |
| ARKUI_RENDERSTRATEGY_OFFSCREEN = 1 | 离屏绘制模式。 |
enum OH_ArkUI_CrossLanguageOperatingStatus
描述
跨语言配置项的节点树操作状态。
起始版本: 26.0.0
| 枚举项 | 描述 |
|---|---|
| OH_ARKUI_TREE_OPERATING_STATUS_UNDEFINED = 0 | 未定义,节点树操作状态的初始值。处于此状态的节点不支持跨语言节点树操作。 |
| OH_ARKUI_TREE_OPERATING_STATUS_ENABLE = 1 | 启用,表示当该配置项应用到节点时,节点的节点树操作状态将被启用。 |
| OH_ARKUI_TREE_OPERATING_STATUS_DISABLE = 2 | 禁用,表示当该配置项应用到节点时,节点的节点树操作状态将被禁用。 |
enum OH_ArkUI_NodeMountPolicy
描述
子节点挂载策略类型枚举。
起始版本: 26.0.0
| 枚举项 | 描述 |
|---|---|
| OH_ARKUI_NODE_MOUNT_POLICY_SINGLE_IF_RENDER_NODE = 0 | 如果需要将RenderNode作为子节点挂载,此RenderNode必须是唯一子节点。 |
| OH_ARKUI_NODE_MOUNT_POLICY_MIXED = 1 | 允许同时挂载多个typeNode与RenderNode。 |
enum OH_ArkUI_ArcDirection
描述
弧形方向类型枚举。
起始版本: 26.0.1
| 枚举项 | 描述 |
|---|---|
| OH_ARKUI_ARCDIRECTION_THREE_CLOCK_DIRECTION = 0 | 3点钟方向。 |
| OH_ARKUI_ARCDIRECTION_SIX_CLOCK_DIRECTION = 1 | 6点钟方向。 |
| OH_ARKUI_ARCDIRECTION_NINE_CLOCK_DIRECTION = 2 | 9点钟方向。 |
ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Create()
描述:
创建布局约束。创建的布局约束指针需在使用完毕后调用OH_ArkUI_LayoutConstraint_Dispose释放,未释放会导致内存泄漏。
起始版本: 12
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_LayoutConstraint* | 创建布局约束的指针。 |
ArkUI_LayoutConstraint* OH_ArkUI_LayoutConstraint_Copy(const ArkUI_LayoutConstraint* Constraint)
描述:
布局约束深拷贝。深拷贝返回的新布局约束指针与原指针相互独立,需在使用完毕后分别调用OH_ArkUI_LayoutConstraint_Dispose释放。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_LayoutConstraint* | 新的布局约束指针。 |
void* OH_ArkUI_LayoutConstraint_Dispose(ArkUI_LayoutConstraint* Constraint)
描述:
销毁布局约束指针。必须与OH_ArkUI_LayoutConstraint_Create或OH_ArkUI_LayoutConstraint_Copy配对使用,每个布局约束指针只能销毁一次,销毁后不应再使用该指针。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| void* | 空指针。 |
int32_t OH_ArkUI_LayoutConstraint_GetMaxWidth(const ArkUI_LayoutConstraint* Constraint)
描述:
通过布局约束获取最大宽度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 最大宽度,单位为px。 |
int32_t OH_ArkUI_LayoutConstraint_GetMinWidth(const ArkUI_LayoutConstraint* Constraint)
描述:
通过布局约束获取最小宽度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 最小宽度,单位为px。 |
int32_t OH_ArkUI_LayoutConstraint_GetMaxHeight(const ArkUI_LayoutConstraint* Constraint)
描述:
通过布局约束获取最大高度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 最大高度,单位为px。 |
int32_t OH_ArkUI_LayoutConstraint_GetMinHeight(const ArkUI_LayoutConstraint* Constraint)
描述:
通过布局约束获取最小高度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 最小高度,单位为px。 |
int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceWidth(const ArkUI_LayoutConstraint* Constraint)
描述:
通过布局约束获取宽度百分比基准。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 宽度百分比基准。 |
int32_t OH_ArkUI_LayoutConstraint_GetPercentReferenceHeight(const ArkUI_LayoutConstraint* Constraint)
描述:
通过布局约束获取高度百分比基准。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| const ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 高度百分比基准。 |
void OH_ArkUI_LayoutConstraint_SetMaxWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)
描述:
设置最大宽度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
| int32_t value | 最大宽度,单位为px,取值范围:[0, +∞)。 |
void OH_ArkUI_LayoutConstraint_SetMinWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)
描述:
设置最小宽度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
| int32_t value | 最小宽度,单位为px,取值范围:[0, +∞)。 |
void OH_ArkUI_LayoutConstraint_SetMaxHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)
描述:
设置最大高度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
| int32_t value | 最大高度,单位为px,取值范围:[0, +∞)。 |
void OH_ArkUI_LayoutConstraint_SetMinHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)
描述:
设置最小高度。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
| int32_t value | 最小高度,单位为px,取值范围:[0, +∞)。 |
void OH_ArkUI_LayoutConstraint_SetPercentReferenceWidth(ArkUI_LayoutConstraint* Constraint, int32_t value)
描述:
设置宽度百分比基准。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
| int32_t value | 宽度百分比基准,取值范围:[0, +∞)。 |
void OH_ArkUI_LayoutConstraint_SetPercentReferenceHeight(ArkUI_LayoutConstraint* Constraint, int32_t value)
描述:
设置高度百分比基准。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_LayoutConstraint* Constraint | 布局约束的指针。 |
| int32_t value | 高度百分比基准,取值范围:[0, +∞)。 |
void* OH_ArkUI_DrawContext_GetCanvas(ArkUI_DrawContext* context)
描述:
获取绘制canvas指针,可以转换为图形库的OH_Drawing_Canvas指针进行绘制。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_DrawContext* context | 绘制上下文。 |
返回:
| 类型 | 说明 |
|---|---|
| void* | 用于绘制的canvas指针。 |
ArkUI_IntSize OH_ArkUI_DrawContext_GetSize(ArkUI_DrawContext* context)
描述:
获取可绘制区域大小。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_DrawContext* context | 绘制上下文。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_IntSize | 可绘制区域大小。 |
void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight fontWeight)
描述:
设置Swiper组件数字导航指示器字体粗细属性。
起始版本: 19
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SwiperDigitIndicator *indicator | 数字导航指示器对象指针。 |
| ArkUI_FontWeight fontWeight | 字体粗细样式ArkUI_FontWeight。 |
ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator)
描述:
获取Swiper组件数字导航指示器字体粗细属性。
起始版本: 19
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SwiperDigitIndicator* indicator | 数字导航指示器对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_FontWeight | 字体粗细样式ArkUI_FontWeight。 |
void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight selectedFontWeight)
描述:
设置被选中Swiper组件数字导航指示器字体粗细属性。
起始版本: 19
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SwiperDigitIndicator *indicator | 数字导航指示器对象指针。 |
| ArkUI_FontWeight selectedFontWeight | 字体粗细样式ArkUI_FontWeight。 |
ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator)
描述:
获取被选中Swiper组件数字导航指示器字体粗细属性。
起始版本: 19
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SwiperDigitIndicator* indicator | 数字导航指示器对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_FontWeight | 字体粗细样式ArkUI_FontWeight。 |
ArkUI_AccessibilityState* OH_ArkUI_AccessibilityState_Create(void)
描述:
创建无障碍状态。
起始版本: 12
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_AccessibilityState* | 无障碍状态对象指针。如果对象返回空指针,表示创建失败,失败的可能原因是应用地址空间满。 |
void OH_ArkUI_AccessibilityState_Dispose(ArkUI_AccessibilityState* state)
描述:
销毁无障碍状态指针。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
void OH_ArkUI_AccessibilityState_SetDisabled(ArkUI_AccessibilityState* state, int32_t isDisabled)
描述:
设置无障碍状态是否禁用。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
| int32_t isDisabled | 无障碍状态是否禁用, 1表示禁用,0表示不禁用,默认为0。 |
int32_t OH_ArkUI_AccessibilityState_IsDisabled(ArkUI_AccessibilityState* state)
描述:
获取无障碍状态是否禁用。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 是否禁用, 1表示禁用,0表示未禁用,默认为0; 若state为空,返回默认值。 |
void OH_ArkUI_AccessibilityState_SetSelected(ArkUI_AccessibilityState* state, int32_t isSelected)
描述:
设置无障碍状态是否选中。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
| int32_t isSelected | 是否被选中, 1表示选中,0表示未选中,默认为0。 |
int32_t OH_ArkUI_AccessibilityState_IsSelected(ArkUI_AccessibilityState* state)
描述:
获取无障碍状态是否选中。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 是否被选中, 1表示选中,0表示未选中,默认为0; 若state为空,返回默认值。 |
void OH_ArkUI_AccessibilityState_SetCheckedState(ArkUI_AccessibilityState* state, int32_t checkedState)
描述:
设置无障碍状态复选框状态。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
| int32_t checkedState | 复选框状态,参数类型ArkUI_AccessibilityCheckedState, 默认值:ARKUI_ACCESSIBILITY_UNCHECKED。 |
int32_t OH_ArkUI_AccessibilityState_GetCheckedState(ArkUI_AccessibilityState* state)
描述:
获取无障碍状态复选框状态。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityState* state | 无障碍状态对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 复选框状态,参数类型ArkUI_AccessibilityCheckedState, 默认值:ARKUI_ACCESSIBILITY_UNCHECKED; 若函数参数异常,返回默认值。 |
ArkUI_AccessibilityValue* OH_ArkUI_AccessibilityValue_Create(void)
描述:
创建无障碍信息。
起始版本: 12
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_AccessibilityValue* | 无障碍信息对象指针。 |
void OH_ArkUI_AccessibilityValue_Dispose(ArkUI_AccessibilityValue* value)
描述:
销毁无障碍信息指针。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
void OH_ArkUI_AccessibilityValue_SetMin(ArkUI_AccessibilityValue* value, int32_t min)
描述:
设置无障碍最小值信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
| int32_t min | 基于范围组件的最小值, 默认为-1。 |
int32_t OH_ArkUI_AccessibilityValue_GetMin(ArkUI_AccessibilityValue* value)
描述:
获取无障碍最小值信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 基于范围组件的最小值, 默认为-1; 若函数参数异常,返回-1。 |
void OH_ArkUI_AccessibilityValue_SetMax(ArkUI_AccessibilityValue* value, int32_t max)
描述:
设置无障碍最大值信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
| int32_t max | 基于范围组件的最大值, 默认为-1。 |
int32_t OH_ArkUI_AccessibilityValue_GetMax(ArkUI_AccessibilityValue* value)
描述:
获取无障碍最大值信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 基于范围组件的最大值, 默认为-1; 若函数参数异常,返回-1。 |
void OH_ArkUI_AccessibilityValue_SetCurrent(ArkUI_AccessibilityValue* value, int32_t current)
描述:
设置无障碍当前值信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
| int32_t current | 基于范围组件的当前值, 默认为-1。 |
int32_t OH_ArkUI_AccessibilityValue_GetCurrent(ArkUI_AccessibilityValue* value)
描述:
获取无障碍当前值信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 基于范围组件的当前值, 默认为-1; 若函数参数异常,返回-1。 |
void OH_ArkUI_AccessibilityValue_SetRangeMin(ArkUI_AccessibilityValue* value, int32_t rangeMin)
描述:
设置范围组件的无障碍最小值信息。
起始版本: 18
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 需要设置最小值的范围组件无障碍信息对象指针。 |
| int32_t rangeMin | 基于范围组件的最小值, 默认为-1。 |
int32_t OH_ArkUI_AccessibilityValue_GetRangeMin(ArkUI_AccessibilityValue* value)
描述:
获取范围组件的无障碍最小值信息。
起始版本: 18
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 需要获取最小值的范围组件无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 基于范围组件的最小值, 默认为-1; 若函数参数异常,返回-1。 |
void OH_ArkUI_AccessibilityValue_SetRangeMax(ArkUI_AccessibilityValue* value, int32_t rangeMax)
描述:
设置范围组件的无障碍最大值信息。
起始版本: 18
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 需要设置最大值的范围组件无障碍信息对象指针。 |
| int32_t rangeMax | 基于范围组件的最大值, 默认为-1。 |
int32_t OH_ArkUI_AccessibilityValue_GetRangeMax(ArkUI_AccessibilityValue* value)
描述:
获取范围组件的无障碍最大值信息。
起始版本: 18
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 需要获取最小值的范围组件无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 基于范围组件的最大值, 默认为-1; 若函数参数异常,返回-1。 |
void OH_ArkUI_AccessibilityValue_SetRangeCurrent(ArkUI_AccessibilityValue* value, int32_t rangeCurrent)
描述:
用于设置范围组件的无障碍当前值信息。
起始版本: 18
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 需要设置当前值的范围组件无障碍信息对象指针。 |
| int32_t rangeCurrent | 基于范围组件的当前值, 默认为-1。 |
int32_t OH_ArkUI_AccessibilityValue_GetRangeCurrent(ArkUI_AccessibilityValue* value)
描述:
用于获取范围组件的无障碍当前值信息。
起始版本: 18
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 需要获取当前值的范围组件无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 基于范围组件的当前值, 默认为-1; 若函数参数异常,返回-1。 |
void OH_ArkUI_AccessibilityValue_SetText(ArkUI_AccessibilityValue* value, const char* text)
描述:
设置无障碍文本描述信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
| const char* text | 组件的文本描述信息, 默认为空字符串。 |
const char* OH_ArkUI_AccessibilityValue_GetText(ArkUI_AccessibilityValue* value)
描述:
获取无障碍文本描述信息。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_AccessibilityValue* value | 无障碍信息对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| const char* | 组件的文本描述信息, 默认为空字符串; 若函数参数异常,返回空指针。 |
void OH_ArkUI_CustomProperty_Destroy(ArkUI_CustomProperty* handle)
描述:
销毁ArkUI_CustomProperty实例。
起始版本: 14
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CustomProperty* handle | 要销毁的实例。 |
const char* OH_ArkUI_CustomProperty_GetStringValue(ArkUI_CustomProperty* handle)
描述:
获取自定义属性对象的value信息。
起始版本: 14
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CustomProperty* handle | 自定义属性对象指针。 |
返回:
| 类型 | 说明 |
|---|---|
| const char* | 自定义属性对象的value信息。 |
const char* OH_ArkUI_HostWindowInfo_GetName(ArkUI_HostWindowInfo* info)
描述:
获取ArkUI_HostWindowInfo对象中的窗口名称。
起始版本: 15
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_HostWindowInfo* info | HostWindowInfo对象。 |
返回:
| 类型 | 说明 |
|---|---|
| const char* | ArkUI_HostWindowInfo对象中的窗口名称。 |
void OH_ArkUI_HostWindowInfo_Destroy(ArkUI_HostWindowInfo* info)
描述:
销毁ArkUI_HostWindowInfo对象。
起始版本: 15
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_HostWindowInfo* info | 要销毁的ArkUI_HostWindowInfo对象。 |
void OH_ArkUI_ActiveChildrenInfo_Destroy(ArkUI_ActiveChildrenInfo* handle)
描述:
销毁ArkUI_ActiveChildrenInfo实例,释放获取活跃子节点信息时分配的资源。
起始版本: 14
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_ActiveChildrenInfo* handle | 要销毁的ArkUI_ActiveChildrenInfo实例。 |
ArkUI_NodeHandle OH_ArkUI_ActiveChildrenInfo_GetNodeByIndex(ArkUI_ActiveChildrenInfo* handle, int32_t index)
描述:
获取ArkUI_ActiveChildrenInfo结构体中下标为index的子节点,适用于按下标遍历活跃子节点。
起始版本: 14
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_ActiveChildrenInfo* handle | 要获取信息的ArkUI_ActiveChildrenInfo实例。 |
| int32_t index | 子节点的下标。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_NodeHandle | 下标对应的子节点指针,异常时返回nullptr。 |
int32_t OH_ArkUI_ActiveChildrenInfo_GetCount(ArkUI_ActiveChildrenInfo* handle)
描述:
获取ArkUI_ActiveChildrenInfo结构体内的子节点数量,适用于遍历活跃子节点前确定数量。
起始版本: 14
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_ActiveChildrenInfo* handle | 要获取信息的ArkUI_ActiveChildrenInfo实例。 |
返回:
| 类型 | 说明 |
|---|---|
| int32_t | 子节点数量,默认值0. |
ArkUI_CrossLanguageOption* OH_ArkUI_CrossLanguageOption_Create(void)
描述:
创建跨语言配置项实例。
起始版本: 15
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_CrossLanguageOption* | 返回跨语言实例。如果对象返回空指针,则表示创建失败,失败的原因可能是地址空间已满。 |
void OH_ArkUI_CrossLanguageOption_Destroy(ArkUI_CrossLanguageOption* option)
描述:
销毁跨语言配置项实例。
起始版本: 15
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CrossLanguageOption* option | 要销毁的跨语言配置项实例。 |
void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageOption* option, bool enabled)
描述:
设置配置项中是否允许跨语言修改属性。
起始版本: 15
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CrossLanguageOption* option | 跨语言配置项实例。 |
| bool enabled | 是否允许跨语言修改属性。true表示允许跨语言修改属性,false表示不允许跨语言修改属性,默认值:false。 |
bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option)
描述:
获取配置项中是否允许跨语言修改属性。
起始版本: 15
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CrossLanguageOption* option | 跨语言配置项实例。 |
返回:
| 类型 | 说明 |
|---|---|
| bool | 是否允许跨语言修改属性。true表示允许跨语言修改属性,false表示不允许跨语言修改属性。 |
void OH_ArkUI_CrossLanguageOption_SetTreeOperatingStatus(ArkUI_CrossLanguageOption* option, OH_ArkUI_CrossLanguageOperatingStatus status)
描述:
设置跨语言配置项的节点树操作状态。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CrossLanguageOption* option | 跨语言配置项实例。 |
| OH_ArkUI_CrossLanguageOperatingStatus status | 需要设置的节点树操作状态。 默认值:OH_ARKUI_TREE_OPERATING_STATUS_UNDEFINED。 |
OH_ArkUI_CrossLanguageOperatingStatus OH_ArkUI_CrossLanguageOption_GetTreeOperatingStatus(ArkUI_CrossLanguageOption* option)
描述:
获取跨语言配置项的节点树操作状态。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_CrossLanguageOption* option | 跨语言配置项实例。 |
返回:
| 类型 | 说明 |
|---|---|
| OH_ArkUI_CrossLanguageOperatingStatus | 跨语言配置项的节点树操作状态。 |
ArkUI_ContentTransitionEffect* OH_ArkUI_ContentTransitionEffect_Create(int32_t type)
描述:
创建ContentTransitionEffect属性对象。
起始版本: 21
参数:
| 参数项 | 描述 |
|---|---|
| int32_t type | 指定动效的转场方式。值为0表示无动效转场,值为1时表示淡入淡出动效转场。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ContentTransitionEffect* | 指向ContentTransitionEffect对象的指针。 |
ArkUI_SelectionOptions* OH_ArkUI_SelectionOptions_Create()
描述:
创建选择选项。
起始版本: 23
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_SelectionOptions* | 指向选择选项对象的指针。 |
void OH_ArkUI_SelectionOptions_Dispose(ArkUI_SelectionOptions* options)
描述:
释放选择选项对象。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SelectionOptions* options | 指向待释放的选择选项对象的指针。 |
ArkUI_SelectedDragPreviewStyle* OH_ArkUI_SelectedDragPreviewStyle_Create();
描述
创建选中状态下拖拽文本预览样式对象。
起始版本: 23
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_SelectedDragPreviewStyle* | 指向ArkUI_SelectedDragPreviewStyle对象的指针。 |
void OH_ArkUI_SelectedDragPreviewStyle_Dispose(ArkUI_SelectedDragPreviewStyle* config)
描述
销毁选中状态下拖拽文本预览样式对象。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SelectedDragPreviewStyle* config | 指向ArkUI_SelectedDragPreviewStyle对象的指针。 |
void OH_ArkUI_SelectedDragPreviewStyle_SetColor(ArkUI_SelectedDragPreviewStyle* config, uint32_t color);
描述
设置选中态拖拽文本预览样式的背景色。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SelectedDragPreviewStyle* config | 指向ArkUI_SelectedDragPreviewStyle对象的指针。 |
| uint32_t color | 选中态拖拽文本预览样式的背景,格式为RGBA。 |
uint32_t OH_ArkUI_SelectedDragPreviewStyle_GetColor(ArkUI_SelectedDragPreviewStyle* config)
描述
获取选中态拖拽文本预览样式的背景色。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_SelectedDragPreviewStyle* config | 指向ArkUI_SelectedDragPreviewStyle对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| uint32_t | 选中态拖拽文本预览样式的背景,格式为RGBA。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_SetTextDecorationType(OH_ArkUI_DecorationStyleOptions* options, ArkUI_TextDecorationType type)
描述
设置装饰线样式的装饰类型。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| ArkUI_TextDecorationType type | 装饰类型ArkUI_TextDecorationType。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_GetTextDecorationType(OH_ArkUI_DecorationStyleOptions* options, ArkUI_TextDecorationType* type)
描述
获取装饰线样式的装饰类型。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| ArkUI_TextDecorationType* type | 装饰类型ArkUI_TextDecorationType。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_SetColor(OH_ArkUI_DecorationStyleOptions* options, uint32_t color)
描述
设置装饰线的颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| uint32_t color | 装饰线的颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_GetColor(OH_ArkUI_DecorationStyleOptions* options, uint32_t* color)
描述
获取装饰线的颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| uint32_t* color | 装饰线的颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_SetTextDecorationStyle(OH_ArkUI_DecorationStyleOptions* options, ArkUI_TextDecorationStyle style)
描述
设置装饰线的样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| ArkUI_TextDecorationStyle style | 装饰线的样式ArkUI_TextDecorationStyle。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_GetTextDecorationStyle(OH_ArkUI_DecorationStyleOptions* options, ArkUI_TextDecorationStyle* style)
描述
获取装饰线的样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| ArkUI_TextDecorationStyle* style | 装饰线的样式ArkUI_TextDecorationStyle。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_SetThicknessScale(OH_ArkUI_DecorationStyleOptions* options, float thicknessScale)
描述
设置装饰线的粗细缩放比例。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| float thicknessScale | 装饰线的粗细缩放比例。取值范围为[0, +∞)。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_DecorationStyleOptions_GetThicknessScale(OH_ArkUI_DecorationStyleOptions* options, float* thicknessScale)
描述
获取装饰线的粗细缩放比例。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
| float* thicknessScale | 装饰线的粗细缩放比例。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_SetTypes(OH_ArkUI_TextDataDetectorConfig* config, const ArkUI_TextDataDetectorType* types, int32_t length)
描述
设置文本实体识别配置的类型。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| const ArkUI_TextDataDetectorType* types | 文本实体识别配置的类型,取值为ArkUI_TextDataDetectorType枚举。 |
| int32_t length | 类型的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_GetTypes(OH_ArkUI_TextDataDetectorConfig* config, ArkUI_TextDataDetectorType* buffer, int32_t bufferSize, int32_t* writeLength)
描述
获取文本实体识别配置的类型。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| ArkUI_TextDataDetectorType* buffer | 指向类型数组的缓冲区指针。 |
| int32_t bufferSize | 开发者为类型预留的缓冲区最多可以写入的类型的数量。 |
| int32_t* writeLength | 实际写入缓冲区的类型的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 若bufferSize小于writeLength,返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_RegisterOnDetectResultUpdateCallback(OH_ArkUI_TextDataDetectorConfig* config, void* userData, void (*callback)(const char* result, int32_t length, void* userData))
描述
设置文本实体识别结果更新回调。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| void* userData | 用户数据。 |
| void (*callback)(const char* result, int32_t length, void* userData) | 识别结果更新回调。result 识别到的文本实体内容。length 选中文本的结束位置。userData 用户自定义数据,对应OH_ArkUI_TextDataDetectorConfig_RegisterOnDetectResultUpdateCallback接口的入参userData。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_SetColor(OH_ArkUI_TextDataDetectorConfig* config, uint32_t color)
描述
设置识别内容的颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| uint32_t color | 识别内容的颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_GetColor(OH_ArkUI_TextDataDetectorConfig* config, uint32_t* color)
描述
获取识别内容的颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| uint32_t* color | 识别内容的颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_SetDecorationStyleOptions(OH_ArkUI_TextDataDetectorConfig* config, OH_ArkUI_DecorationStyleOptions* decoration)
描述
设置识别内容的装饰样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| OH_ArkUI_DecorationStyleOptions* decoration | 识别内容的装饰样式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextDataDetectorConfig_GetDecorationStyleOptions(OH_ArkUI_TextDataDetectorConfig* config, OH_ArkUI_DecorationStyleOptions* decoration)
描述
获取识别内容的装饰样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | 指向OH_ArkUI_TextDataDetectorConfig对象的指针。 |
| OH_ArkUI_DecorationStyleOptions* decoration | 识别内容的装饰样式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_SetValue(OH_ArkUI_TextEditorPlaceholderOptions* options, const char* value)
描述
设置无输入时的提示文本选项的提示文字。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| const char* value | 提示文字。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_GetValue(OH_ArkUI_TextEditorPlaceholderOptions* options, char* buffer, int32_t bufferSize, int32_t* writeLength)
描述
获取无输入时的提示文本选项的提示文字。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| char* buffer | 提示文字写入内存的缓冲区,内存空间需由开发者分配。 |
| int32_t bufferSize | 缓冲区最多可写入的字符的数量。 |
| int32_t* writeLength | 实际表示写入缓冲区的字符的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 错误码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若节点、缓冲区或writeLength为空,返回ARKUI_ERROR_CODE_PARAM_INVALID。 若bufferSize小于writeLength,返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_SetFontSize(OH_ArkUI_TextEditorPlaceholderOptions* options, float fontSize)
描述
设置无输入时的提示文本选项的字体大小。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| float fontSize | 字体大小,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_GetFontSize(OH_ArkUI_TextEditorPlaceholderOptions* options, float* fontSize)
描述
获取无输入时的提示文本选项的字体大小。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| float* fontSize | 字体大小,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_SetFontWeight(OH_ArkUI_TextEditorPlaceholderOptions* options, uint32_t fontWeight)
描述
设置无输入时的提示文本选项的字体粗细。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| uint32_t fontWeight | 字体粗细。取值为ArkUI_FontWeight中的枚举值,默认值为ARKUI_FONT_WEIGHT_W400。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_GetFontWeight(OH_ArkUI_TextEditorPlaceholderOptions* options, uint32_t* fontWeight)
描述
获取无输入时的提示文本选项的字体粗细。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| uint32_t* fontWeight | 字体粗细。取值为ArkUI_FontWeight中的枚举值,默认值为ARKUI_FONT_WEIGHT_W400。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_SetFontFamily(OH_ArkUI_TextEditorPlaceholderOptions* options, const char* fontFamily)
描述
设置无输入时的提示文本选项的字体家族。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| const char* fontFamily | 字体家族。存放待设置的字体名称,不同字体名称通过逗号拼接。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_GetFontFamily(OH_ArkUI_TextEditorPlaceholderOptions* options, char* buffer, int32_t bufferSize, int32_t* writeLength)
描述
获取无输入时的提示文本选项的字体家族。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| char* buffer | 字体家族写入内存的缓冲区,内存空间需由开发者分配。 |
| int32_t bufferSize | 缓冲区最多可写入的字符的数量。 |
| int32_t* writeLength | 实际写入缓冲区的字符的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 错误码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若节点、缓冲区或writeLength为空,返回ARKUI_ERROR_CODE_PARAM_INVALID。 若bufferSize小于writeLength,返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_SetFontStyle(OH_ArkUI_TextEditorPlaceholderOptions* options, ArkUI_FontStyle fontStyle)
描述
设置无输入时的提示文本选项的字体样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| ArkUI_FontStyle fontStyle | 字体样式。取值为ArkUI_FontStyle中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_GetFontStyle(OH_ArkUI_TextEditorPlaceholderOptions* options, ArkUI_FontStyle* fontStyle)
描述
获取无输入时的提示文本选项的字体样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| ArkUI_FontStyle* fontStyle | 字体样式。取值为ArkUI_FontStyle中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_SetFontColor(OH_ArkUI_TextEditorPlaceholderOptions* options, uint32_t fontColor)
描述
设置无输入时的提示文本选项的字体颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| uint32_t fontColor | 字体颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorPlaceholderOptions_GetFontColor(OH_ArkUI_TextEditorPlaceholderOptions* options, uint32_t* fontColor)
描述
获取无输入时的提示文本选项的字体颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorPlaceholderOptions* options | 指向OH_ArkUI_TextEditorPlaceholderOptions对象的指针。 |
| uint32_t* fontColor | 字体颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetCaretOffset(OH_ArkUI_TextEditorStyledStringController* controller, int32_t caretOffset)
描述
通过属性字符串控制器设置光标偏移量。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| int32_t caretOffset | 索引位置。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetCaretOffset(OH_ArkUI_TextEditorStyledStringController* controller, int32_t* caretOffset)
描述
通过属性字符串控制器获取光标索引位置。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| int32_t* caretOffset | 索引位置。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetSelection(OH_ArkUI_TextEditorStyledStringController* controller, uint32_t start, uint32_t end, ArkUI_MenuPolicy menuPolicy)
描述
通过属性字符串控制器设置选中区域。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| uint32_t start | 选中区域的起始位置。 |
| uint32_t end | 选中区域的结束位置。 |
| ArkUI_MenuPolicy menuPolicy | 选区内菜单弹出的策略。取值为ArkUI_MenuPolicy中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_IsEditing(OH_ArkUI_TextEditorStyledStringController* controller, bool* isEditing)
描述
通过属性字符串控制器获取文本编辑器的编辑状态。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| bool* isEditing | 编辑状态。true表示是编辑态,false表示不是编辑态。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_StopEditing(OH_ArkUI_TextEditorStyledStringController* controller)
描述
通过属性字符串控制器退出文本编辑器的编辑状态。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetPreviewText(OH_ArkUI_TextEditorStyledStringController* controller, uint32_t* offset, char* buffer, int32_t bufferSize, int32_t* writeLength)
描述
通过属性字符串控制器获取预上屏文本内容。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| uint32_t* offset | 预上屏文本位置。 |
| char* buffer | 预上屏文本内容写入内存的缓冲区,内存空间需由开发者分配。 |
| int32_t bufferSize | 缓冲区最多可写入的字符的数量。 |
| int32_t* writeLength | 实际写入缓冲区的字符的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetCaretRect(OH_ArkUI_TextEditorStyledStringController* controller, ArkUI_Rect* rect)
描述
通过属性字符串控制器获取光标矩形区域。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| ArkUI_Rect* rect | 光标区域信息。取值为ArkUI_Rect中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_DeleteBackward(OH_ArkUI_TextEditorStyledStringController* controller)
描述
通过属性字符串控制器删除字符。没有内容被选中时,删除当前光标位置前的1个字符。有内容被选中时,删除选中内容。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetTextAlign(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_TextAlignment align)
描述
设置段落样式中的文本对齐方式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_TextAlignment align | 文本对齐方式。取值为ArkUI_TextAlignment中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetTextAlign(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_TextAlignment* align)
描述
获取段落样式中的文本对齐方式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_TextAlignment* align | 文本对齐方式。取值为ArkUI_TextAlignment中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetLeadingMarginPixelMap(OH_ArkUI_TextEditorParagraphStyle* style, struct OH_PixelmapNative* pixelmap)
描述
设置段落样式中段落缩进的像素图。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| struct OH_PixelmapNative* pixelmap | 段落缩进的像素图。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetLeadingMarginPixelMap(OH_ArkUI_TextEditorParagraphStyle* style, struct OH_PixelmapNative** pixelmap)
描述
获取段落样式中段落缩进的像素图。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| struct OH_PixelmapNative** pixelmap | 段落缩进的像素图。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetLeadingMarginWidth(OH_ArkUI_TextEditorParagraphStyle* style, uint32_t width)
描述
设置段落样式中段落缩进的宽度。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| uint32_t width | 段落缩进的宽度,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetLeadingMarginWidth(OH_ArkUI_TextEditorParagraphStyle* style, uint32_t* width)
描述
获取段落样式中段落缩进的宽度。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| uint32_t* width | 段落缩进的宽度,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetLeadingMarginHeight(OH_ArkUI_TextEditorParagraphStyle* style, uint32_t height)
描述
设置段落样式中段落缩进的高度。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| uint32_t height | 段落缩进的高度,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetLeadingMarginHeight(OH_ArkUI_TextEditorParagraphStyle* style, uint32_t* height)
描述
获取段落样式中段落缩进的高度。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| uint32_t* height | 段落缩进的高度,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetWordBreak(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_WordBreak wordBreak)
描述
设置段落样式的断字方式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_WordBreak wordBreak | 断字方式。取值为ArkUI_WordBreak中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetWordBreak(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_WordBreak* wordBreak)
描述
获取段落样式的断字方式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_WordBreak* wordBreak | 断字方式。取值为ArkUI_WordBreak中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetLineBreakStrategy(OH_ArkUI_TextEditorParagraphStyle* style, OH_ArkUI_LineBreakStrategy lineBreakStrategy)
描述
设置段落样式的换行策略。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| OH_ArkUI_LineBreakStrategy lineBreakStrategy | 换行策略。取值为OH_ArkUI_LineBreakStrategy中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetLineBreakStrategy(OH_ArkUI_TextEditorParagraphStyle* style, OH_ArkUI_LineBreakStrategy* lineBreakStrategy)
描述
获取段落样式的换行策略。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| OH_ArkUI_LineBreakStrategy* lineBreakStrategy | 换行策略。取值为OH_ArkUI_LineBreakStrategy中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetParagraphSpacing(OH_ArkUI_TextEditorParagraphStyle* style, uint32_t paragraphSpacing)
描述
设置段落样式的段落间距。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| uint32_t paragraphSpacing | 段落间距,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetParagraphSpacing(OH_ArkUI_TextEditorParagraphStyle* style, uint32_t* paragraphSpacing)
描述
获取段落样式的段落间距。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| uint32_t* paragraphSpacing | 段落间距,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetTextVerticalAlign(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_TextVerticalAlignment verticalAlignment)
描述
设置段落样式的文本垂直对齐方式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_TextVerticalAlignment verticalAlignment | 文本垂直对齐方式。取值为ArkUI_TextVerticalAlignment中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetTextVerticalAlign(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_TextVerticalAlignment* verticalAlignment)
描述
获取段落样式的文本垂直对齐方式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_TextVerticalAlignment* verticalAlignment | 文本垂直对齐方式。取值为ArkUI_TextVerticalAlignment中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_SetTextDirection(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_TextDirection textDirection)
描述
设置段落样式的文本方向。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_TextDirection textDirection | 文本方向。取值为ArkUI_TextDirection中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorParagraphStyle_GetTextDirection(OH_ArkUI_TextEditorParagraphStyle* style, ArkUI_TextDirection* textDirection)
描述
获取段落样式的文本方向。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorParagraphStyle* style | 指向OH_ArkUI_TextEditorParagraphStyle对象的指针。 |
| ArkUI_TextDirection* textDirection | 文本方向。取值为ArkUI_TextDirection中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetTypingParagraphStyle(OH_ArkUI_TextEditorStyledStringController* controller, OH_ArkUI_TextEditorParagraphStyle* style)
描述
通过属性字符串控制器设置预设段落样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| OH_ArkUI_TextEditorParagraphStyle* style | 预设段落样式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetFontColor(OH_ArkUI_TextEditorTextStyle* style, uint32_t color)
描述
设置文本样式的字体颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| uint32_t color | 字体颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetFontColor(OH_ArkUI_TextEditorTextStyle* style, uint32_t* color)
描述
获取文本样式的字体颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| uint32_t* color | 字体颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetFontSize(OH_ArkUI_TextEditorTextStyle* style, float size)
描述
设置文本样式的字体大小。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| float size | 字体大小,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetFontSize(OH_ArkUI_TextEditorTextStyle* style, float* size)
描述
获取文本样式的字体大小。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| float* size | 字体大小,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetFontStyle(OH_ArkUI_TextEditorTextStyle* style, ArkUI_FontStyle fontStyle)
描述
设置文本样式的字体样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| ArkUI_FontStyle fontStyle | 字体样式。取值为ArkUI_FontStyle中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetFontStyle(OH_ArkUI_TextEditorTextStyle* style, ArkUI_FontStyle* fontStyle)
描述
获取文本样式的字体样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| ArkUI_FontStyle* fontStyle | 字体样式。取值为ArkUI_FontStyle中的枚举。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetFontWeight(OH_ArkUI_TextEditorTextStyle* style, uint32_t fontWeight)
描述
设置文本样式的字体粗细。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| uint32_t fontWeight | 字体粗细。取值为ArkUI_FontWeight中的枚举值,默认值为ARKUI_FONT_WEIGHT_W400。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetFontWeight(OH_ArkUI_TextEditorTextStyle* style, uint32_t* fontWeight)
描述
获取文本样式的字体粗细。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| uint32_t* fontWeight | 字体粗细。取值为ArkUI_FontWeight中的枚举值,默认值为ARKUI_FONT_WEIGHT_W400。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetFontFamily(OH_ArkUI_TextEditorTextStyle* style, const char* fontFamily)
描述
设置文本样式的字体家族。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| const char* fontFamily | 字体家族。存放待设置的字体名称,不同字体名称通过逗号拼接。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetFontFamily(OH_ArkUI_TextEditorTextStyle* style, char* buffer, int32_t bufferSize, int32_t* writeLength)
描述
获取文本样式的字体家族。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| char* buffer | 字体家族内容写入内存的缓冲区,内存空间需由开发者分配。 |
| int32_t bufferSize | 缓冲区最多可写入的字符的数量。 |
| int32_t* writeLength | 实际写入缓冲区的字符的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetDecoration(OH_ArkUI_TextEditorTextStyle* style, OH_ArkUI_DecorationStyleOptions* options)
描述
设置文本样式的文本装饰选项。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetDecoration(OH_ArkUI_TextEditorTextStyle* style, OH_ArkUI_DecorationStyleOptions* options)
描述
获取文本样式的文本装饰选项。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| OH_ArkUI_DecorationStyleOptions* options | 指向OH_ArkUI_DecorationStyleOptions对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetTextShadows(OH_ArkUI_TextEditorTextStyle* style, const OH_ArkUI_ShadowOptions** options, int32_t length)
描述
设置文本样式的文本阴影选项。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| const OH_ArkUI_ShadowOptions** options | 文本阴影选项。 |
| int32_t length | 文本阴影选项的长度。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetTextShadows(OH_ArkUI_TextEditorTextStyle* style, OH_ArkUI_ShadowOptions** shadowOptions, uint32_t shadowOptionsSize, uint32_t* writeLength)
描述
获取文本样式的文本阴影选项。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| OH_ArkUI_ShadowOptions** shadowOptions | 文本阴影选项。 |
| uint32_t shadowOptionsSize | 阴影选项的缓冲区大小。 |
| uint32_t* writeLength | 文本样式中实际的文本阴影选项数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetLineHeight(OH_ArkUI_TextEditorTextStyle* style, int32_t lineHeight)
描述
设置文本样式的文本行高。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| int32_t lineHeight | 文本行高。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetLineHeight(OH_ArkUI_TextEditorTextStyle* style, int32_t* lineHeight)
描述
获取文本样式的文本行高。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| int32_t* lineHeight | 文本行高。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetLetterSpacing(OH_ArkUI_TextEditorTextStyle* style, int32_t letterSpacing)
描述
设置文本样式的字符间距。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| int32_t letterSpacing | 字符间距。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetLetterSpacing(OH_ArkUI_TextEditorTextStyle* style, int32_t* letterSpacing)
描述
获取文本样式的字符间距。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| int32_t* letterSpacing | 字符间距。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetFontFeature(OH_ArkUI_TextEditorTextStyle* style, const char* fontFeature)
描述
设置文本样式的文字特性效果,比如数字等宽的特性。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| const char* fontFeature | 字体特性。存放待设置的字体特性,多个特性通过逗号拼接。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetFontFeature(OH_ArkUI_TextEditorTextStyle* style, char* buffer, int32_t bufferSize, int32_t* writeLength)
描述
获取文本样式的文字特性效果,比如数字等宽的特性。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| char* buffer | 字体特性内容写入内存的缓冲区,内存空间需由开发者分配。 |
| int32_t bufferSize | 缓冲区最多可写入的字符的数量。 |
| int32_t* writeLength | 实际表示写入缓冲区的字符的数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetHalfLeading(OH_ArkUI_TextEditorTextStyle* style, bool halfLeading)
描述
设置文本样式中文本是否将行间距平分至行的顶部与底部。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| bool halfLeading | 文本是否将行间距平分至行的顶部与底部。 true表示将行间距平分至行的顶部与底部,false表示不将行间距平分至行的顶部与底部。默认值为false。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetHalfLeading(OH_ArkUI_TextEditorTextStyle* style, bool* halfLeading)
描述
获取文本样式中文本是否将行间距平分至行的顶部与底部。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| bool* halfLeading | 文本是否将行间距平分至行的顶部与底部。 true表示将行间距平分至行的顶部与底部,false表示不将行间距平分至行的顶部与底部。默认值为false。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetTextBackgroundColor(OH_ArkUI_TextEditorTextStyle* style, uint32_t color)
描述
设置文本样式中的文本背景颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| uint32_t color | 文本背景颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetTextBackgroundColor(OH_ArkUI_TextEditorTextStyle* style, uint32_t* color)
描述
获取文本样式中的文本背景颜色。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| uint32_t* color | 文本背景颜色,0xARGB格式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_SetTextBackgroundRadius(OH_ArkUI_TextEditorTextStyle* style, float topLeft, float topRight, float bottomLeft, float bottomRight)
描述
设置文本样式中文本背景的圆角半径。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| float topLeft | 文本背景左上角的圆角半径。单位为vp。 |
| float topRight | 文本背景右上角的圆角半径。单位为vp。 |
| float bottomLeft | 文本背景左下角的圆角半径。单位为vp。 |
| float bottomRight | 文本背景右下角的圆角半径。单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorTextStyle_GetTextBackgroundRadius(OH_ArkUI_TextEditorTextStyle* style, float* topLeft, float* topRight, float* bottomLeft, float* bottomRight)
描述
获取文本样式中文本背景的圆角半径。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorTextStyle* style | TextEditor组件文本样式。 |
| float* topLeft | 文本背景左上角的圆角半径。单位为vp。 |
| float* topRight | 文本背景右上角的圆角半径。单位为vp。 |
| float* bottomLeft | 文本背景左下角的圆角半径。单位为vp。 |
| float* bottomRight | 文本背景右下角的圆角半径。单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetTypingStyle(OH_ArkUI_TextEditorStyledStringController* controller, OH_ArkUI_TextEditorTextStyle* style)
描述
通过属性字符串控制器设置预设输入样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| OH_ArkUI_TextEditorTextStyle* style | 预设输入样式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetTypingStyle(OH_ArkUI_TextEditorStyledStringController* controller, OH_ArkUI_TextEditorTextStyle* style)
描述
通过属性字符串控制器获取预设输入样式。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| OH_ArkUI_TextEditorTextStyle* style | 预设输入样式。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetSelection(const OH_ArkUI_TextEditorStyledStringController* controller, uint32_t* start, uint32_t* end)
描述
通过属性字符串控制器获取选中区域。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| uint32_t* start | 选中区域的起始位置。 |
| uint32_t* end | 选中区域的结束位置。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetStyledString(const OH_ArkUI_TextEditorStyledStringController* controller, const ArkUI_StyledString_Descriptor* descriptor)
描述
通过属性字符串控制器设置显示的属性字符串。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| const ArkUI_StyledString_Descriptor* descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetStyledString(const OH_ArkUI_TextEditorStyledStringController* controller, ArkUI_StyledString_Descriptor* descriptor)
描述
通过属性字符串控制器获取显示的属性字符串。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| ArkUI_StyledString_Descriptor* descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetStyledPlaceholder(const OH_ArkUI_TextEditorStyledStringController* controller, const ArkUI_StyledString_Descriptor* descriptor)
描述
通过属性字符串控制器设置属性字符串样式的提示文本。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| const ArkUI_StyledString_Descriptor* descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_ScrollToVisible(const OH_ArkUI_TextEditorStyledStringController* controller, int32_t start, int32_t end)
描述
通过属性字符串控制器使指定起始索引至结束索引范围内的内容滚动至可视区域。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_TextEditorStyledStringController* controller | 指向OH_ArkUI_TextEditorStyledStringController对象的指针。 |
| int32_t start | 起始内容索引值。 起始索引应小于等于结束索引,否则接口调用无效。取值范围[0, TextEditor组件内容总长度],起始索引小于0视为0,大于总长度视为总长度。 |
| int32_t end | 结束内容索引值。 结束索引应大于等于起始索引,否则接口调用无效。取值范围[0, TextEditor组件内容总长度],结束索引小于0视为0,大于总长度视为总长度。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果码。 若操作成功,返回ARKUI_ERROR_CODE_NO_ERROR。 若参数异常,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_PickerIndicatorStyle_ConfigureBackground(ArkUI_PickerIndicatorStyle* style, ArkUI_PickerIndicatorBackground* background)
描述
设置背景样式参数,此接口仅当选择器选中项样式枚举类型为ARKUI_PICKER_INDICATOR_BACKGROUND时生效。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_PickerIndicatorStyle* style | 选中项指示器样式ArkUI_PickerIndicatorStyle的实例。 |
| ArkUI_PickerIndicatorBackground* background | 背景样式参数。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 |
ArkUI_ErrorCode OH_ArkUI_PickerIndicatorStyle_ConfigureDivider(ArkUI_PickerIndicatorStyle* style, ArkUI_PickerIndicatorDivider* divider)
描述
设置分割线样式参数,此接口仅当选择器选中项样式枚举类型为ARKUI_PICKER_INDICATOR_DIVIDER时生效。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| ArkUI_PickerIndicatorStyle* style | 选中项指示器样式ArkUI_PickerIndicatorStyle的实例。 |
| ArkUI_PickerIndicatorDivider* divider | 分割线样式参数。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 |
ArkUI_ErrorCode OH_ArkUI_TextController_SetStyledString(OH_ArkUI_TextController* controller, ArkUI_StyledString_Descriptor* descriptor)
描述
设置文本组件的属性字符串。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_TextController* controller | 指向OH_ArkUI_TextController对象的指针。 |
| ArkUI_StyledString_Descriptor* descriptor | 指向ArkUI_StyledString_Descriptor对象的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 返回结果。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 |
OH_ArkUI_LinearGradientOptions* OH_ArkUI_LinearGradientOptions_Create()
描述
创建线性渐变效果选项对象。
起始版本: 26.0.0
返回:
void OH_ArkUI_LinearGradientOptions_Destroy(OH_ArkUI_LinearGradientOptions* options)
描述
销毁线性渐变效果选项对象。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_SetAngle(OH_ArkUI_LinearGradientOptions* options, float angle)
描述
设置线性渐变效果选项的角度。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| float angle | 线性渐变效果选项的角度。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_GetAngle(const OH_ArkUI_LinearGradientOptions* options, float* angle)
描述
获取线性渐变效果选项的角度。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| float* angle | 线性渐变效果选项的角度。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_SetDirection(OH_ArkUI_LinearGradientOptions* options, ArkUI_LinearGradientDirection direction)
描述
设置线性渐变选项的方向。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| ArkUI_LinearGradientDirection direction | 线性渐变选项的方向。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_GetDirection(const OH_ArkUI_LinearGradientOptions* options, ArkUI_LinearGradientDirection* direction)
描述
获取线性渐变选项的方向。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| ArkUI_LinearGradientDirection* direction | 线性渐变选项的方向。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_SetRepeating(OH_ArkUI_LinearGradientOptions* options, bool repeating)
描述
设置颜色是否在线性渐变选项中重复。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| bool repeating | 颜色是否在线性渐变选项中重复,false表示不重复着色,true表示重复着色。默认值:false。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_GetRepeating(const OH_ArkUI_LinearGradientOptions* options, bool* repeating)
描述
查询线性渐变选项中颜色是否重复。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| bool* repeating | 指向线性渐变选项中颜色是否重复的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_SetColorStop(OH_ArkUI_LinearGradientOptions* options, const uint32_t* colors, const float* stops, int32_t colorsAndStopsSize)
描述
设置线性渐变选项的颜色停止点。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| const uint32_t* colors | 指向颜色数组的指针。 |
| const float* stops | 指向颜色停止点数组的指针。 |
| int32_t colorsAndStopsSize | 颜色和颜色停止点中的元素数量。颜色和颜色停止点的元素数量必须相同。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_LinearGradientOptions_GetColorStop(const OH_ArkUI_LinearGradientOptions* options, uint32_t* colors, float* stops, int32_t colorsAndStopsSize, int32_t* writeLength)
描述
获取线性渐变选项的颜色停止点。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_LinearGradientOptions* options | 指向OH_ArkUI_LinearGradientOptions对象的指针。 |
| uint32_t* colors | 指向颜色数组的指针。 |
| float* stops | 指向颜色停止点数组的指针。 |
| int32_t colorsAndStopsSize | 颜色和颜色停止点中的元素数量。颜色和颜色停止点的元素数量必须相同。 |
| int32_t* writeLength | 实际写入的颜色及颜色停止点数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
OH_ArkUI_RadialGradientOptions* OH_ArkUI_RadialGradientOptions_Create()
描述
创建一个径向渐变选项对象。
起始版本: 26.0.0
返回:
void OH_ArkUI_RadialGradientOptions_Destroy(OH_ArkUI_RadialGradientOptions* options)
描述
销毁一个径向渐变选项对象。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_SetCenterX(OH_ArkUI_RadialGradientOptions* options, float centerX)
描述
设置径向渐变选项中心点的X坐标。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| float centerX | 径向渐变选项中心点的X坐标。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_GetCenterX(const OH_ArkUI_RadialGradientOptions* options, float* centerX)
描述
获取径向渐变选项中心点的X坐标。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| float* centerX | 指向径向渐变选项中心点的X坐标。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_SetCenterY(OH_ArkUI_RadialGradientOptions* options, float centerY)
描述
设置径向渐变选项中心点的Y坐标。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| float centerY | 径向渐变选项中心点的Y坐标。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_GetCenterY(const OH_ArkUI_RadialGradientOptions* options, float* centerY)
描述
获取径向渐变选项中心点的Y坐标。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| float* centerY | 指向径向渐变选项中心点的Y坐标。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_SetRadius(OH_ArkUI_RadialGradientOptions* options, float radius)
描述
设置径向渐变选项的半径。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| float radius | 径向渐变选项的半径。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_GetRadius(const OH_ArkUI_RadialGradientOptions* options, float* radius)
描述
获取径向渐变选项的半径。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| float* radius | 指向径向渐变选项的半径的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_SetRepeating(OH_ArkUI_RadialGradientOptions* options, bool repeating)
描述
设置径向渐变选项中颜色是否重复。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| bool repeating | 径向渐变选项中颜色是否重复,false表示不重复着色,true表示重复着色。默认值:false。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_GetRepeating(const OH_ArkUI_RadialGradientOptions* options, bool* repeating)
描述
查询径向渐变选项中颜色是否重复。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| bool* repeating | 指向径向渐变选项中颜色是否重复的指针。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_SetColorStop(OH_ArkUI_RadialGradientOptions* options, const uint32_t* colors, const float* stops, int32_t colorsAndStopsSize)
描述
设置径向渐变选项的颜色停止点。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| const uint32_t* colors | 指向颜色数组的指针。 |
| const float* stops | 指向颜色停止点数组的指针。 |
| int32_t colorsAndStopsSize | 颜色和颜色停止点中的元素数量。颜色和颜色停止点的元素数量必须相同。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |
ArkUI_ErrorCode OH_ArkUI_RadialGradientOptions_GetColorStop(const OH_ArkUI_RadialGradientOptions* options, uint32_t* colors, float* stops, int32_t colorsAndStopsSize, int32_t* writeLength)
描述
获取径向渐变选项的颜色停止点。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| const OH_ArkUI_RadialGradientOptions* options | 指向OH_ArkUI_RadialGradientOptions对象的指针。 |
| uint32_t* colors | 指向颜色数组的缓冲区指针。 |
| float* stops | 指向颜色停止点数组的指针。 |
| int32_t colorsAndStopsSize | 颜色和颜色停止点中的元素数量。颜色和颜色停止点的元素数量必须相同。 |
| int32_t* writeLength | 实际写入的颜色停止点数量。 |
返回:
| 类型 | 说明 |
|---|---|
| ArkUI_ErrorCode | 操作结果码。 操作成功时,返回ARKUI_ERROR_CODE_NO_ERROR。 参数异常时,返回ARKUI_ERROR_CODE_PARAM_INVALID。 |