• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# drawing_text_global.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_global.h>
13
14**库:** libnative_drawing.so
15
16**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
17
18**起始版本:** 20
19
20**相关模块:** [Drawing](capi-drawing.md)
21
22## 汇总
23
24### 枚举
25
26| 名称 | typedef关键字 | 描述 |
27| -- | -- | -- |
28| [OH_Drawing_TextHighContrast](#oh_drawing_texthighcontrast) | OH_Drawing_TextHighContrast | 文本渲染高对比度模式枚举。 |
29| [OH_Drawing_TextUndefinedGlyphDisplay](#oh_drawing_textundefinedglyphdisplay) | OH_Drawing_TextUndefinedGlyphDisplay | 显示未定义字形的方式。 |
30
31### 函数
32
33| 名称 | 描述 |
34| -- | -- |
35| [void OH_Drawing_SetTextHighContrast(OH_Drawing_TextHighContrast action)](#oh_drawing_settexthighcontrast) | 设置文本渲染高对比度模式。 |
36| [void OH_Drawing_SetTextUndefinedGlyphDisplay(OH_Drawing_TextUndefinedGlyphDisplay undefinedGlyphDisplay)](#oh_drawing_settextundefinedglyphdisplay) | 控制未定义字形的呈现方式,影响此后渲染的所有文本。 |
37
38## 枚举类型说明
39
40### OH_Drawing_TextHighContrast
41
42```
43enum OH_Drawing_TextHighContrast
44```
45
46**描述**
47
48文本渲染高对比度模式枚举。
49
50**起始版本:** 20
51
52| 枚举项 | 描述 |
53| -- | -- |
54| TEXT_FOLLOW_SYSTEM_HIGH_CONTRAST | 跟随系统设置中的高对比度文字配置。 |
55| TEXT_APP_DISABLE_HIGH_CONTRAST | 关闭APP的文本渲染高对比度配置,该模式的优先级要高于系统设置中的高对比度文字配置。 |
56| TEXT_APP_ENABLE_HIGH_CONTRAST | 开启APP的文本渲染高对比度配置,该模式的优先级要高于系统设置中的高对比度文字配置。 |
57
58### OH_Drawing_TextUndefinedGlyphDisplay
59
60```
61enum OH_Drawing_TextUndefinedGlyphDisplay
62```
63
64**描述**
65
66显示未定义字形的方式。
67
68**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
69
70**起始版本:** 20
71
72| 枚举项 | 描述 |
73| -- | -- |
74| TEXT_NO_GLYPH_USE_DEFAULT = 0 | 使用字体文件中定义的默认字形(可能是空框、空白或自定义符号等)。 |
75| TEXT_NO_GLYPH_USE_TOFU = 1 | 始终使用豆腐块显示缺失的字形。 |
76
77## 函数说明
78
79### OH_Drawing_SetTextHighContrast()
80
81```
82void OH_Drawing_SetTextHighContrast(OH_Drawing_TextHighContrast action)
83```
84
85**描述**
86
87设置文本渲染高对比度模式。
88
89该接口设置后整个进程都会生效,进程内所有页面共用相同模式。
90
91可调用此接口设置,也可通过系统设置界面中高对比度文字配置开关进行开启/关闭。使用此接口设置开启/关闭文本渲染高对比度配置的优先级高于系统开关设置。
92
93该接口针对应用的文字自绘制场景不生效。
94
95**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
96
97**起始版本:** 20
98
99
100**参数:**
101
102| 参数项 | 描述 |
103| -- | -- |
104| [OH_Drawing_TextHighContrast](#oh_drawing_texthighcontrast) action | 表示文本渲染高对比度模式,为[OH_Drawing_TextHighContrast](#oh_drawing_texthighcontrast)类型的枚举值。 |
105
106### OH_Drawing_SetTextUndefinedGlyphDisplay()
107
108```
109void OH_Drawing_SetTextUndefinedGlyphDisplay(OH_Drawing_TextUndefinedGlyphDisplay undefinedGlyphDisplay)
110```
111
112**描述**
113
114控制未定义字形的呈现方式,影响此后渲染的所有文本。
115
116**系统能力:** SystemCapability.Graphic.Graphic2D.NativeDrawing
117
118**起始版本:** 20
119
120
121**参数:**
122
123| 参数项 | 描述 |
124| -- | -- |
125| [OH_Drawing_TextUndefinedGlyphDisplay](#oh_drawing_textundefinedglyphdisplay) undefinedGlyphDisplay | 表示显示未定义字形的方式,为[OH_Drawing_TextUndefinedGlyphDisplay](#oh_drawing_textundefinedglyphdisplay)类型的枚举值。 |