• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# drawing_text_typography.h
2<!--Kit: ArkGraphics 2D-->
3<!--Subsystem: Graphics-->
4<!--Owner: @oh_wangxk; @gmiao522; @Lem0nC-->
5<!--Designer: @liumingxiang-->
6<!--Tester: @yhl0101-->
7<!--Adviser: @ge-yafang-->
8## 概述
9
10定义绘制模块中排版相关的函数。
11
12**引用文件:** <native_drawing/drawing_text_typography.h>
13
14**库:** libnative_drawing.so
15
16**起始版本:** 8
17
18**相关模块:** [Drawing](capi-drawing.md)
19
20## 汇总
21
22### 结构体
23
24| 名称 | typedef关键字 | 描述 |
25| -- | -- | -- |
26| [OH_Drawing_PlaceholderSpan](capi-drawing-oh-drawing-placeholderspan.md) | OH_Drawing_PlaceholderSpan | 用于描述占位符跨度的结构体。 |
27| [OH_Drawing_FontDescriptor](capi-drawing-oh-drawing-fontdescriptor.md) | OH_Drawing_FontDescriptor | 描述系统字体详细信息的结构体。 |
28| [OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md) | OH_Drawing_LineMetrics | 文字行位置信息。 |
29| [OH_Drawing_FontFallbackInfo](capi-drawing-oh-drawing-fontfallbackinfo.md) | OH_Drawing_FontFallbackInfo | 备用字体信息结构体。 |
30| [OH_Drawing_FontFallbackGroup](capi-drawing-oh-drawing-fontfallbackgroup.md) | OH_Drawing_FontFallbackGroup | 备用字体集信息结构体。 |
31| [OH_Drawing_FontAdjustInfo](capi-drawing-oh-drawing-fontadjustinfo.md) | OH_Drawing_FontAdjustInfo | 字重映射信息结构体。 |
32| [OH_Drawing_FontAliasInfo](capi-drawing-oh-drawing-fontaliasinfo.md) | OH_Drawing_FontAliasInfo | 别名字体信息结构体。 |
33| [OH_Drawing_FontGenericInfo](capi-drawing-oh-drawing-fontgenericinfo.md) | OH_Drawing_FontGenericInfo | 系统所支持的通用字体集信息结构体。 |
34| [OH_Drawing_FontConfigInfo](capi-drawing-oh-drawing-fontconfiginfo.md) | OH_Drawing_FontConfigInfo | 系统字体配置信息结构体。 |
35| [OH_Drawing_FontStyleStruct](capi-drawing-oh-drawing-fontstylestruct.md) | OH_Drawing_FontStyleStruct | 定义字体样式信息的结构体。 |
36| [OH_Drawing_FontFeature](capi-drawing-oh-drawing-fontfeature.md) | OH_Drawing_FontFeature | 描述文本字体特征结构体。 |
37| [OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md) | OH_Drawing_StrutStyle | 用于描述支柱样式的结构体。支柱样式用于控制绘制文本时行之间的间距、基线对齐方式以及其他与行高相关的属性。 |
38
39### 枚举
40
41| 名称 | typedef关键字 | 描述 |
42| -- | -- | -- |
43| [OH_Drawing_TextDirection](#oh_drawing_textdirection) | - | 文字方向。 |
44| [OH_Drawing_TextAlign](#oh_drawing_textalign) | - | 文字对齐方式。|
45| [OH_Drawing_FontWeight](#oh_drawing_fontweight) | - | 字重。 |
46| [OH_Drawing_TextBaseline](#oh_drawing_textbaseline) | - | 基线位置。 |
47| [OH_Drawing_TextDecoration](#oh_drawing_textdecoration) | - | 文本装饰。 |
48| [OH_Drawing_FontStyle](#oh_drawing_fontstyle) | - | 区分字体是否为斜体。 |
49| [OH_Drawing_PlaceholderVerticalAlignment](#oh_drawing_placeholderverticalalignment) | OH_Drawing_PlaceholderVerticalAlignment | 占位符垂直对齐枚举。 |
50| [OH_Drawing_TextDecorationStyle](#oh_drawing_textdecorationstyle) | OH_Drawing_TextDecorationStyle | 文本装饰样式枚举。 |
51| [OH_Drawing_EllipsisModal](#oh_drawing_ellipsismodal) | OH_Drawing_EllipsisModal | 省略号样式枚举。 |
52| [OH_Drawing_BreakStrategy](#oh_drawing_breakstrategy) | OH_Drawing_BreakStrategy | 文本的中断策略枚举。 |
53| [OH_Drawing_WordBreakType](#oh_drawing_wordbreaktype) | OH_Drawing_WordBreakType | 单词的断词方式枚举。 |
54| [OH_Drawing_RectHeightStyle](#oh_drawing_rectheightstyle) | OH_Drawing_RectHeightStyle | 矩形框高度样式枚举。 |
55| [OH_Drawing_RectWidthStyle](#oh_drawing_rectwidthstyle) | OH_Drawing_RectWidthStyle | 矩形框宽度样式枚举。 |
56| [OH_Drawing_TextBadgeType](#oh_drawing_textbadgetype) | OH_Drawing_TextBadgeType | 上下标样式枚举。 |
57| [OH_Drawing_FontConfigInfoErrorCode](#oh_drawing_fontconfiginfoerrorcode) | - | 获取系统字体配置信息列表结果枚举。 |
58| [OH_Drawing_FontWidth](#oh_drawing_fontwidth) | - | 字体宽度的枚举。 |
59| [OH_Drawing_TextHeightBehavior](#oh_drawing_textheightbehavior) | - | 文本高度修饰符模式枚举。 |
60| [OH_Drawing_TextStyleType](#oh_drawing_textstyletype) | - | 文本样式类型枚举。 |
61| [OH_Drawing_TextVerticalAlignment](#oh_drawing_textverticalalignment) | OH_Drawing_TextVerticalAlignment | 垂直对齐方式枚举。 |
62
63### 函数
64
65| 名称 | 描述 |
66| -- | -- |
67| [OH_Drawing_TypographyStyle* OH_Drawing_CreateTypographyStyle(void)](#oh_drawing_createtypographystyle) | 创建指向OH_Drawing_TypographyStyle对象的指针。不再需要[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)时,请使用[OH_Drawing_DestroyTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_destroytypographystyle)接口释放该对象的指针。 |
68| [void OH_Drawing_DestroyTypographyStyle(OH_Drawing_TypographyStyle* style)](#oh_drawing_destroytypographystyle) | 释放被OH_Drawing_TypographyStyle对象占据的内存。 |
69| [void OH_Drawing_SetTypographyTextDirection(OH_Drawing_TypographyStyle* style, int direction)](#oh_drawing_settypographytextdirection) | 设置指定排版样式中的文本方向。 |
70| [void OH_Drawing_SetTypographyTextAlign(OH_Drawing_TypographyStyle* style, int align)](#oh_drawing_settypographytextalign) | 设置文本对齐方式。 |
71| [int OH_Drawing_TypographyGetEffectiveAlignment(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographygeteffectivealignment) | 获取文字对齐方式。 |
72| [void OH_Drawing_SetTypographyTextMaxLines(OH_Drawing_TypographyStyle* style, int lineNumber)](#oh_drawing_settypographytextmaxlines) | 设置文本最大行数。 |
73| [OH_Drawing_TextStyle* OH_Drawing_CreateTextStyle(void)](#oh_drawing_createtextstyle) | 创建指向OH_Drawing_TextStyle对象的指针。 |
74| [OH_Drawing_TextStyle* OH_Drawing_TypographyGetTextStyle(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographygettextstyle) | 获取指定排版样式中设置的默认文本样式。 |
75| [void OH_Drawing_DestroyTextStyle(OH_Drawing_TextStyle* style)](#oh_drawing_destroytextstyle) | 释放被OH_Drawing_TextStyle对象占据的内存。 |
76| [void OH_Drawing_SetTextStyleColor(OH_Drawing_TextStyle* style, uint32_t color)](#oh_drawing_settextstylecolor) | 设置文本颜色。 |
77| [void OH_Drawing_SetTextStyleFontSize(OH_Drawing_TextStyle* style, double fontSize)](#oh_drawing_settextstylefontsize) | 设置字号。 |
78| [void OH_Drawing_SetTextStyleFontWeight(OH_Drawing_TextStyle* style, int fontWeight)](#oh_drawing_settextstylefontweight) | 设置字重。目前只有系统默认字体支持字重的调节,其他字体设置字重值小于semi-bold时字体粗细无变化,当设置字重值大于等于semi-bold时可能会触发伪加粗效果。 |
79| [void OH_Drawing_SetTextStyleBaseLine(OH_Drawing_TextStyle* style, int baseline)](#oh_drawing_settextstylebaseline) | 设置文本样式的字体基线位置。 |
80| [void OH_Drawing_SetTextStyleDecoration(OH_Drawing_TextStyle* style, int decoration)](#oh_drawing_settextstyledecoration) | 设置指定文本样式中的装饰线类型,只能设置一个装饰线类型,添加多个需要使用[OH_Drawing_AddTextStyleDecoration](capi-drawing-text-typography-h.md#oh_drawing_addtextstyledecoration)。 |
81| [void OH_Drawing_AddTextStyleDecoration(OH_Drawing_TextStyle* style, int decoration)](#oh_drawing_addtextstyledecoration) | 新增指定装饰,可同时显示多种装饰线。 |
82| [void OH_Drawing_RemoveTextStyleDecoration(OH_Drawing_TextStyle* style, int decoration)](#oh_drawing_removetextstyledecoration) | 删除指定装饰。 |
83| [void OH_Drawing_SetTextStyleDecorationColor(OH_Drawing_TextStyle* style, uint32_t color)](#oh_drawing_settextstyledecorationcolor) | 设置指定文本样式中的装饰线颜色。如果不调用该接口或者设置color为0时,装饰线颜色跟随文本颜色。 |
84| [void OH_Drawing_SetTextStyleFontHeight(OH_Drawing_TextStyle* style, double fontHeight)](#oh_drawing_settextstylefontheight) | 设置行高,按当前字体大小的倍数进行设置。 |
85| [void OH_Drawing_SetTextStyleFontFamilies(OH_Drawing_TextStyle* style,int fontFamiliesNumber, const char* fontFamilies[])](#oh_drawing_settextstylefontfamilies) | 设置指定文本样式的字体家族类型。 |
86| [void OH_Drawing_SetTextStyleFontStyle(OH_Drawing_TextStyle* style, int fontStyle)](#oh_drawing_settextstylefontstyle) | 为指定文本样式设置字体样式。 |
87| [void OH_Drawing_SetTextStyleLocale(OH_Drawing_TextStyle* style, const char* locale)](#oh_drawing_settextstylelocale) | 设置文本语言环境。 |
88| [void OH_Drawing_SetTextStyleForegroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* foregroundBrush)](#oh_drawing_settextstyleforegroundbrush) | 设置指定文本样式中的前景色画刷。 |
89| [void OH_Drawing_TextStyleGetForegroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* foregroundBrush)](#oh_drawing_textstylegetforegroundbrush) | 返回设置的前景色画刷。 |
90| [void OH_Drawing_SetTextStyleForegroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* foregroundPen)](#oh_drawing_settextstyleforegroundpen) | 设置指定文本样式中的前景色画笔。 |
91| [void OH_Drawing_TextStyleGetForegroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* foregroundPen)](#oh_drawing_textstylegetforegroundpen) | 返回设置的前景色画笔。 |
92| [void OH_Drawing_SetTextStyleBackgroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* backgroundBrush)](#oh_drawing_settextstylebackgroundbrush) | 设置指定文本样式中的背景色画刷。 |
93| [void OH_Drawing_TextStyleGetBackgroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* backgroundBrush)](#oh_drawing_textstylegetbackgroundbrush) | 返回设置的背景色画刷。 |
94| [void OH_Drawing_SetTextStyleBackgroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* backgroundPen)](#oh_drawing_settextstylebackgroundpen) | 设置指定文本样式中的背景色画笔。 |
95| [void OH_Drawing_TextStyleGetBackgroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* backgroundPen)](#oh_drawing_textstylegetbackgroundpen) | 返回设置的背景色画笔。 |
96| [OH_Drawing_TypographyCreate* OH_Drawing_CreateTypographyHandler(OH_Drawing_TypographyStyle* style,OH_Drawing_FontCollection* fontCollection)](#oh_drawing_createtypographyhandler) | 创建指向OH_Drawing_TypographyCreate对象的指针。不再需要[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)时,请使用[OH_Drawing_DestroyTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_destroytypographyhandler)接口释放该对象的指针。 |
97| [void OH_Drawing_DestroyTypographyHandler(OH_Drawing_TypographyCreate* handler)](#oh_drawing_destroytypographyhandler) | 释放被OH_Drawing_TypographyCreate对象占据的内存。 |
98| [void OH_Drawing_TypographyHandlerPushTextStyle(OH_Drawing_TypographyCreate* handler, OH_Drawing_TextStyle* style)](#oh_drawing_typographyhandlerpushtextstyle) | 将指定文本样式压入文本样式栈,后续添加的文本总是会使用栈顶的文本样式。 |
99| [void OH_Drawing_TypographyHandlerAddText(OH_Drawing_TypographyCreate* handler, const char* text)](#oh_drawing_typographyhandleraddtext) | 设置文本内容。 |
100| [void OH_Drawing_TypographyHandlerPopTextStyle(OH_Drawing_TypographyCreate* handler)](#oh_drawing_typographyhandlerpoptextstyle) | 从文本样式栈中弹出栈顶文本样式。 |
101| [OH_Drawing_Typography* OH_Drawing_CreateTypography(OH_Drawing_TypographyCreate* handler)](#oh_drawing_createtypography) | 创建指向OH_Drawing_Typography对象的指针。不再需要[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)时,请使用[OH_Drawing_DestroyTypography](capi-drawing-text-typography-h.md#oh_drawing_destroytypography)接口释放该对象的指针。 |
102| [void OH_Drawing_DestroyTypography(OH_Drawing_Typography* typography)](#oh_drawing_destroytypography) | 释放OH_Drawing_Typography对象占据的内存。 |
103| [void OH_Drawing_TypographyLayout(OH_Drawing_Typography* typography, double maxWidth)](#oh_drawing_typographylayout) | 排版布局。 |
104| [void OH_Drawing_TypographyPaint(OH_Drawing_Typography* typography, OH_Drawing_Canvas* canvas,double positionX, double positionY)](#oh_drawing_typographypaint) | 在指定位置绘制文本,从左上角开始绘制,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用并生效之后调用。 |
105| [void OH_Drawing_TypographyPaintOnPath(OH_Drawing_Typography* typography, OH_Drawing_Canvas* canvas,OH_Drawing_Path* path, double hOffset, double vOffset)](#oh_drawing_typographypaintonpath) | 沿指定路径绘制文本。建议搭配[OH_Drawing_SetTypographyTextMaxLines](capi-drawing-text-typography-h.md#oh_drawing_settypographytextmaxlines)接口设置最大行为1行,避免因文本宽度超过排版宽度出现跨行重叠问题。 |
106| [double OH_Drawing_TypographyGetMaxWidth(OH_Drawing_Typography* typography)](#oh_drawing_typographygetmaxwidth) | 获取用户设置的排版宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
107| [double OH_Drawing_TypographyGetHeight(OH_Drawing_Typography* typography)](#oh_drawing_typographygetheight) | 获取排版对象整体的高度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
108| [double OH_Drawing_TypographyGetLongestLine(OH_Drawing_Typography* typography)](#oh_drawing_typographygetlongestline) | 获取排版对象最长行的宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,建议实际使用时将返回值向上取整。当文本内容为空时,返回0.0。 |
109| [double OH_Drawing_TypographyGetLongestLineWithIndent(OH_Drawing_Typography* typography)](#oh_drawing_typographygetlongestlinewithindent) | 获取排版对象最长行的宽度(该宽度包含当前行缩进的宽度),该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,建议实际使用时将返回值向上取整。当文本内容为空时,返回0.0。 |
110| [double OH_Drawing_TypographyGetMinIntrinsicWidth(OH_Drawing_Typography* typography)](#oh_drawing_typographygetminintrinsicwidth) | 获取排版对象的最小固有宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
111| [double OH_Drawing_TypographyGetMaxIntrinsicWidth(OH_Drawing_Typography* typography)](#oh_drawing_typographygetmaxintrinsicwidth) | 获取排版对象的最大固有宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
112| [double OH_Drawing_TypographyGetAlphabeticBaseline(OH_Drawing_Typography* typography)](#oh_drawing_typographygetalphabeticbaseline) | 获取排版样式字母文字基线。 |
113| [double OH_Drawing_TypographyGetIdeographicBaseline(OH_Drawing_Typography* typography)](#oh_drawing_typographygetideographicbaseline) | 获取排版样式表意文字基线。 |
114| [void OH_Drawing_TypographyHandlerAddPlaceholder(OH_Drawing_TypographyCreate* handler,OH_Drawing_PlaceholderSpan* span)](#oh_drawing_typographyhandleraddplaceholder) | 设置占位符。 |
115| [bool OH_Drawing_TypographyDidExceedMaxLines(OH_Drawing_Typography* typography)](#oh_drawing_typographydidexceedmaxlines) | 获取排版对象中文本是否超过最大行,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,如果没有通过[OH_Drawing_SetTypographyTextMaxLines](capi-drawing-text-typography-h.md#oh_drawing_settypographytextmaxlines)接口设置最大行,则返回false。 |
116| [OH_Drawing_TextBox* OH_Drawing_TypographyGetRectsForRange(OH_Drawing_Typography* typography,size_t start, size_t end, OH_Drawing_RectHeightStyle heightStyle, OH_Drawing_RectWidthStyle widthStyle)](#oh_drawing_typographygetrectsforrange) | 获取排版对象中指定范围内的文本框,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。不再需要[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)时,请使用[OH_Drawing_TypographyDestroyTextBox](capi-drawing-text-typography-h.md#oh_drawing_typographydestroytextbox)接口释放该对象的指针。 |
117| [OH_Drawing_TextBox* OH_Drawing_TypographyGetRectsForPlaceholders(OH_Drawing_Typography* typography)](#oh_drawing_typographygetrectsforplaceholders) | 获取排版对象中占位符的文本框,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。不再需要[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)时,请使用[OH_Drawing_TypographyDestroyTextBox](capi-drawing-text-typography-h.md#oh_drawing_typographydestroytextbox)接口释放该对象的指针。 |
118| [float OH_Drawing_GetLeftFromTextBox(OH_Drawing_TextBox* textbox, int index)](#oh_drawing_getleftfromtextbox) | 获取文本框左侧位置。 |
119| [float OH_Drawing_GetRightFromTextBox(OH_Drawing_TextBox* textbox, int index)](#oh_drawing_getrightfromtextbox) | 获取文本框右侧位置。 |
120| [float OH_Drawing_GetTopFromTextBox(OH_Drawing_TextBox* textbox, int index)](#oh_drawing_gettopfromtextbox) | 获取文本框顶部位置。 |
121| [float OH_Drawing_GetBottomFromTextBox(OH_Drawing_TextBox* textbox, int index)](#oh_drawing_getbottomfromtextbox) | 获取文本框底部位置。 |
122| [int OH_Drawing_GetTextDirectionFromTextBox(OH_Drawing_TextBox* textbox, int index)](#oh_drawing_gettextdirectionfromtextbox) | 获取文本框方向。 |
123| [size_t OH_Drawing_GetSizeOfTextBox(OH_Drawing_TextBox* textBox)](#oh_drawing_getsizeoftextbox) | 获取文本框数量大小。 |
124| [OH_Drawing_PositionAndAffinity* OH_Drawing_TypographyGetGlyphPositionAtCoordinate(OH_Drawing_Typography* typography,double dx, double dy)](#oh_drawing_typographygetglyphpositionatcoordinate) | 获取坐标处文本的索引位置和亲和性。 |
125| [OH_Drawing_PositionAndAffinity* OH_Drawing_TypographyGetGlyphPositionAtCoordinateWithCluster(OH_Drawing_Typography* typography, double dx, double dy)](#oh_drawing_typographygetglyphpositionatcoordinatewithcluster) | 获取坐标处文本所属字符簇的索引位置和亲和性,字符簇指一个或多个字符组成的整体。 |
126| [size_t OH_Drawing_GetPositionFromPositionAndAffinity(OH_Drawing_PositionAndAffinity* positionAndAffinity)](#oh_drawing_getpositionfrompositionandaffinity) | 获取OH_Drawing_PositionAndAffinity对象的位置属性。 |
127| [int OH_Drawing_GetAffinityFromPositionAndAffinity(OH_Drawing_PositionAndAffinity* positionAndAffinity)](#oh_drawing_getaffinityfrompositionandaffinity) | 获取OH_Drawing_PositionAndAffinity对象的亲和性,根据亲和性可判断字体会靠近前方文本还是后方文本。 |
128| [OH_Drawing_Range* OH_Drawing_TypographyGetWordBoundary(OH_Drawing_Typography* typography, size_t offset)](#oh_drawing_typographygetwordboundary) | 获取排版对象中单词的边界。 |
129| [size_t OH_Drawing_GetStartFromRange(OH_Drawing_Range* range)](#oh_drawing_getstartfromrange) | 获取OH_Drawing_Range对象开始位置。 |
130| [size_t OH_Drawing_GetEndFromRange(OH_Drawing_Range* range)](#oh_drawing_getendfromrange) | 获取OH_Drawing_Range对象结束位置。 |
131| [size_t OH_Drawing_TypographyGetLineCount(OH_Drawing_Typography* typography)](#oh_drawing_typographygetlinecount) | 获取排版对象中文本行数,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
132| [void OH_Drawing_SetTextStyleDecorationStyle(OH_Drawing_TextStyle* style, int decorationStyle)](#oh_drawing_settextstyledecorationstyle) | 设置指定文本样式中的装饰线样式。 |
133| [void OH_Drawing_SetTextStyleDecorationThicknessScale(OH_Drawing_TextStyle* style, double decorationThicknessScale)](#oh_drawing_settextstyledecorationthicknessscale) | 设置文本装饰线的粗细缩放比例。 |
134| [void OH_Drawing_SetTextStyleLetterSpacing(OH_Drawing_TextStyle* style, double letterSpacing)](#oh_drawing_settextstyleletterspacing) | 设置文本的字符间距。 |
135| [void OH_Drawing_SetTextStyleWordSpacing(OH_Drawing_TextStyle* style, double wordSpacing)](#oh_drawing_settextstylewordspacing) | 设置文本的单词间距。 |
136| [void OH_Drawing_SetTextStyleHalfLeading(OH_Drawing_TextStyle* style, bool halfLeading)](#oh_drawing_settextstylehalfleading) | 设置文本为一半行间距。 |
137| [void OH_Drawing_SetTextStyleEllipsis(OH_Drawing_TextStyle* style, const char* ellipsis)](#oh_drawing_settextstyleellipsis) | 设置文本的省略号内容。 |
138| [void OH_Drawing_SetTextStyleEllipsisModal(OH_Drawing_TextStyle* style, int ellipsisModal)](#oh_drawing_settextstyleellipsismodal) | 设置文本的省略号样式。 |
139| [void OH_Drawing_SetTypographyTextBreakStrategy(OH_Drawing_TypographyStyle* style, int breakStrategy)](#oh_drawing_settypographytextbreakstrategy) | 设置文本的中断策略。 |
140| [void OH_Drawing_SetTypographyTextWordBreakType(OH_Drawing_TypographyStyle* style, int wordBreakType)](#oh_drawing_settypographytextwordbreaktype) | 设置单词的断词方式。 |
141| [void OH_Drawing_SetTypographyTextEllipsisModal(OH_Drawing_TypographyStyle* style, int ellipsisModal)](#oh_drawing_settypographytextellipsismodal) | 设置文本的省略模式。 |
142| [void OH_Drawing_SetTypographyTextEllipsis(OH_Drawing_TypographyStyle* style, const char* ellipsis)](#oh_drawing_settypographytextellipsis) | 设置排版样式省略号文本。 |
143| [double OH_Drawing_TypographyGetLineHeight(OH_Drawing_Typography* typography, int lineNumber)](#oh_drawing_typographygetlineheight) | 获取排版对象中指定行的行高,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
144| [double OH_Drawing_TypographyGetLineWidth(OH_Drawing_Typography* typography, int lineNumber)](#oh_drawing_typographygetlinewidth) | 获取指定行的行宽,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
145| [void OH_Drawing_SetTypographyTextSplitRatio(OH_Drawing_TypographyStyle* style, float textSplitRatio)](#oh_drawing_settypographytextsplitratio) | 设置文本划分比率。 |
146| [bool OH_Drawing_TypographyIsLineUnlimited(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographyislineunlimited) | 获取文本是否有最大行数限制。 |
147| [bool OH_Drawing_TypographyIsEllipsized(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographyisellipsized) | 获取指定排版样式是否配置省略号。 |
148| [void OH_Drawing_SetTypographyTextLocale(OH_Drawing_TypographyStyle* style, const char* locale)](#oh_drawing_settypographytextlocale) | 设置指定排版样式的语言环境。 |
149| [bool OH_Drawing_TextStyleGetFontMetrics(OH_Drawing_Typography* typography,OH_Drawing_TextStyle* style, OH_Drawing_Font_Metrics* fontmetrics)](#oh_drawing_textstylegetfontmetrics) | 获取文本字体属性。 |
150| [void OH_Drawing_SetTypographyTextStyle(OH_Drawing_TypographyStyle* handler, OH_Drawing_TextStyle* style)](#oh_drawing_settypographytextstyle) | 设置排版样式。 |
151| [OH_Drawing_FontDescriptor* OH_Drawing_CreateFontDescriptor(void)](#oh_drawing_createfontdescriptor) | 构造字体描述对象,用于描述系统字体详细信息。 |
152| [void OH_Drawing_DestroyFontDescriptor(OH_Drawing_FontDescriptor* descriptor)](#oh_drawing_destroyfontdescriptor) | 释放字体描述对象占用的内存。 |
153| [OH_Drawing_FontParser* OH_Drawing_CreateFontParser(void)](#oh_drawing_createfontparser) | 构造字体解析对象,用于解析系统字体。 |
154| [void OH_Drawing_DestroyFontParser(OH_Drawing_FontParser* parser)](#oh_drawing_destroyfontparser) | 释放字体解析对象占用的内存。 |
155| [char** OH_Drawing_FontParserGetSystemFontList(OH_Drawing_FontParser* fontParser, size_t* num)](#oh_drawing_fontparsergetsystemfontlist) | 获取系统字体名称列表,此接口仅在2in1、phone设备上可用。 |
156| [void OH_Drawing_DestroySystemFontList(char** fontList, size_t num)](#oh_drawing_destroysystemfontlist) | 释放系统字体名称列表占用的内存。 |
157| [OH_Drawing_FontDescriptor* OH_Drawing_FontParserGetFontByName(OH_Drawing_FontParser* fontParser, const char* name)](#oh_drawing_fontparsergetfontbyname) | 根据传入的系统字体名称获取系统字体的相关信息。 |
158| [OH_Drawing_LineMetrics* OH_Drawing_TypographyGetLineMetrics(OH_Drawing_Typography* typography)](#oh_drawing_typographygetlinemetrics) | 获取排版对象的行位置信息,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。不再需要[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)时,请使用[OH_Drawing_DestroyLineMetrics](capi-drawing-text-typography-h.md#oh_drawing_destroylinemetrics)接口释放该对象的指针。 |
159| [size_t OH_Drawing_LineMetricsGetSize(OH_Drawing_LineMetrics* lineMetrics)](#oh_drawing_linemetricsgetsize) | 获取行数量。 |
160| [void OH_Drawing_DestroyLineMetrics(OH_Drawing_LineMetrics* lineMetrics)](#oh_drawing_destroylinemetrics) | 释放行位置信息对象占用的内存。 |
161| [bool OH_Drawing_TypographyGetLineMetricsAt(OH_Drawing_Typography* typography,int lineNumber, OH_Drawing_LineMetrics* lineMetric)](#oh_drawing_typographygetlinemetricsat) | 获取排版对象的指定行位置信息,具体参见[OH_Drawing_LineMetr](capi-drawing-oh-drawing-linemetrics.md)结构体,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
162| [bool OH_Drawing_TypographyGetLineInfo(OH_Drawing_Typography* typography, int lineNumber, bool oneLine,bool includeWhitespace, OH_Drawing_LineMetrics* drawingLineMetrics)](#oh_drawing_typographygetlineinfo) | 获取排版对象中指定行的位置信息或指定行第一个字符的位置信息,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。 |
163| [void OH_Drawing_SetTypographyTextFontWeight(OH_Drawing_TypographyStyle* style, int weight)](#oh_drawing_settypographytextfontweight) | 设置排版样式默认字重。目前只有系统默认字体支持字重的调节,其他字体设置字重值小于semi-bold时字体粗细无变化,当设置字重值大于等于semi-bold时可能会触发伪加粗效果。 |
164| [void OH_Drawing_SetTypographyTextFontStyle(OH_Drawing_TypographyStyle* style, int fontStyle)](#oh_drawing_settypographytextfontstyle) | 设置排版样式默认的字体样式。 |
165| [void OH_Drawing_SetTypographyTextFontFamily(OH_Drawing_TypographyStyle* style, const char* fontFamily)](#oh_drawing_settypographytextfontfamily) | 设置字体家族的名称。 |
166| [void OH_Drawing_SetTypographyTextFontSize(OH_Drawing_TypographyStyle* style, double fontSize)](#oh_drawing_settypographytextfontsize) | 设置文本排版字号。 |
167| [void OH_Drawing_SetTypographyTextFontHeight(OH_Drawing_TypographyStyle* style, double fontHeight)](#oh_drawing_settypographytextfontheight) | 设置文本排版字体高度。 |
168| [void OH_Drawing_SetTypographyTextHalfLeading(OH_Drawing_TypographyStyle* style, bool halfLeading)](#oh_drawing_settypographytexthalfleading) | 设置文本排版是否为一半行间距。 |
169| [void OH_Drawing_SetTypographyTextUseLineStyle(OH_Drawing_TypographyStyle* style, bool useLineStyle)](#oh_drawing_settypographytextuselinestyle) | 设置文本排版是否启用行样式。 |
170| [void OH_Drawing_SetTypographyTextLineStyleFontWeight(OH_Drawing_TypographyStyle* style, int weight)](#oh_drawing_settypographytextlinestylefontweight) | 设置排版样式中支柱样式的文本样式字重。目前只有系统默认字体支持字重的调节,其他字体设置字重值小于semi-bold时字体粗细无变化,当设置字重值大于等于semi-bold时可能会触发伪加粗效果。 |
171| [void OH_Drawing_SetTypographyTextLineStyleFontStyle(OH_Drawing_TypographyStyle* style, int fontStyle)](#oh_drawing_settypographytextlinestylefontstyle) | 设置文本排版样式中支柱样式的字体样式。 |
172| [void OH_Drawing_SetTypographyTextLineStyleFontFamilies(OH_Drawing_TypographyStyle* style,int fontFamiliesNumber, const char* fontFamilies[])](#oh_drawing_settypographytextlinestylefontfamilies) | 设置文本排版行样式字体类型。 |
173| [void OH_Drawing_SetTypographyTextLineStyleFontSize(OH_Drawing_TypographyStyle* style, double lineStyleFontSize)](#oh_drawing_settypographytextlinestylefontsize) | 设置文本排版行样式字号。 |
174| [void OH_Drawing_SetTypographyTextLineStyleFontHeight(OH_Drawing_TypographyStyle* style, double lineStyleFontHeight)](#oh_drawing_settypographytextlinestylefontheight) | 设置文本排版行样式字体高度。 |
175| [void OH_Drawing_SetTypographyTextLineStyleHalfLeading(OH_Drawing_TypographyStyle* style, bool lineStyleHalfLeading)](#oh_drawing_settypographytextlinestylehalfleading) | 设置文本排版行样式是否为一半行间距。 |
176| [void OH_Drawing_SetTypographyTextLineStyleSpacingScale(OH_Drawing_TypographyStyle* style, double spacingScale)](#oh_drawing_settypographytextlinestylespacingscale) | 设置文本排版行样式间距比例。 |
177| [void OH_Drawing_SetTypographyTextLineStyleOnly(OH_Drawing_TypographyStyle* style, bool lineStyleOnly)](#oh_drawing_settypographytextlinestyleonly) | 设置文本排版是否仅启用行样式。 |
178| [OH_Drawing_TextShadow* OH_Drawing_CreateTextShadow(void)](#oh_drawing_createtextshadow) | 创建指向字体阴影对象的指针。不再需要[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)时,请使用[OH_Drawing_DestroyTextShadow](capi-drawing-text-typography-h.md#oh_drawing_destroytextshadow)接口释放该对象的指针。 |
179| [void OH_Drawing_DestroyTextShadow(OH_Drawing_TextShadow* shadow)](#oh_drawing_destroytextshadow) | 释放被字体阴影对象占据的内存。 |
180| [OH_Drawing_TextShadow* OH_Drawing_TextStyleGetShadows(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetshadows) | 获取字体阴影容器。不再需要[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)时,请使用[OH_Drawing_DestroyTextShadows](capi-drawing-text-typography-h.md#oh_drawing_destroytextshadows)接口释放该对象的指针。 |
181| [int OH_Drawing_TextStyleGetShadowCount(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetshadowcount) | 获取字体阴影容器的大小。 |
182| [void OH_Drawing_TextStyleAddShadow(OH_Drawing_TextStyle* style, const OH_Drawing_TextShadow* shadow)](#oh_drawing_textstyleaddshadow) | 字体阴影容器中添加字体阴影元素。 |
183| [void OH_Drawing_TextStyleClearShadows(OH_Drawing_TextStyle* style)](#oh_drawing_textstyleclearshadows) | 清除字体阴影容器中的所有元素。 |
184| [OH_Drawing_TextShadow* OH_Drawing_TextStyleGetShadowWithIndex(OH_Drawing_TextStyle* style, int index)](#oh_drawing_textstylegetshadowwithindex) | 根据下标获取字体阴影容器中的元素。 |
185| [void OH_Drawing_TypographySetIndents(OH_Drawing_Typography* typography, int indentsNumber, const float indents[])](#oh_drawing_typographysetindents) | 设置文本的排版缩进,不调用此接口默认文本无缩进。 |
186| [float OH_Drawing_TypographyGetIndentsWithIndex(OH_Drawing_Typography* typography, int index)](#oh_drawing_typographygetindentswithindex) | 根据行索引获取排版对象缩进容器中的元素,行索引从0开始。 |
187| [OH_Drawing_Range* OH_Drawing_TypographyGetLineTextRange(OH_Drawing_Typography* typography,int lineNumber, bool includeSpaces)](#oh_drawing_typographygetlinetextrange) | 获取排版对象中行的边界,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。该接口只能获取已有行的边界,即输入行索引从0开始,最大行索引为[OH_Drawing_TypographyGetLineCount](capi-drawing-text-typography-h.md#oh_drawing_typographygetlinecount) - 1。 |
188| [void OH_Drawing_DestroyTextShadows(OH_Drawing_TextShadow* shadow)](#oh_drawing_destroytextshadows) | 释放由被字体阴影对象OH_Drawing_TextShadow构成的vector占据的内存。 |
189| [OH_Drawing_FontConfigInfo* OH_Drawing_GetSystemFontConfigInfo(OH_Drawing_FontConfigInfoErrorCode* errorCode)](#oh_drawing_getsystemfontconfiginfo) | 获取系统字体配置信息。 |
190| [void OH_Drawing_DestroySystemFontConfigInfo(OH_Drawing_FontConfigInfo* drawFontCfgInfo)](#oh_drawing_destroysystemfontconfiginfo) | 释放系统字体配置信息占用的内存。 |
191| [void OH_Drawing_SetTextStyleFontStyleStruct(OH_Drawing_TextStyle* drawingTextStyle,OH_Drawing_FontStyleStruct fontStyle)](#oh_drawing_settextstylefontstylestruct) | 设置文本样式中的字体样式,包括字体字重、字体宽度和字体斜度。 |
192| [void OH_Drawing_SetTextStyleBadgeType(OH_Drawing_TextStyle* style, OH_Drawing_TextBadgeType textBadgeType)](#oh_drawing_settextstylebadgetype) | 设置文本排版时是否使能上标或下标。未调用此接口时,默认不使能。 |
193| [OH_Drawing_FontStyleStruct OH_Drawing_TextStyleGetFontStyleStruct(OH_Drawing_TextStyle* drawingTextStyle)](#oh_drawing_textstylegetfontstylestruct) | 获取文本样式中的字体样式,包括字体字重、字体宽度和字体斜度。 |
194| [void OH_Drawing_SetTypographyStyleFontStyleStruct(OH_Drawing_TypographyStyle* drawingStyle,OH_Drawing_FontStyleStruct fontStyle)](#oh_drawing_settypographystylefontstylestruct) | 设置排版样式中默认文本样式的字体样式,包括字体字重、字体宽度和字体斜度。 |
195| [OH_Drawing_FontStyleStruct OH_Drawing_TypographyStyleGetFontStyleStruct(OH_Drawing_TypographyStyle* drawingStyle)](#oh_drawing_typographystylegetfontstylestruct) | 获取排版样式中默认文本样式的字体样式,包括字体字重、字体宽度和字体斜度。 |
196| [void OH_Drawing_TextStyleSetBackgroundRect(OH_Drawing_TextStyle* style,const OH_Drawing_RectStyle_Info* rectStyleInfo, int styleId)](#oh_drawing_textstylesetbackgroundrect) | 设置文本背景矩形框和样式id。样式id仅当背景框为圆角矩形时有效。 |
197| [void OH_Drawing_TypographyHandlerAddSymbol(OH_Drawing_TypographyCreate* handler, uint32_t symbol)](#oh_drawing_typographyhandleraddsymbol) | 设置排版创建过程中的符号。 |
198| [void OH_Drawing_TextStyleAddFontFeature(OH_Drawing_TextStyle* style, const char* tag, int value)](#oh_drawing_textstyleaddfontfeature) | 设置文本样式中指定字体特征是否启用。 |
199| [void OH_Drawing_TextStyleAddFontVariation(OH_Drawing_TextStyle* style, const char* axis, const float value)](#oh_drawing_textstyleaddfontvariation) | 添加可变字体属性。对应的字体文件(.ttf文件)需要支持可变调节,此接口才能生效。当对应的字体不支持可变调节时,此接口调用不生效。 |
200| [OH_Drawing_FontFeature* OH_Drawing_TextStyleGetFontFeatures(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetfontfeatures) | 获取指定文本样式的字体特征map容器中所有内容。 |
201| [void OH_Drawing_TextStyleDestroyFontFeatures(OH_Drawing_FontFeature* fontFeature, size_t fontFeatureSize)](#oh_drawing_textstyledestroyfontfeatures) | 释放存放字体特征所有内容的结构体数组所占用的空间。 |
202| [size_t OH_Drawing_TextStyleGetFontFeatureSize(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetfontfeaturesize) | 获取指定文本样式中字体特征map容器的大小。 |
203| [void OH_Drawing_TextStyleClearFontFeature(OH_Drawing_TextStyle* style)](#oh_drawing_textstyleclearfontfeature) | 清除指定文本样式的字体特征map容器中所有内容。 |
204| [double OH_Drawing_TextStyleGetBaselineShift(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetbaselineshift) | 获取指定文本样式的基线偏移。 |
205| [void OH_Drawing_TextStyleSetBaselineShift(OH_Drawing_TextStyle* style, double lineShift)](#oh_drawing_textstylesetbaselineshift) | 设置文本样式基线偏移。 |
206| [void OH_Drawing_TypographyTextSetHeightBehavior(OH_Drawing_TypographyStyle* style,OH_Drawing_TextHeightBehavior heightMode)](#oh_drawing_typographytextsetheightbehavior) | 设置文本高度修饰符模式。 |
207| [OH_Drawing_TextHeightBehavior OH_Drawing_TypographyTextGetHeightBehavior(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextgetheightbehavior) | 获取文本高度修饰符模式。 |
208| [OH_Drawing_Font_Metrics* OH_Drawing_TypographyGetLineFontMetrics(OH_Drawing_Typography* typography,size_t lineNumber, size_t* fontMetricsSize)](#oh_drawing_typographygetlinefontmetrics) | 从排版对象中目标行获取所有字体度量信息,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,否则会返回空指针。不再需要[OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)时,请使用[OH_Drawing_TypographyDestroyLineFontMetrics](capi-drawing-text-typography-h.md#oh_drawing_typographydestroylinefontmetrics)接口释放该对象的指针。 |
209| [void OH_Drawing_TypographyDestroyLineFontMetrics(OH_Drawing_Font_Metrics* lineFontMetric)](#oh_drawing_typographydestroylinefontmetrics) | 释放指定行所有字体度量结构体集合所占用的所有空间。 |
210| [bool OH_Drawing_TextStyleIsEqual(const OH_Drawing_TextStyle* style, const OH_Drawing_TextStyle* comparedStyle)](#oh_drawing_textstyleisequal) | 判断两个文本样式对象是否相等,字宽属性不参与对比。 |
211| [bool OH_Drawing_TextStyleIsEqualByFont(const OH_Drawing_TextStyle* style, const OH_Drawing_TextStyle* comparedStyle)](#oh_drawing_textstyleisequalbyfont) | 判断两个文本样式对象的字体样式属性是否相等。 |
212| [bool OH_Drawing_TextStyleIsAttributeMatched(const OH_Drawing_TextStyle* style,const OH_Drawing_TextStyle* comparedStyle, OH_Drawing_TextStyleType textStyleType)](#oh_drawing_textstyleisattributematched) | 判断两个文本样式对象是否有一样的字体样式类型。 |
213| [void OH_Drawing_TextStyleSetPlaceholder(OH_Drawing_TextStyle* style)](#oh_drawing_textstylesetplaceholder) | 设置占位符。 |
214| [bool OH_Drawing_TextStyleIsPlaceholder(OH_Drawing_TextStyle* style)](#oh_drawing_textstyleisplaceholder) | 返回是否有设置文本占位符。 |
215| [OH_Drawing_TextAlign OH_Drawing_TypographyStyleGetEffectiveAlignment(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographystylegeteffectivealignment) | 获取文本对齐模式。 |
216| [bool OH_Drawing_TypographyStyleIsHintEnabled(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographystyleishintenabled) | 获取文本是否启用字形轮廓自动调整,字形轮廓自动调整用于在渲染小字号文本时改善其可读性和外观。 |
217| [void OH_Drawing_SetTypographyStyleTextStrutStyle(OH_Drawing_TypographyStyle* style, OH_Drawing_StrutStyle* strutstyle)](#oh_drawing_settypographystyletextstrutstyle) | 设置文本支柱样式。 |
218| [OH_Drawing_StrutStyle* OH_Drawing_TypographyStyleGetStrutStyle(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographystylegetstrutstyle) | 获取文本支柱样式。 |
219| [void OH_Drawing_TypographyStyleDestroyStrutStyle(OH_Drawing_StrutStyle* strutstyle)](#oh_drawing_typographystyledestroystrutstyle) | 释放被支柱样式对象占据的内存。 |
220| [bool OH_Drawing_TypographyStyleStrutStyleEquals(OH_Drawing_StrutStyle* from, OH_Drawing_StrutStyle* to)](#oh_drawing_typographystylestrutstyleequals) | 判断支柱样式结构体是否相同。 |
221| [void OH_Drawing_TypographyStyleSetHintsEnabled(OH_Drawing_TypographyStyle* style, bool hintsEnabled)](#oh_drawing_typographystylesethintsenabled) | 设置文本是否启用字形轮廓自动调整,字形轮廓自动调整用于在渲染小字号文本时改善其可读性和外观。 |
222| [void  OH_Drawing_TypographyMarkDirty(OH_Drawing_Typography* typography)](#oh_drawing_typographymarkdirty) | 将排版标记为脏数据,用于初始化排版状态。 |
223| [int32_t OH_Drawing_TypographyGetUnresolvedGlyphsCount(OH_Drawing_Typography* typography)](#oh_drawing_typographygetunresolvedglyphscount) | 获取文本中尚未解析的字形的数量,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用并生效之后调用。 |
224| [void OH_Drawing_TypographyUpdateFontSize(OH_Drawing_Typography* typography, size_t from, size_t to, float fontSize)](#oh_drawing_typographyupdatefontsize) | 更新排版对象中的字体大小。 |
225| [void OH_Drawing_TypographyUpdateFontColor(OH_Drawing_Typography* typography, uint32_t color)](#oh_drawing_typographyupdatefontcolor) | 更新排版对象中的字体颜色。如果当前装饰线未设置颜色,使用该接口也会同时更新装饰线的颜色。使用该接口更新字体颜色属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。 |
226| [void OH_Drawing_TypographyUpdateDecoration(OH_Drawing_Typography* typography, OH_Drawing_TextDecoration decoration)](#oh_drawing_typographyupdatedecoration) | 更新排版对象中的文本装饰线类型。使用该接口更新文本装饰线类型属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。 |
227| [void OH_Drawing_TypographyUpdateDecorationThicknessScale(OH_Drawing_Typography* typography,double decorationThicknessScale)](#oh_drawing_typographyupdatedecorationthicknessscale) | 更新排版对象中的文本装饰线的粗细缩放比例。使用该接口更新文本装饰线粗细缩放比例属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。 |
228| [void OH_Drawing_TypographyUpdateDecorationStyle(OH_Drawing_Typography* typography,OH_Drawing_TextDecorationStyle decorationStyle)](#oh_drawing_typographyupdatedecorationstyle) | 更新排版对象中的文本装饰线样式。使用该接口更新文本装饰线样式属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。 |
229| [bool OH_Drawing_TypographyTextGetLineStyle(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextgetlinestyle) | 获取文本排版是否启用行样式。 |
230| [OH_Drawing_FontWeight OH_Drawing_TypographyTextlineStyleGetFontWeight(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegetfontweight) | 获取文本排版行样式字重。 |
231| [OH_Drawing_FontStyle OH_Drawing_TypographyTextlineStyleGetFontStyle(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegetfontstyle) | 获取文本排版样式中支柱样式的字体样式。 |
232| [char** OH_Drawing_TypographyTextlineStyleGetFontFamilies(OH_Drawing_TypographyStyle* style, size_t* num)](#oh_drawing_typographytextlinestylegetfontfamilies) | 获取文本排版行样式字体家族名。 |
233| [void OH_Drawing_TypographyTextlineStyleDestroyFontFamilies(char** fontFamilies, size_t fontFamiliesNum)](#oh_drawing_typographytextlinestyledestroyfontfamilies) | 释放字体类型占用的内存。 |
234| [double OH_Drawing_TypographyTextlineStyleGetFontSize(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegetfontsize) | 获取文本排版行样式字号。 |
235| [double OH_Drawing_TypographyTextlineStyleGetHeightScale(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegetheightscale) | 获取文本排版行样式的行高缩放系数。 |
236| [bool OH_Drawing_TypographyTextlineStyleGetHeightOnly(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegetheightonly) | 获取字体渲染过程中计算字体块高度相关参数的方法。 |
237| [bool OH_Drawing_TypographyTextlineStyleGetHalfLeading(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegethalfleading) | 获取文本排版行样式是否为一半行间距。 |
238| [double OH_Drawing_TypographyTextlineStyleGetSpacingScale(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinestylegetspacingscale) | 获取文本排版行样式间距比例。 |
239| [bool OH_Drawing_TypographyTextlineGetStyleOnly(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographytextlinegetstyleonly) | 获取文本排版是否仅启用行样式。 |
240| [OH_Drawing_TextAlign OH_Drawing_TypographyGetTextAlign(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographygettextalign) | 获取文本对齐方式。 |
241| [OH_Drawing_TextDirection OH_Drawing_TypographyGetTextDirection(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographygettextdirection) | 获取指定排版样式中的文本方向。 |
242| [size_t OH_Drawing_TypographyGetTextMaxLines(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographygettextmaxlines) | 获取文本的最大行数。 |
243| [char* OH_Drawing_TypographyGetTextEllipsis(OH_Drawing_TypographyStyle* style)](#oh_drawing_typographygettextellipsis) | 获取指定排版样式设置的省略号文本。 |
244| [void OH_Drawing_TypographyDestroyEllipsis(char* ellipsis)](#oh_drawing_typographydestroyellipsis) | 释放省略号名称列表占用的内存。 |
245| [bool OH_Drawing_TypographyStyleEquals(OH_Drawing_TypographyStyle* from, OH_Drawing_TypographyStyle* to)](#oh_drawing_typographystyleequals) | 判断排版样式是否相同,当前文本高度修饰符模式[OH_Drawing_TextHeightBehavior](capi-drawing-text-typography-h.md#oh_drawing_textheightbehavior)没有被纳入比较。 |
246| [uint32_t OH_Drawing_TextStyleGetColor(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetcolor) | 获取文本颜色。 |
247| [OH_Drawing_TextDecorationStyle OH_Drawing_TextStyleGetDecorationStyle(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetdecorationstyle) | 获取文本装饰样式。 |
248| [OH_Drawing_FontWeight OH_Drawing_TextStyleGetFontWeight(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetfontweight) | 获取字重。 |
249| [OH_Drawing_FontStyle OH_Drawing_TextStyleGetFontStyle(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetfontstyle) | 获取指定文本样式的字体样式。 |
250| [OH_Drawing_TextBaseline OH_Drawing_TextStyleGetBaseline(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetbaseline) | 获取指定文本样式的字体基线位置。 |
251| [char** OH_Drawing_TextStyleGetFontFamilies(OH_Drawing_TextStyle* style, size_t* num)](#oh_drawing_textstylegetfontfamilies) | 获取字体类型名称列表。 |
252| [void OH_Drawing_TextStyleDestroyFontFamilies(char** fontFamilies, size_t num)](#oh_drawing_textstyledestroyfontfamilies) | 释放长度为num的字体家族名称列表占用的内存。 |
253| [double OH_Drawing_TextStyleGetFontSize(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetfontsize) | 获取指定文本样式字号。 |
254| [double OH_Drawing_TextStyleGetLetterSpacing(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetletterspacing) | 获取指定文本样式的字符间距。 |
255| [double OH_Drawing_TextStyleGetWordSpacing(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetwordspacing) | 获取指定文本样式的单词间距。 |
256| [double OH_Drawing_TextStyleGetFontHeight(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetfontheight) | 获取指定文本样式行高缩放系数。 |
257| [bool OH_Drawing_TextStyleGetHalfLeading(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegethalfleading) | 获取指定文本样式一半行间距开关状态。 |
258| [const char* OH_Drawing_TextStyleGetLocale(OH_Drawing_TextStyle* style)](#oh_drawing_textstylegetlocale) | 获取语言环境。 |
259| [void OH_Drawing_TypographyDestroyTextBox(OH_Drawing_TextBox* textBox)](#oh_drawing_typographydestroytextbox) | 释放文本框占用的内存。 |
260| [void OH_Drawing_SetTextShadow(OH_Drawing_TextShadow* shadow, uint32_t color, OH_Drawing_Point* offset,double blurRadius)](#oh_drawing_settextshadow) | 设置字体阴影对象的参数。 |
261| [OH_Drawing_TextTab* OH_Drawing_CreateTextTab(OH_Drawing_TextAlign alignment, float location)](#oh_drawing_createtexttab) | 创建文本制表符对象。 |
262| [void OH_Drawing_DestroyTextTab(OH_Drawing_TextTab* tab)](#oh_drawing_destroytexttab) | 释放文本制表符对象占据的内存。 |
263| [OH_Drawing_TextAlign OH_Drawing_GetTextTabAlignment(OH_Drawing_TextTab* tab)](#oh_drawing_gettexttabalignment) | 获取文本制表符对象的对齐方式。 |
264| [float OH_Drawing_GetTextTabLocation(OH_Drawing_TextTab* tab)](#oh_drawing_gettexttablocation) | 获取文本制表符的位置。 |
265| [void OH_Drawing_SetTypographyTextTab(OH_Drawing_TypographyStyle* style, OH_Drawing_TextTab* tab)](#oh_drawing_settypographytexttab) | 设置文本制表符对齐方式及位置。当设置了文本对齐方式或者省略号风格时制表符不生效,当制表符位置小于1.0时为替换成空格的效果。 |
266| [size_t OH_Drawing_GetDrawingArraySize(OH_Drawing_Array* drawingArray)](#oh_drawing_getdrawingarraysize) | 获取传入类型为对象数组[OH_Drawing_Array](capi-drawing-oh-drawing-array.md)中的对象个数。 |
267| [void OH_Drawing_SetTypographyTextTrailingSpaceOptimized(OH_Drawing_TypographyStyle* style, bool trailingSpaceOptimized)](#oh_drawing_settypographytexttrailingspaceoptimized) | 设置文本排版时行尾空格是否参与对齐计算。 |
268| [void OH_Drawing_TypographyHandlerAddEncodedText(OH_Drawing_TypographyCreate* handler, const void* text,size_t byteLength, OH_Drawing_TextEncoding textEncodingType)](#oh_drawing_typographyhandleraddencodedtext) | 添加指定编码的文本。 |
269| [void OH_Drawing_SetTypographyTextAutoSpace(OH_Drawing_TypographyStyle *style, bool enableAutoSpace)](#oh_drawing_settypographytextautospace) | 设置文本排版时是否使能自动间距。<br>默认不使能自动间距,一旦使能则会自动调整CJK(中文字符、日文字符、韩文字符)与西文(拉丁字母、西里尔字母、希腊字母)、CJK与数字、CJK与版权符号、版权符号与数字、版权符号与西文之间的间距。 |
270| [void OH_Drawing_TypographyUpdateDecorationColor(OH_Drawing_Typography* typography, uint32_t color)](#oh_drawing_typographyupdatedecorationcolor) | 更新排版对象中的文本装饰线颜色。<br> 使用该接口更新文本装饰线颜色属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。 |
271| [void OH_Drawing_SetTypographyVerticalAlignment(OH_Drawing_TypographyStyle* style,OH_Drawing_TextVerticalAlignment align)](#oh_drawing_settypographyverticalalignment) | 设置文本垂直对齐方式。 |
272| [OH_Drawing_TypographyStyle* OH_Drawing_CopyTypographyStyle(OH_Drawing_TypographyStyle* style)](#oh_drawing_copytypographystyle) | 创建一个段落样式的对象副本,用于拷贝一个已有的段落样式对象。 |
273| [OH_Drawing_TextStyle* OH_Drawing_CopyTextStyle(OH_Drawing_TextStyle* style)](#oh_drawing_copytextstyle) | 创建一个文本样式的对象副本,用于拷贝一个已有的文本样式对象。 |
274| [OH_Drawing_TextShadow* OH_Drawing_CopyTextShadow(OH_Drawing_TextShadow* shadow)](#oh_drawing_copytextshadow) | 创建一个文本阴影的对象副本,用于拷贝一个已有的文本阴影对象。 |
275
276## 枚举类型说明
277
278### OH_Drawing_TextDirection
279
280```
281enum OH_Drawing_TextDirection
282```
283
284**描述**
285
286文字方向。
287
288| 枚举项 | 描述 |
289| -- | -- |
290| TEXT_DIRECTION_RTL | 方向:从右到左。 |
291| TEXT_DIRECTION_LTR | 方向:从左到右。 |
292
293### OH_Drawing_TextAlign
294
295```
296enum OH_Drawing_TextAlign
297```
298
299**描述**
300
301文字对齐方式。
302
303| 枚举项 | 描述 |
304| -- | -- |
305| TEXT_ALIGN_LEFT | 左对齐。 |
306| TEXT_ALIGN_RIGHT | 右对齐。 |
307| TEXT_ALIGN_CENTER | 居中对齐。 |
308| TEXT_ALIGN_JUSTIFY | 两端对齐,即紧靠左和右边缘,中间单词空隙由空格填充,最后一行除外。 |
309| TEXT_ALIGN_START | 当OH_Drawing_TextDirection是TEXT_DIRECTION_LTR时,TEXT_ALIGN_START和TEXT_ALIGN_LEFT相同;<br>类似地,当OH_Drawing_TextDirection是TEXT_DIRECTION_RTL时,TEXT_ALIGN_START和TEXT_ALIGN_RIGHT相同。 |
310| TEXT_ALIGN_END | 当OH_Drawing_TextDirection是TEXT_DIRECTION_LTR时,TEXT_ALIGN_END和TEXT_ALIGN_RIGHT相同;<br>类似地,当OH_Drawing_TextDirection是TEXT_DIRECTION_RTL时,TEXT_ALIGN_END和TEXT_ALIGN_LEFT相同。 |
311
312### OH_Drawing_FontWeight
313
314```
315enum OH_Drawing_FontWeight
316```
317
318**描述**
319
320字重。
321
322| 枚举项 | 描述 |
323| -- | -- |
324| FONT_WEIGHT_100 | 字重为thin。 |
325| FONT_WEIGHT_200 | 字重为extra-light。 |
326| FONT_WEIGHT_300 | 字重为light。 |
327| FONT_WEIGHT_400 | 字重为normal/regular。 |
328| FONT_WEIGHT_500 | 字重为medium。 |
329| FONT_WEIGHT_600 | 字重为semi-bold。 |
330| FONT_WEIGHT_700 | 字重为bold。 |
331| FONT_WEIGHT_800 | 字重为extra-bold。 |
332| FONT_WEIGHT_900 | 字重为black。 |
333
334### OH_Drawing_TextBaseline
335
336```
337enum OH_Drawing_TextBaseline
338```
339
340**描述**
341
342基线位置。
343
344| 枚举项 | 描述 |
345| -- | -- |
346| TEXT_BASELINE_ALPHABETIC | 用于表音文字,基线在中间偏下的位置。 |
347| TEXT_BASELINE_IDEOGRAPHIC | 用于表意文字,基线位于底部。 |
348
349### OH_Drawing_TextDecoration
350
351```
352enum OH_Drawing_TextDecoration
353```
354
355**描述**
356
357文本装饰。
358
359| 枚举项 | 描述 |
360| -- | -- |
361| TEXT_DECORATION_NONE = 0x0 | 无装饰。 |
362| TEXT_DECORATION_UNDERLINE = 0x1 | 下划线。 |
363| TEXT_DECORATION_OVERLINE = 0x2 | 上划线。 |
364| TEXT_DECORATION_LINE_THROUGH = 0x4 | 删除线。 |
365
366### OH_Drawing_FontStyle
367
368```
369enum OH_Drawing_FontStyle
370```
371
372**描述**
373
374区分字体是否为斜体。
375
376| 枚举项 | 描述 |
377| -- | -- |
378| FONT_STYLE_NORMAL | 非斜体。 |
379| FONT_STYLE_ITALIC | 斜体。 |
380| FONT_STYLE_OBLIQUE | 倾斜字体。<br>**起始版本:** 12 |
381
382### OH_Drawing_PlaceholderVerticalAlignment
383
384```
385enum OH_Drawing_PlaceholderVerticalAlignment
386```
387
388**描述**
389
390占位符垂直对齐枚举。
391
392**起始版本:** 11
393
394| 枚举项 | 描述 |
395| -- | -- |
396| ALIGNMENT_OFFSET_AT_BASELINE | 偏移于基线对齐。 |
397| ALIGNMENT_ABOVE_BASELINE | 高于基线对齐。 |
398| ALIGNMENT_BELOW_BASELINE | 低于基线对齐。 |
399| ALIGNMENT_TOP_OF_ROW_BOX | 行框顶部对齐。 |
400| ALIGNMENT_BOTTOM_OF_ROW_BOX | 行框底部对齐。 |
401| ALIGNMENT_CENTER_OF_ROW_BOX | 行框中心对齐。 |
402| ALIGNMENT_FOLLOW_PARAGRAPH<sup>20+</sup> | 跟随文本垂直对齐方式。 |
403
404### OH_Drawing_TextVerticalAlignment
405
406```
407enum OH_Drawing_TextVerticalAlignment
408```
409
410**描述**
411
412垂直对齐方式枚举。
413
414**起始版本:** 20
415
416| 枚举项 | 描述 |
417| -- | -- |
418| TEXT_VERTICAL_ALIGNMENT_BASELINE | 基线对齐。 |
419| TEXT_VERTICAL_ALIGNMENT_BOTTOM | 底部对齐。 |
420| TEXT_VERTICAL_ALIGNMENT_CENTER | 居中对齐。 |
421| TEXT_VERTICAL_ALIGNMENT_TOP | 顶部对齐。 |
422
423### OH_Drawing_TextDecorationStyle
424
425```
426enum OH_Drawing_TextDecorationStyle
427```
428
429**描述**
430
431文本装饰样式枚举。
432
433**起始版本:** 11
434
435| 枚举项 | 描述 |
436| -- | -- |
437| TEXT_DECORATION_STYLE_SOLID | 实心样式。 |
438| TEXT_DECORATION_STYLE_DOUBLE | 双重样式。 |
439| TEXT_DECORATION_STYLE_DOTTED | 圆点样式。 |
440| TEXT_DECORATION_STYLE_DASHED | 虚线样式。 |
441| TEXT_DECORATION_STYLE_WAVY | 波浪样式。 |
442
443### OH_Drawing_EllipsisModal
444
445```
446enum OH_Drawing_EllipsisModal
447```
448
449**描述**
450
451省略号样式枚举。
452
453**起始版本:** 11
454
455| 枚举项 | 描述 |
456| -- | -- |
457| ELLIPSIS_MODAL_HEAD = 0 | 头部模式,即省略号放在文本头部。 |
458| ELLIPSIS_MODAL_MIDDLE = 1 | 中部模式,即省略号放在文本中部。 |
459| ELLIPSIS_MODAL_TAIL = 2 | 尾部模式,即省略号放在文本尾部。 |
460
461### OH_Drawing_BreakStrategy
462
463```
464enum OH_Drawing_BreakStrategy
465```
466
467**描述**
468
469文本的中断策略枚举。
470
471**起始版本:** 11
472
473| 枚举项 | 描述 |
474| -- | -- |
475| BREAK_STRATEGY_GREEDY = 0 | 贪心策略,换行时尽可能填满每一行。 |
476| BREAK_STRATEGY_HIGH_QUALITY = 1 | 高质量策略,换行时优先考虑文本的连续性。 |
477| BREAK_STRATEGY_BALANCED = 2 | 平衡策略,换行时在单词边界换行。 |
478
479### OH_Drawing_WordBreakType
480
481```
482enum OH_Drawing_WordBreakType
483```
484
485**描述**
486
487单词的断词方式枚举。
488
489**起始版本:** 11
490
491| 枚举项 | 描述 |
492| -- | -- |
493| WORD_BREAK_TYPE_NORMAL = 0 | 常规方式。 |
494| WORD_BREAK_TYPE_BREAK_ALL = 1 | 全部中断方式。 |
495| WORD_BREAK_TYPE_BREAK_WORD = 2 | 单词中断方式。 |
496| WORD_BREAK_TYPE_BREAK_HYPHEN = 3 | 每行末尾单词尝试通过连字符“-”进行断行,若无法添加连字符“-”,则跟`WORD_BREAK_TYPE_BREAK_WORD`保持一致。<br/> **起始版本:** 18 |
497
498### OH_Drawing_RectHeightStyle
499
500```
501enum OH_Drawing_RectHeightStyle
502```
503
504**描述**
505
506矩形框高度样式枚举。
507
508**起始版本:** 11
509
510| 枚举项 | 描述 |
511| -- | -- |
512| RECT_HEIGHT_STYLE_TIGHT | 紧密样式。 |
513| RECT_HEIGHT_STYLE_MAX | 最大样式。 |
514| RECT_HEIGHT_STYLE_INCLUDELINESPACEMIDDLE | 包含行间距中间样式。 |
515| RECT_HEIGHT_STYLE_INCLUDELINESPACETOP | 包含行间距顶部样式。 |
516| RECT_HEIGHT_STYLE_INCLUDELINESPACEBOTTOM | 包含行间距底部样式。 |
517| RECT_HEIGHT_STYLE_STRUCT | 结构样式。 |
518
519### OH_Drawing_RectWidthStyle
520
521```
522enum OH_Drawing_RectWidthStyle
523```
524
525**描述**
526
527矩形框宽度样式枚举。
528
529**起始版本:** 11
530
531| 枚举项 | 描述 |
532| -- | -- |
533| RECT_WIDTH_STYLE_TIGHT | 紧密样式。 |
534| RECT_WIDTH_STYLE_MAX | 最大样式。 |
535
536### OH_Drawing_TextBadgeType
537
538```
539enum OH_Drawing_TextBadgeType
540```
541
542**描述**
543
544上下标样式枚举。
545
546**起始版本:** 20
547
548| 枚举项 | 描述 |
549| -- | -- |
550| TEXT_BADGE_NONE | 不使能上标或下标。 |
551| TEXT_SUPERSCRIPT | 使能上标。 |
552| TEXT_SUBSCRIPT | 使能下标。 |
553
554### OH_Drawing_FontConfigInfoErrorCode
555
556```
557enum OH_Drawing_FontConfigInfoErrorCode
558```
559
560**描述**
561
562获取系统字体配置信息列表结果枚举。
563
564**起始版本:** 12
565
566| 枚举项 | 描述 |
567| -- | -- |
568| SUCCESS_FONT_CONFIG_INFO = 0 | 获取系统字体配置信息列表成功。 |
569| ERROR_FONT_CONFIG_INFO_UNKNOWN = 1 | 未知错误。 |
570| ERROR_FONT_CONFIG_INFO_PARSE_FILE = 2 | 解析系统配置文件失败。 |
571| ERROR_FONT_CONFIG_INFO_ALLOC_MEMORY = 3 | 申请内存失败。 |
572| ERROR_FONT_CONFIG_INFO_COPY_STRING_DATA = 4 | 拷贝字符串数据失败。 |
573
574### OH_Drawing_FontWidth
575
576```
577enum OH_Drawing_FontWidth
578```
579
580**描述**
581
582字体宽度的枚举。
583
584**起始版本:** 12
585
586| 枚举项 | 描述 |
587| -- | -- |
588| FONT_WIDTH_ULTRA_CONDENSED = 1 | 表示超窄的字宽。 |
589| FONT_WIDTH_EXTRA_CONDENSED = 2 | 表示特窄的字宽。 |
590| FONT_WIDTH_CONDENSED = 3 | 表示窄的字宽。 |
591| FONT_WIDTH_SEMI_CONDENSED = 4 | 表示半窄的字宽。 |
592| FONT_WIDTH_NORMAL = 5 | 表示常规的字宽。 |
593| FONT_WIDTH_SEMI_EXPANDED = 6 | 表示半宽的字宽。 |
594| FONT_WIDTH_EXPANDED = 7 | 表示宽的字宽。 |
595| FONT_WIDTH_EXTRA_EXPANDED = 8 | 表示特宽的字宽。 |
596| FONT_WIDTH_ULTRA_EXPANDED = 9 | 表示超宽的字宽。 |
597
598### OH_Drawing_TextHeightBehavior
599
600```
601enum OH_Drawing_TextHeightBehavior
602```
603
604**描述**
605
606文本高度修饰符模式枚举。
607
608**起始版本:** 12
609
610| 枚举项 | 描述 |
611| -- | -- |
612| TEXT_HEIGHT_ALL = 0x0 | 段落中第一行顶部和段落中最后一行底部[OH_Drawing_SetTextStyleFontHeight](capi-drawing-text-typography-h.md#oh_drawing_settextstylefontheight)设置的高度生效。 |
613| TEXT_HEIGHT_DISABLE_FIRST_ASCENT = 0x1 | 禁止段落中第一行顶部[OH_Drawing_SetTextStyleFontHeight](capi-drawing-text-typography-h.md#oh_drawing_settextstylefontheight)设置的高度生效。 |
614| TEXT_HEIGHT_DISABLE_LAST_ASCENT = 0x2 | 禁止段落中最后一行底部[OH_Drawing_SetTextStyleFontHeight](capi-drawing-text-typography-h.md#oh_drawing_settextstylefontheight)设置的高度生效。 |
615| TEXT_HEIGHT_DISABLE_ALL = 0x1 \| 0x2 | 禁止段落中第一行顶部和段落中最后一行底部[OH_Drawing_SetTextStyleFontHeight](capi-drawing-text-typography-h.md#oh_drawing_settextstylefontheight)设置的高度生效。 |
616
617### OH_Drawing_TextStyleType
618
619```
620enum OH_Drawing_TextStyleType
621```
622
623**描述**
624
625文本样式类型枚举。
626
627**起始版本:** 12
628
629| 枚举项 | 描述 |
630| -- | -- |
631| TEXT_STYLE_NONE | 无文本样式。 |
632| TEXT_STYLE_ALL_ATTRIBUTES | 所有文本样式。 |
633| TEXT_STYLE_FONT | 字体样式。 |
634| TEXT_STYLE_FOREGROUND | 文本前景样式。 |
635| TEXT_STYLE_BACKGROUND | 文本背景样式。 |
636| TEXT_STYLE_SHADOW | 文本阴影样式。 |
637| TEXT_STYLE_DECORATIONS | 文本装饰样式。 |
638| TEXT_STYLE_LETTER_SPACING | 文本字符间距样式。 |
639| TEXT_STYLE_WORD_SPACING | 文本单词间距样式。 |
640
641
642## 函数说明
643
644### OH_Drawing_CreateTypographyStyle()
645
646```
647OH_Drawing_TypographyStyle* OH_Drawing_CreateTypographyStyle(void)
648```
649
650**描述**
651
652创建指向OH_Drawing_TypographyStyle对象的指针。不再需要[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)时,请使用[OH_Drawing_DestroyTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_destroytypographystyle)接口释放该对象的指针。
653
654**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
655
656**起始版本:** 8
657
658**返回:**
659
660| 类型 | 说明 |
661| -- | -- |
662| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* | 指向创建的[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针。 |
663
664### OH_Drawing_DestroyTypographyStyle()
665
666```
667void OH_Drawing_DestroyTypographyStyle(OH_Drawing_TypographyStyle* style)
668```
669
670**描述**
671
672释放被OH_Drawing_TypographyStyle对象占据的内存。
673
674**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
675
676**起始版本:** 8
677
678
679**参数:**
680
681| 参数项 | 描述 |
682| -- | -- |
683| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
684
685### OH_Drawing_SetTypographyTextDirection()
686
687```
688void OH_Drawing_SetTypographyTextDirection(OH_Drawing_TypographyStyle* style, int direction)
689```
690
691**描述**
692
693设置指定排版样式中的文本方向。
694
695**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
696
697**起始版本:** 8
698
699
700**参数:**
701
702| 参数项 | 描述 |
703| -- | -- |
704| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
705| int direction | 设置文本方向,设置0为从右到左,设置1或其他值为从左到右,具体可见[OH_Drawing_TextDirection](capi-drawing-text-typography-h.md#oh_drawing_textdirection)枚举。 |
706
707### OH_Drawing_SetTypographyTextAlign()
708
709```
710void OH_Drawing_SetTypographyTextAlign(OH_Drawing_TypographyStyle* style, int align)
711```
712
713**描述**
714
715设置文本对齐方式。
716
717**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
718
719**起始版本:** 8
720
721
722**参数:**
723
724| 参数项 | 描述 |
725| -- | -- |
726| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
727| int align | 设置文本对齐方式,设置1为右对齐,设置2为居中对齐,设置3为两端对齐,设置4为与文字方向相同,设置5为文字方向相反,设置0或其它为左对齐,具体可见[OH_Drawing_TextAlign](capi-drawing-text-typography-h.md#oh_drawing_textalign)枚举。 |
728
729### OH_Drawing_TypographyGetEffectiveAlignment()
730
731```
732int OH_Drawing_TypographyGetEffectiveAlignment(OH_Drawing_TypographyStyle* style)
733```
734
735**描述**
736
737获取文字对齐方式。
738
739**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
740
741**起始版本:** 12
742
743
744**参数:**
745
746| 参数项 | 描述 |
747| -- | -- |
748| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
749
750**返回:**
751
752| 类型 | 说明 |
753| -- | -- |
754| int | 返回文字对齐方式。 |
755
756### OH_Drawing_SetTypographyTextMaxLines()
757
758```
759void OH_Drawing_SetTypographyTextMaxLines(OH_Drawing_TypographyStyle* style, int lineNumber)
760```
761
762**描述**
763
764设置文本最大行数。
765
766**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
767
768**起始版本:** 8
769
770
771**参数:**
772
773| 参数项 | 描述 |
774| -- | -- |
775| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
776| int lineNumber | 最大行数。 |
777
778### OH_Drawing_CreateTextStyle()
779
780```
781OH_Drawing_TextStyle* OH_Drawing_CreateTextStyle(void)
782```
783
784**描述**
785
786创建指向OH_Drawing_TextStyle对象的指针。
787
788**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
789
790**起始版本:** 8
791
792**返回:**
793
794| 类型 | 说明 |
795| -- | -- |
796| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* | 指向创建的[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针。 |
797
798### OH_Drawing_TypographyGetTextStyle()
799
800```
801OH_Drawing_TextStyle* OH_Drawing_TypographyGetTextStyle(OH_Drawing_TypographyStyle* style)
802```
803
804**描述**
805
806获取指定排版样式中设置的默认文本样式。
807
808**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
809
810**起始版本:** 12
811
812
813**参数:**
814
815| 参数项 | 描述 |
816| -- | -- |
817| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
818
819**返回:**
820
821| 类型 | 说明 |
822| -- | -- |
823| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* | 返回指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,不再需要时,请使用[OH_Drawing_DestroyTextStyle](capi-drawing-text-typography-h.md#oh_drawing_destroytextstyle)释放该对象指针。 |
824
825### OH_Drawing_DestroyTextStyle()
826
827```
828void OH_Drawing_DestroyTextStyle(OH_Drawing_TextStyle* style)
829```
830
831**描述**
832
833释放被OH_Drawing_TextStyle对象占据的内存。
834
835**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
836
837**起始版本:** 8
838
839
840**参数:**
841
842| 参数项 | 描述 |
843| -- | -- |
844| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
845
846### OH_Drawing_SetTextStyleColor()
847
848```
849void OH_Drawing_SetTextStyleColor(OH_Drawing_TextStyle* style, uint32_t color)
850```
851
852**描述**
853
854设置文本颜色。
855
856**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
857
858**起始版本:** 8
859
860
861**参数:**
862
863| 参数项 | 描述 |
864| -- | -- |
865| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
866| uint32_t color | 颜色。 |
867
868### OH_Drawing_SetTextStyleFontSize()
869
870```
871void OH_Drawing_SetTextStyleFontSize(OH_Drawing_TextStyle* style, double fontSize)
872```
873
874**描述**
875
876设置字号。
877
878**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
879
880**起始版本:** 8
881
882
883**参数:**
884
885| 参数项 | 描述 |
886| -- | -- |
887| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
888| double fontSize | 字号。 |
889
890### OH_Drawing_SetTextStyleFontWeight()
891
892```
893void OH_Drawing_SetTextStyleFontWeight(OH_Drawing_TextStyle* style, int fontWeight)
894```
895
896**描述**
897
898设置字重。目前只有系统默认字体支持字重的调节,其他字体设置字重值小于semi-bold时字体粗细无变化,当设置字重值大于等于semi-bold时可能会触发伪加粗效果。
899
900**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
901
902**起始版本:** 8
903
904
905**参数:**
906
907| 参数项 | 描述 |
908| -- | -- |
909| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
910| int fontWeight | 设置字重,设置0字重为thin,设置1字重为extra-light,设置2字重为light,设置4字重为medium,设置5字重为semi-bold,<br>设置6字重为bold,设置7字重为extra-bold,设置8字重为black,设置3或其它字重为normal/regular,具体可见[OH_Drawing_FontWeight](capi-drawing-text-typography-h.md#oh_drawing_fontweight)枚举。 |
911
912### OH_Drawing_SetTextStyleBaseLine()
913
914```
915void OH_Drawing_SetTextStyleBaseLine(OH_Drawing_TextStyle* style, int baseline)
916```
917
918**描述**
919
920设置文本样式的字体基线位置。
921
922**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
923
924**起始版本:** 8
925
926
927**参数:**
928
929| 参数项 | 描述 |
930| -- | -- |
931| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
932| int baseline | 设置字体基线位置,设置1基线位于底部,设置0或其它基线在中间偏下的位置,具体可见[OH_Drawing_TextBaseline](capi-drawing-text-typography-h.md#oh_drawing_textbaseline)枚举。 |
933
934### OH_Drawing_SetTextStyleDecoration()
935
936```
937void OH_Drawing_SetTextStyleDecoration(OH_Drawing_TextStyle* style, int decoration)
938```
939
940**描述**
941
942设置指定文本样式中的装饰线类型,只能设置一个装饰线类型,添加多个需要使用[OH_Drawing_AddTextStyleDecoration](capi-drawing-text-typography-h.md#oh_drawing_addtextstyledecoration)。
943
944**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
945
946**起始版本:** 8
947
948
949**参数:**
950
951| 参数项 | 描述 |
952| -- | -- |
953| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
954| int decoration | 设置装饰,设置1为下划线,设置2为上划线,设置4为删除线,设置0或其它为无装饰,具体可见[OH_Drawing_TextDecoration](capi-drawing-text-typography-h.md#oh_drawing_textdecoration)枚举。 |
955
956### OH_Drawing_AddTextStyleDecoration()
957
958```
959void OH_Drawing_AddTextStyleDecoration(OH_Drawing_TextStyle* style, int decoration)
960```
961
962**描述**
963
964新增指定装饰,可同时显示多种装饰线。
965
966**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
967
968**起始版本:** 18
969
970
971**参数:**
972
973| 参数项 | 描述 |
974| -- | -- |
975| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
976| int decoration | 要新增的装饰。设置1为新增下划线,设置2为新增上划线,设置4为新增删除线。可通过位或操作一次新增多种装饰线。<br>设置非[OH_Drawing_TextDecoration](capi-drawing-text-typography-h.md#oh_drawing_textdecoration)枚举的装饰样式则保持原有装饰。 |
977
978### OH_Drawing_RemoveTextStyleDecoration()
979
980```
981void OH_Drawing_RemoveTextStyleDecoration(OH_Drawing_TextStyle* style, int decoration)
982```
983
984**描述**
985
986删除指定装饰。
987
988**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
989
990**起始版本:** 18
991
992
993**参数:**
994
995| 参数项 | 描述 |
996| -- | -- |
997| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
998| int decoration | 要删除的装饰。应该与现有的装饰相匹配,设置1为删除下划线,设置2为删除上划线,设置4为删除删除线,可通过位或操作一次删除多种装饰线。<br>设置非[OH_Drawing_TextDecoration](capi-drawing-text-typography-h.md#oh_drawing_textdecoration)枚举的装饰样式则保持原有装饰。 |
999
1000### OH_Drawing_SetTextStyleDecorationColor()
1001
1002```
1003void OH_Drawing_SetTextStyleDecorationColor(OH_Drawing_TextStyle* style, uint32_t color)
1004```
1005
1006**描述**
1007
1008设置指定文本样式中的装饰线颜色。如果不调用该接口或者设置color为0时,装饰线颜色跟随文本颜色。
1009
1010**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1011
1012**起始版本:** 8
1013
1014
1015**参数:**
1016
1017| 参数项 | 描述 |
1018| -- | -- |
1019| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1020| uint32_t color | 颜色。 |
1021
1022### OH_Drawing_SetTextStyleFontHeight()
1023
1024```
1025void OH_Drawing_SetTextStyleFontHeight(OH_Drawing_TextStyle* style, double fontHeight)
1026```
1027
1028**描述**
1029
1030设置行高,按当前字体大小的倍数进行设置。
1031
1032**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1033
1034**起始版本:** 8
1035
1036
1037**参数:**
1038
1039| 参数项 | 描述 |
1040| -- | -- |
1041| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1042| double fontHeight | 当前字体大小的倍数。 |
1043
1044### OH_Drawing_SetTextStyleFontFamilies()
1045
1046```
1047void OH_Drawing_SetTextStyleFontFamilies(OH_Drawing_TextStyle* style,int fontFamiliesNumber, const char* fontFamilies[])
1048```
1049
1050**描述**
1051
1052设置指定文本样式的字体家族类型。
1053
1054**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1055
1056**起始版本:** 8
1057
1058
1059**参数:**
1060
1061| 参数项 | 描述 |
1062| -- | -- |
1063| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1064| int fontFamiliesNumber | 字体名称数量,禁止填入负数。 |
1065| fontFamilies |  指向字体家族类型的指针。 |
1066
1067### OH_Drawing_SetTextStyleFontStyle()
1068
1069```
1070void OH_Drawing_SetTextStyleFontStyle(OH_Drawing_TextStyle* style, int fontStyle)
1071```
1072
1073**描述**
1074
1075为指定文本样式设置字体样式。
1076
1077**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1078
1079**起始版本:** 8
1080
1081
1082**参数:**
1083
1084| 参数项 | 描述 |
1085| -- | -- |
1086| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1087| int fontStyle | 设置字体样式,设置1为斜体,设置0或其它为非斜体,具体可见[OH_Drawing_FontStyle](capi-drawing-text-typography-h.md#oh_drawing_fontstyle)枚举。 |
1088
1089### OH_Drawing_SetTextStyleLocale()
1090
1091```
1092void OH_Drawing_SetTextStyleLocale(OH_Drawing_TextStyle* style, const char* locale)
1093```
1094
1095**描述**
1096
1097设置文本语言环境。
1098
1099**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1100
1101**起始版本:** 8
1102
1103
1104**参数:**
1105
1106| 参数项 | 描述 |
1107| -- | -- |
1108| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1109| const char* locale | 语言类型,数据类型为指向char的指针,如'en'代表英文,'zh-Hans'代表简体中文,'zh-Hant'代表繁体中文。 |
1110
1111### OH_Drawing_SetTextStyleForegroundBrush()
1112
1113```
1114void OH_Drawing_SetTextStyleForegroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* foregroundBrush)
1115```
1116
1117**描述**
1118
1119设置指定文本样式中的前景色画刷。
1120
1121**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1122
1123**起始版本:** 12
1124
1125
1126**参数:**
1127
1128| 参数项 | 描述 |
1129| -- | -- |
1130| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1131| [OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)* foregroundBrush | 指向画刷[OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)对象的指针,由[OH_Drawing_BrushCreate](capi-drawing-brush-h.md#oh_drawing_brushcreate)获取。 |
1132
1133### OH_Drawing_TextStyleGetForegroundBrush()
1134
1135```
1136void OH_Drawing_TextStyleGetForegroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* foregroundBrush)
1137```
1138
1139**描述**
1140
1141返回设置的前景色画刷。
1142
1143**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1144
1145**起始版本:** 12
1146
1147
1148**参数:**
1149
1150| 参数项 | 描述 |
1151| -- | -- |
1152| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1153| [OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)* foregroundBrush | 指向画刷[OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)对象的指针,由[OH_Drawing_BrushCreate](capi-drawing-brush-h.md#oh_drawing_brushcreate)获取。 |
1154
1155### OH_Drawing_SetTextStyleForegroundPen()
1156
1157```
1158void OH_Drawing_SetTextStyleForegroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* foregroundPen)
1159```
1160
1161**描述**
1162
1163设置指定文本样式中的前景色画笔。
1164
1165**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1166
1167**起始版本:** 12
1168
1169
1170**参数:**
1171
1172| 参数项 | 描述 |
1173| -- | -- |
1174| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1175| [OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)* foregroundPen | 指向画笔[OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)对象的指针,由[OH_Drawing_PenCreate](capi-drawing-pen-h.md#oh_drawing_pencreate)获取。 |
1176
1177### OH_Drawing_TextStyleGetForegroundPen()
1178
1179```
1180void OH_Drawing_TextStyleGetForegroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* foregroundPen)
1181```
1182
1183**描述**
1184
1185返回设置的前景色画笔。
1186
1187**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1188
1189**起始版本:** 12
1190
1191
1192**参数:**
1193
1194| 参数项 | 描述 |
1195| -- | -- |
1196| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1197| [OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)* foregroundPen | 指向画笔[OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)对象的指针,由[OH_Drawing_PenCreate](capi-drawing-pen-h.md#oh_drawing_pencreate)获取。 |
1198
1199### OH_Drawing_SetTextStyleBackgroundBrush()
1200
1201```
1202void OH_Drawing_SetTextStyleBackgroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* backgroundBrush)
1203```
1204
1205**描述**
1206
1207设置指定文本样式中的背景色画刷。
1208
1209**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1210
1211**起始版本:** 12
1212
1213
1214**参数:**
1215
1216| 参数项 | 描述 |
1217| -- | -- |
1218| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1219| [OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)* backgroundBrush | 指向画刷[OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)对象的指针,由[OH_Drawing_BrushCreate](capi-drawing-brush-h.md#oh_drawing_brushcreate)获取。 |
1220
1221### OH_Drawing_TextStyleGetBackgroundBrush()
1222
1223```
1224void OH_Drawing_TextStyleGetBackgroundBrush(OH_Drawing_TextStyle* style, OH_Drawing_Brush* backgroundBrush)
1225```
1226
1227**描述**
1228
1229返回设置的背景色画刷。
1230
1231**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1232
1233**起始版本:** 12
1234
1235
1236**参数:**
1237
1238| 参数项 | 描述 |
1239| -- | -- |
1240| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1241| [OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)* backgroundBrush | 指向画刷[OH_Drawing_Brush](capi-drawing-oh-drawing-brush.md)对象的指针,由[OH_Drawing_BrushCreate](capi-drawing-brush-h.md#oh_drawing_brushcreate)获取。 |
1242
1243### OH_Drawing_SetTextStyleBackgroundPen()
1244
1245```
1246void OH_Drawing_SetTextStyleBackgroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* backgroundPen)
1247```
1248
1249**描述**
1250
1251设置指定文本样式中的背景色画笔。
1252
1253**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1254
1255**起始版本:** 12
1256
1257
1258**参数:**
1259
1260| 参数项 | 描述 |
1261| -- | -- |
1262| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1263| [OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)* backgroundPen | 指向画笔[OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)对象的指针,由[OH_Drawing_PenCreate](capi-drawing-pen-h.md#oh_drawing_pencreate)获取。 |
1264
1265### OH_Drawing_TextStyleGetBackgroundPen()
1266
1267```
1268void OH_Drawing_TextStyleGetBackgroundPen(OH_Drawing_TextStyle* style, OH_Drawing_Pen* backgroundPen)
1269```
1270
1271**描述**
1272
1273返回设置的背景色画笔。
1274
1275**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1276
1277**起始版本:** 12
1278
1279
1280**参数:**
1281
1282| 参数项 | 描述 |
1283| -- | -- |
1284| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1285| [OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)* backgroundPen | 指向画笔[OH_Drawing_Pen](capi-drawing-oh-drawing-pen.md)对象的指针,由[OH_Drawing_PenCreate](capi-drawing-pen-h.md#oh_drawing_pencreate)获取。 |
1286
1287### OH_Drawing_CreateTypographyHandler()
1288
1289```
1290OH_Drawing_TypographyCreate* OH_Drawing_CreateTypographyHandler(OH_Drawing_TypographyStyle* style,OH_Drawing_FontCollection* fontCollection)
1291```
1292
1293**描述**
1294
1295创建指向OH_Drawing_TypographyCreate对象的指针。不再需要[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)时,请使用[OH_Drawing_DestroyTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_destroytypographyhandler)接口释放该对象的指针。
1296
1297**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1298
1299**起始版本:** 8
1300
1301
1302**参数:**
1303
1304| 参数项 | 描述 |
1305| -- | -- |
1306| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
1307| [OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)* fontCollection | 指向字体集对象[OH_Drawing_FontCollection](capi-drawing-oh-drawing-fontcollection.md)的指针,由[OH_Drawing_CreateFontCollection](capi-drawing-font-collection-h.md#oh_drawing_createfontcollection)获取。 |
1308
1309**返回:**
1310
1311| 类型 | 说明 |
1312| -- | -- |
1313| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* | 指向新创建的OH_Drawing_TypographyCreate对象的指针。 |
1314
1315### OH_Drawing_DestroyTypographyHandler()
1316
1317```
1318void OH_Drawing_DestroyTypographyHandler(OH_Drawing_TypographyCreate* handler)
1319```
1320
1321**描述**
1322
1323释放被OH_Drawing_TypographyCreate对象占据的内存。
1324
1325**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1326
1327**起始版本:** 8
1328
1329
1330**参数:**
1331
1332| 参数项 | 描述 |
1333| -- | -- |
1334| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
1335
1336### OH_Drawing_TypographyHandlerPushTextStyle()
1337
1338```
1339void OH_Drawing_TypographyHandlerPushTextStyle(OH_Drawing_TypographyCreate* handler, OH_Drawing_TextStyle* style)
1340```
1341
1342**描述**
1343
1344将指定文本样式压入文本样式栈,后续添加的文本总是会使用栈顶的文本样式。
1345
1346**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1347
1348**起始版本:** 8
1349
1350
1351**参数:**
1352
1353| 参数项 | 描述 |
1354| -- | -- |
1355| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
1356| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
1357
1358### OH_Drawing_TypographyHandlerAddText()
1359
1360```
1361void OH_Drawing_TypographyHandlerAddText(OH_Drawing_TypographyCreate* handler, const char* text)
1362```
1363
1364**描述**
1365
1366设置文本内容。
1367
1368**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1369
1370**起始版本:** 8
1371
1372
1373**参数:**
1374
1375| 参数项 | 描述 |
1376| -- | -- |
1377| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
1378| const char* text | 指向文本内容的指针。 |
1379
1380### OH_Drawing_TypographyHandlerPopTextStyle()
1381
1382```
1383void OH_Drawing_TypographyHandlerPopTextStyle(OH_Drawing_TypographyCreate* handler)
1384```
1385
1386**描述**
1387
1388从文本样式栈中弹出栈顶文本样式。
1389
1390**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1391
1392**起始版本:** 8
1393
1394
1395**参数:**
1396
1397| 参数项 | 描述 |
1398| -- | -- |
1399| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
1400
1401### OH_Drawing_CreateTypography()
1402
1403```
1404OH_Drawing_Typography* OH_Drawing_CreateTypography(OH_Drawing_TypographyCreate* handler)
1405```
1406
1407**描述**
1408
1409创建指向OH_Drawing_Typography对象的指针。不再需要[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)时,请使用[OH_Drawing_DestroyTypography](capi-drawing-text-typography-h.md#oh_drawing_destroytypography)接口释放该对象的指针。
1410
1411**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1412
1413**起始版本:** 8
1414
1415
1416**参数:**
1417
1418| 参数项 | 描述 |
1419| -- | -- |
1420| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
1421
1422**返回:**
1423
1424| 类型 | 说明 |
1425| -- | -- |
1426| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* | 指向OH_Drawing_Typography对象的指针。 |
1427
1428### OH_Drawing_DestroyTypography()
1429
1430```
1431void OH_Drawing_DestroyTypography(OH_Drawing_Typography* typography)
1432```
1433
1434**描述**
1435
1436释放OH_Drawing_Typography对象占据的内存。
1437
1438**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1439
1440**起始版本:** 8
1441
1442
1443**参数:**
1444
1445| 参数项 | 描述 |
1446| -- | -- |
1447| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1448
1449### OH_Drawing_TypographyLayout()
1450
1451```
1452void OH_Drawing_TypographyLayout(OH_Drawing_Typography* typography, double maxWidth)
1453```
1454
1455**描述**
1456
1457排版布局。
1458
1459**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1460
1461**起始版本:** 8
1462
1463
1464**参数:**
1465
1466| 参数项 | 描述 |
1467| -- | -- |
1468| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1469| double maxWidth | 文本最大宽度。 |
1470
1471### OH_Drawing_TypographyPaint()
1472
1473```
1474void OH_Drawing_TypographyPaint(OH_Drawing_Typography* typography, OH_Drawing_Canvas* canvas,double positionX, double positionY)
1475```
1476
1477**描述**
1478
1479在指定位置绘制文本,从左上角开始绘制,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用并生效之后调用。
1480
1481**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1482
1483**起始版本:** 8
1484
1485
1486**参数:**
1487
1488| 参数项 | 描述 |
1489| -- | -- |
1490| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1491| [OH_Drawing_Canvas](capi-drawing-oh-drawing-canvas.md)* canvas | 指向OH_Drawing_Canvas对象的指针,由[OH_Drawing_CanvasCreate](capi-drawing-canvas-h.md#oh_drawing_canvascreate)获取。 |
1492| double positionX | x坐标。 |
1493| double positionY | y坐标。 |
1494
1495### OH_Drawing_TypographyPaintOnPath()
1496
1497```
1498void OH_Drawing_TypographyPaintOnPath(OH_Drawing_Typography* typography, OH_Drawing_Canvas* canvas,OH_Drawing_Path* path, double hOffset, double vOffset)
1499```
1500
1501**描述**
1502
1503沿指定路径绘制文本。建议搭配[OH_Drawing_SetTypographyTextMaxLines](capi-drawing-text-typography-h.md#oh_drawing_settypographytextmaxlines)接口设置最大行为1行,避免因文本宽度超过排版宽度出现跨行重叠问题。
1504
1505**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1506
1507**起始版本:** 12
1508
1509**参数:**
1510
1511| 参数项 | 描述 |
1512| -- | -- |
1513| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1514| [OH_Drawing_Canvas](capi-drawing-oh-drawing-canvas.md)* canvas | 指向OH_Drawing_Canvas对象的指针,由[OH_Drawing_CanvasCreate](capi-drawing-canvas-h.md#oh_drawing_canvascreate)获取。 |
1515| [OH_Drawing_Path](capi-drawing-oh-drawing-path.md)* path | 指向OH_Drawing_Path对象的指针,由[OH_Drawing_PathCreate](capi-drawing-path-h.md#oh_drawing_pathcreate)获取。 |
1516| double hOffset | 水平偏移量,文本沿路径的水平偏移(X 轴),向前为正,向后为负。 |
1517| double vOffset | 垂直偏移量,文本沿路径的垂直偏移(Y 轴),向下为正,向上为负。 |
1518
1519### OH_Drawing_TypographyGetMaxWidth()
1520
1521```
1522double OH_Drawing_TypographyGetMaxWidth(OH_Drawing_Typography* typography)
1523```
1524
1525**描述**
1526
1527获取用户设置的排版宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
1528
1529**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1530
1531**起始版本:** 9
1532
1533
1534**参数:**
1535
1536| 参数项 | 描述 |
1537| -- | -- |
1538| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1539
1540**返回:**
1541
1542| 类型 | 说明 |
1543| -- | -- |
1544| double | 返回最大宽度。 |
1545
1546### OH_Drawing_TypographyGetHeight()
1547
1548```
1549double OH_Drawing_TypographyGetHeight(OH_Drawing_Typography* typography)
1550```
1551
1552**描述**
1553
1554获取排版对象整体的高度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
1555
1556**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1557
1558**起始版本:** 9
1559
1560
1561**参数:**
1562
1563| 参数项 | 描述 |
1564| -- | -- |
1565| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1566
1567**返回:**
1568
1569| 类型 | 说明 |
1570| -- | -- |
1571| double | 返回高度。 |
1572
1573### OH_Drawing_TypographyGetLongestLine()
1574
1575```
1576double OH_Drawing_TypographyGetLongestLine(OH_Drawing_Typography* typography)
1577```
1578
1579**描述**
1580
1581获取排版对象最长行的宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,建议实际使用时将返回值向上取整。当文本内容为空时,返回0.0。
1582
1583**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1584
1585**起始版本:** 9
1586
1587
1588**参数:**
1589
1590| 参数项 | 描述 |
1591| -- | -- |
1592| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1593
1594**返回:**
1595
1596| 类型 | 说明 |
1597| -- | -- |
1598| double | 返回最长行的宽度。 |
1599
1600### OH_Drawing_TypographyGetLongestLineWithIndent()
1601
1602```
1603double OH_Drawing_TypographyGetLongestLineWithIndent(OH_Drawing_Typography* typography)
1604```
1605
1606**描述**
1607
1608获取排版对象最长行的宽度(该宽度包含当前行缩进的宽度),该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,建议实际使用时将返回值向上取整。当文本内容为空时,返回0.0。
1609
1610**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1611
1612**起始版本:** 13
1613
1614
1615**参数:**
1616
1617| 参数项 | 描述 |
1618| -- | -- |
1619| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1620
1621**返回:**
1622
1623| 类型 | 说明 |
1624| -- | -- |
1625| double | 返回最长行的宽度(该宽度包含当前行缩进的宽度),单位:物理像素px。 |
1626
1627### OH_Drawing_TypographyGetMinIntrinsicWidth()
1628
1629```
1630double OH_Drawing_TypographyGetMinIntrinsicWidth(OH_Drawing_Typography* typography)
1631```
1632
1633**描述**
1634
1635获取排版对象的最小固有宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
1636
1637**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1638
1639**起始版本:** 9
1640
1641
1642**参数:**
1643
1644| 参数项 | 描述 |
1645| -- | -- |
1646| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1647
1648**返回:**
1649
1650| 类型 | 说明 |
1651| -- | -- |
1652| double | 返回最小固有宽度。 |
1653
1654### OH_Drawing_TypographyGetMaxIntrinsicWidth()
1655
1656```
1657double OH_Drawing_TypographyGetMaxIntrinsicWidth(OH_Drawing_Typography* typography)
1658```
1659
1660**描述**
1661
1662获取排版对象的最大固有宽度,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
1663
1664**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1665
1666**起始版本:** 9
1667
1668
1669**参数:**
1670
1671| 参数项 | 描述 |
1672| -- | -- |
1673| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1674
1675**返回:**
1676
1677| 类型 | 说明 |
1678| -- | -- |
1679| double | 返回最大固有宽度。 |
1680
1681### OH_Drawing_TypographyGetAlphabeticBaseline()
1682
1683```
1684double OH_Drawing_TypographyGetAlphabeticBaseline(OH_Drawing_Typography* typography)
1685```
1686
1687**描述**
1688
1689获取排版样式字母文字基线。
1690
1691**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1692
1693**起始版本:** 9
1694
1695
1696**参数:**
1697
1698| 参数项 | 描述 |
1699| -- | -- |
1700| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1701
1702**返回:**
1703
1704| 类型 | 说明 |
1705| -- | -- |
1706| double | 返回字母文字基线。 |
1707
1708### OH_Drawing_TypographyGetIdeographicBaseline()
1709
1710```
1711double OH_Drawing_TypographyGetIdeographicBaseline(OH_Drawing_Typography* typography)
1712```
1713
1714**描述**
1715
1716获取排版样式表意文字基线。
1717
1718**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1719
1720**起始版本:** 9
1721
1722
1723**参数:**
1724
1725| 参数项 | 描述 |
1726| -- | -- |
1727| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1728
1729**返回:**
1730
1731| 类型 | 说明 |
1732| -- | -- |
1733| double | 返回表意文字基线。 |
1734
1735### OH_Drawing_TypographyHandlerAddPlaceholder()
1736
1737```
1738void OH_Drawing_TypographyHandlerAddPlaceholder(OH_Drawing_TypographyCreate* handler,OH_Drawing_PlaceholderSpan* span)
1739```
1740
1741**描述**
1742
1743设置占位符。
1744
1745**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1746
1747**起始版本:** 11
1748
1749
1750**参数:**
1751
1752| 参数项 | 描述 |
1753| -- | -- |
1754| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
1755| [OH_Drawing_PlaceholderSpan](capi-drawing-oh-drawing-placeholderspan.md)* span | 指向[OH_Drawing_PlaceholderSpan](capi-drawing-oh-drawing-placeholderspan.md)对象的指针。 |
1756
1757### OH_Drawing_TypographyDidExceedMaxLines()
1758
1759```
1760bool OH_Drawing_TypographyDidExceedMaxLines(OH_Drawing_Typography* typography)
1761```
1762
1763**描述**
1764
1765获取排版对象中文本是否超过最大行,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,如果没有通过[OH_Drawing_SetTypographyTextMaxLines](capi-drawing-text-typography-h.md#oh_drawing_settypographytextmaxlines)接口设置最大行,则返回false。
1766
1767**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1768
1769**起始版本:** 11
1770
1771
1772**参数:**
1773
1774| 参数项 | 描述 |
1775| -- | -- |
1776| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1777
1778**返回:**
1779
1780| 类型 | 说明 |
1781| -- | -- |
1782| bool | 返回文本是否超过最大行,true表示超过,false表示未超过。 |
1783
1784### OH_Drawing_TypographyGetRectsForRange()
1785
1786```
1787OH_Drawing_TextBox* OH_Drawing_TypographyGetRectsForRange(OH_Drawing_Typography* typography,size_t start, size_t end, OH_Drawing_RectHeightStyle heightStyle, OH_Drawing_RectWidthStyle widthStyle)
1788```
1789
1790**描述**
1791
1792获取排版对象中指定范围内的文本框,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。不再需要[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)时,请使用[OH_Drawing_TypographyDestroyTextBox](capi-drawing-text-typography-h.md#oh_drawing_typographydestroytextbox)接口释放该对象的指针。
1793
1794**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1795
1796**起始版本:** 11
1797
1798
1799**参数:**
1800
1801| 参数项 | 描述 |
1802| -- | -- |
1803| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1804| size_t start | 设置开始位置。 |
1805| size_t end | 设置结束位置。 |
1806| [OH_Drawing_RectHeightStyle](#oh_drawing_rectheightstyle) heightStyle | 设置高度样式,支持可选的高度样式具体可见[OH_Drawing_RectHeightStyle](capi-drawing-text-typography-h.md#oh_drawing_rectheightstyle)枚举。 |
1807| [OH_Drawing_RectWidthStyle](#oh_drawing_rectwidthstyle) widthStyle | 设置宽度样式,支持可选的宽度样式具体可见[OH_Drawing_RectWidthStyle](capi-drawing-text-typography-h.md#oh_drawing_rectwidthstyle)枚举。 |
1808
1809**返回:**
1810
1811| 类型 | 说明 |
1812| -- | -- |
1813| OH_Drawing_TextBox* | 返回指定范围内的文本框,具体可见[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)结构体。 |
1814
1815### OH_Drawing_TypographyGetRectsForPlaceholders()
1816
1817```
1818OH_Drawing_TextBox* OH_Drawing_TypographyGetRectsForPlaceholders(OH_Drawing_Typography* typography)
1819```
1820
1821**描述**
1822
1823获取排版对象中占位符的文本框,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。不再需要[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)时,请使用[OH_Drawing_TypographyDestroyTextBox](capi-drawing-text-typography-h.md#oh_drawing_typographydestroytextbox)接口释放该对象的指针。
1824
1825**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1826
1827**起始版本:** 11
1828
1829
1830**参数:**
1831
1832| 参数项 | 描述 |
1833| -- | -- |
1834| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
1835
1836**返回:**
1837
1838| 类型 | 说明 |
1839| -- | -- |
1840| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* | 返回占位符的文本框,返回类型为[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)结构体。 |
1841
1842### OH_Drawing_GetLeftFromTextBox()
1843
1844```
1845float OH_Drawing_GetLeftFromTextBox(OH_Drawing_TextBox* textbox, int index)
1846```
1847
1848**描述**
1849
1850获取文本框左侧位置。
1851
1852**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1853
1854**起始版本:** 11
1855
1856
1857**参数:**
1858
1859| 参数项 | 描述 |
1860| -- | -- |
1861| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textbox | 指向OH_Drawing_TextBox对象的指针,由[OH_Drawing_TypographyGetRectsForRange](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforrange)或[OH_Drawing_TypographyGetRectsForPlaceholders](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforplaceholders)获取。 |
1862| int index | 文本框的索引。 |
1863
1864**返回:**
1865
1866| 类型 | 说明 |
1867| -- | -- |
1868| float | 返回文本框左侧位置。 |
1869
1870### OH_Drawing_GetRightFromTextBox()
1871
1872```
1873float OH_Drawing_GetRightFromTextBox(OH_Drawing_TextBox* textbox, int index)
1874```
1875
1876**描述**
1877
1878获取文本框右侧位置。
1879
1880**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1881
1882**起始版本:** 11
1883
1884
1885**参数:**
1886
1887| 参数项 | 描述 |
1888| -- | -- |
1889| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textbox | 指向OH_Drawing_TextBox对象的指针,由[OH_Drawing_TypographyGetRectsForRange](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforrange)或[OH_Drawing_TypographyGetRectsForPlaceholders](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforplaceholders)获取。 |
1890| int index | 文本框的索引。 |
1891
1892**返回:**
1893
1894| 类型 | 说明 |
1895| -- | -- |
1896| float | 返回文本框右侧位置。 |
1897
1898### OH_Drawing_GetTopFromTextBox()
1899
1900```
1901float OH_Drawing_GetTopFromTextBox(OH_Drawing_TextBox* textbox, int index)
1902```
1903
1904**描述**
1905
1906获取文本框顶部位置。
1907
1908**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1909
1910**起始版本:** 11
1911
1912
1913**参数:**
1914
1915| 参数项 | 描述 |
1916| -- | -- |
1917| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textbox | 指向OH_Drawing_TextBox对象的指针,由[OH_Drawing_TypographyGetRectsForRange](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforrange)或[OH_Drawing_TypographyGetRectsForPlaceholders](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforplaceholders)获取。 |
1918| int index | 文本框的索引。 |
1919
1920**返回:**
1921
1922| 类型 | 说明 |
1923| -- | -- |
1924| float | 返回文本框顶部位置。 |
1925
1926### OH_Drawing_GetBottomFromTextBox()
1927
1928```
1929float OH_Drawing_GetBottomFromTextBox(OH_Drawing_TextBox* textbox, int index)
1930```
1931
1932**描述**
1933
1934获取文本框底部位置。
1935
1936**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1937
1938**起始版本:** 11
1939
1940
1941**参数:**
1942
1943| 参数项 | 描述 |
1944| -- | -- |
1945| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textbox | 指向OH_Drawing_TextBox对象的指针,由[OH_Drawing_TypographyGetRectsForRange](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforrange)或[OH_Drawing_TypographyGetRectsForPlaceholders](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforplaceholders)获取。 |
1946| int index | 文本框的索引。 |
1947
1948**返回:**
1949
1950| 类型 | 说明 |
1951| -- | -- |
1952| float | 返回文本框底部位置。 |
1953
1954### OH_Drawing_GetTextDirectionFromTextBox()
1955
1956```
1957int OH_Drawing_GetTextDirectionFromTextBox(OH_Drawing_TextBox* textbox, int index)
1958```
1959
1960**描述**
1961
1962获取文本框方向。
1963
1964**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1965
1966**起始版本:** 11
1967
1968
1969**参数:**
1970
1971| 参数项 | 描述 |
1972| -- | -- |
1973| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textbox | 指向[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)对象的指针,由[OH_Drawing_TypographyGetRectsForRange](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforrange)或[OH_Drawing_TypographyGetRectsForPlaceholders](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforplaceholders)获取。 |
1974| int index | 文本框的索引。 |
1975
1976**返回:**
1977
1978| 类型 | 说明 |
1979| -- | -- |
1980| int | 返回文本框方向。 |
1981
1982### OH_Drawing_GetSizeOfTextBox()
1983
1984```
1985size_t OH_Drawing_GetSizeOfTextBox(OH_Drawing_TextBox* textBox)
1986```
1987
1988**描述**
1989
1990获取文本框数量大小。
1991
1992**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
1993
1994**起始版本:** 11
1995
1996
1997**参数:**
1998
1999| 参数项 | 描述 |
2000| -- | -- |
2001| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textBox | 指向OH_Drawing_TextBox对象的指针,由[OH_Drawing_TypographyGetRectsForRange](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforrange)或[OH_Drawing_TypographyGetRectsForPlaceholders](capi-drawing-text-typography-h.md#oh_drawing_typographygetrectsforplaceholders)获取。 |
2002
2003**返回:**
2004
2005| 类型 | 说明 |
2006| -- | -- |
2007| size_t | 返回文本框数量大小。 |
2008
2009### OH_Drawing_TypographyGetGlyphPositionAtCoordinate()
2010
2011```
2012OH_Drawing_PositionAndAffinity* OH_Drawing_TypographyGetGlyphPositionAtCoordinate(OH_Drawing_Typography* typography,double dx, double dy)
2013```
2014
2015**描述**
2016
2017获取坐标处文本的索引位置和亲和性。
2018
2019**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2020
2021**起始版本:** 11
2022
2023
2024**参数:**
2025
2026| 参数项 | 描述 |
2027| -- | -- |
2028| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2029| double dx | 光标的x坐标。 |
2030| double dy | 光标的y坐标。 |
2031
2032**返回:**
2033
2034| 类型 | 说明 |
2035| -- | -- |
2036| [OH_Drawing_PositionAndAffinity](capi-drawing-oh-drawing-positionandaffinity.md)* | 返回坐标处字体的索引位置和亲和性,返回类型为[OH_Drawing_PositionAndAffinity](capi-drawing-oh-drawing-positionandaffinity.md)结构体。 |
2037
2038### OH_Drawing_TypographyGetGlyphPositionAtCoordinateWithCluster()
2039
2040```
2041OH_Drawing_PositionAndAffinity* OH_Drawing_TypographyGetGlyphPositionAtCoordinateWithCluster(OH_Drawing_Typography* typography, double dx, double dy)
2042```
2043
2044**描述**
2045
2046获取坐标处文本所属字符簇的索引位置和亲和性,字符簇指一个或多个字符组成的整体。
2047
2048**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2049
2050**起始版本:** 11
2051
2052
2053**参数:**
2054
2055| 参数项 | 描述 |
2056| -- | -- |
2057| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2058| double dx | 光标的x坐标。 |
2059| double dy | 光标的y坐标。 |
2060
2061**返回:**
2062
2063| 类型 | 说明 |
2064| -- | -- |
2065| [OH_Drawing_PositionAndAffinity](capi-drawing-oh-drawing-positionandaffinity.md)* | 返回坐标处指定类型字体的索引位置和亲和性,返回类型为[OH_Drawing_PositionAndAffinity](capi-drawing-oh-drawing-positionandaffinity.md)结构体。 |
2066
2067### OH_Drawing_GetPositionFromPositionAndAffinity()
2068
2069```
2070size_t OH_Drawing_GetPositionFromPositionAndAffinity(OH_Drawing_PositionAndAffinity* positionAndAffinity)
2071```
2072
2073**描述**
2074
2075获取OH_Drawing_PositionAndAffinity对象的位置属性。
2076
2077**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2078
2079**起始版本:** 11
2080
2081
2082**参数:**
2083
2084| 参数项 | 描述 |
2085| -- | -- |
2086| [OH_Drawing_PositionAndAffinity](capi-drawing-oh-drawing-positionandaffinity.md)* positionAndAffinity | 指向OH_Drawing_PositionAndAffinity对象的指针,由[OH_Drawing_TypographyGetGlyphPositionAtCoordinate](capi-drawing-text-typography-h.md#oh_drawing_typographygetglyphpositionatcoordinate)或[OH_Drawing_TypographyGetGlyphPositionAtCoordinateWithCluster](capi-drawing-text-typography-h.md#oh_drawing_typographygetglyphpositionatcoordinatewithcluster)获取。 |
2087
2088**返回:**
2089
2090| 类型 | 说明 |
2091| -- | -- |
2092| size_t | 返回OH_Drawing_PositionAndAffinity对象的位置属性。 |
2093
2094### OH_Drawing_GetAffinityFromPositionAndAffinity()
2095
2096```
2097int OH_Drawing_GetAffinityFromPositionAndAffinity(OH_Drawing_PositionAndAffinity* positionAndAffinity)
2098```
2099
2100**描述**
2101
2102获取OH_Drawing_PositionAndAffinity对象的亲和性,根据亲和性可判断字体会靠近前方文本还是后方文本。
2103
2104**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2105
2106**起始版本:** 11
2107
2108
2109**参数:**
2110
2111| 参数项 | 描述 |
2112| -- | -- |
2113| [OH_Drawing_PositionAndAffinity](capi-drawing-oh-drawing-positionandaffinity.md)* positionAndAffinity | 指向OH_Drawing_PositionAndAffinity对象的指针,由[OH_Drawing_TypographyGetGlyphPositionAtCoordinate](capi-drawing-text-typography-h.md#oh_drawing_typographygetglyphpositionatcoordinate)或[OH_Drawing_TypographyGetGlyphPositionAtCoordinateWithCluster](capi-drawing-text-typography-h.md#oh_drawing_typographygetglyphpositionatcoordinatewithcluster)获取。 |
2114
2115**返回:**
2116
2117| 类型 | 说明 |
2118| -- | -- |
2119| int | 返回OH_Drawing_PositionAndAffinity对象的亲和性。 |
2120
2121### OH_Drawing_TypographyGetWordBoundary()
2122
2123```
2124OH_Drawing_Range* OH_Drawing_TypographyGetWordBoundary(OH_Drawing_Typography* typography, size_t offset)
2125```
2126
2127**描述**
2128
2129获取排版对象中单词的边界。
2130
2131**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2132
2133**起始版本:** 11
2134
2135
2136**参数:**
2137
2138| 参数项 | 描述 |
2139| -- | -- |
2140| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2141| size_t offset | 单词索引。 |
2142
2143**返回:**
2144
2145| 类型 | 说明 |
2146| -- | -- |
2147| [OH_Drawing_Range](capi-drawing-oh-drawing-range.md)* | 返回单词边界,返回类型为[OH_Drawing_Range](capi-drawing-oh-drawing-range.md)结构体。 |
2148
2149### OH_Drawing_GetStartFromRange()
2150
2151```
2152size_t OH_Drawing_GetStartFromRange(OH_Drawing_Range* range)
2153```
2154
2155**描述**
2156
2157获取OH_Drawing_Range对象开始位置。
2158
2159**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2160
2161**起始版本:** 11
2162
2163
2164**参数:**
2165
2166| 参数项 | 描述 |
2167| -- | -- |
2168| [OH_Drawing_Range](capi-drawing-oh-drawing-range.md)* range | 指向OH_Drawing_Range对象的指针,由[OH_Drawing_TypographyGetWordBoundary](capi-drawing-text-typography-h.md#oh_drawing_typographygetwordboundary)获取。 |
2169
2170**返回:**
2171
2172| 类型 | 说明 |
2173| -- | -- |
2174| size_t | 返回OH_Drawing_Range对象开始位置。 |
2175
2176### OH_Drawing_GetEndFromRange()
2177
2178```
2179size_t OH_Drawing_GetEndFromRange(OH_Drawing_Range* range)
2180```
2181
2182**描述**
2183
2184获取OH_Drawing_Range对象结束位置。
2185
2186**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2187
2188**起始版本:** 11
2189
2190
2191**参数:**
2192
2193| 参数项 | 描述 |
2194| -- | -- |
2195| [OH_Drawing_Range](capi-drawing-oh-drawing-range.md)* range | 指向OH_Drawing_Range对象的指针,由[OH_Drawing_TypographyGetWordBoundary](capi-drawing-text-typography-h.md#oh_drawing_typographygetwordboundary)获取。 |
2196
2197**返回:**
2198
2199| 类型 | 说明 |
2200| -- | -- |
2201| size_t | 返回OH_Drawing_Range对象结束位置。 |
2202
2203### OH_Drawing_TypographyGetLineCount()
2204
2205```
2206size_t OH_Drawing_TypographyGetLineCount(OH_Drawing_Typography* typography)
2207```
2208
2209**描述**
2210
2211获取排版对象中文本行数,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
2212
2213**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2214
2215**起始版本:** 11
2216
2217
2218**参数:**
2219
2220| 参数项 | 描述 |
2221| -- | -- |
2222| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2223
2224**返回:**
2225
2226| 类型 | 说明 |
2227| -- | -- |
2228| size_t | 返回行数。 |
2229
2230### OH_Drawing_SetTextStyleDecorationStyle()
2231
2232```
2233void OH_Drawing_SetTextStyleDecorationStyle(OH_Drawing_TextStyle* style, int decorationStyle)
2234```
2235
2236**描述**
2237
2238设置指定文本样式中的装饰线样式。
2239
2240**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2241
2242**起始版本:** 11
2243
2244
2245**参数:**
2246
2247| 参数项 | 描述 |
2248| -- | -- |
2249| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2250| int decorationStyle | 设置的文本装饰样式,支持可选的装饰样式具体可见[OH_Drawing_TextDecorationStyle](capi-drawing-text-typography-h.md#oh_drawing_textdecorationstyle)枚举。 |
2251
2252### OH_Drawing_SetTextStyleDecorationThicknessScale()
2253
2254```
2255void OH_Drawing_SetTextStyleDecorationThicknessScale(OH_Drawing_TextStyle* style, double decorationThicknessScale)
2256```
2257
2258**描述**
2259
2260设置文本装饰线的粗细缩放比例。
2261
2262**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2263
2264**起始版本:** 11
2265
2266
2267**参数:**
2268
2269| 参数项 | 描述 |
2270| -- | -- |
2271| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2272| double decorationThicknessScale | 粗细缩放比例。默认值为1,如果设置的粗细缩放比例小于等于0,不会绘制装饰线。 |
2273
2274### OH_Drawing_SetTextStyleLetterSpacing()
2275
2276```
2277void OH_Drawing_SetTextStyleLetterSpacing(OH_Drawing_TextStyle* style, double letterSpacing)
2278```
2279
2280**描述**
2281
2282设置文本的字符间距。
2283
2284**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2285
2286**起始版本:** 11
2287
2288
2289**参数:**
2290
2291| 参数项 | 描述 |
2292| -- | -- |
2293| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2294| double letterSpacing | 间距大小。 |
2295
2296### OH_Drawing_SetTextStyleWordSpacing()
2297
2298```
2299void OH_Drawing_SetTextStyleWordSpacing(OH_Drawing_TextStyle* style, double wordSpacing)
2300```
2301
2302**描述**
2303
2304设置文本的单词间距。
2305
2306**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2307
2308**起始版本:** 11
2309
2310
2311**参数:**
2312
2313| 参数项 | 描述 |
2314| -- | -- |
2315| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2316| double wordSpacing | 间距大小。 |
2317
2318### OH_Drawing_SetTextStyleHalfLeading()
2319
2320```
2321void OH_Drawing_SetTextStyleHalfLeading(OH_Drawing_TextStyle* style, bool halfLeading)
2322```
2323
2324**描述**
2325
2326设置文本为一半行间距。
2327
2328**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2329
2330**起始版本:** 11
2331
2332
2333**参数:**
2334
2335| 参数项 | 描述 |
2336| -- | -- |
2337| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2338| bool halfLeading | 设置一半行间距是否生效。true表示生效,false表示不生效。 |
2339
2340### OH_Drawing_SetTextStyleEllipsis()
2341
2342```
2343void OH_Drawing_SetTextStyleEllipsis(OH_Drawing_TextStyle* style, const char* ellipsis)
2344```
2345
2346**描述**
2347
2348设置文本的省略号内容。
2349
2350**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2351
2352**起始版本:** 11
2353
2354
2355**参数:**
2356
2357| 参数项 | 描述 |
2358| -- | -- |
2359| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2360| const char* ellipsis | 设置省略号内容,数据类型为指向char的指针。 |
2361
2362### OH_Drawing_SetTextStyleEllipsisModal()
2363
2364```
2365void OH_Drawing_SetTextStyleEllipsisModal(OH_Drawing_TextStyle* style, int ellipsisModal)
2366```
2367
2368**描述**
2369
2370设置文本的省略号样式。
2371
2372**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2373
2374**起始版本:** 11
2375
2376
2377**参数:**
2378
2379| 参数项 | 描述 |
2380| -- | -- |
2381| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2382| int ellipsisModal | 设置省略号样式,支持可选的省略号样式具体可见[OH_Drawing_EllipsisModal](capi-drawing-text-typography-h.md#oh_drawing_ellipsismodal)枚举。 |
2383
2384### OH_Drawing_SetTypographyTextBreakStrategy()
2385
2386```
2387void OH_Drawing_SetTypographyTextBreakStrategy(OH_Drawing_TypographyStyle* style, int breakStrategy)
2388```
2389
2390**描述**
2391
2392设置文本的中断策略。
2393
2394**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2395
2396**起始版本:** 11
2397
2398
2399**参数:**
2400
2401| 参数项 | 描述 |
2402| -- | -- |
2403| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2404| int breakStrategy | 设置中断策略,支持可选的中断策略具体可见[OH_Drawing_BreakStrategy](capi-drawing-text-typography-h.md#oh_drawing_breakstrategy)枚举。 |
2405
2406### OH_Drawing_SetTypographyTextWordBreakType()
2407
2408```
2409void OH_Drawing_SetTypographyTextWordBreakType(OH_Drawing_TypographyStyle* style, int wordBreakType)
2410```
2411
2412**描述**
2413
2414设置单词的断词方式。
2415
2416**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2417
2418**起始版本:** 11
2419
2420
2421**参数:**
2422
2423| 参数项 | 描述 |
2424| -- | -- |
2425| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2426| int wordBreakType | 设置断词方式,支持可选的断词方式样式具体可见[OH_Drawing_WordBreakType](capi-drawing-text-typography-h.md#oh_drawing_wordbreaktype)枚举。 |
2427
2428### OH_Drawing_SetTypographyTextEllipsisModal()
2429
2430```
2431void OH_Drawing_SetTypographyTextEllipsisModal(OH_Drawing_TypographyStyle* style, int ellipsisModal)
2432```
2433
2434**描述**
2435
2436设置文本的省略模式。
2437
2438**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2439
2440**起始版本:** 11
2441
2442
2443**参数:**
2444
2445| 参数项 | 描述 |
2446| -- | -- |
2447| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向OH_Drawing_TypographyStyle对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2448| int ellipsisModal | 设置省略号样式,支持可选的省略号样式样式具体可见[OH_Drawing_EllipsisModal](capi-drawing-text-typography-h.md#oh_drawing_ellipsismodal)枚举。 |
2449
2450### OH_Drawing_SetTypographyTextEllipsis()
2451
2452```
2453void OH_Drawing_SetTypographyTextEllipsis(OH_Drawing_TypographyStyle* style, const char* ellipsis)
2454```
2455
2456**描述**
2457
2458设置排版样式省略号文本。
2459
2460**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2461
2462**起始版本:** 12
2463
2464
2465**参数:**
2466
2467| 参数项 | 描述 |
2468| -- | -- |
2469| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2470| const char* ellipsis | 省略号文本。 |
2471
2472### OH_Drawing_TypographyGetLineHeight()
2473
2474```
2475double OH_Drawing_TypographyGetLineHeight(OH_Drawing_Typography* typography, int lineNumber)
2476```
2477
2478**描述**
2479
2480获取排版对象中指定行的行高,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
2481
2482**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2483
2484**起始版本:** 11
2485
2486
2487**参数:**
2488
2489| 参数项 | 描述 |
2490| -- | -- |
2491| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2492| int lineNumber | 要指定的行数。 |
2493
2494**返回:**
2495
2496| 类型 | 说明 |
2497| -- | -- |
2498| double | 返回指定行的行高。 |
2499
2500### OH_Drawing_TypographyGetLineWidth()
2501
2502```
2503double OH_Drawing_TypographyGetLineWidth(OH_Drawing_Typography* typography, int lineNumber)
2504```
2505
2506**描述**
2507
2508获取指定行的行宽,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
2509
2510**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2511
2512**起始版本:** 11
2513
2514
2515**参数:**
2516
2517| 参数项 | 描述 |
2518| -- | -- |
2519| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向OH_Drawing_Typography对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2520| int lineNumber | 要指定的行数。 |
2521
2522**返回:**
2523
2524| 类型 | 说明 |
2525| -- | -- |
2526| double | 返回指定行的行宽。 |
2527
2528### OH_Drawing_SetTypographyTextSplitRatio()
2529
2530```
2531void OH_Drawing_SetTypographyTextSplitRatio(OH_Drawing_TypographyStyle* style, float textSplitRatio)
2532```
2533
2534**描述**
2535
2536设置文本划分比率。
2537
2538**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2539
2540**起始版本:** 12
2541
2542
2543**参数:**
2544
2545| 参数项 | 描述 |
2546| -- | -- |
2547| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2548| float textSplitRatio | 文本划分比率。 |
2549
2550### OH_Drawing_TypographyIsLineUnlimited()
2551
2552```
2553bool OH_Drawing_TypographyIsLineUnlimited(OH_Drawing_TypographyStyle* style)
2554```
2555
2556**描述**
2557
2558获取文本是否有最大行数限制。
2559
2560**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2561
2562**起始版本:** 12
2563
2564
2565**参数:**
2566
2567| 参数项 | 描述 |
2568| -- | -- |
2569| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2570
2571**返回:**
2572
2573| 类型 | 说明 |
2574| -- | -- |
2575| bool | 返回文本是否有最大行数限制,true表示有最大行数限制,false表示无最大行数限制。 |
2576
2577### OH_Drawing_TypographyIsEllipsized()
2578
2579```
2580bool OH_Drawing_TypographyIsEllipsized(OH_Drawing_TypographyStyle* style)
2581```
2582
2583**描述**
2584
2585获取指定排版样式是否配置省略号。
2586
2587**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2588
2589**起始版本:** 12
2590
2591
2592**参数:**
2593
2594| 参数项 | 描述 |
2595| -- | -- |
2596| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2597
2598**返回:**
2599
2600| 类型 | 说明 |
2601| -- | -- |
2602| bool | 返回指定排版样式是否配置省略号,true表示已配置省略号,false表示没有配置省略号。 |
2603
2604### OH_Drawing_SetTypographyTextLocale()
2605
2606```
2607void OH_Drawing_SetTypographyTextLocale(OH_Drawing_TypographyStyle* style, const char* locale)
2608```
2609
2610**描述**
2611
2612设置指定排版样式的语言环境。
2613
2614**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2615
2616**起始版本:** 12
2617
2618
2619**参数:**
2620
2621| 参数项 | 描述 |
2622| -- | -- |
2623| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2624| const char* locale | 语言环境,数据类型为指向char的指针,如'en'代表英文,'zh-Hans'代表简体中文,'zh-Hant'代表繁体中文。 |
2625
2626### OH_Drawing_TextStyleGetFontMetrics()
2627
2628```
2629bool OH_Drawing_TextStyleGetFontMetrics(OH_Drawing_Typography* typography,OH_Drawing_TextStyle* style, OH_Drawing_Font_Metrics* fontmetrics)
2630```
2631
2632**描述**
2633
2634获取文本字体属性。
2635
2636**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2637
2638**起始版本:** 12
2639
2640
2641**参数:**
2642
2643| 参数项 | 描述 |
2644| -- | -- |
2645| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2646| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2647| [OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)* fontmetrics | 指向字体属性对象[OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)的指针,由[OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)获取。 |
2648
2649**返回:**
2650
2651| 类型 | 说明 |
2652| -- | -- |
2653| bool | 是否获取到字体属性。true表示获取到字体属性,false表示未获取到字体属性。 |
2654
2655### OH_Drawing_SetTypographyTextStyle()
2656
2657```
2658void OH_Drawing_SetTypographyTextStyle(OH_Drawing_TypographyStyle* handler, OH_Drawing_TextStyle* style)
2659```
2660
2661**描述**
2662
2663设置排版样式。
2664
2665**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2666
2667**起始版本:** 12
2668
2669
2670**参数:**
2671
2672| 参数项 | 描述 |
2673| -- | -- |
2674| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* handler | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2675| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
2676
2677### OH_Drawing_CreateFontDescriptor()
2678
2679```
2680OH_Drawing_FontDescriptor* OH_Drawing_CreateFontDescriptor(void)
2681```
2682
2683**描述**
2684
2685构造字体描述对象,用于描述系统字体详细信息。
2686
2687**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2688
2689**起始版本:** 12
2690
2691**返回:**
2692
2693| 类型 | 说明 |
2694| -- | -- |
2695| [OH_Drawing_FontDescriptor](capi-drawing-oh-drawing-fontdescriptor.md)* | 返回指向已创建的字体描述对象[OH_Drawing_FontDescriptor](capi-drawing-oh-drawing-fontdescriptor.md)的指针。 |
2696
2697### OH_Drawing_DestroyFontDescriptor()
2698
2699```
2700void OH_Drawing_DestroyFontDescriptor(OH_Drawing_FontDescriptor* descriptor)
2701```
2702
2703**描述**
2704
2705释放字体描述对象占用的内存。
2706
2707**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2708
2709**起始版本:** 12
2710
2711
2712**参数:**
2713
2714| 参数项 | 描述 |
2715| -- | -- |
2716| [OH_Drawing_FontDescriptor](capi-drawing-oh-drawing-fontdescriptor.md)* descriptor | 指向字体描述对象[OH_Drawing_FontDescriptor](capi-drawing-oh-drawing-fontdescriptor.md)的指针,由[OH_Drawing_CreateFontDescriptor](capi-drawing-text-typography-h.md#oh_drawing_createfontdescriptor)获取。 |
2717
2718### OH_Drawing_CreateFontParser()
2719
2720```
2721OH_Drawing_FontParser* OH_Drawing_CreateFontParser(void)
2722```
2723
2724**描述**
2725
2726构造字体解析对象,用于解析系统字体。
2727
2728**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2729
2730**起始版本:** 12
2731
2732**返回:**
2733
2734| 类型 | 说明 |
2735| -- | -- |
2736| [OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)* | 返回指向已创建的字体解析对象[OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)的指针。 |
2737
2738### OH_Drawing_DestroyFontParser()
2739
2740```
2741void OH_Drawing_DestroyFontParser(OH_Drawing_FontParser* parser)
2742```
2743
2744**描述**
2745
2746释放字体解析对象占用的内存。
2747
2748**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2749
2750**起始版本:** 12
2751
2752
2753**参数:**
2754
2755| 参数项 | 描述 |
2756| -- | -- |
2757| [OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)* parser | 指向字体解析对象[OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)的指针,由[OH_Drawing_CreateFontParser](capi-drawing-text-typography-h.md#oh_drawing_createfontparser)获取。 |
2758
2759### OH_Drawing_FontParserGetSystemFontList()
2760
2761```
2762char** OH_Drawing_FontParserGetSystemFontList(OH_Drawing_FontParser* fontParser, size_t* num)
2763```
2764
2765**描述**
2766
2767获取系统字体名称列表,此接口仅在2in1、phone设备上可用。
2768
2769**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2770
2771**起始版本:** 12
2772
2773
2774**参数:**
2775
2776| 参数项 | 描述 |
2777| -- | -- |
2778| [OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)* fontParser | 指向字体解析对象[OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)的指针,由[OH_Drawing_CreateFontParser](capi-drawing-text-typography-h.md#oh_drawing_createfontparser)获取。 |
2779| size_t* num | 返回获取到的系统字体名称数量。 |
2780
2781**返回:**
2782
2783| 类型 | 说明 |
2784| -- | -- |
2785| char** | 返回获取到的系统字体列表。 |
2786
2787### OH_Drawing_DestroySystemFontList()
2788
2789```
2790void OH_Drawing_DestroySystemFontList(char** fontList, size_t num)
2791```
2792
2793**描述**
2794
2795释放系统字体名称列表占用的内存。
2796
2797**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2798
2799**起始版本:** 12
2800
2801
2802**参数:**
2803
2804| 参数项 | 描述 |
2805| -- | -- |
2806| char** fontList | 指向系统字体名称列表的指针。 |
2807| size_t num | 系统字体名称列表的数量。 |
2808
2809### OH_Drawing_FontParserGetFontByName()
2810
2811```
2812OH_Drawing_FontDescriptor* OH_Drawing_FontParserGetFontByName(OH_Drawing_FontParser* fontParser, const char* name)
2813```
2814
2815**描述**
2816
2817根据传入的系统字体名称获取系统字体的相关信息。
2818
2819**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2820
2821**起始版本:** 12
2822
2823
2824**参数:**
2825
2826| 参数项 | 描述 |
2827| -- | -- |
2828| [OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)* fontParser | 指向字体解析对象[OH_Drawing_FontParser](capi-drawing-oh-drawing-fontparser.md)的指针,由[OH_Drawing_CreateFontParser](capi-drawing-text-typography-h.md#oh_drawing_createfontparser)获取。 |
2829| const char* name | 系统字体名。 |
2830
2831**返回:**
2832
2833| 类型 | 说明 |
2834| -- | -- |
2835| OH_Drawing_FontDescriptor* | 返回系统字体描述对象,不再需要时,请使用[OH_Drawing_DestroyFontParser](capi-drawing-text-typography-h.md#oh_drawing_destroyfontparser)释放该对象指针。 |
2836
2837### OH_Drawing_TypographyGetLineMetrics()
2838
2839```
2840OH_Drawing_LineMetrics* OH_Drawing_TypographyGetLineMetrics(OH_Drawing_Typography* typography)
2841```
2842
2843**描述**
2844
2845获取排版对象的行位置信息,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。不再需要[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)时,请使用[OH_Drawing_DestroyLineMetrics](capi-drawing-text-typography-h.md#oh_drawing_destroylinemetrics)接口释放该对象的指针。
2846
2847**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2848
2849**起始版本:** 12
2850
2851
2852**参数:**
2853
2854| 参数项 | 描述 |
2855| -- | -- |
2856| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2857
2858**返回:**
2859
2860| 类型 | 说明 |
2861| -- | -- |
2862| [OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)* | 返回指向行位置信息对象[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)的指针。 |
2863
2864### OH_Drawing_LineMetricsGetSize()
2865
2866```
2867size_t OH_Drawing_LineMetricsGetSize(OH_Drawing_LineMetrics* lineMetrics)
2868```
2869
2870**描述**
2871
2872获取行数量。
2873
2874**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2875
2876**起始版本:** 12
2877
2878
2879**参数:**
2880
2881| 参数项 | 描述 |
2882| -- | -- |
2883| [OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)* lineMetrics | 指向行位置信息对象[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)的指针,由[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)获取。 |
2884
2885**返回:**
2886
2887| 类型 | 说明 |
2888| -- | -- |
2889| size_t | 返回行数量。 |
2890
2891### OH_Drawing_DestroyLineMetrics()
2892
2893```
2894void OH_Drawing_DestroyLineMetrics(OH_Drawing_LineMetrics* lineMetrics)
2895```
2896
2897**描述**
2898
2899释放行位置信息对象占用的内存。
2900
2901**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2902
2903**起始版本:** 12
2904
2905
2906**参数:**
2907
2908| 参数项 | 描述 |
2909| -- | -- |
2910| [OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)* lineMetrics | 指向行位置信息对象[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)的指针,由[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)获取。 |
2911
2912### OH_Drawing_TypographyGetLineMetricsAt()
2913
2914```
2915bool OH_Drawing_TypographyGetLineMetricsAt(OH_Drawing_Typography* typography,int lineNumber, OH_Drawing_LineMetrics* lineMetric)
2916```
2917
2918**描述**
2919
2920获取排版对象的指定行位置信息,具体参见[OH_Drawing_LineMetr](capi-drawing-oh-drawing-linemetrics.md)结构体,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
2921
2922**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2923
2924**起始版本:** 12
2925
2926
2927**参数:**
2928
2929| 参数项 | 描述 |
2930| -- | -- |
2931| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2932| int lineNumber | 要获取的行数。 |
2933| [OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)* lineMetric | 指向行位置信息对象[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)的指针,由[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)获取。 |
2934
2935**返回:**
2936
2937| 类型 | 说明 |
2938| -- | -- |
2939| bool | 行位置信息对象是否成功获取。true表示成功获取,false表示未成功获取。 |
2940
2941### OH_Drawing_TypographyGetLineInfo()
2942
2943```
2944bool OH_Drawing_TypographyGetLineInfo(OH_Drawing_Typography* typography, int lineNumber, bool oneLine,bool includeWhitespace, OH_Drawing_LineMetrics* drawingLineMetrics)
2945```
2946
2947**描述**
2948
2949获取排版对象中指定行的位置信息或指定行第一个字符的位置信息,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。
2950
2951**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2952
2953**起始版本:** 12
2954
2955
2956**参数:**
2957
2958| 参数项 | 描述 |
2959| -- | -- |
2960| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
2961| int lineNumber | 行号。 |
2962| bool oneLine | true为获取整行的位置信息,false为获取第一个字符的位置信息。 |
2963| bool includeWhitespace | 文字宽度是否包含空白符。true表示不包含空白符,false表示包含空白符。 |
2964| [OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)* drawingLineMetrics | 指向行位置信息对象[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)的指针,由[OH_Drawing_LineMetrics](capi-drawing-oh-drawing-linemetrics.md)获取。 |
2965
2966**返回:**
2967
2968| 类型 | 说明 |
2969| -- | -- |
2970| bool | 指定行的行位置信息或第一个字符的位置信息是否成功获取,true表示成功获取,false表示未成功获取。 |
2971
2972### OH_Drawing_SetTypographyTextFontWeight()
2973
2974```
2975void OH_Drawing_SetTypographyTextFontWeight(OH_Drawing_TypographyStyle* style, int weight)
2976```
2977
2978**描述**
2979
2980设置排版样式默认字重。目前只有系统默认字体支持字重的调节,其他字体设置字重值小于semi-bold时字体粗细无变化,当设置字重值大于等于semi-bold时可能会触发伪加粗效果。
2981
2982**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
2983
2984**起始版本:** 12
2985
2986
2987**参数:**
2988
2989| 参数项 | 描述 |
2990| -- | -- |
2991| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
2992| int weight | 设置字重,设置0字重为thin,设置1字重为extra-light,设置2字重为light,设置4字重为medium,设置5字重为semi-bold,<br>设置6字重为bold,设置7字重为extra-bold,设置8字重为black,设置3或其它字重为normal/regular,具体可见[OH_Drawing_FontWeight](capi-drawing-text-typography-h.md#oh_drawing_fontweight)枚举。 |
2993
2994### OH_Drawing_SetTypographyTextFontStyle()
2995
2996```
2997void OH_Drawing_SetTypographyTextFontStyle(OH_Drawing_TypographyStyle* style, int fontStyle)
2998```
2999
3000**描述**
3001
3002设置排版样式默认的字体样式。
3003
3004**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3005
3006**起始版本:** 12
3007
3008
3009**参数:**
3010
3011| 参数项 | 描述 |
3012| -- | -- |
3013| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本样式对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3014| int fontStyle | 设置字体样式,设置1为斜体,设置0或其它为非斜体,具体可见[OH_Drawing_FontStyle](capi-drawing-text-typography-h.md#oh_drawing_fontstyle)枚举。 |
3015
3016### OH_Drawing_SetTypographyTextFontFamily()
3017
3018```
3019void OH_Drawing_SetTypographyTextFontFamily(OH_Drawing_TypographyStyle* style, const char* fontFamily)
3020```
3021
3022**描述**
3023
3024设置字体家族的名称。
3025
3026**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3027
3028**起始版本:** 12
3029
3030
3031**参数:**
3032
3033| 参数项 | 描述 |
3034| -- | -- |
3035| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3036| const char* fontFamily | 字体家族的名称,数据类型为指向char的指针。 |
3037
3038### OH_Drawing_SetTypographyTextFontSize()
3039
3040```
3041void OH_Drawing_SetTypographyTextFontSize(OH_Drawing_TypographyStyle* style, double fontSize)
3042```
3043
3044**描述**
3045
3046设置文本排版字号。
3047
3048**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3049
3050**起始版本:** 12
3051
3052
3053**参数:**
3054
3055| 参数项 | 描述 |
3056| -- | -- |
3057| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3058| double fontSize | 字号(大于0)。 |
3059
3060### OH_Drawing_SetTypographyTextFontHeight()
3061
3062```
3063void OH_Drawing_SetTypographyTextFontHeight(OH_Drawing_TypographyStyle* style, double fontHeight)
3064```
3065
3066**描述**
3067
3068设置文本排版字体高度。
3069
3070**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3071
3072**起始版本:** 12
3073
3074
3075**参数:**
3076
3077| 参数项 | 描述 |
3078| -- | -- |
3079| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3080| double fontHeight | 字体高度。 |
3081
3082### OH_Drawing_SetTypographyTextHalfLeading()
3083
3084```
3085void OH_Drawing_SetTypographyTextHalfLeading(OH_Drawing_TypographyStyle* style, bool halfLeading)
3086```
3087
3088**描述**
3089
3090设置文本排版是否为一半行间距。
3091
3092**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3093
3094**起始版本:** 12
3095
3096
3097**参数:**
3098
3099| 参数项 | 描述 |
3100| -- | -- |
3101| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3102| bool halfLeading | 设置一半行间距是否生效,true表示生效,false表示不生效。 |
3103
3104### OH_Drawing_SetTypographyTextUseLineStyle()
3105
3106```
3107void OH_Drawing_SetTypographyTextUseLineStyle(OH_Drawing_TypographyStyle* style, bool useLineStyle)
3108```
3109
3110**描述**
3111
3112设置文本排版是否启用行样式。
3113
3114**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3115
3116**起始版本:** 12
3117
3118
3119**参数:**
3120
3121| 参数项 | 描述 |
3122| -- | -- |
3123| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3124| bool useLineStyle | 设置行样式是否启用,true表示启用,false表示不启用。 |
3125
3126### OH_Drawing_SetTypographyTextLineStyleFontWeight()
3127
3128```
3129void OH_Drawing_SetTypographyTextLineStyleFontWeight(OH_Drawing_TypographyStyle* style, int weight)
3130```
3131
3132**描述**
3133
3134设置排版样式中支柱样式的文本样式字重。目前只有系统默认字体支持字重的调节,其他字体设置字重值小于semi-bold时字体粗细无变化,当设置字重值大于等于semi-bold时可能会触发伪加粗效果。
3135
3136**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3137
3138**起始版本:** 12
3139
3140
3141**参数:**
3142
3143| 参数项 | 描述 |
3144| -- | -- |
3145| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3146| int weight | 设置字重,设置0字重为thin,设置1字重为extra-light,设置2字重为light,设置4字重为medium,设置5字重为semi-bold,设置6字重为bold,设置7字重为extra-bold,设置8字重为black,设置3或其它字重为normal/regular,具体可见[OH_Drawing_FontWeight](capi-drawing-text-typography-h.md#oh_drawing_fontweight)枚举。 |
3147
3148### OH_Drawing_SetTypographyTextLineStyleFontStyle()
3149
3150```
3151void OH_Drawing_SetTypographyTextLineStyleFontStyle(OH_Drawing_TypographyStyle* style, int fontStyle)
3152```
3153
3154**描述**
3155
3156设置文本排版样式中支柱样式的字体样式。
3157
3158**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3159
3160**起始版本:** 12
3161
3162
3163**参数:**
3164
3165| 参数项 | 描述 |
3166| -- | -- |
3167| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格指向排版样式对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3168| int fontStyle | 设置字体样式,设置1为斜体,设置0或其它为非斜体,具体可见[OH_Drawing_FontStyle](capi-drawing-text-typography-h.md#oh_drawing_fontstyle)枚举。 |
3169
3170### OH_Drawing_SetTypographyTextLineStyleFontFamilies()
3171
3172```
3173void OH_Drawing_SetTypographyTextLineStyleFontFamilies(OH_Drawing_TypographyStyle* style,int fontFamiliesNumber, const char* fontFamilies[])
3174```
3175
3176**描述**
3177
3178设置文本排版行样式字体类型。
3179
3180**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3181
3182**起始版本:** 12
3183
3184
3185**参数:**
3186
3187| 参数项 | 描述 |
3188| -- | -- |
3189| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3190| int fontFamiliesNumber | 字体名称数量。 |
3191| fontFamilies |  指向字体类型的指针。 |
3192
3193### OH_Drawing_SetTypographyTextLineStyleFontSize()
3194
3195```
3196void OH_Drawing_SetTypographyTextLineStyleFontSize(OH_Drawing_TypographyStyle* style, double lineStyleFontSize)
3197```
3198
3199**描述**
3200
3201设置文本排版行样式字号。
3202
3203**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3204
3205**起始版本:** 12
3206
3207
3208**参数:**
3209
3210| 参数项 | 描述 |
3211| -- | -- |
3212| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3213| double lineStyleFontSize | 字号(大于0)。 |
3214
3215### OH_Drawing_SetTypographyTextLineStyleFontHeight()
3216
3217```
3218void OH_Drawing_SetTypographyTextLineStyleFontHeight(OH_Drawing_TypographyStyle* style, double lineStyleFontHeight)
3219```
3220
3221**描述**
3222
3223设置文本排版行样式字体高度。
3224
3225**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3226
3227**起始版本:** 12
3228
3229
3230**参数:**
3231
3232| 参数项 | 描述 |
3233| -- | -- |
3234| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3235| double lineStyleFontHeight | 字体高度。 |
3236
3237### OH_Drawing_SetTypographyTextLineStyleHalfLeading()
3238
3239```
3240void OH_Drawing_SetTypographyTextLineStyleHalfLeading(OH_Drawing_TypographyStyle* style, bool lineStyleHalfLeading)
3241```
3242
3243**描述**
3244
3245设置文本排版行样式是否为一半行间距。
3246
3247**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3248
3249**起始版本:** 12
3250
3251
3252**参数:**
3253
3254| 参数项 | 描述 |
3255| -- | -- |
3256| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3257| bool lineStyleHalfLeading | 设置一半行间距是否生效。true表示生效,false表示不生效。 |
3258
3259### OH_Drawing_SetTypographyTextLineStyleSpacingScale()
3260
3261```
3262void OH_Drawing_SetTypographyTextLineStyleSpacingScale(OH_Drawing_TypographyStyle* style, double spacingScale)
3263```
3264
3265**描述**
3266
3267设置文本排版行样式间距比例。
3268
3269**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3270
3271**起始版本:** 12
3272
3273
3274**参数:**
3275
3276| 参数项 | 描述 |
3277| -- | -- |
3278| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3279| double spacingScale | 间距比例。 |
3280
3281### OH_Drawing_SetTypographyTextLineStyleOnly()
3282
3283```
3284void OH_Drawing_SetTypographyTextLineStyleOnly(OH_Drawing_TypographyStyle* style, bool lineStyleOnly)
3285```
3286
3287**描述**
3288
3289设置文本排版是否仅启用行样式。
3290
3291**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3292
3293**起始版本:** 12
3294
3295
3296**参数:**
3297
3298| 参数项 | 描述 |
3299| -- | -- |
3300| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3301| bool lineStyleOnly | 设置仅启用行样式是否生效。true表示生效,false表示不生效。 |
3302
3303### OH_Drawing_CreateTextShadow()
3304
3305```
3306OH_Drawing_TextShadow* OH_Drawing_CreateTextShadow(void)
3307```
3308
3309**描述**
3310
3311创建指向字体阴影对象的指针。不再需要[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)时,请使用[OH_Drawing_DestroyTextShadow](capi-drawing-text-typography-h.md#oh_drawing_destroytextshadow)接口释放该对象的指针。
3312
3313**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3314
3315**起始版本:** 12
3316
3317**返回:**
3318
3319| 类型 | 说明 |
3320| -- | -- |
3321| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* | 指向创建的字体阴影对象。 |
3322
3323### OH_Drawing_DestroyTextShadow()
3324
3325```
3326void OH_Drawing_DestroyTextShadow(OH_Drawing_TextShadow* shadow)
3327```
3328
3329**描述**
3330
3331释放被字体阴影对象占据的内存。
3332
3333**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3334
3335**起始版本:** 12
3336
3337
3338**参数:**
3339
3340| 参数项 | 描述 |
3341| -- | -- |
3342| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* shadow | 指向字体阴影对象[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针,由[OH_Drawing_CreateTextShadow](capi-drawing-text-typography-h.md#oh_drawing_createtextshadow)获取。 |
3343
3344### OH_Drawing_TextStyleGetShadows()
3345
3346```
3347OH_Drawing_TextShadow* OH_Drawing_TextStyleGetShadows(OH_Drawing_TextStyle* style)
3348```
3349
3350**描述**
3351
3352获取字体阴影容器。不再需要[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)时,请使用[OH_Drawing_DestroyTextShadows](capi-drawing-text-typography-h.md#oh_drawing_destroytextshadows)接口释放该对象的指针。
3353
3354**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3355
3356**起始版本:** 12
3357
3358
3359**参数:**
3360
3361| 参数项 | 描述 |
3362| -- | -- |
3363| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3364
3365**返回:**
3366
3367| 类型 | 说明 |
3368| -- | -- |
3369| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* | 返回指向字体阴影容器[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针。 |
3370
3371### OH_Drawing_TextStyleGetShadowCount()
3372
3373```
3374int OH_Drawing_TextStyleGetShadowCount(OH_Drawing_TextStyle* style)
3375```
3376
3377**描述**
3378
3379获取字体阴影容器的大小。
3380
3381**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3382
3383**起始版本:** 12
3384
3385
3386**参数:**
3387
3388| 参数项 | 描述 |
3389| -- | -- |
3390| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3391
3392**返回:**
3393
3394| 类型 | 说明 |
3395| -- | -- |
3396| int | int 返回字体阴影容器的大小。 |
3397
3398### OH_Drawing_TextStyleAddShadow()
3399
3400```
3401void OH_Drawing_TextStyleAddShadow(OH_Drawing_TextStyle* style, const OH_Drawing_TextShadow* shadow)
3402```
3403
3404**描述**
3405
3406字体阴影容器中添加字体阴影元素。
3407
3408**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3409
3410**起始版本:** 12
3411
3412
3413**参数:**
3414
3415| 参数项 | 描述 |
3416| -- | -- |
3417| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3418| const [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* shadow | 指向字体阴影对象[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针,由[OH_Drawing_CreateTextShadow](capi-drawing-text-typography-h.md#oh_drawing_createtextshadow)获取。 |
3419
3420### OH_Drawing_TextStyleClearShadows()
3421
3422```
3423void OH_Drawing_TextStyleClearShadows(OH_Drawing_TextStyle* style)
3424```
3425
3426**描述**
3427
3428清除字体阴影容器中的所有元素。
3429
3430**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3431
3432**起始版本:** 12
3433
3434
3435**参数:**
3436
3437| 参数项 | 描述 |
3438| -- | -- |
3439| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3440
3441### OH_Drawing_TextStyleGetShadowWithIndex()
3442
3443```
3444OH_Drawing_TextShadow* OH_Drawing_TextStyleGetShadowWithIndex(OH_Drawing_TextStyle* style, int index)
3445```
3446
3447**描述**
3448
3449根据下标获取字体阴影容器中的元素。
3450
3451**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3452
3453**起始版本:** 12
3454
3455
3456**参数:**
3457
3458| 参数项 | 描述 |
3459| -- | -- |
3460| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3461| int index | 下标索引。 |
3462
3463**返回:**
3464
3465| 类型 | 说明 |
3466| -- | -- |
3467| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* | 返回指向字体阴影对象[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针。 |
3468
3469### OH_Drawing_TypographySetIndents()
3470
3471```
3472void OH_Drawing_TypographySetIndents(OH_Drawing_Typography* typography, int indentsNumber, const float indents[])
3473```
3474
3475**描述**
3476
3477设置文本的排版缩进,不调用此接口默认文本无缩进。
3478
3479**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3480
3481**起始版本:** 12
3482
3483
3484**参数:**
3485
3486| 参数项 | 描述 |
3487| -- | -- |
3488| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
3489| int indentsNumber | 为段落设置的缩进数量。该值应小于或等于 indents 数组的长度,以避免访问数组越界导致的显示异常。 |
3490| indents |  指向浮点类型数组的指针,每个数组元素表示一个缩进宽度,单位为物理像素(px)。在应用[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)接口时,需要先声明并初始化该浮点数组。 |
3491
3492### OH_Drawing_TypographyGetIndentsWithIndex()
3493
3494```
3495float OH_Drawing_TypographyGetIndentsWithIndex(OH_Drawing_Typography* typography, int index)
3496```
3497
3498**描述**
3499
3500根据行索引获取排版对象缩进容器中的元素,行索引从0开始。
3501
3502**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3503
3504**起始版本:** 12
3505
3506
3507**参数:**
3508
3509| 参数项 | 描述 |
3510| -- | -- |
3511| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
3512| int index | 下标索引。 |
3513
3514**返回:**
3515
3516| 类型 | 说明 |
3517| -- | -- |
3518| float | float 返回索引对应的元素值。 |
3519
3520### OH_Drawing_TypographyGetLineTextRange()
3521
3522```
3523OH_Drawing_Range* OH_Drawing_TypographyGetLineTextRange(OH_Drawing_Typography* typography,int lineNumber, bool includeSpaces)
3524```
3525
3526**描述**
3527
3528获取排版对象中行的边界,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用。该接口只能获取已有行的边界,即输入行索引从0开始,最大行索引为[OH_Drawing_TypographyGetLineCount](capi-drawing-text-typography-h.md#oh_drawing_typographygetlinecount) - 1。
3529
3530**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3531
3532**起始版本:** 12
3533
3534
3535**参数:**
3536
3537| 参数项 | 描述 |
3538| -- | -- |
3539| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
3540| int lineNumber | 行索引 |
3541| bool includeSpaces | 设置返回的边界是否包含空格,true为包含空格,false为不包含空格。 |
3542
3543**返回:**
3544
3545| 类型 | 说明 |
3546| -- | -- |
3547| [OH_Drawing_Range](capi-drawing-oh-drawing-range.md)* | 返回指向行边界对象的指针[OH_Drawing_Range](capi-drawing-oh-drawing-range.md)。如果输入的行索引是非法的行索引,则返回的边界范围的start和end都为0。 |
3548
3549### OH_Drawing_DestroyTextShadows()
3550
3551```
3552void OH_Drawing_DestroyTextShadows(OH_Drawing_TextShadow* shadow)
3553```
3554
3555**描述**
3556
3557释放由被字体阴影对象OH_Drawing_TextShadow构成的vector占据的内存。
3558
3559**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3560
3561**起始版本:** 12
3562
3563
3564**参数:**
3565
3566| 参数项 | 描述 |
3567| -- | -- |
3568| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* shadow | 指向字体阴影对象[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针,由[OH_Drawing_CreateTextShadow](capi-drawing-text-typography-h.md#oh_drawing_createtextshadow)获取。 |
3569
3570### OH_Drawing_GetSystemFontConfigInfo()
3571
3572```
3573OH_Drawing_FontConfigInfo* OH_Drawing_GetSystemFontConfigInfo(OH_Drawing_FontConfigInfoErrorCode* errorCode)
3574```
3575
3576**描述**
3577
3578获取系统字体配置信息。
3579
3580**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3581
3582**起始版本:** 12
3583
3584
3585**参数:**
3586
3587| 参数项 | 描述 |
3588| -- | -- |
3589| [OH_Drawing_FontConfigInfoErrorCode](#oh_drawing_fontconfiginfoerrorcode)* errorCode | 错误码,具体可见[OH_Drawing_FontConfigInfoErrorCode](capi-drawing-text-typography-h.md#oh_drawing_fontconfiginfoerrorcode)枚举。 |
3590
3591**返回:**
3592
3593| 类型 | 说明 |
3594| -- | -- |
3595| [OH_Drawing_FontConfigInfo](capi-drawing-oh-drawing-fontconfiginfo.md)* | 返回系统字体配置信息的指针,不再需要时,请使用[OH_Drawing_DestroySystemFontConfigInfo](capi-drawing-text-typography-h.md#oh_drawing_destroysystemfontconfiginfo)释放该对象指针。 |
3596
3597### OH_Drawing_DestroySystemFontConfigInfo()
3598
3599```
3600void OH_Drawing_DestroySystemFontConfigInfo(OH_Drawing_FontConfigInfo* drawFontCfgInfo)
3601```
3602
3603**描述**
3604
3605释放系统字体配置信息占用的内存。
3606
3607**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3608
3609**起始版本:** 12
3610
3611
3612**参数:**
3613
3614| 参数项 | 描述 |
3615| -- | -- |
3616| [OH_Drawing_FontConfigInfo](capi-drawing-oh-drawing-fontconfiginfo.md)* drawFontCfgInfo | 指向系统字体配置信息[OH_Drawing_FontConfigInfo](capi-drawing-oh-drawing-fontconfiginfo.md)的指针,由[OH_Drawing_GetSystemFontConfigInfo](capi-drawing-text-typography-h.md#oh_drawing_getsystemfontconfiginfo)获取。 |
3617
3618### OH_Drawing_SetTextStyleFontStyleStruct()
3619
3620```
3621void OH_Drawing_SetTextStyleFontStyleStruct(OH_Drawing_TextStyle* drawingTextStyle,OH_Drawing_FontStyleStruct fontStyle)
3622```
3623
3624**描述**
3625
3626设置文本样式中的字体样式,包括字体字重、字体宽度和字体斜度。
3627
3628**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3629
3630**起始版本:** 12
3631
3632
3633**参数:**
3634
3635| 参数项 | 描述 |
3636| -- | -- |
3637| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* drawingTextStyle | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3638| [OH_Drawing_FontStyleStruct](capi-drawing-oh-drawing-fontstylestruct.md) fontStyle | 字体样式对象,包括字体字重、字体宽度和字体斜度信息。 |
3639
3640### OH_Drawing_SetTextStyleBadgeType()
3641
3642```
3643void OH_Drawing_SetTextStyleBadgeType(OH_Drawing_TextStyle* style, OH_Drawing_TextBadgeType textBadgeType)
3644```
3645
3646**描述**
3647
3648设置文本排版时是否使能上标或下标。未调用此接口时,默认不使能。
3649
3650**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3651
3652**起始版本:** 20
3653
3654
3655**参数:**
3656
3657| 参数项 | 描述 |
3658| -- | -- |
3659| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 表示指向[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3660| [OH_Drawing_TextBadgeType](#oh_drawing_textbadgetype) textBadgeType | 设置文本排版时是否使能上标或下标。TEXT_SUPERSCRIPT表示使能上标,TEXT_SUBSCRIPT表示使能下标,默认值为TEXT_BADGE_NONE表示不使能。 |
3661
3662### OH_Drawing_TextStyleGetFontStyleStruct()
3663
3664```
3665OH_Drawing_FontStyleStruct OH_Drawing_TextStyleGetFontStyleStruct(OH_Drawing_TextStyle* drawingTextStyle)
3666```
3667
3668**描述**
3669
3670获取文本样式中的字体样式,包括字体字重、字体宽度和字体斜度。
3671
3672**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3673
3674**起始版本:** 12
3675
3676
3677**参数:**
3678
3679| 参数项 | 描述 |
3680| -- | -- |
3681| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* drawingTextStyle | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3682
3683**返回:**
3684
3685| 类型 | 说明 |
3686| -- | -- |
3687| [OH_Drawing_FontStyleStruct](capi-drawing-oh-drawing-fontstylestruct.md) | 返回获取到的字体样式对象,包括字体字重、字体宽度和字体斜度信息。 |
3688
3689### OH_Drawing_SetTypographyStyleFontStyleStruct()
3690
3691```
3692void OH_Drawing_SetTypographyStyleFontStyleStruct(OH_Drawing_TypographyStyle* drawingStyle,OH_Drawing_FontStyleStruct fontStyle)
3693```
3694
3695**描述**
3696
3697设置排版样式中默认文本样式的字体样式,包括字体字重、字体宽度和字体斜度。
3698
3699**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3700
3701**起始版本:** 12
3702
3703
3704**参数:**
3705
3706| 参数项 | 描述 |
3707| -- | -- |
3708| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* drawingStyle | 指向排版样式对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3709| [OH_Drawing_FontStyleStruct](capi-drawing-oh-drawing-fontstylestruct.md) fontStyle | 字体样式对象,包括字体字重、字体宽度和字体斜度信息。 |
3710
3711### OH_Drawing_TypographyStyleGetFontStyleStruct()
3712
3713```
3714OH_Drawing_FontStyleStruct OH_Drawing_TypographyStyleGetFontStyleStruct(OH_Drawing_TypographyStyle* drawingStyle)
3715```
3716
3717**描述**
3718
3719获取排版样式中默认文本样式的字体样式,包括字体字重、字体宽度和字体斜度。
3720
3721**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3722
3723**起始版本:** 12
3724
3725
3726**参数:**
3727
3728| 参数项 | 描述 |
3729| -- | -- |
3730| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* drawingStyle | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3731
3732**返回:**
3733
3734| 类型 | 说明 |
3735| -- | -- |
3736| [OH_Drawing_FontStyleStruct](capi-drawing-oh-drawing-fontstylestruct.md) | 返回获取到的字体样式对象,包括字体字重、字体宽度和字体斜度信息。 |
3737
3738### OH_Drawing_TextStyleSetBackgroundRect()
3739
3740```
3741void OH_Drawing_TextStyleSetBackgroundRect(OH_Drawing_TextStyle* style,const OH_Drawing_RectStyle_Info* rectStyleInfo, int styleId)
3742```
3743
3744**描述**
3745
3746设置文本背景矩形框和样式id。样式id仅当背景框为圆角矩形时有效。
3747
3748**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3749
3750**起始版本:** 12
3751
3752
3753**参数:**
3754
3755| 参数项 | 描述 |
3756| -- | -- |
3757| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3758| const [OH_Drawing_RectStyle_Info](capi-drawing-oh-drawing-rectstyle-info.md)* rectStyleInfo | 指向[OH_Drawing_RectStyle_Info](capi-drawing-oh-drawing-rectstyle-info.md)对象的指针。 |
3759| int styleId | 要设置的样式id,仅当背景框为圆角矩形时有效。文本处理时会被划分为多个分段,每个分段都有自己的TextStyle,id标识着这个分段将被绘制于第几个背景矩形框中。<br>若一行中每个分段的id全为0,表示所有分段绘制在同一个圆角矩形背景框中;若一行中的id为0, 1,则id为0的分段绘制在一个圆角矩形背景框内,id为1的分段绘制在另一个圆角矩形背景框内,以此类推。 |
3760
3761### OH_Drawing_TypographyHandlerAddSymbol()
3762
3763```
3764void OH_Drawing_TypographyHandlerAddSymbol(OH_Drawing_TypographyCreate* handler, uint32_t symbol)
3765```
3766
3767**描述**
3768
3769设置排版创建过程中的符号。
3770
3771**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3772
3773**起始版本:** 12
3774
3775
3776**参数:**
3777
3778| 参数项 | 描述 |
3779| -- | -- |
3780| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
3781| uint32_t symbol | 设置的symbol码位值,详见[主题图标库](https://developer.huawei.com/consumer/cn/design/harmonyos-symbol/)列表视图下的unicode值。 |
3782
3783### OH_Drawing_TextStyleAddFontFeature()
3784
3785```
3786void OH_Drawing_TextStyleAddFontFeature(OH_Drawing_TextStyle* style, const char* tag, int value)
3787```
3788
3789**描述**
3790
3791设置文本样式中指定字体特征是否启用。
3792
3793**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3794
3795**起始版本:** 12
3796
3797
3798**参数:**
3799
3800| 参数项 | 描述 |
3801| -- | -- |
3802| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3803| const char* tag | 指向字体特征键值对中关键字所标识的字符串。 |
3804| int value | 要设置的字体特征键值对的值。 |
3805
3806### OH_Drawing_TextStyleAddFontVariation()
3807
3808```
3809void OH_Drawing_TextStyleAddFontVariation(OH_Drawing_TextStyle* style, const char* axis, const float value)
3810```
3811
3812**描述**
3813
3814添加可变字体属性。对应的字体文件(.ttf文件)需要支持可变调节,此接口才能生效。当对应的字体不支持可变调节时,此接口调用不生效。
3815
3816**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3817
3818**起始版本:** 12
3819
3820
3821**参数:**
3822
3823| 参数项 | 描述 |
3824| -- | -- |
3825| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3826| const char* axis | 可变字体属性键值对中的键。目前仅支持'wght',表示字重属性。 |
3827| const float value | 设置的可变字体属性键值对的值。目前默认字体下字重属性支持的取值范围为[0,900]。 |
3828
3829### OH_Drawing_TextStyleGetFontFeatures()
3830
3831```
3832OH_Drawing_FontFeature* OH_Drawing_TextStyleGetFontFeatures(OH_Drawing_TextStyle* style)
3833```
3834
3835**描述**
3836
3837获取指定文本样式的字体特征map容器中所有内容。
3838
3839**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3840
3841**起始版本:** 12
3842
3843
3844**参数:**
3845
3846| 参数项 | 描述 |
3847| -- | -- |
3848| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3849
3850**返回:**
3851
3852| 类型 | 说明 |
3853| -- | -- |
3854| [OH_Drawing_FontFeature](capi-drawing-oh-drawing-fontfeature.md)* | 要获取的字体特征容器的所有内容,指向存放容器所有键值对的一个结构体数组。 |
3855
3856### OH_Drawing_TextStyleDestroyFontFeatures()
3857
3858```
3859void OH_Drawing_TextStyleDestroyFontFeatures(OH_Drawing_FontFeature* fontFeature, size_t fontFeatureSize)
3860```
3861
3862**描述**
3863
3864释放存放字体特征所有内容的结构体数组所占用的空间。
3865
3866**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3867
3868**起始版本:** 12
3869
3870
3871**参数:**
3872
3873| 参数项 | 描述 |
3874| -- | -- |
3875| [OH_Drawing_FontFeature](capi-drawing-oh-drawing-fontfeature.md)* fontFeature | 指向存放容器所有键值对的结构体数组指针,由[OH_Drawing_TextStyleGetFontFeatures](capi-drawing-text-typography-h.md#oh_drawing_textstylegetfontfeatures)获取。 |
3876| size_t fontFeatureSize | 存放容器所有键值对的结构体数组的大小。 |
3877
3878### OH_Drawing_TextStyleGetFontFeatureSize()
3879
3880```
3881size_t OH_Drawing_TextStyleGetFontFeatureSize(OH_Drawing_TextStyle* style)
3882```
3883
3884**描述**
3885
3886获取指定文本样式中字体特征map容器的大小。
3887
3888**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3889
3890**起始版本:** 12
3891
3892
3893**参数:**
3894
3895| 参数项 | 描述 |
3896| -- | -- |
3897| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3898
3899**返回:**
3900
3901| 类型 | 说明 |
3902| -- | -- |
3903| size_t | 字体特征map容器的大小。 |
3904
3905### OH_Drawing_TextStyleClearFontFeature()
3906
3907```
3908void OH_Drawing_TextStyleClearFontFeature(OH_Drawing_TextStyle* style)
3909```
3910
3911**描述**
3912
3913清除指定文本样式的字体特征map容器中所有内容。
3914
3915**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3916
3917**起始版本:** 12
3918
3919
3920**参数:**
3921
3922| 参数项 | 描述 |
3923| -- | -- |
3924| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3925
3926### OH_Drawing_TextStyleGetBaselineShift()
3927
3928```
3929double OH_Drawing_TextStyleGetBaselineShift(OH_Drawing_TextStyle* style)
3930```
3931
3932**描述**
3933
3934获取指定文本样式的基线偏移。
3935
3936**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3937
3938**起始版本:** 12
3939
3940
3941**参数:**
3942
3943| 参数项 | 描述 |
3944| -- | -- |
3945| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3946
3947**返回:**
3948
3949| 类型 | 说明 |
3950| -- | -- |
3951| double | 基线偏移的值。 |
3952
3953### OH_Drawing_TextStyleSetBaselineShift()
3954
3955```
3956void OH_Drawing_TextStyleSetBaselineShift(OH_Drawing_TextStyle* style, double lineShift)
3957```
3958
3959**描述**
3960
3961设置文本样式基线偏移。
3962
3963**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3964
3965**起始版本:** 12
3966
3967
3968**参数:**
3969
3970| 参数项 | 描述 |
3971| -- | -- |
3972| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向OH_Drawing_TextStyle对象的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
3973| double lineShift | 文本的基线偏移。 |
3974
3975### OH_Drawing_TypographyTextSetHeightBehavior()
3976
3977```
3978void OH_Drawing_TypographyTextSetHeightBehavior(OH_Drawing_TypographyStyle* style,OH_Drawing_TextHeightBehavior heightMode)
3979```
3980
3981**描述**
3982
3983设置文本高度修饰符模式。
3984
3985**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
3986
3987**起始版本:** 12
3988
3989
3990**参数:**
3991
3992| 参数项 | 描述 |
3993| -- | -- |
3994| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
3995| [OH_Drawing_TextHeightBehavior](#oh_drawing_textheightbehavior) heightMode | 文本高度修饰符模式,为[OH_Drawing_TextHeightBehavior](capi-drawing-text-typography-h.md#oh_drawing_textheightbehavior)类型的枚举值。 |
3996
3997### OH_Drawing_TypographyTextGetHeightBehavior()
3998
3999```
4000OH_Drawing_TextHeightBehavior OH_Drawing_TypographyTextGetHeightBehavior(OH_Drawing_TypographyStyle* style)
4001```
4002
4003**描述**
4004
4005获取文本高度修饰符模式。
4006
4007**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4008
4009**起始版本:** 12
4010
4011
4012**参数:**
4013
4014| 参数项 | 描述 |
4015| -- | -- |
4016| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4017
4018**返回:**
4019
4020| 类型 | 说明 |
4021| -- | -- |
4022| [OH_Drawing_TextHeightBehavior](#oh_drawing_textheightbehavior) | 返回文本高度修饰符模式,为[OH_Drawing_TextHeightBehavior](capi-drawing-text-typography-h.md#oh_drawing_textheightbehavior)类型的枚举值。 |
4023
4024### OH_Drawing_TypographyGetLineFontMetrics()
4025
4026```
4027OH_Drawing_Font_Metrics* OH_Drawing_TypographyGetLineFontMetrics(OH_Drawing_Typography* typography,size_t lineNumber, size_t* fontMetricsSize)
4028```
4029
4030**描述**
4031
4032从排版对象中目标行获取所有字体度量信息,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用之后调用,否则会返回空指针。不再需要[OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)时,请使用[OH_Drawing_TypographyDestroyLineFontMetrics](capi-drawing-text-typography-h.md#oh_drawing_typographydestroylinefontmetrics)接口释放该对象的指针。
4033
4034**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4035
4036**起始版本:** 12
4037
4038
4039**参数:**
4040
4041| 参数项 | 描述 |
4042| -- | -- |
4043| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 指向文本对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4044| size_t lineNumber | 指定行数,取值为整数,最小有效值为1,最大行取决于文本输入后字体引擎解析出来的行数,若输入值大于最大行会返回错误值并打印错误消息。 |
4045| size_t* fontMetricsSize | 指示从当前行返回的字体度量结构的大小。 |
4046
4047**返回:**
4048
4049| 类型 | 说明 |
4050| -- | -- |
4051| [OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)* | 返回当前行的所有字体度量信息。 |
4052
4053### OH_Drawing_TypographyDestroyLineFontMetrics()
4054
4055```
4056void OH_Drawing_TypographyDestroyLineFontMetrics(OH_Drawing_Font_Metrics* lineFontMetric)
4057```
4058
4059**描述**
4060
4061释放指定行所有字体度量结构体集合所占用的所有空间。
4062
4063**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4064
4065**起始版本:** 12
4066
4067
4068**参数:**
4069
4070| 参数项 | 描述 |
4071| -- | -- |
4072| [OH_Drawing_Font_Metrics](capi-drawing-oh-drawing-font-metrics.md)* lineFontMetric | 指示要释放空间的指定行所有字体度量结构体集合的第一个地址。 |
4073
4074### OH_Drawing_TextStyleIsEqual()
4075
4076```
4077bool OH_Drawing_TextStyleIsEqual(const OH_Drawing_TextStyle* style, const OH_Drawing_TextStyle* comparedStyle)
4078```
4079
4080**描述**
4081
4082判断两个文本样式对象是否相等,字宽属性不参与对比。
4083
4084**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4085
4086**起始版本:** 12
4087
4088
4089**参数:**
4090
4091| 参数项 | 描述 |
4092| -- | -- |
4093| const [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 比较的文本样式对象。 |
4094| const [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* comparedStyle | 比较的文本样式对象。 |
4095
4096**返回:**
4097
4098| 类型 | 说明 |
4099| -- | -- |
4100| bool | 返回两个文本样式对象是否相等。true表示相等,false表示不相等。 |
4101
4102### OH_Drawing_TextStyleIsEqualByFont()
4103
4104```
4105bool OH_Drawing_TextStyleIsEqualByFont(const OH_Drawing_TextStyle* style, const OH_Drawing_TextStyle* comparedStyle)
4106```
4107
4108**描述**
4109
4110判断两个文本样式对象的字体样式属性是否相等。
4111
4112**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4113
4114**起始版本:** 12
4115
4116
4117**参数:**
4118
4119| 参数项 | 描述 |
4120| -- | -- |
4121| const [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 比较的文本样式对象。 |
4122| const [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* comparedStyle | 比较的文本样式对象。 |
4123
4124**返回:**
4125
4126| 类型 | 说明 |
4127| -- | -- |
4128| bool | 返回两个文本样式对象的字体样式属性是否相等的结果。 |
4129
4130### OH_Drawing_TextStyleIsAttributeMatched()
4131
4132```
4133bool OH_Drawing_TextStyleIsAttributeMatched(const OH_Drawing_TextStyle* style,const OH_Drawing_TextStyle* comparedStyle, OH_Drawing_TextStyleType textStyleType)
4134```
4135
4136**描述**
4137
4138判断两个文本样式对象是否有一样的字体样式类型。
4139
4140**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4141
4142**起始版本:** 12
4143
4144
4145**参数:**
4146
4147| 参数项 | 描述 |
4148| -- | -- |
4149| const [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 比较的文本样式对象。 |
4150| const [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* comparedStyle | 比较的文本样式对象。 |
4151| [OH_Drawing_TextStyleType](#oh_drawing_textstyletype) textStyleType | 文本样式类型枚举[OH_Drawing_TextStyleType](capi-drawing-text-typography-h.md#oh_drawing_textstyletype)。 |
4152
4153**返回:**
4154
4155| 类型 | 说明 |
4156| -- | -- |
4157| bool | 返回两个TextStyle对象是否有对应的文本样式类型一样的结果。true表示其文本样式类型一样,false表示不一样。 |
4158
4159### OH_Drawing_TextStyleSetPlaceholder()
4160
4161```
4162void OH_Drawing_TextStyleSetPlaceholder(OH_Drawing_TextStyle* style)
4163```
4164
4165**描述**
4166
4167设置占位符。
4168
4169**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4170
4171**起始版本:** 12
4172
4173
4174**参数:**
4175
4176| 参数项 | 描述 |
4177| -- | -- |
4178| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
4179
4180### OH_Drawing_TextStyleIsPlaceholder()
4181
4182```
4183bool OH_Drawing_TextStyleIsPlaceholder(OH_Drawing_TextStyle* style)
4184```
4185
4186**描述**
4187
4188返回是否有设置文本占位符。
4189
4190**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4191
4192**起始版本:** 12
4193
4194
4195**参数:**
4196
4197| 参数项 | 描述 |
4198| -- | -- |
4199| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
4200
4201**返回:**
4202
4203| 类型 | 说明 |
4204| -- | -- |
4205| bool | 返回是否有设置文本占位符。true表示有设置文本占位符,false表示未设置文本占位符。 |
4206
4207### OH_Drawing_TypographyStyleGetEffectiveAlignment()
4208
4209```
4210OH_Drawing_TextAlign OH_Drawing_TypographyStyleGetEffectiveAlignment(OH_Drawing_TypographyStyle* style)
4211```
4212
4213**描述**
4214
4215获取文本对齐模式。
4216
4217**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4218
4219**起始版本:** 12
4220
4221
4222**参数:**
4223
4224| 参数项 | 描述 |
4225| -- | -- |
4226| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4227
4228**返回:**
4229
4230| 类型 | 说明 |
4231| -- | -- |
4232| [OH_Drawing_TextAlign](#oh_drawing_textalign) | 返回文本对齐模式的枚举值[OH_Drawing_TextAlign](capi-drawing-text-typography-h.md#oh_drawing_textalign)。 |
4233
4234### OH_Drawing_TypographyStyleIsHintEnabled()
4235
4236```
4237bool OH_Drawing_TypographyStyleIsHintEnabled(OH_Drawing_TypographyStyle* style)
4238```
4239
4240**描述**
4241
4242获取文本是否启用字形轮廓自动调整,字形轮廓自动调整用于在渲染小字号文本时改善其可读性和外观。
4243
4244**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4245
4246**起始版本:** 12
4247
4248
4249**参数:**
4250
4251| 参数项 | 描述 |
4252| -- | -- |
4253| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4254
4255**返回:**
4256
4257| 类型 | 说明 |
4258| -- | -- |
4259| bool | 返回文本是否启用字体提示。true表示启用,false表示不启用。 |
4260
4261### OH_Drawing_SetTypographyStyleTextStrutStyle()
4262
4263```
4264void OH_Drawing_SetTypographyStyleTextStrutStyle(OH_Drawing_TypographyStyle* style, OH_Drawing_StrutStyle* strutstyle)
4265```
4266
4267**描述**
4268
4269设置文本支柱样式。
4270
4271**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4272
4273**起始版本:** 12
4274
4275
4276**参数:**
4277
4278| 参数项 | 描述 |
4279| -- | -- |
4280| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4281| [OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)* strutstyle | 指向支柱样式对象[OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)的指针,由[OH_Drawing_TypographyStyleGetStrutStyle](capi-drawing-text-typography-h.md#oh_drawing_typographystylegetstrutstyle)获取。 |
4282
4283### OH_Drawing_TypographyStyleGetStrutStyle()
4284
4285```
4286OH_Drawing_StrutStyle* OH_Drawing_TypographyStyleGetStrutStyle(OH_Drawing_TypographyStyle* style)
4287```
4288
4289**描述**
4290
4291获取文本支柱样式。
4292
4293**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4294
4295**起始版本:** 12
4296
4297
4298**参数:**
4299
4300| 参数项 | 描述 |
4301| -- | -- |
4302| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4303
4304**返回:**
4305
4306| 类型 | 说明 |
4307| -- | -- |
4308| [OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)* | 返回指向支柱样式对象[OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)的指针。 |
4309
4310### OH_Drawing_TypographyStyleDestroyStrutStyle()
4311
4312```
4313void OH_Drawing_TypographyStyleDestroyStrutStyle(OH_Drawing_StrutStyle* strutstyle)
4314```
4315
4316**描述**
4317
4318释放被支柱样式对象占据的内存。
4319
4320**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4321
4322**起始版本:** 12
4323
4324
4325**参数:**
4326
4327| 参数项 | 描述 |
4328| -- | -- |
4329| [OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)* strutstyle | 指向支柱样式对象[OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)的指针,由[OH_Drawing_TypographyStyleGetStrutStyle](capi-drawing-text-typography-h.md#oh_drawing_typographystylegetstrutstyle)获取。 |
4330
4331### OH_Drawing_TypographyStyleStrutStyleEquals()
4332
4333```
4334bool OH_Drawing_TypographyStyleStrutStyleEquals(OH_Drawing_StrutStyle* from, OH_Drawing_StrutStyle* to)
4335```
4336
4337**描述**
4338
4339判断支柱样式结构体是否相同。
4340
4341**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4342
4343**起始版本:** 12
4344
4345
4346**参数:**
4347
4348| 参数项 | 描述 |
4349| -- | -- |
4350| [OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)* from | 被比较的支柱样式结构体。 |
4351| [OH_Drawing_StrutStyle](capi-drawing-oh-drawing-strutstyle.md)* to | 用于比较的支柱样式结构体。 |
4352
4353### OH_Drawing_TypographyStyleSetHintsEnabled()
4354
4355```
4356void OH_Drawing_TypographyStyleSetHintsEnabled(OH_Drawing_TypographyStyle* style, bool hintsEnabled)
4357```
4358
4359**描述**
4360
4361设置文本是否启用字形轮廓自动调整,字形轮廓自动调整用于在渲染小字号文本时改善其可读性和外观。
4362
4363**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4364
4365**起始版本:** 12
4366
4367
4368**参数:**
4369
4370| 参数项 | 描述 |
4371| -- | -- |
4372| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4373| bool hintsEnabled | 是否启用字体提示。true表示启用,false表示不启用。 |
4374
4375### OH_Drawing_TypographyMarkDirty()
4376
4377```
4378void  OH_Drawing_TypographyMarkDirty(OH_Drawing_Typography* typography)
4379```
4380
4381**描述**
4382
4383将排版标记为脏数据,用于初始化排版状态。
4384
4385**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4386
4387**起始版本:** 12
4388
4389
4390**参数:**
4391
4392| 参数项 | 描述 |
4393| -- | -- |
4394| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向文本[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4395
4396### OH_Drawing_TypographyGetUnresolvedGlyphsCount()
4397
4398```
4399int32_t OH_Drawing_TypographyGetUnresolvedGlyphsCount(OH_Drawing_Typography* typography)
4400```
4401
4402**描述**
4403
4404获取文本中尚未解析的字形的数量,该接口需要在[OH_Drawing_TypographyLayout](capi-drawing-text-typography-h.md#oh_drawing_typographylayout)接口调用并生效之后调用。
4405
4406**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4407
4408**起始版本:** 12
4409
4410
4411**参数:**
4412
4413| 参数项 | 描述 |
4414| -- | -- |
4415| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向文本[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)对象的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4416
4417**返回:**
4418
4419| 类型 | 说明 |
4420| -- | -- |
4421| int32_t | 返回文本中尚未解析的字形的数量。 |
4422
4423### OH_Drawing_TypographyUpdateFontSize()
4424
4425```
4426void OH_Drawing_TypographyUpdateFontSize(OH_Drawing_Typography* typography, size_t from, size_t to, float fontSize)
4427```
4428
4429**描述**
4430
4431更新排版对象中的字体大小。
4432
4433**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4434
4435**起始版本:** 12
4436
4437
4438**参数:**
4439
4440| 参数项 | 描述 |
4441| -- | -- |
4442| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4443| size_t from | 保留字段,暂未使用。 |
4444| size_t to | 保留字段,暂未使用。 |
4445| float fontSize | 表示更新后的字体大小。 |
4446
4447### OH_Drawing_TypographyUpdateFontColor()
4448
4449```
4450void OH_Drawing_TypographyUpdateFontColor(OH_Drawing_Typography* typography, uint32_t color)
4451```
4452
4453**描述**
4454
4455更新排版对象中的字体颜色。如果当前装饰线未设置颜色,使用该接口也会同时更新装饰线的颜色。使用该接口更新字体颜色属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。
4456
4457**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4458
4459**起始版本:** 20
4460
4461
4462**参数:**
4463
4464| 参数项 | 描述 |
4465| -- | -- |
4466| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4467| uint32_t color | 表示更新后的字体颜色。 |
4468
4469### OH_Drawing_TypographyUpdateDecoration()
4470
4471```
4472void OH_Drawing_TypographyUpdateDecoration(OH_Drawing_Typography* typography, OH_Drawing_TextDecoration decoration)
4473```
4474
4475**描述**
4476
4477更新排版对象中的文本装饰线类型。使用该接口更新文本装饰线类型属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。
4478
4479**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4480
4481**起始版本:** 20
4482
4483
4484**参数:**
4485
4486| 参数项 | 描述 |
4487| -- | -- |
4488| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4489| [OH_Drawing_TextDecoration](#oh_drawing_textdecoration) decoration | 表示更新后的装饰线类型,具体可见[OH_Drawing_TextDecoration](capi-drawing-text-typography-h.md#oh_drawing_textdecoration)枚举。可通过位或操作一次设置多种装饰线类型。设置非[OH_Drawing_TextDecoration](capi-drawing-text-typography-h.md#oh_drawing_textdecoration)枚举的装饰样式则保持原有装饰线类型。 |
4490
4491### OH_Drawing_TypographyUpdateDecorationThicknessScale()
4492
4493```
4494void OH_Drawing_TypographyUpdateDecorationThicknessScale(OH_Drawing_Typography* typography,double decorationThicknessScale)
4495```
4496
4497**描述**
4498
4499更新排版对象中的文本装饰线的粗细缩放比例。使用该接口更新文本装饰线粗细缩放比例属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。
4500
4501**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4502
4503**起始版本:** 20
4504
4505
4506**参数:**
4507
4508| 参数项 | 描述 |
4509| -- | -- |
4510| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4511| double decorationThicknessScale | 表示更新后的文本装饰线的粗细缩放比例。装饰线的粗细会随着这个比例变大而变粗,如果更新的粗细缩放比例小于等于0,那么就不会绘制装饰线。 |
4512
4513### OH_Drawing_TypographyUpdateDecorationStyle()
4514
4515```
4516void OH_Drawing_TypographyUpdateDecorationStyle(OH_Drawing_Typography* typography,OH_Drawing_TextDecorationStyle decorationStyle)
4517```
4518
4519**描述**
4520
4521更新排版对象中的文本装饰线样式。使用该接口更新文本装饰线样式属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。
4522
4523**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4524
4525**起始版本:** 20
4526
4527
4528**参数:**
4529
4530| 参数项 | 描述 |
4531| -- | -- |
4532| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
4533| [OH_Drawing_TextDecorationStyle](#oh_drawing_textdecorationstyle) decorationStyle | 表示更新后的文本装饰线样式,支持可选的装饰样式具体可见[OH_Drawing_TextDecorationStyle](capi-drawing-text-typography-h.md#oh_drawing_textdecorationstyle)枚举。 |
4534
4535### OH_Drawing_TypographyTextGetLineStyle()
4536
4537```
4538bool OH_Drawing_TypographyTextGetLineStyle(OH_Drawing_TypographyStyle* style)
4539```
4540
4541**描述**
4542
4543获取文本排版是否启用行样式。
4544
4545**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4546
4547**起始版本:** 12
4548
4549
4550**参数:**
4551
4552| 参数项 | 描述 |
4553| -- | -- |
4554| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4555
4556**返回:**
4557
4558| 类型 | 说明 |
4559| -- | -- |
4560| bool | 返回行样式是否启用的结果。true表示启用,false表示不启用。 |
4561
4562### OH_Drawing_TypographyTextlineStyleGetFontWeight()
4563
4564```
4565OH_Drawing_FontWeight OH_Drawing_TypographyTextlineStyleGetFontWeight(OH_Drawing_TypographyStyle* style)
4566```
4567
4568**描述**
4569
4570获取文本排版行样式字重。
4571
4572**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4573
4574**起始版本:** 12
4575
4576
4577**参数:**
4578
4579| 参数项 | 描述 |
4580| -- | -- |
4581| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4582
4583**返回:**
4584
4585| 类型 | 说明 |
4586| -- | -- |
4587| [OH_Drawing_FontWeight](#oh_drawing_fontweight) | 返回文本排版行样式字重。<br> 0字重为thin,1字重为extra-light,2字重为light,4字重为medium,5字重为semi-bold,6字重为bold,7字重为extra-bold,8字重为black,3或其它字重为normal/regular,具体可见[OH_Drawing_FontWeight](capi-drawing-text-typography-h.md#oh_drawing_fontweight)枚举。 |
4588
4589### OH_Drawing_TypographyTextlineStyleGetFontStyle()
4590
4591```
4592OH_Drawing_FontStyle OH_Drawing_TypographyTextlineStyleGetFontStyle(OH_Drawing_TypographyStyle* style)
4593```
4594
4595**描述**
4596
4597获取文本排版样式中支柱样式的字体样式。
4598
4599**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4600
4601**起始版本:** 12
4602
4603
4604**参数:**
4605
4606| 参数项 | 描述 |
4607| -- | -- |
4608| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4609
4610**返回:**
4611
4612| 类型 | 说明 |
4613| -- | -- |
4614| [OH_Drawing_FontStyle](#oh_drawing_fontstyle) | 返回文本排版样式中支柱样式的字体样式。1为斜体,0或其它为非斜体,具体可见[OH_Drawing_FontStyle](capi-drawing-text-typography-h.md#oh_drawing_fontstyle)枚举。 |
4615
4616### OH_Drawing_TypographyTextlineStyleGetFontFamilies()
4617
4618```
4619char** OH_Drawing_TypographyTextlineStyleGetFontFamilies(OH_Drawing_TypographyStyle* style, size_t* num)
4620```
4621
4622**描述**
4623
4624获取文本排版行样式字体家族名。
4625
4626**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4627
4628**起始版本:** 12
4629
4630
4631**参数:**
4632
4633| 参数项 | 描述 |
4634| -- | -- |
4635| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4636| size_t* num | 指向字体名称数量的指针。 |
4637
4638**返回:**
4639
4640| 类型 | 说明 |
4641| -- | -- |
4642| char** | 返回文本排版行样式字体家族名。 |
4643
4644### OH_Drawing_TypographyTextlineStyleDestroyFontFamilies()
4645
4646```
4647void OH_Drawing_TypographyTextlineStyleDestroyFontFamilies(char** fontFamilies, size_t fontFamiliesNum)
4648```
4649
4650**描述**
4651
4652释放字体类型占用的内存。
4653
4654**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4655
4656**起始版本:** 12
4657
4658
4659**参数:**
4660
4661| 参数项 | 描述 |
4662| -- | -- |
4663| char** fontFamilies | 表示指向字体字体类型的指针。 |
4664| size_t fontFamiliesNum | 字体名称的数量。 |
4665
4666### OH_Drawing_TypographyTextlineStyleGetFontSize()
4667
4668```
4669double OH_Drawing_TypographyTextlineStyleGetFontSize(OH_Drawing_TypographyStyle* style)
4670```
4671
4672**描述**
4673
4674获取文本排版行样式字号。
4675
4676**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4677
4678**起始版本:** 12
4679
4680
4681**参数:**
4682
4683| 参数项 | 描述 |
4684| -- | -- |
4685| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4686
4687**返回:**
4688
4689| 类型 | 说明 |
4690| -- | -- |
4691| double | 返回文本排版行样式字号。 |
4692
4693### OH_Drawing_TypographyTextlineStyleGetHeightScale()
4694
4695```
4696double OH_Drawing_TypographyTextlineStyleGetHeightScale(OH_Drawing_TypographyStyle* style)
4697```
4698
4699**描述**
4700
4701获取文本排版行样式的行高缩放系数。
4702
4703**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4704
4705**起始版本:** 12
4706
4707
4708**参数:**
4709
4710| 参数项 | 描述 |
4711| -- | -- |
4712| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4713
4714**返回:**
4715
4716| 类型 | 说明 |
4717| -- | -- |
4718| double | 返回文本排版行样式的行高缩放系数。 |
4719
4720### OH_Drawing_TypographyTextlineStyleGetHeightOnly()
4721
4722```
4723bool OH_Drawing_TypographyTextlineStyleGetHeightOnly(OH_Drawing_TypographyStyle* style)
4724```
4725
4726**描述**
4727
4728获取字体渲染过程中计算字体块高度相关参数的方法。
4729
4730**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4731
4732**起始版本:** 12
4733
4734
4735**参数:**
4736
4737| 参数项 | 描述 |
4738| -- | -- |
4739| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4740
4741**返回:**
4742
4743| 类型 | 说明 |
4744| -- | -- |
4745| bool | 返回计算字体块高度相关参数的方法。true表示以字号为准计算,false表示以行距计算。 |
4746
4747### OH_Drawing_TypographyTextlineStyleGetHalfLeading()
4748
4749```
4750bool OH_Drawing_TypographyTextlineStyleGetHalfLeading(OH_Drawing_TypographyStyle* style)
4751```
4752
4753**描述**
4754
4755获取文本排版行样式是否为一半行间距。
4756
4757**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4758
4759**起始版本:** 12
4760
4761
4762**参数:**
4763
4764| 参数项 | 描述 |
4765| -- | -- |
4766| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4767
4768**返回:**
4769
4770| 类型 | 说明 |
4771| -- | -- |
4772| bool | 文本排版行样式是否为一半行间距,true表示是一半行间距,false表示不是。 |
4773
4774### OH_Drawing_TypographyTextlineStyleGetSpacingScale()
4775
4776```
4777double OH_Drawing_TypographyTextlineStyleGetSpacingScale(OH_Drawing_TypographyStyle* style)
4778```
4779
4780**描述**
4781
4782获取文本排版行样式间距比例。
4783
4784**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4785
4786**起始版本:** 12
4787
4788
4789**参数:**
4790
4791| 参数项 | 描述 |
4792| -- | -- |
4793| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4794
4795**返回:**
4796
4797| 类型 | 说明 |
4798| -- | -- |
4799| double | 返回文本排版行样式间距比例。 |
4800
4801### OH_Drawing_TypographyTextlineGetStyleOnly()
4802
4803```
4804bool OH_Drawing_TypographyTextlineGetStyleOnly(OH_Drawing_TypographyStyle* style)
4805```
4806
4807**描述**
4808
4809获取文本排版是否仅启用行样式。
4810
4811**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4812
4813**起始版本:** 12
4814
4815
4816**参数:**
4817
4818| 参数项 | 描述 |
4819| -- | -- |
4820| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4821
4822**返回:**
4823
4824| 类型 | 说明 |
4825| -- | -- |
4826| bool | 返回文本排版是否仅启用行样式。true表示启用,false表示不启用。 |
4827
4828### OH_Drawing_TypographyGetTextAlign()
4829
4830```
4831OH_Drawing_TextAlign OH_Drawing_TypographyGetTextAlign(OH_Drawing_TypographyStyle* style)
4832```
4833
4834**描述**
4835
4836获取文本对齐方式。
4837
4838**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4839
4840**起始版本:** 12
4841
4842
4843**参数:**
4844
4845| 参数项 | 描述 |
4846| -- | -- |
4847| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4848
4849**返回:**
4850
4851| 类型 | 说明 |
4852| -- | -- |
4853| [OH_Drawing_TextAlign](#oh_drawing_textalign) | 返回文本对齐方式。1为右对齐,2为居中对齐,3为两端对齐,4为与文字方向相同,5为文字方向相反,0或其它为左对齐,具体可见[OH_Drawing_TextAlign](capi-drawing-text-typography-h.md#oh_drawing_textalign)枚举。 |
4854
4855### OH_Drawing_TypographyGetTextDirection()
4856
4857```
4858OH_Drawing_TextDirection OH_Drawing_TypographyGetTextDirection(OH_Drawing_TypographyStyle* style)
4859```
4860
4861**描述**
4862
4863获取指定排版样式中的文本方向。
4864
4865**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4866
4867**起始版本:** 12
4868
4869
4870**参数:**
4871
4872| 参数项 | 描述 |
4873| -- | -- |
4874| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4875
4876**返回:**
4877
4878| 类型 | 说明 |
4879| -- | -- |
4880| [OH_Drawing_TextDirection](#oh_drawing_textdirection) | 返回文本方向。0为从右到左,1为从左到右,具体可见[OH_Drawing_TextDirection](capi-drawing-text-typography-h.md#oh_drawing_textdirection)枚举。 |
4881
4882### OH_Drawing_TypographyGetTextMaxLines()
4883
4884```
4885size_t OH_Drawing_TypographyGetTextMaxLines(OH_Drawing_TypographyStyle* style)
4886```
4887
4888**描述**
4889
4890获取文本的最大行数。
4891
4892**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4893
4894**起始版本:** 12
4895
4896
4897**参数:**
4898
4899| 参数项 | 描述 |
4900| -- | -- |
4901| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向排版样式[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4902
4903**返回:**
4904
4905| 类型 | 说明 |
4906| -- | -- |
4907| size_t | 返回结果为文本最大行数。 |
4908
4909### OH_Drawing_TypographyGetTextEllipsis()
4910
4911```
4912char* OH_Drawing_TypographyGetTextEllipsis(OH_Drawing_TypographyStyle* style)
4913```
4914
4915**描述**
4916
4917获取指定排版样式设置的省略号文本。
4918
4919**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4920
4921**起始版本:** 12
4922
4923
4924**参数:**
4925
4926| 参数项 | 描述 |
4927| -- | -- |
4928| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
4929
4930**返回:**
4931
4932| 类型 | 说明 |
4933| -- | -- |
4934| char* | 返回设置的省略号文本。 |
4935
4936### OH_Drawing_TypographyDestroyEllipsis()
4937
4938```
4939void OH_Drawing_TypographyDestroyEllipsis(char* ellipsis)
4940```
4941
4942**描述**
4943
4944释放省略号名称列表占用的内存。
4945
4946**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4947
4948**起始版本:** 12
4949
4950
4951**参数:**
4952
4953| 参数项 | 描述 |
4954| -- | -- |
4955| char* ellipsis | 表示指向省略号名称列表的指针。 |
4956
4957### OH_Drawing_TypographyStyleEquals()
4958
4959```
4960bool OH_Drawing_TypographyStyleEquals(OH_Drawing_TypographyStyle* from, OH_Drawing_TypographyStyle* to)
4961```
4962
4963**描述**
4964
4965判断排版样式是否相同,当前文本高度修饰符模式[OH_Drawing_TextHeightBehavior](capi-drawing-text-typography-h.md#oh_drawing_textheightbehavior)没有被纳入比较。
4966
4967**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4968
4969**起始版本:** 12
4970
4971
4972**参数:**
4973
4974| 参数项 | 描述 |
4975| -- | -- |
4976| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* from | 被比较的排版样式。 |
4977| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* to | 用于比较的排版样式。 |
4978
4979**返回:**
4980
4981| 类型 | 说明 |
4982| -- | -- |
4983| bool | 返回排版样式是否相同。true表示相同,false表示不相同。 |
4984
4985### OH_Drawing_TextStyleGetColor()
4986
4987```
4988uint32_t OH_Drawing_TextStyleGetColor(OH_Drawing_TextStyle* style)
4989```
4990
4991**描述**
4992
4993获取文本颜色。
4994
4995**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
4996
4997**起始版本:** 12
4998
4999
5000**参数:**
5001
5002| 参数项 | 描述 |
5003| -- | -- |
5004| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5005
5006**返回:**
5007
5008| 类型 | 说明 |
5009| -- | -- |
5010| uint32_t | 返回文本颜色。 |
5011
5012### OH_Drawing_TextStyleGetDecorationStyle()
5013
5014```
5015OH_Drawing_TextDecorationStyle OH_Drawing_TextStyleGetDecorationStyle(OH_Drawing_TextStyle* style)
5016```
5017
5018**描述**
5019
5020获取文本装饰样式。
5021
5022**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5023
5024**起始版本:** 12
5025
5026
5027**参数:**
5028
5029| 参数项 | 描述 |
5030| -- | -- |
5031| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5032
5033**返回:**
5034
5035| 类型 | 说明 |
5036| -- | -- |
5037| [OH_Drawing_TextDecorationStyle](#oh_drawing_textdecorationstyle) | 返回文本装饰样式,具体可见[OH_Drawing_TextDecorationStyle](capi-drawing-text-typography-h.md#oh_drawing_textdecorationstyle)枚举。 |
5038
5039### OH_Drawing_TextStyleGetFontWeight()
5040
5041```
5042OH_Drawing_FontWeight OH_Drawing_TextStyleGetFontWeight(OH_Drawing_TextStyle* style)
5043```
5044
5045**描述**
5046
5047获取字重。
5048
5049**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5050
5051**起始版本:** 12
5052
5053
5054**参数:**
5055
5056| 参数项 | 描述 |
5057| -- | -- |
5058| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5059
5060**返回:**
5061
5062| 类型 | 说明 |
5063| -- | -- |
5064| [OH_Drawing_FontWeight](#oh_drawing_fontweight) | 返回字重,具体可见[OH_Drawing_FontWeight](capi-drawing-text-typography-h.md#oh_drawing_fontweight)枚举。 |
5065
5066### OH_Drawing_TextStyleGetFontStyle()
5067
5068```
5069OH_Drawing_FontStyle OH_Drawing_TextStyleGetFontStyle(OH_Drawing_TextStyle* style)
5070```
5071
5072**描述**
5073
5074获取指定文本样式的字体样式。
5075
5076**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5077
5078**起始版本:** 12
5079
5080
5081**参数:**
5082
5083| 参数项 | 描述 |
5084| -- | -- |
5085| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向字体样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5086
5087**返回:**
5088
5089| 类型 | 说明 |
5090| -- | -- |
5091| [OH_Drawing_FontStyle](#oh_drawing_fontstyle) | 返回字体样式,具体可见[OH_Drawing_FontStyle](capi-drawing-text-typography-h.md#oh_drawing_fontstyle)枚举。 |
5092
5093### OH_Drawing_TextStyleGetBaseline()
5094
5095```
5096OH_Drawing_TextBaseline OH_Drawing_TextStyleGetBaseline(OH_Drawing_TextStyle* style)
5097```
5098
5099**描述**
5100
5101获取指定文本样式的字体基线位置。
5102
5103**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5104
5105**起始版本:** 12
5106
5107
5108**参数:**
5109
5110| 参数项 | 描述 |
5111| -- | -- |
5112| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5113
5114**返回:**
5115
5116| 类型 | 说明 |
5117| -- | -- |
5118| [OH_Drawing_TextBaseline](#oh_drawing_textbaseline) | 返回字体基线位置,具体可见[OH_Drawing_TextBaseline](capi-drawing-text-typography-h.md#oh_drawing_textbaseline)枚举。 |
5119
5120### OH_Drawing_TextStyleGetFontFamilies()
5121
5122```
5123char** OH_Drawing_TextStyleGetFontFamilies(OH_Drawing_TextStyle* style, size_t* num)
5124```
5125
5126**描述**
5127
5128获取字体类型名称列表。
5129
5130**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5131
5132**起始版本:** 12
5133
5134
5135**参数:**
5136
5137| 参数项 | 描述 |
5138| -- | -- |
5139| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5140| size_t* num | 指向字体名称数量的指针。 |
5141
5142**返回:**
5143
5144| 类型 | 说明 |
5145| -- | -- |
5146| char** | 返回获取到的字体类型列表。 |
5147
5148### OH_Drawing_TextStyleDestroyFontFamilies()
5149
5150```
5151void OH_Drawing_TextStyleDestroyFontFamilies(char** fontFamilies, size_t num)
5152```
5153
5154**描述**
5155
5156释放长度为num的字体家族名称列表占用的内存。
5157
5158**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5159
5160**起始版本:** 12
5161
5162
5163**参数:**
5164
5165| 参数项 | 描述 |
5166| -- | -- |
5167| char** fontFamilies | 指向字体家族名称列表的指针。 |
5168| size_t num | 字体家族名称列表的长度。 |
5169
5170### OH_Drawing_TextStyleGetFontSize()
5171
5172```
5173double OH_Drawing_TextStyleGetFontSize(OH_Drawing_TextStyle* style)
5174```
5175
5176**描述**
5177
5178获取指定文本样式字号。
5179
5180**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5181
5182**起始版本:** 12
5183
5184
5185**参数:**
5186
5187| 参数项 | 描述 |
5188| -- | -- |
5189| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5190
5191**返回:**
5192
5193| 类型 | 说明 |
5194| -- | -- |
5195| double | 返回字号。 |
5196
5197### OH_Drawing_TextStyleGetLetterSpacing()
5198
5199```
5200double OH_Drawing_TextStyleGetLetterSpacing(OH_Drawing_TextStyle* style)
5201```
5202
5203**描述**
5204
5205获取指定文本样式的字符间距。
5206
5207**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5208
5209**起始版本:** 12
5210
5211
5212**参数:**
5213
5214| 参数项 | 描述 |
5215| -- | -- |
5216| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5217
5218**返回:**
5219
5220| 类型 | 说明 |
5221| -- | -- |
5222| double | 返回字符间距大小。 |
5223
5224### OH_Drawing_TextStyleGetWordSpacing()
5225
5226```
5227double OH_Drawing_TextStyleGetWordSpacing(OH_Drawing_TextStyle* style)
5228```
5229
5230**描述**
5231
5232获取指定文本样式的单词间距。
5233
5234**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5235
5236**起始版本:** 12
5237
5238
5239**参数:**
5240
5241| 参数项 | 描述 |
5242| -- | -- |
5243| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5244
5245**返回:**
5246
5247| 类型 | 说明 |
5248| -- | -- |
5249| double | 返回单词间距大小。 |
5250
5251### OH_Drawing_TextStyleGetFontHeight()
5252
5253```
5254double OH_Drawing_TextStyleGetFontHeight(OH_Drawing_TextStyle* style)
5255```
5256
5257**描述**
5258
5259获取指定文本样式行高缩放系数。
5260
5261**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5262
5263**起始版本:** 12
5264
5265
5266**参数:**
5267
5268| 参数项 | 描述 |
5269| -- | -- |
5270| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5271
5272**返回:**
5273
5274| 类型 | 说明 |
5275| -- | -- |
5276| double | 返回行高缩放系数。 |
5277
5278### OH_Drawing_TextStyleGetHalfLeading()
5279
5280```
5281bool OH_Drawing_TextStyleGetHalfLeading(OH_Drawing_TextStyle* style)
5282```
5283
5284**描述**
5285
5286获取指定文本样式一半行间距开关状态。
5287
5288**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5289
5290**起始版本:** 12
5291
5292
5293**参数:**
5294
5295| 参数项 | 描述 |
5296| -- | -- |
5297| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5298
5299**返回:**
5300
5301| 类型 | 说明                                                         |
5302| ---- | ------------------------------------------------------------ |
5303| bool | 返回当前文本样式一半行间距的开关状态。true表示开启一半行间距,false表示未开启一半行间距。 |
5304
5305### OH_Drawing_TextStyleGetLocale()
5306
5307```
5308const char* OH_Drawing_TextStyleGetLocale(OH_Drawing_TextStyle* style)
5309```
5310
5311**描述**
5312
5313获取语言环境。
5314
5315**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5316
5317**起始版本:** 12
5318
5319
5320**参数:**
5321
5322| 参数项 | 描述 |
5323| -- | -- |
5324| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向文本样式对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针,由[OH_Drawing_CreateTextStyle](capi-drawing-text-typography-h.md#oh_drawing_createtextstyle)获取。 |
5325
5326**返回:**
5327
5328| 类型 | 说明 |
5329| -- | -- |
5330| const char* | 返回语言环境,数据类型为指向char对象的指针。语言环境格式为:语言-国家。如zh-CN表示中文(中国),en-US表示英语(美国)等。具体参考BCP 47语言标签标准。 |
5331
5332### OH_Drawing_TypographyDestroyTextBox()
5333
5334```
5335void OH_Drawing_TypographyDestroyTextBox(OH_Drawing_TextBox* textBox)
5336```
5337
5338**描述**
5339
5340释放文本框占用的内存。
5341
5342**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5343
5344**起始版本:** 12
5345
5346
5347**参数:**
5348
5349| 参数项 | 描述 |
5350| -- | -- |
5351| [OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)* textBox | 指向文本框对象[OH_Drawing_TextBox](capi-drawing-oh-drawing-textbox.md)的指针。 |
5352
5353### OH_Drawing_SetTextShadow()
5354
5355```
5356void OH_Drawing_SetTextShadow(OH_Drawing_TextShadow* shadow, uint32_t color, OH_Drawing_Point* offset,double blurRadius)
5357```
5358
5359**描述**
5360
5361设置字体阴影对象的参数。
5362
5363**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5364
5365**起始版本:** 12
5366
5367
5368**参数:**
5369
5370| 参数项 | 描述 |
5371| -- | -- |
5372| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* shadow | 指向字体阴影对象[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针,由[OH_Drawing_CreateTextShadow](capi-drawing-text-typography-h.md#oh_drawing_createtextshadow)获取。 |
5373| uint32_t color | 字体阴影的颜色,例如入参为0xAABBCCDD,AA代表透明度,BB代表红色分量的值,CC代表绿色分量的值,DD代表蓝色分量的值。 |
5374| [OH_Drawing_Point](capi-drawing-oh-drawing-point.md)* offset | 指向坐标点对象[OH_Drawing_Point](capi-drawing-oh-drawing-point.md)的指针,字体阴影基于当前文本的偏移位置。 |
5375| double blurRadius | 模糊半径,浮点数,没有单位,值为0.0时表示没有模糊效果。 |
5376
5377### OH_Drawing_CreateTextTab()
5378
5379```
5380OH_Drawing_TextTab* OH_Drawing_CreateTextTab(OH_Drawing_TextAlign alignment, float location)
5381```
5382
5383**描述**
5384
5385创建文本制表符对象。
5386
5387**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5388
5389**起始版本:** 18
5390
5391
5392**参数:**
5393
5394| 参数项 | 描述 |
5395| -- | -- |
5396| [OH_Drawing_TextAlign](#oh_drawing_textalign) alignment | 制表符之后的文本对齐方式。1为右对齐,2为居中对齐,0或其它为左对齐。 |
5397| float location | 文本制表符之后的文本对齐的位置,相对于当前文本起始位置的偏移。单位为物理像素px,最小值为1.0。 |
5398
5399**返回:**
5400
5401| 类型 | 说明 |
5402| -- | -- |
5403| [OH_Drawing_TextTab](capi-drawing-oh-drawing-texttab.md)* | 返回指向文本制表符对象的指针。如果返回空指针,表示创建失败。失败的原因可能为没有可用的内存。 |
5404
5405### OH_Drawing_DestroyTextTab()
5406
5407```
5408void OH_Drawing_DestroyTextTab(OH_Drawing_TextTab* tab)
5409```
5410
5411**描述**
5412
5413释放文本制表符对象占据的内存。
5414
5415**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5416
5417**起始版本:** 18
5418
5419
5420**参数:**
5421
5422| 参数项 | 描述 |
5423| -- | -- |
5424| [OH_Drawing_TextTab](capi-drawing-oh-drawing-texttab.md)* tab | 指向文本制表符对象的指针。 |
5425
5426### OH_Drawing_GetTextTabAlignment()
5427
5428```
5429OH_Drawing_TextAlign OH_Drawing_GetTextTabAlignment(OH_Drawing_TextTab* tab)
5430```
5431
5432**描述**
5433
5434获取文本制表符对象的对齐方式。
5435
5436**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5437
5438**起始版本:** 18
5439
5440
5441**参数:**
5442
5443| 参数项 | 描述 |
5444| -- | -- |
5445| [OH_Drawing_TextTab](capi-drawing-oh-drawing-texttab.md)* tab | 指向文本制表符对象的指针。 |
5446
5447**返回:**
5448
5449| 类型 | 说明 |
5450| -- | -- |
5451| [OH_Drawing_TextAlign](#oh_drawing_textalign) | 返回文本对齐方式。1为右对齐,2为居中对齐,0或其它为左对齐。 |
5452
5453### OH_Drawing_GetTextTabLocation()
5454
5455```
5456float OH_Drawing_GetTextTabLocation(OH_Drawing_TextTab* tab)
5457```
5458
5459**描述**
5460
5461获取文本制表符的位置。
5462
5463**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5464
5465**起始版本:** 18
5466
5467
5468**参数:**
5469
5470| 参数项 | 描述 |
5471| -- | -- |
5472| [OH_Drawing_TextTab](capi-drawing-oh-drawing-texttab.md)* tab | 指向文本制表符对象的指针。 |
5473
5474**返回:**
5475
5476| 类型 | 说明 |
5477| -- | -- |
5478| float | 返回文本制表符对象的位置。 |
5479
5480### OH_Drawing_SetTypographyTextTab()
5481
5482```
5483void OH_Drawing_SetTypographyTextTab(OH_Drawing_TypographyStyle* style, OH_Drawing_TextTab* tab)
5484```
5485
5486**描述**
5487
5488设置文本制表符对齐方式及位置。当设置了文本对齐方式或者省略号风格时制表符不生效,当制表符位置小于1.0时为替换成空格的效果。
5489
5490**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5491
5492**起始版本:** 18
5493
5494
5495**参数:**
5496
5497| 参数项 | 描述 |
5498| -- | -- |
5499| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针。 |
5500| [OH_Drawing_TextTab](capi-drawing-oh-drawing-texttab.md)* tab | 指向文本制表符对象的指针。 |
5501
5502### OH_Drawing_GetDrawingArraySize()
5503
5504```
5505size_t OH_Drawing_GetDrawingArraySize(OH_Drawing_Array* drawingArray)
5506```
5507
5508**描述**
5509
5510获取传入类型为对象数组[OH_Drawing_Array](capi-drawing-oh-drawing-array.md)中的对象个数。
5511
5512**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5513
5514**起始版本:** 14
5515
5516
5517**参数:**
5518
5519| 参数项 | 描述 |
5520| -- | -- |
5521| [OH_Drawing_Array](capi-drawing-oh-drawing-array.md)* drawingArray | 指向对象数组[OH_Drawing_Array](capi-drawing-oh-drawing-array.md)的指针。 |
5522
5523**返回:**
5524
5525| 类型 | 说明 |
5526| -- | -- |
5527| size_t | 数组中的对象个数。 |
5528
5529### OH_Drawing_SetTypographyTextTrailingSpaceOptimized()
5530
5531```
5532void OH_Drawing_SetTypographyTextTrailingSpaceOptimized(OH_Drawing_TypographyStyle* style, bool trailingSpaceOptimized)
5533```
5534
5535**描述**
5536
5537设置文本排版时行尾空格是否参与对齐计算。
5538
5539**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5540
5541**起始版本:** 20
5542
5543
5544**参数:**
5545
5546| 参数项 | 描述 |
5547| -- | -- |
5548| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md) |  指向文本风格对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针。 |
5549| bool |  设置文本排版时行尾空格是否参与对齐计算。true表示行尾空格不参与计算,false表示行尾空格参与计算,默认值为false。文本居中对齐场景下推荐设置为true。 |
5550
5551### OH_Drawing_TypographyHandlerAddEncodedText()
5552
5553```
5554void OH_Drawing_TypographyHandlerAddEncodedText(OH_Drawing_TypographyCreate* handler, const void* text,size_t byteLength, OH_Drawing_TextEncoding textEncodingType)
5555```
5556
5557**描述**
5558
5559添加指定编码的文本。
5560
5561**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5562
5563**起始版本:** 20
5564
5565
5566**参数:**
5567
5568| 参数项 | 描述 |
5569| -- | -- |
5570| [OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)* handler | 指向[OH_Drawing_TypographyCreate](capi-drawing-oh-drawing-typographycreate.md)对象的指针,由[OH_Drawing_CreateTypographyHandler](capi-drawing-text-typography-h.md#oh_drawing_createtypographyhandler)获取。 |
5571| const void* text | 指向文本内容的指针。 |
5572| size_t byteLength | 文本的字节长度。 |
5573| [OH_Drawing_TextEncoding](capi-drawing-types-h.md#oh_drawing_textencoding) textEncodingType | 文本的编码类型,为[OH_Drawing_TextEncoding](capi-drawing-types-h.md#oh_drawing_textencoding)类型的枚举值。只支持TEXT_ENCODING_UTF8, TEXT_ENCODING_UTF16, TEXT_ENCODING_UTF32。 |
5574
5575### OH_Drawing_SetTypographyTextAutoSpace()
5576
5577```
5578void OH_Drawing_SetTypographyTextAutoSpace(OH_Drawing_TypographyStyle *style, bool enableAutoSpace)
5579```
5580
5581**描述**
5582
5583设置文本排版时是否使能自动间距。<br>默认不使能自动间距,一旦使能则会自动调整CJK(中文字符、日文字符、韩文字符)与西文(拉丁字母、西里尔字母、希腊字母)、CJK与数字、CJK与版权符号、版权符号与数字、版权符号与西文之间的间距。
5584
5585**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5586
5587**起始版本:** 20
5588
5589
5590**参数:**
5591
5592| 参数项 | 描述 |
5593| -- | -- |
5594| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md) *style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
5595| bool enableAutoSpace | 设置文本排版时是否使能自动间距。true表示使能自动间距,false表示不使能自动间距,默认值为false。 |
5596
5597### OH_Drawing_TypographyUpdateDecorationColor()
5598
5599```
5600void OH_Drawing_TypographyUpdateDecorationColor(OH_Drawing_Typography* typography, uint32_t color)
5601```
5602
5603**描述**
5604
5605更新排版对象中的文本装饰线颜色。<br> 使用该接口更新文本装饰线颜色属性后,可直接使用[OH_Drawing_TypographyPaint](capi-drawing-text-typography-h.md#oh_drawing_typographypaint)进行绘制生效。
5606
5607**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5608
5609**起始版本:** 20
5610
5611**参数:**
5612
5613| 参数项 | 描述 |
5614| -- | -- |
5615| [OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)* typography | 表示指向排版对象[OH_Drawing_Typography](capi-drawing-oh-drawing-typography.md)的指针,由[OH_Drawing_CreateTypography](capi-drawing-text-typography-h.md#oh_drawing_createtypography)获取。 |
5616| uint32_t color | 表示更新后的文本装饰线颜色。 |
5617
5618### OH_Drawing_SetTypographyVerticalAlignment()
5619
5620```
5621void OH_Drawing_SetTypographyVerticalAlignment(OH_Drawing_TypographyStyle* style,OH_Drawing_TextVerticalAlignment align)
5622```
5623
5624**描述**
5625
5626设置文本垂直对齐方式。
5627
5628**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5629
5630**起始版本:** 20
5631
5632
5633**参数:**
5634
5635| 参数项 | 描述 |
5636| -- | -- |
5637| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 表示指向[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象的指针,由[OH_Drawing_CreateTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_createtypographystyle)获取。 |
5638| [OH_Drawing_TextVerticalAlignment](capi-drawing-text-typography-h.md#oh_drawing_textverticalalignment) align | 设置文本垂直对齐方式。默认为基线对齐,其余对齐方式见[OH_Drawing_TextVerticalAlignment](capi-drawing-text-typography-h.md#oh_drawing_textverticalalignment)。 |
5639
5640### OH_Drawing_CopyTypographyStyle()
5641
5642```
5643OH_Drawing_TypographyStyle* OH_Drawing_CopyTypographyStyle(OH_Drawing_TypographyStyle* style)
5644```
5645
5646**描述**
5647
5648创建一个段落样式的对象副本,用于拷贝一个已有的段落样式对象。
5649
5650**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5651
5652**起始版本:** 20
5653
5654
5655**参数:**
5656
5657| 参数项 | 描述 |
5658| -- | -- |
5659| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* style | 指向被拷贝对象[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)的指针。 |
5660
5661**返回:**
5662
5663| 类型 | 说明 |
5664| -- | -- |
5665| [OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)* | 返回拷贝的[OH_Drawing_TypographyStyle](capi-drawing-oh-drawing-typographystyle.md)对象指针。如果返回空指针,表示创建失败;可能的原因是无可用内存,或者style为空指针。不再需要时,请使用[OH_Drawing_DestroyTypographyStyle](capi-drawing-text-typography-h.md#oh_drawing_destroytypographystyle)释放该对象指针。 |
5666
5667### OH_Drawing_CopyTextStyle()
5668
5669```
5670OH_Drawing_TextStyle* OH_Drawing_CopyTextStyle(OH_Drawing_TextStyle* style)
5671```
5672
5673**描述**
5674
5675创建一个文本样式的对象副本,用于拷贝一个已有的文本样式对象。
5676
5677**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5678
5679**起始版本:** 20
5680
5681
5682**参数:**
5683
5684| 参数项 | 描述 |
5685| -- | -- |
5686| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* style | 指向被拷贝对象[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)的指针。 |
5687
5688**返回:**
5689
5690| 类型 | 说明 |
5691| -- | -- |
5692| [OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)* | 返回拷贝的[OH_Drawing_TextStyle](capi-drawing-oh-drawing-textstyle.md)对象指针。如果返回空指针,表示创建失败;可能的原因是无可用内存,或者style为空指针。不再需要时,请使用[OH_Drawing_DestroyTextStyle](capi-drawing-text-typography-h.md#oh_drawing_destroytextstyle)释放该对象指针。 |
5693
5694### OH_Drawing_CopyTextShadow()
5695
5696```
5697OH_Drawing_TextShadow* OH_Drawing_CopyTextShadow(OH_Drawing_TextShadow* shadow)
5698```
5699
5700**描述**
5701
5702创建一个文本阴影的对象副本,用于拷贝一个已有的文本阴影对象。
5703
5704**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
5705
5706**起始版本:** 20
5707
5708**参数:**
5709
5710| 参数项 | 描述 |
5711| -- | -- |
5712| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* shadow | 指向被拷贝对象[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)的指针。 |
5713
5714**返回:**
5715
5716| 类型 | 说明 |
5717| -- | -- |
5718| [OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)* | 返回拷贝的[OH_Drawing_TextShadow](capi-drawing-oh-drawing-textshadow.md)对象指针。如果返回空指针,表示创建失败;可能的原因是无可用内存,或者shadow为空指针。不再需要时,请使用[OH_Drawing_DestroyTextShadow](capi-drawing-text-typography-h.md#oh_drawing_destroytextshadow)释放该对象指针。 |