目录

text.h

概述

定义Text相关的枚举和接口,用于配置文本样式、控制跑马灯效果、实现文本实体识别以及管理文本控制器等功能。适用于需要自定义文本显示效果、实现动态文本交互、识别文本中特殊实体(如地址、电话号码)以及精确控制文本字体粗细等场景。通过这些配置接口,开发者可以灵活控制文本组件的显示效果和交互行为,提升用户体验。

引用文件: <arkui/node_attributes/text.h>

库: libace_ndk.z.so

系统能力: SystemCapability.ArkUI.ArkUI.Full

起始版本: 12

相关模块: ArkUI_NativeModule

相关示例: native_type_sample

汇总

[h2]结构体

名称 typedef关键字 描述
OH_ArkUI_TextDataDetectorConfig OH_ArkUI_TextDataDetectorConfig 定义文本实体识别的配置。文本实体指的是地址、电话号码等特殊内容实体。
ArkUI_TextMarqueeOptions ArkUI_TextMarqueeOptions 定义文本跑马灯模式配置项,用于配置文本跑马灯效果的各项显示参数。适用于需要在有限空间内循环展示较长文本内容的场景,如通知栏滚动消息、标题滚动展示等,可有效解决文本超出显示区域时的展示问题。
OH_ArkUI_FontWeightConfigs OH_ArkUI_FontWeightConfigs 定义文本的字体粗细配置,适用于需要精确控制文本字体粗细或需要文本字体粗细跟随设备字体设置变化的应用场景。可以通过OH_ArkUI_FontWeightConfigs_Create接口创建文本字体粗细配置对象,使用完毕后必须调用OH_ArkUI_FontWeightConfigs_Destroy接口销毁对象以释放资源,避免内存泄漏。配置创建后,可通过以下接口进行设置和查询:通过OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight接口设置是否启用可变字重调节,通过OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight接口查看是否启用了可变字重调节,通过OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory接口设置文本字体粗细是否跟随设备的字体粗细级别更新,通过OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory接口查看文本字体粗细是否跟随设备的字体粗细级别更新。当该配置对象被使用且不为空指针时,若用户未通过接口显式设置,各项配置将使用默认值(可变字重调节默认为禁用,文本字体粗细跟随设备字体粗细级别更新默认为启用)。当该配置为空指针时,不应用默认值,文本字体粗细行为与父组件保持一致。
OH_ArkUI_FontConfigs OH_ArkUI_FontConfigs 定义文本的字体配置,当前支持通过相关接口设置和获取字体粗细配置,适用于需要自定义字体粗细显示效果的场景。可以通过OH_ArkUI_FontConfigs_Create接口创建字体配置对象,通过OH_ArkUI_FontConfigs_Destroy接口销毁字体配置对象。配置创建后,可通过以下接口进行设置和查询:通过OH_ArkUI_FontConfigs_SetFontWeightConfigs接口设置字体粗细配置,通过OH_ArkUI_FontConfigs_GetFontWeightConfigs接口获取字体粗细配置。
OH_ArkUI_TextController OH_ArkUI_TextController 定义文本组件的控制器,用于在Native侧对文本组件进行控制和交互。控制器需要先通过节点属性绑定到文本组件,才能进行后续操作。一个控制器只能绑定到一个文本组件,绑定后该控制器将管理对应文本组件的样式和内容。可通过OH_ArkUI_TextController_Create创建控制器对象,创建后必须在使用完毕后调用OH_ArkUI_TextController_Destroy接口销毁对象以释放资源,二者必须成对使用,否则会导致内存泄漏。创建控制器后,可通过节点属性将控制器绑定到文本组件,然后使用OH_ArkUI_TextController_SetStyledString等接口设置文本组件的属性字符串,实现对文本内容的动态管理和样式控制。适用于需要在Native层操作文本组件的场景。
OH_ArkUI_NativeModule_LineSpacingOptions OH_ArkUI_NativeModule_LineSpacingOptions 定义文本行间距选项对象,用于配置文本行间距是否仅在行与行之间生效。可以通过OH_ArkUI_NativeModule_LineSpacingOptions_Create接口创建行间距选项对象,创建后必须在使用完毕后调用OH_ArkUI_NativeModule_LineSpacingOptions_Destroy接口销毁对象以释放资源,二者必须成对使用,否则会导致内存泄漏。创建对象后,可使用OH_ArkUI_NativeModule_LineSpacingOptions_SetOnlyBetweenLines接口设置行间距是否仅在行与行之间生效,通过OH_ArkUI_NativeModule_LineSpacingOptions_GetOnlyBetweenLines接口获取行间距配置。适用于需要精确控制文本行间距显示效果的场景,如排版要求首尾行不加行间距的文本显示。

