• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 自定义字体的注册和使用（C/C++）
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
13
14## 实现流程
15
16**自定义字体的注册**是指将字体文件（如ttf、otf文件等）从应用资源注册到系统中，使得应用能够使用这些字体进行文本渲染。注册过程通常指将字体文件通过字体管理接口注册到系统字体库中，以便在应用中进行调用。
17
18**自定义字体的使用**是指在应用中显式指定使用已注册的自定义字体进行文本绘制。开发者可以根据需要选择特定的文本样式（如常规、粗体、斜体等），并将其应用到UI元素、文本控件或其他文本展示区域，以确保符合设计要求并提供一致的视觉效果。
19
20
21## 接口说明
22
23注册使用自定义字体的相关接口如下所示，详细接口说明请参考[Drawing](../reference/apis-arkgraphics2d/capi-drawing.md)。
24
25| 接口名 | 描述 |
26| -------- | -------- |
27| OH_Drawing_CreateSharedFontCollection (void) | 创建可共享的字体集对象OH_Drawing_FontCollection。 |
28| OH_Drawing_RegisterFont (OH_Drawing_FontCollection\* , const char\* fontFamily, const char\* familySrc ) | 用于在字体管理器中注册自定义字体，支持的字体文件格式包含：ttf、otf。 |
29| OH_Drawing_CreateTextStyle(void) | 创建指向OH_Drawing_TextStyle对象的指针，用于设置文本样式。 |
30| OH_Drawing_SetTextStyleFontFamilies (OH_Drawing_TextStyle \*, int, const char \*fontFamilies[]) | 设置字体类型。 |
31| OH_Drawing_UnregisterFont (OH_Drawing_FontCollection\* , const char\* fontFamily) | 通过字体家族名称取消注册自定义字体。 |
32
33## 开发步骤
341. 在工程的`src/main/cpp/CMakeLists.txt`文件中添加以下lib。
35   ```c++
36   libnative_drawing.so
37   ```
38
392. 导入依赖的相关头文件。
40
41   ```c++
42   #include <native_drawing/drawing_font_collection.h>
43   #include <native_drawing/drawing_text_typography.h>
44   #include <native_drawing/drawing_register_font.h>
45   #include <hilog/log.h>
46   ```
47
483. 创建字体管理器，建议优先使用OH_Drawing_CreateSharedFontCollection()创建可共享的字体集对象。
49
50   > **说明：**
51   >
52   > 使用OH_Drawing_CreateFontCollection()和OH_Drawing_CreateSharedFontCollection()均可创建字体管理器OH_Drawing_FontCollection对象，但前者创建的字体集指针对象只能被一个段落生成器OH_Drawing_TypographyCreate对象使用，无法被多个段落生成器OH_Drawing_TypographyCreate对象共享使用。如需在多个段落生成器OH_Drawing_TypographyCreate对象间共享使用，请使用后者创建可共享的字体集对象。
53
54   ```c++
55   OH_Drawing_FontCollection *fontCollection = OH_Drawing_CreateSharedFontCollection();
56   ```
57
584. 设置自定义字体的字体家族名和字体文件所在的沙箱路径。
59
60   > **说明：**
61   >
62   > 确保需注册的可用自定义字体文件已正确放置在应用设备的/system/fonts/myFontFile.ttf路径下。
63
64   ```c++
65   // 后续使用自定义字体时，需使用到该字体家族名
66   const char* fontFamily = "myFamilyName";
67   // 该路径是待注册的自定义字体文件在应用设备下的路径，确保该自定义字体文件已正确放置在该路径下
68   const char* fontPath = "/system/fonts/myFontFile.ttf";
69   ```
70
715. 在字体管理器中使用OH_Drawing_RegisterFont()注册自定义字体。
72
73   可通过接口返回结果，查看具体情况，确认注册成功与否。
74
75   OH_Drawing_RegisterFont接口返回结果的几种情况及含义如下所示：
76
77   0表示注册成功，1表示文件不存在，2表示打开文件失败，3表示读取文件失败，4表示寻找文件失败，5表示获取大小失败，9表示文件损坏。
78
79   ```c++
80   // 返回0为成功，1为文件不存在，2为打开文件失败，3为读取文件失败，4为寻找文件失败，5为获取大小失败，9为文件损坏
81   int errorCode = OH_Drawing_RegisterFont(fontCollection, fontFamily, fontPath);
82   ```
83
846. 确保自定义字体注册成功后，使用OH_Drawing_CreateTextStyle()接口创建文本样式对象，并使用OH_Drawing_SetTextStyleFontFamilies()接口加入自定义字体。
85
86   ```c++
87   OH_Drawing_TextStyle* textStyle = OH_Drawing_CreateTextStyle();
88   // 如果已经注册成功自定义字体，填入自定义字体的字体家族名
89   const char* myFontFamilies[] = {"myFamilyName"};
90   // 加入可使用的自定义字体
91   OH_Drawing_SetTextStyleFontFamilies(textStyle, 1, myFontFamilies);
92   ```
93
947. 生成最终段落文本，使用自定义字体，以便实现最终的文本绘制和显示。
95
96   ```c++
97   // 设置其他文本样式
98   OH_Drawing_SetTextStyleColor(textStyle , OH_Drawing_ColorSetArgb(0xFF, 0x00, 0x00, 0x00));
99   OH_Drawing_SetTextStyleFontSize(textStyle , 50.0);
100   // 创建一个段落样式对象，以设置排版风格
101   OH_Drawing_TypographyStyle *typographyStyle = OH_Drawing_CreateTypographyStyle();
102   OH_Drawing_SetTypographyTextAlign(typographyStyle, TEXT_ALIGN_LEFT); // 设置段落样式为左对齐
103   // 创建一个段落生成器
104   OH_Drawing_TypographyCreate* handler = OH_Drawing_CreateTypographyHandler(typographyStyle, fontCollection);
105   // 在段落生成器中设置文本样式
106   OH_Drawing_TypographyHandlerPushTextStyle(handler, textStyle);
107   // 在段落生成器中设置文本内容
108   const char* text = "Hello World. 你好世界。\n以上文字使用了主题字体";
109   OH_Drawing_TypographyHandlerAddText(handler, text);
110   // 通过段落生成器生成段落
111   OH_Drawing_Typography* typography = OH_Drawing_CreateTypography(handler);
112   ```
113
1147. 如果需要释放自定义字体，可以使用OH_Drawing_UnregisterFont接口。
115
116   ```c++
117   // 释放自定义字体
118   OH_Drawing_UnregisterFont(fontCollection, fontFamily);
119   // 重新排版
120   // ...
121   ```