Merged
文本支持尾部缩进 #148119
falcowyAdd on Jun 1
文本支持尾部缩进 #148119
Merged
falcowyAdd on Jun 1
Total: 6 files changed+257-1
@@ -100,6 +100,7 @@ Text(content?: string | Resource , value?: TextOptions)
100| minLines<sup>22+</sup> | 设置文本显示的最小行数。 |100| minLines<sup>22+</sup> | 设置文本显示的最小行数。 |
101| optimizeTrailingSpace<sup>20+</sup> | 优化行尾空格。 |101| optimizeTrailingSpace<sup>20+</sup> | 优化行尾空格。 |
102| textIndent<sup>10+</sup> | 设置首行文本缩进。 |102| textIndent<sup>10+</sup> | 设置首行文本缩进。 |
103+| tailIndents | 设置文本尾部缩进。<br>**起始版本:** 26.0.0 |
103 104 
104**字体自适应**105**字体自适应**
105 106 
@@ -1467,6 +1468,26 @@ textIndent(value: Length)
1467| ------ | ---------------------------- | ---- | ---------------------------- |1468| ------ | ---------------------------- | ---- | ---------------------------- |
1468| value | [Length](ts-types.md#length) | 是 | 首行文本缩进。<br/>默认值:0<br/>单位:[fp](ts-pixel-units.md#基本像素单位) <br/>取值范围:大于等于0。设置负数时,按默认值处理。|1469| value | [Length](ts-types.md#length) | 是 | 首行文本缩进。<br/>默认值:0<br/>单位:[fp](ts-pixel-units.md#基本像素单位) <br/>取值范围:大于等于0。设置负数时,按默认值处理。|
1469 1470 
1471+### tailIndents
1472+ 
1473+tailIndents(value: Optional\<LengthMetrics> | Array\<LengthMetrics>)
1474+ 
1475+设置文本尾部缩进。未通过该接口设置时,文本尾部缩进为0fp。
1476+ 
liujing
liujingliujingJun 2

26的接口统一补充“起始版本”说明: 起始版本: 26.0.0

likedislike
1477+**起始版本:** 26.0.0
1478+ 
1479+**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。
1480+ 
1481+**模型约束:** 此接口仅可在Stage模型下使用。
1482+ 
1483+**系统能力:** SystemCapability.ArkUI.ArkUI.Full
1484+ 
1485+**参数:**
1486+ 
1487+| 参数名 | 类型 | 必填 | 说明 |
1488+| ------ | ---------------------------- | ---- | ---------------------------- |
1489+| value | [Optional](ts-universal-attributes-custom-property.md#optionalt)&lt;[LengthMetrics](../js-apis-arkui-graphics.md#lengthmetrics12)&gt; \| Array&lt;[LengthMetrics](../js-apis-arkui-graphics.md#lengthmetrics12)&gt; | 是 | 指定文本每一行尾部缩进。当提供一个单独的LengthMetrics值时,所有行共享相同的尾部缩进;当提供一个数组时,第i个元素指定第i行的尾部缩进;如果文本行数超过数组长度,则数组中的最后一个元素将用于剩余的行。不支持百分比。<br/>取值范围:大于等于0。设置负数时,按默认值处理。|
1490+ 
1470### textOverflow1491### textOverflow
1471 1492 
1472textOverflow(options: TextOverflowOptions)1493textOverflow(options: TextOverflowOptions)
@@ -3726,3 +3747,49 @@ struct StyledStringAppend {
3726```3747```
3727 3748 
3728![incrementalUpdatePolicy](figures/incrementalUpdatePolicy.png)3749![incrementalUpdatePolicy](figures/incrementalUpdatePolicy.png)
3750+ 
3751+### 示例32(设置文本尾部缩进)
3752+ 
3753+该示例通过[tailIndents](#tailindents)接口实现了文本尾部缩进的功能。
3754+ 
3755+从API版本26.0.0开始,通过tailIndents属性设置文本尾部缩进。
3756+ 
3757+```ts
3758+import { LengthMetrics } from '@kit.ArkUI';
3759+ 
3760+@Entry
3761+@Component
3762+struct TailIndentsExample {
3763+ build() {
3764+ Column() {
3765+ Text('未设置tailIndents\n未设置tailIndents\n未设置tailIndents\n未设置tailIndents\n未设置tailIndents')
3766+ .fontSize(20)
3767+ .borderWidth(1)
3768+ .borderColor(Color.Blue)
3769+ .textAlign(TextAlign.End)
3770+ .width('100%')
3771+ 
3772+ Text('设置tailIndents单值\n设置tailIndents单值\n设置tailIndents单值\n设置tailIndents单值\n设置tailIndents单值')
3773+ .fontSize(20)
3774+ .borderWidth(1)
3775+ .borderColor(Color.Blue)
3776+ .textAlign(TextAlign.End)
3777+ .width('100%')
3778+ .tailIndents(LengthMetrics.vp(100))
3779+ 
3780+ Text('设置tailIndents数组\n设置tailIndents数组\n设置tailIndents数组\n设置tailIndents数组\n设置tailIndents数组')
3781+ .fontSize(20)
3782+ .borderWidth(1)
3783+ .borderColor(Color.Blue)
3784+ .textAlign(TextAlign.End)
3785+ .width('100%')
3786+ .tailIndents([LengthMetrics.vp(100), LengthMetrics.vp(50), LengthMetrics.vp(20)])
3787+ 
3788+ }
3789+ .height('100%')
3790+ .width('100%')
3791+ }
3792+}
3793+```
3794+ 
3795+![tailIndents](figures/tailIndents.png)
liujing
liujingliujingJun 2

示例图缩小一点,预览显示太大了。

likedislike
@@ -1225,6 +1225,7 @@ invalidate(): void
1225| leadingMarginSpan<sup>22+</sup> | [LeadingMarginSpan](#leadingmarginspan22) | 是 | 是 | 获取属性字符串文本段落的自定义缩进信息。<br/>**原子化服务API:** 从API version 22开始,该接口支持在原子化服务中使用。 |1225| leadingMarginSpan<sup>22+</sup> | [LeadingMarginSpan](#leadingmarginspan22) | 是 | 是 | 获取属性字符串文本段落的自定义缩进信息。<br/>**原子化服务API:** 从API version 22开始,该接口支持在原子化服务中使用。 |
1226| textDirection<sup>23+</sup> | [TextDirection](ts-text-common.md#textdirection22) | 是 | 是 | 获取文本方向。 <br/>**原子化服务API:** 从API version 23开始,该接口支持在原子化服务中使用。|1226| textDirection<sup>23+</sup> | [TextDirection](ts-text-common.md#textdirection22) | 是 | 是 | 获取文本方向。 <br/>**原子化服务API:** 从API version 23开始,该接口支持在原子化服务中使用。|
1227| shaderStyle | [ShaderStyle](ts-text-common.md#shaderstyle20) | 是 | 是 | 获取文本着色器效果。<br/>**起始版本:** 26.0.0。<br/>**模型约束:** 此接口仅可在Stage模型下使用。<br/>**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。|1227| shaderStyle | [ShaderStyle](ts-text-common.md#shaderstyle20) | 是 | 是 | 获取文本着色器效果。<br/>**起始版本:** 26.0.0。<br/>**模型约束:** 此接口仅可在Stage模型下使用。<br/>**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。|
1228+| tailIndents | Array\<number> | 是 | 是 | 获取属性字符串文本段落的文本尾部缩进距离。<br/>单位:vp <br/>取值范围:[0, INT32_MAX]<br/>值为0时不做尾部缩进。<br/>**起始版本:** 26.0.0<br/>**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。|
1228 1229 
1229> **说明:**1230> **说明:**
1230>1231>
@@ -1265,6 +1266,7 @@ constructor(value?: ParagraphStyleInterface)
1265| leadingMarginSpan<sup>22+</sup> | [LeadingMarginSpan](#leadingmarginspan22) | 否 | 是 | 设置文本段落的自定义缩进。不支持百分比。<br/>默认值:0<br/>**原子化服务API:** 从API version 22开始,该接口支持在原子化服务中使用。 |1266| leadingMarginSpan<sup>22+</sup> | [LeadingMarginSpan](#leadingmarginspan22) | 否 | 是 | 设置文本段落的自定义缩进。不支持百分比。<br/>默认值:0<br/>**原子化服务API:** 从API version 22开始,该接口支持在原子化服务中使用。 |
1266| textDirection<sup>23+</sup> | [TextDirection](ts-text-common.md#textdirection22) | 否 | 是 | 设置文本方向。<br/>默认值:TextDirection.DEFAULT<br/>**原子化服务API:** 从API version 23开始,该接口支持在原子化服务中使用。 |1267| textDirection<sup>23+</sup> | [TextDirection](ts-text-common.md#textdirection22) | 否 | 是 | 设置文本方向。<br/>默认值:TextDirection.DEFAULT<br/>**原子化服务API:** 从API version 23开始,该接口支持在原子化服务中使用。 |
1267| shaderStyle | [ShaderStyle](ts-text-common.md#shaderstyle20) | 否 | 是 | 设置文本着色器效果。<br/>该接口与[TextStyleInterface](#textstyleinterface对象说明)的strokeWidth同时设置时,该接口不生效,shaderStyle的优先级高于[TextStyleInterface](#textstyleinterface对象说明)中的fontColor。<br/>**起始版本:** 26.0.0。<br/>**模型约束:** 此接口仅可在Stage模型下使用。<br/>**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。|1268| shaderStyle | [ShaderStyle](ts-text-common.md#shaderstyle20) | 否 | 是 | 设置文本着色器效果。<br/>该接口与[TextStyleInterface](#textstyleinterface对象说明)的strokeWidth同时设置时,该接口不生效,shaderStyle的优先级高于[TextStyleInterface](#textstyleinterface对象说明)中的fontColor。<br/>**起始版本:** 26.0.0。<br/>**模型约束:** 此接口仅可在Stage模型下使用。<br/>**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。|
1269+| tailIndents | [LengthMetrics](../js-apis-arkui-graphics.md#lengthmetrics12) \| Array&lt;[LengthMetrics](../js-apis-arkui-graphics.md#lengthmetrics12)&gt; | 否 | 是 | 设置文本段落的文本尾部缩进。当提供一个单独的LengthMetrics值时,所有行共享相同的尾部缩进;当提供一个数组时,第i个元素指定第i行的尾部缩进;如果文本行数超过数组长度,则数组中的最后一个元素将用于剩余的行。<br/>默认值:0<br/>**起始版本:** 26.0.0<br/>**原子化服务API:** 从API版本26.0.0开始,该接口支持在原子化服务中使用。 |
1268 1270 
1269## UserDataSpan1271## UserDataSpan
1270 1272 
@@ -3389,3 +3391,100 @@ struct ShaderColorStyle {
3389}3391}
3390```3392```
3391![StyledStringShaderStyle](figures/styledStringShaderStyle.png)3393![StyledStringShaderStyle](figures/styledStringShaderStyle.png)
3394+ 
3395+### 示例21(设置文本尾部缩进)
3396+ 
3397+该示例通过[ParagraphStyle](#paragraphstyle)中的tailIndents属性,为属性字符串设置文本尾部缩进。
3398+ 
3399+从API版本26.0.0开始,ParagraphStyle接口新增tailIndents属性。
3400+ 
3401+```ts
3402+import { LengthMetrics } from '@kit.ArkUI';
3403+ 
3404+@Entry
3405+@Component
3406+struct TailIndentsExample {
3407+ styledString1:StyledString =
3408+ new StyledString('未设置tailIndents\n未设置tailIndents\n未设置tailIndents\n未设置tailIndents\n未设置tailIndents', [
3409+ {
3410+ start: 0,
3411+ length: 120,
3412+ styledKey: StyledStringKey.FONT,
3413+ styledValue: new TextStyle({ fontSize: LengthMetrics.vp(20) }),
3414+ },
3415+ ])
3416+ 
3417+ styledString2:StyledString =
3418+ new StyledString('设置tailIndents单值\n设置tailIndents单值\n设置tailIndents单值\n设置tailIndents单值\n设置tailIndents单值', [
3419+ {
3420+ start: 0,
3421+ length: 120,
3422+ styledKey: StyledStringKey.PARAGRAPH_STYLE,
3423+ styledValue: new ParagraphStyle({
3424+ tailIndents: LengthMetrics.vp(100),
3425+ }),
3426+ },
3427+ {
3428+ start: 0,
3429+ length: 120,
3430+ styledKey: StyledStringKey.FONT,
3431+ styledValue: new TextStyle({ fontSize: LengthMetrics.vp(20) }),
3432+ },
3433+ ])
3434+ 
3435+ styledString3:StyledString =
3436+ new StyledString('设置tailIndents数组\n设置tailIndents数组\n设置tailIndents数组\n设置tailIndents数组\n设置tailIndents数组', [
3437+ {
3438+ start: 0,
3439+ length: 120,
3440+ styledKey: StyledStringKey.PARAGRAPH_STYLE,
3441+ styledValue: new ParagraphStyle({
3442+ tailIndents: [LengthMetrics.vp(100), LengthMetrics.vp(50), LengthMetrics.vp(20)],
3443+ }),
3444+ },
3445+ {
3446+ start: 0,
3447+ length: 120,
3448+ styledKey: StyledStringKey.FONT,
3449+ styledValue: new TextStyle({ fontSize: LengthMetrics.vp(20) }),
3450+ },
3451+ ])
3452+ 
3453+ txtController1 = new TextController();
3454+ txtController2 = new TextController();
3455+ txtController3 = new TextController();
3456+ 
3457+ build() {
3458+ Column() {
3459+ Text(undefined, { controller: this.txtController1 })
3460+ .onAppear(() => {
3461+ this.txtController1.setStyledString(this.styledString1);
3462+ })
3463+ .textAlign(TextAlign.End)
3464+ .borderWidth(1)
3465+ .borderColor(Color.Blue)
3466+ .width('100%')
3467+ 
3468+ Text(undefined, { controller: this.txtController2 })
3469+ .onAppear(() => {
3470+ this.txtController2.setStyledString(this.styledString2);
3471+ })
3472+ .textAlign(TextAlign.End)
3473+ .borderWidth(1)
3474+ .borderColor(Color.Blue)
3475+ 
3476+ Text(undefined, { controller: this.txtController3 })
3477+ .onAppear(() => {
3478+ this.txtController3.setStyledString(this.styledString3);
3479+ })
3480+ .textAlign(TextAlign.End)
3481+ .borderWidth(1)
3482+ .borderColor(Color.Blue)
3483+ }
3484+ .height('100%')
3485+ .width('100%')
3486+ }
3487+}
3488+```
3489+ 
3490+![styledStringTailIndents](figures/styledStringTailIndents.png)
@@ -1361,6 +1361,32 @@ NODE_TEXT_PUNCTUATION_OVERFLOW = 1055
1361| -- | -- |1361| -- | -- |
1362| .value[0].i32 | 是否启用行尾标点符号悬挂。 |1362| .value[0].i32 | 是否启用行尾标点符号悬挂。 |
1363 1363 
1364+## NODE_TEXT_TAIL_INDENTS
1365+ 
1366+```c
1367+NODE_TEXT_TAIL_INDENTS = 1056
1368+```
1369+ 
1370+定义文本块中每行的尾部缩进。<br>
1371+作为属性设置方法参数、属性获取方法返回值[ArkUI_AttributeItem](capi-arkui-nativemodule-arkui-attributeitem.md)格式如下。<br>
1372+ 
1373+**起始版本:** 26.0.0
1374+ 
1375+ 
1376+**参数:**
1377+ 
1378+| 参数项 | 描述 |
1379+| -- | -- |
1380+| .value[i].i32 | 表示第i行文本的尾部缩进值,单位为vp。取值范围:[0, +∞)。当.size大小为1时,所有行共享相同的尾部缩进.value[0].i32;当.size大于1时,第i行使用.value[i].i32;当文本行数超过.size,则超出部分复用.value[.size - 1].i32。 |
1381+| .size | 表示有效缩进值的数量,即 .value 数组中实际使用的元素个数。|
1382+ 
1383+**返回:**
1384+ 
1385+| 类型 | 说明 |
1386+| -- | -- |
1387+| .value[i].i32 | 第i个尾部缩进值,单位为vp。 |
1388+| .size | 表示有效缩进值的数量,即.value数组中实际使用的元素个数。 |
1389+ 
1364## NODE_SPAN_CONTENT1390## NODE_SPAN_CONTENT
1365 1391 
1366```c1392```c
@@ -289,6 +289,8 @@
289| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLinearGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_LinearGradientOptions* linearGradient)](#oh_arkui_paragraphstyle_getlineargradient) | 获取段落样式的线性渐变。 |289| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLinearGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_LinearGradientOptions* linearGradient)](#oh_arkui_paragraphstyle_getlineargradient) | 获取段落样式的线性渐变。 |
290| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetRadialGradient(OH_ArkUI_ParagraphStyle* paragraphStyle, const OH_ArkUI_RadialGradientOptions* radialGradient)](#oh_arkui_paragraphstyle_setradialgradient) | 设置段落样式的径向渐变。 |290| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetRadialGradient(OH_ArkUI_ParagraphStyle* paragraphStyle, const OH_ArkUI_RadialGradientOptions* radialGradient)](#oh_arkui_paragraphstyle_setradialgradient) | 设置段落样式的径向渐变。 |
291| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetRadialGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_RadialGradientOptions* radialGradient)](#oh_arkui_paragraphstyle_getradialgradient) | 获取段落样式的径向渐变。 |291| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetRadialGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_RadialGradientOptions* radialGradient)](#oh_arkui_paragraphstyle_getradialgradient) | 获取段落样式的径向渐变。 |
292+| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTailIndents(OH_ArkUI_ParagraphStyle* paragraphStyle, const float* tailIndents, uint32_t size)](#oh_arkui_paragraphstyle_settailindents) | 设置段落样式的尾部缩进。 |
293+| [ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTailIndents(const OH_ArkUI_ParagraphStyle* paragraphStyle, float** tailIndents, uint32_t tailIndentsSize, uint32_t* writeLength)](#oh_arkui_paragraphstyle_gettailindents) | 获取段落样式的尾部缩进。 |
292 294 
293## 枚举类型说明295## 枚举类型说明
294 296 
@@ -6075,4 +6077,66 @@ ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetRadialGradient(const OH_ArkUI_Paragra
6075 6077 
6076| 类型 | 说明 |6078| 类型 | 说明 |
6077| -- | -- |6079| -- | -- |
6078-| [ArkUI_ErrorCode](capi-native-type-h.md#arkui_errorcode) | 返回结果。<br> [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br> [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。 |6080+| [ArkUI_ErrorCode](capi-native-type-h.md#arkui_errorcode) | 返回结果。<br> [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br> [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。 |
6081+ 
6082+### OH_ArkUI_ParagraphStyle_SetTailIndents()
6083+ 
6084+```c
6085+ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTailIndents(OH_ArkUI_ParagraphStyle* paragraphStyle, const float* tailIndents, uint32_t size)
6086+```
6087+ 
6088+**描述**
6089+ 
6090+设置段落样式的尾部缩进。
6091+ 
6092+> **说明:**
6093+>
6094+> 所有输入指针参数必须由调用者负责分配、管理和释放。
6095+ 
6096+**起始版本:** 26.0.0
6097+ 
6098+**参数:**
6099+ 
6100+| 参数项 | 描述 |
6101+| -- | -- |
6102+| [OH_ArkUI_ParagraphStyle](capi-arkui-nativemodule-oh-arkui-paragraphstyle.md)* paragraphStyle | 指向[OH_ArkUI_ParagraphStyle](capi-arkui-nativemodule-oh-arkui-paragraphstyle.md)对象的指针。 |
6103+| const float* tailIndents | 尾部缩进值数组。单位:vp。取值范围:[0, +∞)。其有效长度由size指定。若size等于1,则所有文本行使用相同的尾部缩进值tailIndents[0];若size大于1,则第i行(从0开始计数)使用tailIndents[i]作为尾部缩进值。当文本行数超过size时,超出部分的行将复用tailIndents[size - 1]的值做缩进。 |
6104+| uint32_t size | tailIndents数组中有效尾部缩进值的个数。 |
6105+ 
6106+**返回:**
6107+ 
6108+| 类型 | 说明 |
6109+| -- | -- |
6110+| [ArkUI_ErrorCode](capi-native-type-h.md#arkui_errorcode) | 返回结果。<br> [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br> [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。 |
6111+ 
6112+ 
6113+### OH_ArkUI_ParagraphStyle_GetTailIndents()
6114+ 
6115+```c
6116+ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTailIndents(const OH_ArkUI_ParagraphStyle* paragraphStyle, float** tailIndents, uint32_t tailIndentsSize, uint32_t* writeLength)
6117+```
6118+ 
6119+**描述**
6120+ 
6121+获取段落样式的尾部缩进。
6122+ 
6123+> **说明:**
6124+>
6125+> 所有输入指针参数必须由调用者负责分配、管理和释放。
6126+ 
6127+**起始版本:** 26.0.0
6128+ 
6129+**参数:**
6130+ 
6131+| 参数项 | 描述 |
6132+| -- | -- |
6133+| [const OH_ArkUI_ParagraphStyle](capi-arkui-nativemodule-oh-arkui-paragraphstyle.md)* paragraphStyle | 指向[OH_ArkUI_ParagraphStyle](capi-arkui-nativemodule-oh-arkui-paragraphstyle.md)对象的指针。 |
6134+| float** tailIndents | 尾部缩进值,单位为vp。 |
6135+| uint32_t tailIndentsSize | tailIndents缓冲区大小。 |
6136+| uint32_t* writeLength | 实际写入缓冲区的尾部缩进值个数。 |
6137+ 
6138+**返回:**
6139+ 
6140+| 类型 | 说明 |
6141+| -- | -- |
6142+| [ArkUI_ErrorCode](capi-native-type-h.md#arkui_errorcode) | 返回结果。<br> [ARKUI_ERROR_CODE_NO_ERROR](capi-native-type-h.md#arkui_errorcode) 成功。<br> [ARKUI_ERROR_CODE_PARAM_INVALID](capi-native-type-h.md#arkui_errorcode) 函数参数异常。<br> [ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR](capi-native-type-h.md#arkui_errorcode) 缓冲区长度小于最小缓冲区长度。 |