Star904
5828
代码
代码
Issues937
Pull Requests1240
项目讨论
Wiki
分析
Star904
5828
已关闭
[richEditor]属性字符串CAPI接口文档 #131851
zzc19990127创建于 2月28日关闭于 3月17日
[richEditor]属性字符串CAPI接口文档 #131851
已关闭
zzc19990127创建于 2月28日关闭于 3月17日
从zzc19990127/docs_capicapi合入到openharmony/docsmaster
共 2 个文件变更+122-0
Mzh-cn/application-dev/reference/apis-arkui/capi-native-type-h.md+102-0
@@ -13617,3 +13617,105 @@ ArkUI_ErrorCode OH_ArkUI_PickerIndicatorStyle_ConfigureDivider(ArkUI_PickerIndic
13617| 类型 | 说明 |13617| 类型 | 说明 |
13618| -- | -- |13618| -- | -- |
13619| [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) 函数参数异常。 |13619| [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) 函数参数异常。 |
13620+ 
13621+### OH_ArkUI_TextEditorStyledStringController_GetSelection()
13622+
13623+ ```c
13624+ ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetSelection(
13625+ OH_ArkUI_TextEditorStyledStringController* controller, uint32_t* start, uint32_t* end)
13626+ ```
13627+ **描述：**
13628+
13629+ 获取带属性字符串控制器的文本编辑器的选中内容范围。
13630+
13631+ **起始版本：** 24
13632+
13633+ **参数：**
13634+
13635+ | 参数项 | 描述 |
13636+ | --- | --- |
13637+ | [OH_ArkUI_TextEditorStyledStringController](capi-arkui-nativemodule-oh-arkui-texteditorstyledstringcontroller.md)* controller | 属性字符串控制器。 |
13638+ | uint32_t* start | 选区内起始位置。 |
13639+ | uint32_t* end | 选区内结束位置。 |
13640+ 
13641+ **返回：**
13642+
13643+ | 类型 | 说明 |
13644+ | --- | --- |
13645+ | [ArkUI_ErrorCode](capi-arkui-nativemodule-arkui-errorcode.md) | 返回结果码。<br>操作成功时返回[ARKUI_ERROR_CODE_NO_ERROR](#arkui_errorcode)；<br>参数异常时返回[ARKUI_ERROR_CODE_PARAM_INVALID](#arkui_errorcode)。 |
13646+ 
13647+### OH_ArkUI_TextEditorStyledStringController_SetStyledString()
13648+
13649+ ```c
13650+ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetStyledString(
13651+ OH_ArkUI_TextEditorStyledStringController* controller, ArkUI_StyledString_Descriptor* descriptor)
13652+ ```
13653+ **描述：**
13654+
13655+ 设置文本编辑器的属性字符串。
13656+
13657+ **起始版本：** 24
13658+
13659+ **参数：**
13660+
13661+ | 参数项 | 描述 |
13662+ | --- | --- |
13663+ | [OH_ArkUI_TextEditorStyledStringController](capi-arkui-nativemodule-oh-arkui-texteditorstyledstringcontroller.md)* controller | 属性字符串控制器。 |
13664+ | ArkUI_StyledString_Descriptor* descriptor | 属性字符串。 |
13665+ 
13666+ **返回：**
13667+
13668+ | 类型 | 说明 |
13669+ | --- | --- |
13670+ | [ArkUI_ErrorCode](capi-arkui-nativemodule-arkui-errorcode.md) | 返回结果码。<br>操作成功时返回[ARKUI_ERROR_CODE_NO_ERROR](#arkui_errorcode)；<br>参数异常时返回[ARKUI_ERROR_CODE_PARAM_INVALID](#arkui_errorcode)。 |
13671+ 
13672+### OH_ArkUI_TextEditorStyledStringController_GetStyledString()
13673+
13674+ ```c
13675+ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_GetStyledString(
13676+ OH_ArkUI_TextEditorStyledStringController* controller, ArkUI_StyledString_Descriptor* descriptor)
13677+ ```
13678+ **描述：**
13679+
13680+ 获取文本编辑器的属性字符串。
13681+
13682+ **起始版本：** 24
13683+
13684+ **参数：**
13685+
13686+ | 参数项 | 描述 |
13687+ | --- | --- |
13688+ | [OH_ArkUI_TextEditorStyledStringController](capi-arkui-nativemodule-oh-arkui-texteditorstyledstringcontroller.md)* controller | 属性字符串控制器。 |
13689+ | ArkUI_StyledString_Descriptor* descriptor | 属性字符串。 |
13690+ 
13691+ **返回：**
13692+
13693+ | 类型 | 说明 |
13694+ | --- | --- |
13695+ | [ArkUI_ErrorCode](capi-arkui-nativemodule-arkui-errorcode.md) | 返回结果码。<br>操作成功时返回[ARKUI_ERROR_CODE_NO_ERROR](#arkui_errorcode)；<br>参数异常时返回[ARKUI_ERROR_CODE_PARAM_INVALID](#arkui_errorcode)。 |
13696+ 
13697+### OH_ArkUI_TextEditorStyledStringController_SetStyledPlaceholder()
13698+
13699+ ```c
13700+ ArkUI_ErrorCode OH_ArkUI_TextEditorStyledStringController_SetStyledPlaceholder(
13701+ OH_ArkUI_TextEditorStyledStringController* controller, ArkUI_StyledString_Descriptor* descriptor)
13702+ ```
13703+ **描述：**
13704+
13705+ 设置文本编辑器的属性字符串类型无输入时的提示文本。
13706+
13707+ **起始版本：** 24
13708+
13709+ **参数：**
13710+
13711+ | 参数项 | 描述 |
13712+ | --- | --- |
13713+ | [OH_ArkUI_TextEditorStyledStringController](capi-arkui-nativemodule-oh-arkui-texteditorstyledstringcontroller.md)* controller | 属性字符串控制器。 |
13714+ | ArkUI_StyledString_Descriptor* descriptor | 属性字符串。 |
13715+ 
13716+ **返回：**
13717+
13718+ | 类型 | 说明 |
13719+ | --- | --- |
13720+ | [ArkUI_ErrorCode](capi-arkui-nativemodule-arkui-errorcode.md) | 返回结果码。<br>操作成功时返回[ARKUI_ERROR_CODE_NO_ERROR](#arkui_errorcode)；<br>参数异常时返回[ARKUI_ERROR_CODE_PARAM_INVALID](#arkui_errorcode)。 |
13721+ 
Mzh-cn/application-dev/reference/apis-arkui/capi-styled-string-h.md+20-0
@@ -47,6 +47,26 @@
47| [int32_t OH_ArkUI_UnmarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor)](#oh_arkui_unmarshallstyledstringdescriptor) | 将包含属性字符串信息的字节数组反序列化为属性字符串。 |47| [int32_t OH_ArkUI_UnmarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor)](#oh_arkui_unmarshallstyledstringdescriptor) | 将包含属性字符串信息的字节数组反序列化为属性字符串。 |
48| [int32_t OH_ArkUI_MarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor, size_t* resultSize)](#oh_arkui_marshallstyledstringdescriptor) | 将属性字符串信息序列化为字节数组。 |48| [int32_t OH_ArkUI_MarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor, size_t* resultSize)](#oh_arkui_marshallstyledstringdescriptor) | 将属性字符串信息序列化为字节数组。 |
49| [const char* OH_ArkUI_ConvertToHtml(ArkUI_StyledString_Descriptor* descriptor)](#oh_arkui_converttohtml) | 将属性字符串信息转换成html。 |49| [const char* OH_ArkUI_ConvertToHtml(ArkUI_StyledString_Descriptor* descriptor)](#oh_arkui_converttohtml) | 将属性字符串信息转换成html。 |
50+| [ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithString(const char* value, const OH_ArkUI_SpanStyle** styles, int32_t length)] | 创建关于文本的ArkUI_StyledString_Descriptor对象。 |
51+| [ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithImageAttachment(OH_ArkUI_ImageAttachment* value)] | 创建关于图片的ArkUI_StyledString_Descriptor对象。 |
52+| [ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithCustomSpan(OH_ArkUI_CustomSpan* value)] | 创建关于自定义绘制Span的ArkUI_StyledString_Descriptor对象。 |
53+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetLength(ArkUI_StyledString_Descriptor* descriptor, int32_t* length)] | 获取属性字符串的字符长度。 |
54+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetString(ArkUI_StyledString_Descriptor* descriptor, char* buffer, int32_t bufferSize, int32_t* writeLength)] | 获取属性字符串的文本内容。 |
55+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_IsEqual(ArkUI_StyledString_Descriptor* firstDescriptor, ArkUI_StyledString_Descriptor* secondDescriptor, bool* isEqual)] | 判断两个属性字符串是否相等。 |
56+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_SubStyledString(ArkUI_StyledString_Descriptor* descriptor, ArkUI_StyledString_Descriptor* subDescriptor, uint32_t start, uint32_t length)] | 获取属性字符串的子属性字符串。 |
57+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetStyles(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, OH_ArkUI_StyledStringKey styledKey, OH_ArkUI_SpanStyle** styles, uint32_t stylesSize, uint32_t* writeLength)] | 获取属性字符串指定范围内的span样式。 |
58+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_FromHtml(ArkUI_StyledString_Descriptor* descriptor, const char* html)] | 从提供的HTML字符串中获取属性字符串。 |
59+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, const char* string)] | 替换属性字符串指定范围的字符串。 |
60+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InsertString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, const char* string)] | 在属性字符串的指定位置插入字符串。 |
61+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_RemoveString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length)] | 删除属性字符串指定范围的字符串。 |
62+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceStyle(ArkUI_StyledString_Descriptor* descriptor, const OH_ArkUI_SpanStyle* spanStyle)] | 替换属性字符串指定范围的span样式。 |
63+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_SetStyle(ArkUI_StyledString_Descriptor* descriptor, const OH_ArkUI_SpanStyle* spanStyle)] | 为属性字符串指定范围的字符串添加span样式。 |
64+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_RemoveStyle(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, OH_ArkUI_StyledStringKey styledKey)] | 从属性字符串的指定范围删除指定类型的span样式。 |
65+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ClearStyles(ArkUI_StyledString_Descriptor* descriptor)] | 清除属性字符串中的所有span样式。 |
66+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceStyledString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, ArkUI_StyledString_Descriptor* other)] | 替换指定范围的属性字符串。 |
67+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InsertStyledString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, ArkUI_StyledString_Descriptor* other)] | 在属性字符串的指定位置插入新的属性字符串。 |
68+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_AppendStyledString(ArkUI_StyledString_Descriptor* descriptor, ArkUI_StyledString_Descriptor* other)] | 在末尾追加新的属性字符串。 |
69+| [ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InvalidateCustomSpan(ArkUI_StyledString_Descriptor* descriptor)] | 使属性字符串中的自定义绘制Span绘制失效。 |
50| [void OH_ArkUI_TextLayoutManager_Dispose(ArkUI_TextLayoutManager* layoutManager)](#oh_arkui_textlayoutmanager_dispose) | 释放被文本布局管理器对象占据的内存。 |70| [void OH_ArkUI_TextLayoutManager_Dispose(ArkUI_TextLayoutManager* layoutManager)](#oh_arkui_textlayoutmanager_dispose) | 释放被文本布局管理器对象占据的内存。 |
51| [ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetLineCount(ArkUI_TextLayoutManager* layoutManager, int32_t* outLineCount)](#oh_arkui_textlayoutmanager_getlinecount) | 获取文本行数。 |71| [ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetLineCount(ArkUI_TextLayoutManager* layoutManager, int32_t* outLineCount)](#oh_arkui_textlayoutmanager_getlinecount) | 获取文本行数。 |
52| [ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetRectsForRange(ArkUI_TextLayoutManager* layoutManager, int32_t start, int32_t end, OH_Drawing_RectWidthStyle widthStyle, OH_Drawing_RectHeightStyle heightStyle, OH_Drawing_TextBox** outTextBoxes)](#oh_arkui_textlayoutmanager_getrectsforrange) | 获取给定的矩形区域宽度样式以及高度样式的规格下，文本中任意区间范围内的字符或占位符所占的绘制区域信息。 |72| [ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetRectsForRange(ArkUI_TextLayoutManager* layoutManager, int32_t start, int32_t end, OH_Drawing_RectWidthStyle widthStyle, OH_Drawing_RectHeightStyle heightStyle, OH_Drawing_TextBox** outTextBoxes)](#oh_arkui_textlayoutmanager_getrectsforrange) | 获取给定的矩形区域宽度样式以及高度样式的规格下，文本中任意区间范围内的字符或占位符所占的绘制区域信息。 |