[h2]枚举

名称 typedef关键字 描述
ArkUI_FontStyle ArkUI_FontStyle 定义字体样式枚举值。
ArkUI_FontWeight ArkUI_FontWeight 定义字体粗细/字重枚举值。
ArkUI_TextHeightAdaptivePolicy ArkUI_TextHeightAdaptivePolicy 定义文本自适应高度的方式。
ArkUI_TextDataDetectorType ArkUI_TextDataDetectorType 定义文本识别的实体类型。
ArkUI_MarqueeStartPolicy ArkUI_MarqueeStartPolicy 定义跑马灯启动策略枚举。
ArkUI_MarqueeUpdatePolicy ArkUI_MarqueeUpdatePolicy 定义跑马灯更新策略枚举。

[h2]函数

名称 描述
ArkUI_TextMarqueeOptions* OH_ArkUI_TextMarqueeOptions_Create() 创建文本跑马灯模式配置项。当该对象不再使用时,请调用OH_ArkUI_TextMarqueeOptions_Dispose销毁,以释放资源避免内存泄漏。
void OH_ArkUI_TextMarqueeOptions_Dispose(ArkUI_TextMarqueeOptions* option) 销毁文本跑马灯模式配置项对象。与OH_ArkUI_TextMarqueeOptions_Create成对使用,否则会导致内存泄漏。
void OH_ArkUI_TextMarqueeOptions_SetStart(ArkUI_TextMarqueeOptions* option, bool start) 设置文本跑马灯模式配置项是否播放。
bool OH_ArkUI_TextMarqueeOptions_GetStart(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项是否播放。
void OH_ArkUI_TextMarqueeOptions_SetStep(ArkUI_TextMarqueeOptions* option, float step) 设置文本跑马灯模式配置项的步长。
float OH_ArkUI_TextMarqueeOptions_GetStep(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的步长。
void OH_ArkUI_TextMarqueeOptions_SetSpacing(ArkUI_TextMarqueeOptions* option, float spacing) 设置文本跑马灯模式配置项的首尾间距。
float OH_ArkUI_TextMarqueeOptions_GetSpacing(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的首尾间距。
void OH_ArkUI_TextMarqueeOptions_SetLoop(ArkUI_TextMarqueeOptions* option, int32_t loop) 设置文本跑马灯模式配置项的重复滚动次数,小于等于零时无限循环。
int32_t OH_ArkUI_TextMarqueeOptions_GetLoop(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的重复滚动的次数。
void OH_ArkUI_TextMarqueeOptions_SetFromStart(ArkUI_TextMarqueeOptions* option, bool fromStart) 设置文本跑马灯模式配置项的运行方向。
bool OH_ArkUI_TextMarqueeOptions_GetFromStart(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的运行方向。
void OH_ArkUI_TextMarqueeOptions_SetDelay(ArkUI_TextMarqueeOptions* option, int32_t delay) 设置文本跑马灯模式配置项的每轮滚动延迟时间。
int32_t OH_ArkUI_TextMarqueeOptions_GetDelay(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的每轮滚动延迟时间。
void OH_ArkUI_TextMarqueeOptions_SetFadeout(ArkUI_TextMarqueeOptions* option, bool fadeout) 设置文本跑马灯模式配置项是否支持文字超长时的渐隐效果。当Text内容超出显示范围时,未完全展现的文字边缘将应用渐隐效果。若两端均有文字未完全显示,则两端同时应用渐隐效果。在渐隐效果开启状态下,ArkUI_NodeAttributeType中的NODE_CLIP属性将自动锁定为true,不允许设置为false。
bool OH_ArkUI_TextMarqueeOptions_GetFadeout(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项是否支持文字超长时的渐隐效果。
void OH_ArkUI_TextMarqueeOptions_SetStartPolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeStartPolicy startPolicy) 设置文本跑马灯模式配置项的启动策略。
ArkUI_MarqueeStartPolicy OH_ArkUI_TextMarqueeOptions_GetStartPolicy(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的启动策略。
void OH_ArkUI_TextMarqueeOptions_SetUpdatePolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeUpdatePolicy updatePolicy) 设置文本跑马灯模式配置项的更新策略。
ArkUI_MarqueeUpdatePolicy OH_ArkUI_TextMarqueeOptions_GetUpdatePolicy(ArkUI_TextMarqueeOptions* option) 获取文本跑马灯模式配置项的更新策略。
OH_ArkUI_TextDataDetectorConfig* OH_ArkUI_TextDataDetectorConfig_Create() 创建一个文本实体识别配置对象。当该对象不再使用时,请调用OH_ArkUI_TextDataDetectorConfig_Destroy销毁,以释放资源避免内存泄漏。
void OH_ArkUI_TextDataDetectorConfig_Destroy(OH_ArkUI_TextDataDetectorConfig* config) 销毁文本实体识别配置对象。与OH_ArkUI_TextDataDetectorConfig_Create成对使用,否则会导致内存泄漏。
OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontWeightConfigs_Create() 创建文本字体粗细配置对象。当该对象不再使用时,请调用OH_ArkUI_FontWeightConfigs_Destroy销毁,以释放资源避免内存泄漏。
void OH_ArkUI_FontWeightConfigs_Destroy(OH_ArkUI_FontWeightConfigs* option) 销毁文本字体粗细配置对象。与OH_ArkUI_FontWeightConfigs_Create成对使用,否则会导致内存泄漏。
void OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option, bool enable) 设置是否启用可变字重调节。可变字重调节允许字体在100到900之间以任意整数值显示字重,实现更细腻的字体粗细控制。
bool OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option) 获取文本字体粗细配置对象是否启用了可变字重调节。
void OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option, bool enable) 设置设备的字体粗细级别改变时文本字体粗细是否自动更新。设备的字体粗细级别是指系统设置中的全局字体粗细配置,用户可在系统设置中调整。
bool OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option) 获取文本字体粗细是否跟随设备的字体粗细级别更新。
OH_ArkUI_FontConfigs* OH_ArkUI_FontConfigs_Create() 创建文本字体配置对象。当该对象不再使用时,请调用OH_ArkUI_FontConfigs_Destroy销毁,以释放资源避免内存泄漏。
void OH_ArkUI_FontConfigs_Destroy(OH_ArkUI_FontConfigs* option) 销毁文本字体配置对象。与OH_ArkUI_FontConfigs_Create成对使用,否则会导致内存泄漏。
void OH_ArkUI_FontConfigs_SetFontWeightConfigs(OH_ArkUI_FontConfigs* option, OH_ArkUI_FontWeightConfigs* fontWeightConfigs) 设置文本字体配置对象的文本字体粗细配置。
OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontConfigs_GetFontWeightConfigs(OH_ArkUI_FontConfigs* option) 获取文本字体配置对象的文本字体粗细配置。
OH_ArkUI_TextController* OH_ArkUI_TextController_Create() 创建一个文本控制器对象。当该对象不再使用时,请调用OH_ArkUI_TextController_Destroy销毁,以释放资源避免内存泄漏。
void OH_ArkUI_TextController_Destroy(OH_ArkUI_TextController* controller) 销毁文本控制器对象。与OH_ArkUI_TextController_Create成对使用,否则会导致内存泄漏。
OH_ArkUI_NativeModule_LineSpacingOptions* OH_ArkUI_NativeModule_LineSpacingOptions_Create() 创建文本行间距选项对象。使用完毕后需要调用OH_ArkUI_NativeModule_LineSpacingOptions_Destroy销毁对象。
void OH_ArkUI_NativeModule_LineSpacingOptions_Destroy(OH_ArkUI_NativeModule_LineSpacingOptions* options) 销毁文本行间距选项对象。
ArkUI_ErrorCode OH_ArkUI_NativeModule_LineSpacingOptions_SetOnlyBetweenLines(OH_ArkUI_NativeModule_LineSpacingOptions* options, bool onlyBetweenLines) 设置文本行间距选项的onlyBetweenLines参数。当设置为true时,行间距仅在行之间应用,首行上方和尾行下方无额外的行间距。当设置为false时,首行上方和尾行下方也会存在行间距。
ArkUI_ErrorCode OH_ArkUI_NativeModule_LineSpacingOptions_GetOnlyBetweenLines(const OH_ArkUI_NativeModule_LineSpacingOptions* options, bool* onlyBetweenLines) 获取文本行间距选项的onlyBetweenLines参数。

枚举类型说明

[h2]ArkUI_FontStyle

enum ArkUI_FontStyle

描述

定义字体样式枚举值。

起始版本: 12

枚举项 描述
ARKUI_FONT_STYLE_NORMAL = 0 标准字体样式。
ARKUI_FONT_STYLE_ITALIC = 1 斜体字体样式。

[h2]ArkUI_FontWeight

enum ArkUI_FontWeight

描述

定义字体粗细/字重枚举值。

起始版本: 12

枚举项 描述
ARKUI_FONT_WEIGHT_W100 = 0 100
ARKUI_FONT_WEIGHT_W200 = 1 200
ARKUI_FONT_WEIGHT_W300 = 2 300
ARKUI_FONT_WEIGHT_W400 = 3 400
ARKUI_FONT_WEIGHT_W500 = 4 500
ARKUI_FONT_WEIGHT_W600 = 5 600
ARKUI_FONT_WEIGHT_W700 = 6 700
ARKUI_FONT_WEIGHT_W800 = 7 800
ARKUI_FONT_WEIGHT_W900 = 8 900
ARKUI_FONT_WEIGHT_BOLD = 9 字体较粗。
ARKUI_FONT_WEIGHT_NORMAL = 10 字体粗细正常,与ARKUI_FONT_WEIGHT_REGULAR相同。
ARKUI_FONT_WEIGHT_BOLDER = 11 字体非常粗。
ARKUI_FONT_WEIGHT_LIGHTER = 12 字体较细。
ARKUI_FONT_WEIGHT_MEDIUM = 13 字体粗细适中。
ARKUI_FONT_WEIGHT_REGULAR = 14 字体粗细正常,与ARKUI_FONT_WEIGHT_NORMAL相同。

[h2]ArkUI_TextHeightAdaptivePolicy

enum ArkUI_TextHeightAdaptivePolicy

描述

定义文本自适应高度的方式。

起始版本: 12

枚举项 描述
ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST = 0 设置文本高度自适应方式为以MaxLines优先。优先保持最大行数(maxLines)设置,当文本内容超出显示区域时,优先满足maxLines限制,超出部分可能被截断或通过其他方式处理。
ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST = 1 设置文本高度自适应方式为以缩小字体优先。当文本内容超出显示区域时,优先通过缩小字体大小来适应高度限制,确保文本完整显示,字体大小会在允许范围内自动调整。
ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST = 2 设置文本高度自适应方式为以布局约束(高度)优先。严格遵循布局约束的高度设置,不自动调整文本高度或字体大小,超出部分可能被截断或通过其他方式处理。

[h2]ArkUI_TextDataDetectorType

enum ArkUI_TextDataDetectorType

描述

定义文本识别的实体类型。

起始版本: 12

枚举项 描述
ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER = 0 电话号码。
ARKUI_TEXT_DATA_DETECTOR_TYPE_URL = 1 链接。
ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL = 2 邮箱。
ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS = 3 地址。

[h2]ArkUI_MarqueeStartPolicy

enum ArkUI_MarqueeStartPolicy

描述

定义跑马灯启动策略枚举。

起始版本: 23

枚举项 描述
ARKUI_MARQUEESTARTPOLICY_DEFAULT = 0 默认持续滚动。
ARKUI_MARQUEESTARTPOLICY_ONFOCUS = 1 获焦以及鼠标悬浮时开始滚动。

[h2]ArkUI_MarqueeUpdatePolicy

enum ArkUI_MarqueeUpdatePolicy

描述

定义跑马灯更新策略枚举。

起始版本: 23

枚举项 描述
ARKUI_MARQUEEUPDATEPOLICY_DEFAULT = 0 跑马灯组件属性更新后,从开始位置,运行跑马灯效果。
ARKUI_MARQUEEUPDATEPOLICY_PRESERVEPOSITION = 1 跑马灯组件属性更新后,保持当前位置,运行跑马灯效果。

函数说明

[h2]OH_ArkUI_TextMarqueeOptions_Create()

ArkUI_TextMarqueeOptions* OH_ArkUI_TextMarqueeOptions_Create()

描述

创建文本跑马灯模式配置项。当该对象不再使用时,请调用OH_ArkUI_TextMarqueeOptions_Dispose销毁,以释放资源避免内存泄漏。

起始版本: 23

返回:

类型 说明
ArkUI_TextMarqueeOptions* 返回指向文本跑马灯模式配置项对象的指针。如果创建失败,返回空指针。使用后需调用OH_ArkUI_TextMarqueeOptions_Dispose销毁。

[h2]OH_ArkUI_TextMarqueeOptions_Dispose()

void OH_ArkUI_TextMarqueeOptions_Dispose(ArkUI_TextMarqueeOptions* option)

描述

销毁文本跑马灯模式配置项对象。与OH_ArkUI_TextMarqueeOptions_Create成对使用,否则会导致内存泄漏。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 需要销毁的文本跑马灯模式配置项对象指针。

[h2]OH_ArkUI_TextMarqueeOptions_SetStart()

void OH_ArkUI_TextMarqueeOptions_SetStart(ArkUI_TextMarqueeOptions* option, bool start)

描述

设置文本跑马灯模式配置项是否播放。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
bool start 是否播放。true表示播放,false表示不播放。默认值:true。

[h2]OH_ArkUI_TextMarqueeOptions_GetStart()

bool OH_ArkUI_TextMarqueeOptions_GetStart(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项是否播放。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
bool 是否播放。true表示播放,false表示不播放。

[h2]OH_ArkUI_TextMarqueeOptions_SetStep()

void OH_ArkUI_TextMarqueeOptions_SetStep(ArkUI_TextMarqueeOptions* option, float step)

描述

设置文本跑马灯模式配置项的步长。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
float step 步长。单位:vp。取值范围:(0, 文本长度],超出取值范围时取4.0vp。默认值:4.0vp。设置步长后,跑马灯每次移动的距离为该步长值,步长越大滚动速度越快。

[h2]OH_ArkUI_TextMarqueeOptions_GetStep()

float OH_ArkUI_TextMarqueeOptions_GetStep(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的步长。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
float 步长。单位:vp。

[h2]OH_ArkUI_TextMarqueeOptions_SetSpacing()

void OH_ArkUI_TextMarqueeOptions_SetSpacing(ArkUI_TextMarqueeOptions* option, float spacing)

描述

设置文本跑马灯模式配置项的首尾间距。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
float spacing 首尾间距。单位:vp。取值范围:[0, +∞),小于0时取默认值48.0vp。默认值:48.0vp。设置后,跑马灯滚动一轮结束时,首尾文字之间的间隔距离为该间距值。建议根据显示区域宽度设置。

[h2]OH_ArkUI_TextMarqueeOptions_GetSpacing()

float OH_ArkUI_TextMarqueeOptions_GetSpacing(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的首尾间距。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
float 首尾间距。单位:vp。

[h2]OH_ArkUI_TextMarqueeOptions_SetLoop()

void OH_ArkUI_TextMarqueeOptions_SetLoop(ArkUI_TextMarqueeOptions* option, int32_t loop)

描述

设置文本跑马灯模式配置项的重复滚动次数,小于等于零时无限循环。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
int32_t loop 重复滚动的次数。小于等于零时无限循环。

[h2]OH_ArkUI_TextMarqueeOptions_GetLoop()

int32_t OH_ArkUI_TextMarqueeOptions_GetLoop(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的重复滚动的次数。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
int32_t 重复滚动的次数。

[h2]OH_ArkUI_TextMarqueeOptions_SetFromStart()

void OH_ArkUI_TextMarqueeOptions_SetFromStart(ArkUI_TextMarqueeOptions* option, bool fromStart)

描述

设置文本跑马灯模式配置项的运行方向。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
bool fromStart 跑马灯运行方向。true表示从头开始滚动,false表示反向滚动。默认值:true。

[h2]OH_ArkUI_TextMarqueeOptions_GetFromStart()

bool OH_ArkUI_TextMarqueeOptions_GetFromStart(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的运行方向。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
bool 跑马灯运行方向。true表示从头开始滚动,false表示反向滚动。

[h2]OH_ArkUI_TextMarqueeOptions_SetDelay()

void OH_ArkUI_TextMarqueeOptions_SetDelay(ArkUI_TextMarqueeOptions* option, int32_t delay)

描述

设置文本跑马灯模式配置项的每轮滚动延迟时间。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
int32_t delay 每轮滚动延迟时间,单位为毫秒。取值范围:[0, +∞)。默认值:0。

[h2]OH_ArkUI_TextMarqueeOptions_GetDelay()

int32_t OH_ArkUI_TextMarqueeOptions_GetDelay(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的每轮滚动延迟时间。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
int32_t 每轮滚动延迟时间,单位为毫秒。

[h2]OH_ArkUI_TextMarqueeOptions_SetFadeout()

void OH_ArkUI_TextMarqueeOptions_SetFadeout(ArkUI_TextMarqueeOptions* option, bool fadeout)

描述

设置文本跑马灯模式配置项是否支持文字超长时的渐隐效果。当Text内容超出显示范围时,未完全展现的文字边缘将应用渐隐效果。

若两端均有文字未完全显示,则两端同时应用渐隐效果。

在渐隐效果开启状态下,ArkUI_NodeAttributeType中的NODE_CLIP属性将自动锁定为true,不允许设置为false。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
bool fadeout

跑马灯是否支持文字超长时的渐隐效果。

true表示支持渐隐效果,此时NODE_CLIP属性将自动锁定为true,不允许设置为false。

false表示不支持渐隐效果。

[h2]OH_ArkUI_TextMarqueeOptions_GetFadeout()

bool OH_ArkUI_TextMarqueeOptions_GetFadeout(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项是否支持文字超长时的渐隐效果。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
bool 是否支持文字超长时的渐隐效果。true表示支持渐隐效果,false表示不支持渐隐效果。

[h2]OH_ArkUI_TextMarqueeOptions_SetStartPolicy()

void OH_ArkUI_TextMarqueeOptions_SetStartPolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeStartPolicy startPolicy)

描述

设置文本跑马灯模式配置项的启动策略。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
ArkUI_MarqueeStartPolicy startPolicy 启动策略。

[h2]OH_ArkUI_TextMarqueeOptions_GetStartPolicy()

ArkUI_MarqueeStartPolicy OH_ArkUI_TextMarqueeOptions_GetStartPolicy(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的启动策略。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
ArkUI_MarqueeStartPolicy 启动策略。

[h2]OH_ArkUI_TextMarqueeOptions_SetUpdatePolicy()

void OH_ArkUI_TextMarqueeOptions_SetUpdatePolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeUpdatePolicy updatePolicy)

描述

设置文本跑马灯模式配置项的更新策略。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。
ArkUI_MarqueeUpdatePolicy updatePolicy 更新策略。

[h2]OH_ArkUI_TextMarqueeOptions_GetUpdatePolicy()

ArkUI_MarqueeUpdatePolicy OH_ArkUI_TextMarqueeOptions_GetUpdatePolicy(ArkUI_TextMarqueeOptions* option)

描述

获取文本跑马灯模式配置项的更新策略。

起始版本: 23

参数:

参数项 描述
ArkUI_TextMarqueeOptions* option 文本跑马灯模式配置项。

返回:

类型 说明
ArkUI_MarqueeUpdatePolicy 更新策略。

[h2]OH_ArkUI_TextDataDetectorConfig_Create()

OH_ArkUI_TextDataDetectorConfig* OH_ArkUI_TextDataDetectorConfig_Create()

描述

创建一个文本实体识别配置对象。当该对象不再使用时,请调用OH_ArkUI_TextDataDetectorConfig_Destroy销毁,以释放资源避免内存泄漏。

起始版本: 24

返回:

类型 说明
OH_ArkUI_TextDataDetectorConfig* 指向OH_ArkUI_TextDataDetectorConfig对象的指针。如果创建失败,返回空指针。使用后需调用OH_ArkUI_TextDataDetectorConfig_Destroy销毁。

[h2]OH_ArkUI_TextDataDetectorConfig_Destroy()

void OH_ArkUI_TextDataDetectorConfig_Destroy(OH_ArkUI_TextDataDetectorConfig* config)

描述

销毁文本实体识别配置对象。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_TextDataDetectorConfig* config 指向OH_ArkUI_TextDataDetectorConfig对象的指针。

[h2]OH_ArkUI_FontWeightConfigs_Create()

OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontWeightConfigs_Create()

描述

创建文本字体粗细配置对象。当该对象不再使用时,请调用OH_ArkUI_FontWeightConfigs_Destroy销毁,以释放资源避免内存泄漏。

起始版本: 24

返回:

类型 说明
OH_ArkUI_FontWeightConfigs* 指向文本字体粗细配置对象的指针。如果创建失败,返回空指针。使用后需调用OH_ArkUI_FontWeightConfigs_Destroy销毁。当配置对象为空指针时,不应用默认值,文本字体粗细行为与父组件保持一致。

[h2]OH_ArkUI_FontWeightConfigs_Destroy()

void OH_ArkUI_FontWeightConfigs_Destroy(OH_ArkUI_FontWeightConfigs* option)

描述

销毁文本字体粗细配置对象。与OH_ArkUI_FontWeightConfigs_Create成对使用,否则会导致内存泄漏。

若该对象已被SetFontWeightConfigs设置到FontConfigs中,应在销毁FontConfigs之后再销毁FontWeightConfigs,或在确保FontConfigs不再使用后再销毁FontWeightConfigs,以避免FontConfigs持有无效指针。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontWeightConfigs* option 指向要销毁的文本字体粗细配置对象的指针。

[h2]OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight()

void OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option, bool enable)

描述

设置是否启用可变字重调节。可变字重调节允许字体在100到900之间以任意整数值显示字重,实现更细腻的字体粗细控制。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontWeightConfigs* option 指向待修改的文本字体粗细配置对象的指针。
bool enable 是否启用可变字重调节。默认值为false。true表示启用可变字重调节,此时若设置的字重weight为[100, 900]范围内任意整数,则取该值,否则取默认值400。false表示禁用,此时weight仅支持整百数值[100, 900],非整百数值时取默认值400。

[h2]OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight()

bool OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option)

描述

获取文本字体粗细配置对象是否启用了可变字重调节。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontWeightConfigs* option 指向文本字体粗细配置对象的指针。

返回:

类型 说明
bool

是否启用可变字重调节。

true表示启用可变字重调节。此时如果通过相关接口设置的字重weight取值为[100, 900]范围内任意整数,则字重取值为weight,否则取默认值400。

false表示禁用可变字重调节。此时如果设置的字重weight取值为[100, 900]范围内的整百数值,字重取值为weight;weight是非整百数值时,字重取默认值400。

字重weight取值为[100, 900]范围外的值,字重取默认值400。

[h2]OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory()

void OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option, bool enable)

描述

设置设备的字体粗细级别改变时文本字体粗细是否自动更新。设备的字体粗细级别是指系统设置中的全局字体粗细配置,用户可在系统设置中调整。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontWeightConfigs* option 指向待修改的文本字体粗细配置对象的指针。
bool enable 是否启用文本字体粗细跟随设备的字体粗细级别更新。true表示当设备的字体粗细级别改变时,文本字体粗细将自动更新。false表示当设备的字体粗细级别改变时,文本字体粗细不会自动更新。默认值为true。

[h2]OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory()

bool OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option)

描述

获取文本字体粗细是否跟随设备的字体粗细级别更新。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontWeightConfigs* option 指向文本字体粗细配置对象的指针。

返回:

类型 说明
bool

文本字体粗细是否跟随设备的字体粗细级别更新。

true表示当设备的字体粗细级别改变时,文本字体粗细将自动更新。

false表示当设备的字体粗细级别改变时,文本字体粗细不会自动更新。

[h2]OH_ArkUI_FontConfigs_Create()

OH_ArkUI_FontConfigs* OH_ArkUI_FontConfigs_Create()

描述

创建文本字体配置对象。当该对象不再使用时,请调用OH_ArkUI_FontConfigs_Destroy销毁,以释放资源避免内存泄漏。

起始版本: 24

返回:

类型 说明
OH_ArkUI_FontConfigs* 返回指向文本字体配置对象的指针。如果创建失败,返回空指针。使用后需调用OH_ArkUI_FontConfigs_Destroy销毁。

[h2]OH_ArkUI_FontConfigs_Destroy()

void OH_ArkUI_FontConfigs_Destroy(OH_ArkUI_FontConfigs* option)

描述

销毁文本字体配置对象。与OH_ArkUI_FontConfigs_Create成对使用,否则会导致内存泄漏。

销毁FontConfigs前,应先销毁通过SetFontWeightConfigs设置的FontWeightConfigs对象(如果不再使用),或确保FontWeightConfigs的生命周期长于FontConfigs,以避免悬空指针问题。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontConfigs* option 指向要销毁的文本字体配置对象的指针。

[h2]OH_ArkUI_FontConfigs_SetFontWeightConfigs()

void OH_ArkUI_FontConfigs_SetFontWeightConfigs(OH_ArkUI_FontConfigs* option, OH_ArkUI_FontWeightConfigs* fontWeightConfigs)

描述

设置文本字体配置对象的文本字体粗细配置。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontConfigs* option 指向待修改的文本字体配置对象的指针。
OH_ArkUI_FontWeightConfigs* fontWeightConfigs 文本字体粗细配置。当该配置不为空指针时,若用户未显式设置,各项配置将使用默认值(可变字重调节默认为禁用,文本字体粗细跟随设备字体粗细级别更新默认为启用)。当该配置为空指针时,不应用上述默认值,文本字体粗细行为与父组件保持一致。

[h2]OH_ArkUI_FontConfigs_GetFontWeightConfigs()

OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontConfigs_GetFontWeightConfigs(OH_ArkUI_FontConfigs* option)

描述

获取文本字体配置对象的文本字体粗细配置。

起始版本: 24

参数:

参数项 描述
OH_ArkUI_FontConfigs* option 指向文本字体配置对象的指针。若未设置或设置时为空指针,则返回空指针。

返回:

类型 说明
OH_ArkUI_FontWeightConfigs* 文本字体粗细配置。

[h2]OH_ArkUI_TextController_Create()

OH_ArkUI_TextController* OH_ArkUI_TextController_Create()

描述

创建一个文本控制器对象。当该对象不再使用时,请调用OH_ArkUI_TextController_Destroy销毁,以释放资源避免内存泄漏。

起始版本: 26.0.0

返回:

类型 说明
OH_ArkUI_TextController* 指向文本组件控制器对象的指针。如果创建失败,返回空指针。使用后需调用OH_ArkUI_TextController_Destroy销毁。

[h2]OH_ArkUI_TextController_Destroy()

void OH_ArkUI_TextController_Destroy(OH_ArkUI_TextController* controller)

描述

销毁文本控制器对象。与OH_ArkUI_TextController_Create成对使用,否则会导致内存泄漏。

起始版本: 26.0.0

参数:

参数项 描述
OH_ArkUI_TextController* controller 指向文本组件控制器对象的指针。

[h2]OH_ArkUI_NativeModule_LineSpacingOptions_Create()

OH_ArkUI_NativeModule_LineSpacingOptions* OH_ArkUI_NativeModule_LineSpacingOptions_Create()

描述

创建文本行间距选项对象。使用完毕后需要调用OH_ArkUI_NativeModule_LineSpacingOptions_Destroy销毁对象。

起始版本: 26.0.1

返回:

[h2]OH_ArkUI_NativeModule_LineSpacingOptions_Destroy()

void OH_ArkUI_NativeModule_LineSpacingOptions_Destroy(OH_ArkUI_NativeModule_LineSpacingOptions* options)

描述

销毁文本行间距选项对象。

起始版本: 26.0.1

参数:

[h2]OH_ArkUI_NativeModule_LineSpacingOptions_SetOnlyBetweenLines()

ArkUI_ErrorCode OH_ArkUI_NativeModule_LineSpacingOptions_SetOnlyBetweenLines(OH_ArkUI_NativeModule_LineSpacingOptions* options, bool onlyBetweenLines)

描述

设置文本行间距选项的onlyBetweenLines参数。当设置为true时,行间距仅在行之间应用,首行上方和尾行下方无额外的行间距。当设置为false时,首行上方和尾行下方也会存在行间距。

起始版本: 26.0.1

参数:

参数项 描述
OH_ArkUI_NativeModule_LineSpacingOptions* options 指向OH_ArkUI_NativeModule_LineSpacingOptions对象的指针。
bool onlyBetweenLines 行间距是否仅在行与行之间应用。true表示仅在行之间应用行间距,false表示首行上方和尾行下方也会存在行间距。 默认值为false。

返回:

类型 说明
ArkUI_ErrorCode ARKUI_ERROR_CODE_NO_ERROR 表示操作成功。ARKUI_ERROR_CODE_PARAM_INVALID 表示options参数为空。

[h2]OH_ArkUI_NativeModule_LineSpacingOptions_GetOnlyBetweenLines()

ArkUI_ErrorCode OH_ArkUI_NativeModule_LineSpacingOptions_GetOnlyBetweenLines(const OH_ArkUI_NativeModule_LineSpacingOptions* options, bool* onlyBetweenLines)

描述

获取文本行间距选项的onlyBetweenLines参数。

起始版本: 26.0.1

参数:

参数项 描述
OH_ArkUI_NativeModule_LineSpacingOptions* options 指向OH_ArkUI_NativeModule_LineSpacingOptions对象的指针。
bool* onlyBetweenLines 输出参数,指向bool类型变量的指针,用于接收值。true表示仅在行之间应用行间距,false表示首行上方和尾行下方也会存在行间距。默认值为false。

返回:

类型 说明
ArkUI_ErrorCode ARKUI_ERROR_CODE_NO_ERROR 表示操作成功。ARKUI_ERROR_CODE_PARAM_INVALID 表示任意参数为空。