From 3145f3158bf200ed6318fb9c928c041eabf9c19d Mon Sep 17 00:00:00 2001 From: stella-ren Date: Mon, 7 Mar 2022 16:35:54 +0800 Subject: [PATCH 1/4] add drawing text Chinese explanations Signed-off-by: stella-ren --- .../graphic/drawing_font_collection.h | 69 +++ .../graphic/drawing_text_declaration.h | 88 +++ .../graphic/drawing_text_typography.h | 516 ++++++++++++++++++ 3 files changed, 673 insertions(+) create mode 100644 zh-cn/native_sdk/graphic/drawing_font_collection.h create mode 100644 zh-cn/native_sdk/graphic/drawing_text_declaration.h create mode 100644 zh-cn/native_sdk/graphic/drawing_text_typography.h diff --git a/zh-cn/native_sdk/graphic/drawing_font_collection.h b/zh-cn/native_sdk/graphic/drawing_font_collection.h new file mode 100644 index 00000000..f3abe93f --- /dev/null +++ b/zh-cn/native_sdk/graphic/drawing_font_collection.h @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef C_INCLUDE_DRAWING_FONT_COLLECTION_H +#define C_INCLUDE_DRAWING_FONT_COLLECTION_H + +/** + * @addtogroup Drawing + * @{ + * + * @brief 提供2D绘制功能 + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * + * @since 8 + * @version 1.0 + */ + +/** + * @file drawing_font_collection.h + * + * @brief 定义绘制模块中与fontCollection相关的函数 + * + * @since 8 + * @version 1.0 + */ + +#include "drawing_text_declaration.h" + +#ifdef __cplusplus +extern "C" { +#endif +/** + * @brief 创建fontCollection. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @return 指向创建的OH_Drawing_FontCollection对象的指针 + * @since 8 + * @version 1.0 + */ +OH_Drawing_FontCollection* OH_Drawing_CreateFontCollection(void); + +/** + * @brief 释放被OH_Drawing_FontCollection对象占据的内存 + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_FontCollection 指向OH_Drawing_FontCollection对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_DestroyFontCollection(OH_Drawing_FontCollection*); + +#ifdef __cplusplus +} +#endif +/** @} */ +#endif diff --git a/zh-cn/native_sdk/graphic/drawing_text_declaration.h b/zh-cn/native_sdk/graphic/drawing_text_declaration.h new file mode 100644 index 00000000..76154045 --- /dev/null +++ b/zh-cn/native_sdk/graphic/drawing_text_declaration.h @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef C_INCLUDE_DRAWING_TEXT_DECLARATION_H +#define C_INCLUDE_DRAWING_TEXT_DECLARATION_H + +/** + * @addtogroup Drawing + * @{ + * + * @brief 提供2D绘制功能 + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * + * @since 8 + * @version 1.0 + */ + +/** + * @file drawing_text_declaration.h + * + * @brief 提供2d drawing文本相关的数据结构声明 + * + * @since 8 + * @version 1.0 + */ + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief OH_Drawing_FontCollection用于加载字体. + * + * @since 8 + * @version 1.0 + */ +typedef struct OH_Drawing_FontCollection OH_Drawing_FontCollection; + +/** + * @brief OH_Drawing_Typography用于管理排版的布局和显示等. + * + * @since 8 + * @version 1.0 + */ +typedef struct OH_Drawing_Typography OH_Drawing_Typography; + +/** + * @brief OH_Drawing_TextStyle用于管理字体颜色、装饰等. + * + * @since 8 + * @version 1.0 + */ +typedef struct OH_Drawing_TextStyle OH_Drawing_TextStyle; + +/** + * @brief OH_Drawing_TypographyStyle用于管理排版风格,如文字方向等. + * + * @since 8 + * @version 1.0 + */ +typedef struct OH_Drawing_TypographyStyle OH_Drawing_TypographyStyle; + +/** + * @brief OH_Drawing_TypographyCreate用于创建OH_Drawing_Typography. + * + * @since 8 + * @version 1.0 + */ +typedef struct OH_Drawing_TypographyCreate OH_Drawing_TypographyCreate; + +#ifdef __cplusplus +} +#endif +/** @} */ +#endif \ No newline at end of file diff --git a/zh-cn/native_sdk/graphic/drawing_text_typography.h b/zh-cn/native_sdk/graphic/drawing_text_typography.h new file mode 100644 index 00000000..21fe2d06 --- /dev/null +++ b/zh-cn/native_sdk/graphic/drawing_text_typography.h @@ -0,0 +1,516 @@ +/* + * Copyright (c) 2021-2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef C_INCLUDE_DRAWING_TEXT_TYPOGRAPHY_H +#define C_INCLUDE_DRAWING_TEXT_TYPOGRAPHY_H + +/** + * @addtogroup Drawing + * @{ + * + * @brief 提供2D绘制功能 + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * + * @since 8 + * @version 1.0 + */ + +/** + * @file drawing_text_typography.h + * + * @brief 定义绘制模块中排版相关的函数. + * + * @since 8 + * @version 1.0 + */ + +#include "drawing_canvas.h" +#include "drawing_color.h" +#include "drawing_text_declaration.h" +#include "drawing_types.h" + +#include "stdint.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @brief 文字方向. + */ +enum OH_Drawing_TextDirection { + /** 方向:从右到左 */ + TEXT_DIRECTION_RTL, + /** 方向:从左到右 */ + TEXT_DIRECTION_LTR, +}; + +/** + * @brief 文字对齐方式. + */ +enum OH_Drawing_TextAlign { + /** 左对齐 */ + TEXT_ALIGN_LEFT, + /** 右对齐 */ + TEXT_ALIGN_RIGHT, + /** 居中对齐 */ + TEXT_ALIGN_CENTER, + /** + * 两端对齐,即靠紧左和右边缘,中间单词空隙由空格填充。 + * 最后一行除外. + */ + TEXT_ALIGN_JUSTIFY, + /** + * 当OH_Drawing_TextDirection是TEXT_DIRECTION_LTR时, + * TEXT_ALIGN_START和TEXT_ALIGN_LEFT相同; + * 类似地,当OH_Drawing_TextDirection是TEXT_DIRECTION_RTL时, + * TEXT_ALIGN_START和TEXT_ALIGN_RIGHT相同。 + */ + TEXT_ALIGN_START, + /** + * 当OH_Drawing_TextDirection是TEXT_DIRECTION_LTR时, + * TEXT_ALIGN_START和TEXT_ALIGN_RIGHT相同; + * 类似地,当OH_Drawing_TextDirection是TEXT_DIRECTION_RTL时, + * TEXT_ALIGN_START和TEXT_ALIGN_LEFT相同。 + */ + TEXT_ALIGN_END, +}; + +/** + * @brief font weight. + */ +enum OH_Drawing_FontWeight { + /** 字重为thin */ + FONT_WEIGHT_100, + /** 字重为extra-light */ + FONT_WEIGHT_200, + /** 字重为light */ + FONT_WEIGHT_300, + /** 字重为normal/regular */ + FONT_WEIGHT_400, + /** 字重为medium */ + FONT_WEIGHT_500, + /** 字重为semi-bold */ + FONT_WEIGHT_600, + /** 字重为bold */ + FONT_WEIGHT_700, + /** 字重为extra-bold */ + FONT_WEIGHT_800, + /** 字重为black */ + FONT_WEIGHT_900, +}; + +/** + * @brief 基线位置. + */ +enum OH_Drawing_TextBaseline { + /** 用于表音文字,基线在中间偏下的位置 */ + TEXT_BASELINE_ALPHABETIC, + /** 用于表意文字,基线位于底部 */ + TEXT_BASELINE_IDEOGRAPHIC, +}; + +/** + * @brief 文字装饰. + */ +enum OH_Drawing_TextDecoration { + /** 无装饰 */ + TEXT_DECORATION_NONE = 0x0, + /** 下划线 */ + TEXT_DECORATION_UNDERLINE = 0x1, + /** 上划线 */ + TEXT_DECORATION_OVERLINE = 0x2, + /** 删除线 */ + TEXT_DECORATION_LINE_THROUGH = 0x4, +}; + +/** + * @brief 区分字体是否为斜体. + */ +enum OH_Drawing_FontStyle { + /** 非斜体 */ + FONT_STYLE_NORMAL, + /** 斜体 */ + FONT_STYLE_ITALIC, +}; + +/** + * @brief 创建TypographyStyle. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @return OH_Drawing_TypographyStyle 指向创建的OH_Drawing_TypographyStyle对象的指针 + * @since 8 + * @version 1.0 + */ +OH_Drawing_TypographyStyle* OH_Drawing_CreateTypographyStyle(void); + +/** + * @brief 释放被OH_Drawing_TypographyStyle对象占据的内存. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_DestroyTypographyStyle(OH_Drawing_TypographyStyle*); + +/** + * @brief 设置文本方向. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 + * @param int OH_Drawing_TextDirection枚举类型 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTypographyTextDirection(OH_Drawing_TypographyStyle*, int /* OH_Drawing_TextDirection */); + +/** + * @brief 设置文本对齐方式. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 + * @param int OH_Drawing_TextAlign枚举类型 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTypographyTextAlign(OH_Drawing_TypographyStyle*, int /* OH_Drawing_TextAlign */); + +/** + * @brief 设置文本最大行数. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 + * @param int 最大行数 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTypographyTextMaxLines(OH_Drawing_TypographyStyle*, int /* maxLines */); + +/** + * @brief 创建OH_Drawing_TextStyle. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @return OH_Drawing_TextStyle 指向创建的OH_Drawing_TextStyle对象的指针 + * @since 8 + * @version 1.0 + */ +OH_Drawing_TextStyle* OH_Drawing_CreateTextStyle(void); + +/** + * @brief 释放被OH_Drawing_TextStyle对象占据的内存. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TextStyle对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_DestroyTextStyle(OH_Drawing_TextStyle*); + +/** + * @brief 设置文本颜色. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param uint32_t 颜色 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleColor(OH_Drawing_TextStyle*, uint32_t /* color */); + +/** + * @brief 设置字号. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param double 字号 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleFontSize(OH_Drawing_TextStyle*, double /* fontSize */); + +/** + * @brief 设置字重. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param int OH_Drawing_FontWeight枚举类型 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleFontWeight(OH_Drawing_TextStyle*, int /* OH_Drawing_FontWeight */); + +/** + * @brief 设置字体基线位置. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param int OH_Drawing_TextBaseline枚举类型 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleBaseLine(OH_Drawing_TextStyle*, int /* OH_Drawing_TextBaseline */); + +/** + * @brief 设置装饰. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param int OH_Drawing_TextDecoration枚举类型 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleDecoration(OH_Drawing_TextStyle*, int /* OH_Drawing_TextDecoration */); + +/** + * @brief 设置装饰颜色. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param uint32_t 颜色 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleDecorationColor(OH_Drawing_TextStyle*, uint32_t /* color */); + +/** + * @brief 设置字体高度. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param double 字体高度 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleFontHeight(OH_Drawing_TextStyle*, double /* fontHeight */); + +/** + * @brief 设置字体类型. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param int 字体名称数量 + * @param char 指向字体类型的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleFontFamilies(OH_Drawing_TextStyle*, + int /* fontFamiliesNumber */, const char* fontFamilies[]); + +/** + * @brief 字体风格. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param int OH_Drawing_FontStyle枚举类型 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleFontStyle(OH_Drawing_TextStyle*, int /* fontStyle */); + +/** + * @brief 设置语言区域 + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @param char 语言区域,数据类型为指向char的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_SetTextStyleLocale(OH_Drawing_TextStyle*, const char*); + +/** + * @brief 创建指向OH_Drawing_TypographyCreate对象的指针. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle的指针 + * @param OH_Drawing_FontCollection 指向OH_Drawing_FontCollection的指针 + * @return OH_Drawing_TypographyCreate 指向新创建的OH_Drawing_TypographyCreate对象的指针 + * @since 8 + * @version 1.0 + */ +OH_Drawing_TypographyCreate* OH_Drawing_CreateTypographyHandler(OH_Drawing_TypographyStyle*, + OH_Drawing_FontCollection*); + +/** + * @brief 释放被OH_Drawing_TypographyCreate对象占据的内存. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_DestroyTypographyHandler(OH_Drawing_TypographyCreate*); + +/** + * @brief 设置排版风格. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 + * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_TypographyHandlerPushStyle(OH_Drawing_TypographyCreate*, OH_Drawing_TextStyle*); + +/** + * @brief 设置文本内容. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 + * @param char 指向文本内容的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_TypographyHandlerAddText(OH_Drawing_TypographyCreate*, const char*); + +/** + * @brief 排版弹出. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_TypographyHandlerPop(OH_Drawing_TypographyCreate*); + +/** + * @brief 创建OH_Drawing_Typography. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_TypographyCreate 指向OH_Drawing_Typography对象的指针 + * @return OH_Drawing_Typography a pointer to OH_Drawing_Typography + * @since 8 + * @version 1.0 + */ +OH_Drawing_Typography* OH_Drawing_CreateTypography(OH_Drawing_TypographyCreate*); + +/** + * @brief 释放OH_Drawing_Typography对象占据的内存 + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_DestroyTypography(OH_Drawing_Typography*); + +/** + * @brief 排版布局. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @param double 文本最大宽度 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_TypographyLayout(OH_Drawing_Typography*, double /* maxWidth */); + +/** + * @brief 显示文本. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @param OH_Drawing_Canvas 指向OH_Drawing_Canvas对象的指针 + * @param double x坐标 + * @param double y坐标 + * @since 8 + * @version 1.0 + */ +void OH_Drawing_TypographyPaint(OH_Drawing_Typography*, OH_Drawing_Canvas*, + double /* potisionX */, double /* potisionY */); + +/** + * @brief 获取排版的最大宽度. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double 最大宽度 + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetMaxWidth(OH_Drawing_Typography*); + +/** + * @brief 获取排版的高度. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double 高度 + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetHeight(OH_Drawing_Typography*); + +/** + * @brief 获取最长行. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double longest line + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetLongestLine(OH_Drawing_Typography*); + +/** + * @brief 获取内部最小宽度. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double 内部最小宽度 + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetMinIntrinsicWidth(OH_Drawing_Typography*); + +/** + * @brief 获取内部最大宽度. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double 内部最大宽度 + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetMaxIntrinsicWidth(OH_Drawing_Typography*); + +/** + * @brief 获取表音文字的基线. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double 表音文字的基线 + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetAlphabeticBaseline(OH_Drawing_Typography*); + +/** + * @brief 获取表意文字的基线. + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing + * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 + * @return double 表意文字的基线 + * @since 8 + * @version 1.0 + */ +double OH_Drawing_TypographyGetIdeographicBaseline(OH_Drawing_Typography*); +#ifdef __cplusplus +} +#endif +/** @} */ +#endif \ No newline at end of file -- Gitee From c7e86851a5523afae5b3ecf371dda6cc2e542cb9 Mon Sep 17 00:00:00 2001 From: stella-ren Date: Mon, 7 Mar 2022 16:39:03 +0800 Subject: [PATCH 2/4] add drawing text Chinese explanations Signed-off-by: stella-ren --- zh-cn/native_sdk/graphic/drawing_text_typography.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/zh-cn/native_sdk/graphic/drawing_text_typography.h b/zh-cn/native_sdk/graphic/drawing_text_typography.h index 21fe2d06..a8420a32 100644 --- a/zh-cn/native_sdk/graphic/drawing_text_typography.h +++ b/zh-cn/native_sdk/graphic/drawing_text_typography.h @@ -90,7 +90,7 @@ enum OH_Drawing_TextAlign { }; /** - * @brief font weight. + * @brief 字重. */ enum OH_Drawing_FontWeight { /** 字重为thin */ @@ -124,7 +124,7 @@ enum OH_Drawing_TextBaseline { }; /** - * @brief 文字装饰. + * @brief 文本装饰. */ enum OH_Drawing_TextDecoration { /** 无装饰 */ @@ -460,7 +460,7 @@ double OH_Drawing_TypographyGetHeight(OH_Drawing_Typography*); * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 - * @return double longest line + * @return double 最长行 * @since 8 * @version 1.0 */ -- Gitee From 638c603d9705b4eadeb35c6a1194b43476e28cfc Mon Sep 17 00:00:00 2001 From: stella-ren Date: Tue, 8 Mar 2022 10:24:54 +0800 Subject: [PATCH 3/4] add drawing text Chinese explanations Signed-off-by: stella-ren --- .../graphic/drawing_font_collection.h | 2 +- .../graphic/drawing_text_declaration.h | 10 +-- .../graphic/drawing_text_typography.h | 80 +++++++++---------- 3 files changed, 46 insertions(+), 46 deletions(-) diff --git a/zh-cn/native_sdk/graphic/drawing_font_collection.h b/zh-cn/native_sdk/graphic/drawing_font_collection.h index f3abe93f..18def869 100644 --- a/zh-cn/native_sdk/graphic/drawing_font_collection.h +++ b/zh-cn/native_sdk/graphic/drawing_font_collection.h @@ -43,7 +43,7 @@ extern "C" { #endif /** - * @brief 创建fontCollection. + * @brief 创建fontCollection * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @return 指向创建的OH_Drawing_FontCollection对象的指针 diff --git a/zh-cn/native_sdk/graphic/drawing_text_declaration.h b/zh-cn/native_sdk/graphic/drawing_text_declaration.h index 76154045..64bcbfba 100644 --- a/zh-cn/native_sdk/graphic/drawing_text_declaration.h +++ b/zh-cn/native_sdk/graphic/drawing_text_declaration.h @@ -42,7 +42,7 @@ extern "C" { #endif /** - * @brief OH_Drawing_FontCollection用于加载字体. + * @brief OH_Drawing_FontCollection用于加载字体 * * @since 8 * @version 1.0 @@ -50,7 +50,7 @@ extern "C" { typedef struct OH_Drawing_FontCollection OH_Drawing_FontCollection; /** - * @brief OH_Drawing_Typography用于管理排版的布局和显示等. + * @brief OH_Drawing_Typography用于管理排版的布局和显示等 * * @since 8 * @version 1.0 @@ -58,7 +58,7 @@ typedef struct OH_Drawing_FontCollection OH_Drawing_FontCollection; typedef struct OH_Drawing_Typography OH_Drawing_Typography; /** - * @brief OH_Drawing_TextStyle用于管理字体颜色、装饰等. + * @brief OH_Drawing_TextStyle用于管理字体颜色、装饰等 * * @since 8 * @version 1.0 @@ -66,7 +66,7 @@ typedef struct OH_Drawing_Typography OH_Drawing_Typography; typedef struct OH_Drawing_TextStyle OH_Drawing_TextStyle; /** - * @brief OH_Drawing_TypographyStyle用于管理排版风格,如文字方向等. + * @brief OH_Drawing_TypographyStyle用于管理排版风格,如文字方向等 * * @since 8 * @version 1.0 @@ -74,7 +74,7 @@ typedef struct OH_Drawing_TextStyle OH_Drawing_TextStyle; typedef struct OH_Drawing_TypographyStyle OH_Drawing_TypographyStyle; /** - * @brief OH_Drawing_TypographyCreate用于创建OH_Drawing_Typography. + * @brief OH_Drawing_TypographyCreate用于创建OH_Drawing_Typography * * @since 8 * @version 1.0 diff --git a/zh-cn/native_sdk/graphic/drawing_text_typography.h b/zh-cn/native_sdk/graphic/drawing_text_typography.h index a8420a32..8ce65e03 100644 --- a/zh-cn/native_sdk/graphic/drawing_text_typography.h +++ b/zh-cn/native_sdk/graphic/drawing_text_typography.h @@ -31,7 +31,7 @@ /** * @file drawing_text_typography.h * - * @brief 定义绘制模块中排版相关的函数. + * @brief 定义绘制模块中排版相关的函数 * * @since 8 * @version 1.0 @@ -49,7 +49,7 @@ extern "C" { #endif /** - * @brief 文字方向. + * @brief 文字方向 */ enum OH_Drawing_TextDirection { /** 方向:从右到左 */ @@ -59,7 +59,7 @@ enum OH_Drawing_TextDirection { }; /** - * @brief 文字对齐方式. + * @brief 文字对齐方式 */ enum OH_Drawing_TextAlign { /** 左对齐 */ @@ -69,8 +69,8 @@ enum OH_Drawing_TextAlign { /** 居中对齐 */ TEXT_ALIGN_CENTER, /** - * 两端对齐,即靠紧左和右边缘,中间单词空隙由空格填充。 - * 最后一行除外. + * 两端对齐,即靠紧左和右边缘,中间单词空隙由空格填充 + * 最后一行除外 */ TEXT_ALIGN_JUSTIFY, /** @@ -90,7 +90,7 @@ enum OH_Drawing_TextAlign { }; /** - * @brief 字重. + * @brief 字重 */ enum OH_Drawing_FontWeight { /** 字重为thin */ @@ -114,7 +114,7 @@ enum OH_Drawing_FontWeight { }; /** - * @brief 基线位置. + * @brief 基线位置 */ enum OH_Drawing_TextBaseline { /** 用于表音文字,基线在中间偏下的位置 */ @@ -124,7 +124,7 @@ enum OH_Drawing_TextBaseline { }; /** - * @brief 文本装饰. + * @brief 文本装饰 */ enum OH_Drawing_TextDecoration { /** 无装饰 */ @@ -138,7 +138,7 @@ enum OH_Drawing_TextDecoration { }; /** - * @brief 区分字体是否为斜体. + * @brief 区分字体是否为斜体 */ enum OH_Drawing_FontStyle { /** 非斜体 */ @@ -148,7 +148,7 @@ enum OH_Drawing_FontStyle { }; /** - * @brief 创建TypographyStyle. + * @brief 创建TypographyStyle * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @return OH_Drawing_TypographyStyle 指向创建的OH_Drawing_TypographyStyle对象的指针 @@ -158,7 +158,7 @@ enum OH_Drawing_FontStyle { OH_Drawing_TypographyStyle* OH_Drawing_CreateTypographyStyle(void); /** - * @brief 释放被OH_Drawing_TypographyStyle对象占据的内存. + * @brief 释放被OH_Drawing_TypographyStyle对象占据的内存 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 @@ -168,7 +168,7 @@ OH_Drawing_TypographyStyle* OH_Drawing_CreateTypographyStyle(void); void OH_Drawing_DestroyTypographyStyle(OH_Drawing_TypographyStyle*); /** - * @brief 设置文本方向. + * @brief 设置文本方向 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 @@ -179,7 +179,7 @@ void OH_Drawing_DestroyTypographyStyle(OH_Drawing_TypographyStyle*); void OH_Drawing_SetTypographyTextDirection(OH_Drawing_TypographyStyle*, int /* OH_Drawing_TextDirection */); /** - * @brief 设置文本对齐方式. + * @brief 设置文本对齐方式 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 @@ -190,7 +190,7 @@ void OH_Drawing_SetTypographyTextDirection(OH_Drawing_TypographyStyle*, int /* O void OH_Drawing_SetTypographyTextAlign(OH_Drawing_TypographyStyle*, int /* OH_Drawing_TextAlign */); /** - * @brief 设置文本最大行数. + * @brief 设置文本最大行数 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle对象的指针 @@ -201,7 +201,7 @@ void OH_Drawing_SetTypographyTextAlign(OH_Drawing_TypographyStyle*, int /* OH_Dr void OH_Drawing_SetTypographyTextMaxLines(OH_Drawing_TypographyStyle*, int /* maxLines */); /** - * @brief 创建OH_Drawing_TextStyle. + * @brief 创建OH_Drawing_TextStyle * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @return OH_Drawing_TextStyle 指向创建的OH_Drawing_TextStyle对象的指针 @@ -211,7 +211,7 @@ void OH_Drawing_SetTypographyTextMaxLines(OH_Drawing_TypographyStyle*, int /* ma OH_Drawing_TextStyle* OH_Drawing_CreateTextStyle(void); /** - * @brief 释放被OH_Drawing_TextStyle对象占据的内存. + * @brief 释放被OH_Drawing_TextStyle对象占据的内存 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TextStyle对象的指针 @@ -221,7 +221,7 @@ OH_Drawing_TextStyle* OH_Drawing_CreateTextStyle(void); void OH_Drawing_DestroyTextStyle(OH_Drawing_TextStyle*); /** - * @brief 设置文本颜色. + * @brief 设置文本颜色 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -232,7 +232,7 @@ void OH_Drawing_DestroyTextStyle(OH_Drawing_TextStyle*); void OH_Drawing_SetTextStyleColor(OH_Drawing_TextStyle*, uint32_t /* color */); /** - * @brief 设置字号. + * @brief 设置字号 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -243,7 +243,7 @@ void OH_Drawing_SetTextStyleColor(OH_Drawing_TextStyle*, uint32_t /* color */); void OH_Drawing_SetTextStyleFontSize(OH_Drawing_TextStyle*, double /* fontSize */); /** - * @brief 设置字重. + * @brief 设置字重 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -254,7 +254,7 @@ void OH_Drawing_SetTextStyleFontSize(OH_Drawing_TextStyle*, double /* fontSize * void OH_Drawing_SetTextStyleFontWeight(OH_Drawing_TextStyle*, int /* OH_Drawing_FontWeight */); /** - * @brief 设置字体基线位置. + * @brief 设置字体基线位置 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -265,7 +265,7 @@ void OH_Drawing_SetTextStyleFontWeight(OH_Drawing_TextStyle*, int /* OH_Drawing_ void OH_Drawing_SetTextStyleBaseLine(OH_Drawing_TextStyle*, int /* OH_Drawing_TextBaseline */); /** - * @brief 设置装饰. + * @brief 设置装饰 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -276,7 +276,7 @@ void OH_Drawing_SetTextStyleBaseLine(OH_Drawing_TextStyle*, int /* OH_Drawing_Te void OH_Drawing_SetTextStyleDecoration(OH_Drawing_TextStyle*, int /* OH_Drawing_TextDecoration */); /** - * @brief 设置装饰颜色. + * @brief 设置装饰颜色 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -287,7 +287,7 @@ void OH_Drawing_SetTextStyleDecoration(OH_Drawing_TextStyle*, int /* OH_Drawing_ void OH_Drawing_SetTextStyleDecorationColor(OH_Drawing_TextStyle*, uint32_t /* color */); /** - * @brief 设置字体高度. + * @brief 设置字体高度 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -298,7 +298,7 @@ void OH_Drawing_SetTextStyleDecorationColor(OH_Drawing_TextStyle*, uint32_t /* c void OH_Drawing_SetTextStyleFontHeight(OH_Drawing_TextStyle*, double /* fontHeight */); /** - * @brief 设置字体类型. + * @brief 设置字体类型 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -311,7 +311,7 @@ void OH_Drawing_SetTextStyleFontFamilies(OH_Drawing_TextStyle*, int /* fontFamiliesNumber */, const char* fontFamilies[]); /** - * @brief 字体风格. + * @brief 字体风格 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle 指向OH_Drawing_TextStyle对象的指针 @@ -333,7 +333,7 @@ void OH_Drawing_SetTextStyleFontStyle(OH_Drawing_TextStyle*, int /* fontStyle */ void OH_Drawing_SetTextStyleLocale(OH_Drawing_TextStyle*, const char*); /** - * @brief 创建指向OH_Drawing_TypographyCreate对象的指针. + * @brief 创建指向OH_Drawing_TypographyCreate对象的指针 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyStyle 指向OH_Drawing_TypographyStyle的指针 @@ -346,7 +346,7 @@ OH_Drawing_TypographyCreate* OH_Drawing_CreateTypographyHandler(OH_Drawing_Typog OH_Drawing_FontCollection*); /** - * @brief 释放被OH_Drawing_TypographyCreate对象占据的内存. + * @brief 释放被OH_Drawing_TypographyCreate对象占据的内存 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 @@ -356,7 +356,7 @@ OH_Drawing_TypographyCreate* OH_Drawing_CreateTypographyHandler(OH_Drawing_Typog void OH_Drawing_DestroyTypographyHandler(OH_Drawing_TypographyCreate*); /** - * @brief 设置排版风格. + * @brief 设置排版风格 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 @@ -367,7 +367,7 @@ void OH_Drawing_DestroyTypographyHandler(OH_Drawing_TypographyCreate*); void OH_Drawing_TypographyHandlerPushStyle(OH_Drawing_TypographyCreate*, OH_Drawing_TextStyle*); /** - * @brief 设置文本内容. + * @brief 设置文本内容 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 @@ -378,7 +378,7 @@ void OH_Drawing_TypographyHandlerPushStyle(OH_Drawing_TypographyCreate*, OH_Draw void OH_Drawing_TypographyHandlerAddText(OH_Drawing_TypographyCreate*, const char*); /** - * @brief 排版弹出. + * @brief 排版弹出 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyCreate 指向OH_Drawing_TypographyCreate对象的指针 @@ -388,7 +388,7 @@ void OH_Drawing_TypographyHandlerAddText(OH_Drawing_TypographyCreate*, const cha void OH_Drawing_TypographyHandlerPop(OH_Drawing_TypographyCreate*); /** - * @brief 创建OH_Drawing_Typography. + * @brief 创建OH_Drawing_Typography * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TypographyCreate 指向OH_Drawing_Typography对象的指针 @@ -409,7 +409,7 @@ OH_Drawing_Typography* OH_Drawing_CreateTypography(OH_Drawing_TypographyCreate*) void OH_Drawing_DestroyTypography(OH_Drawing_Typography*); /** - * @brief 排版布局. + * @brief 排版布局 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -420,7 +420,7 @@ void OH_Drawing_DestroyTypography(OH_Drawing_Typography*); void OH_Drawing_TypographyLayout(OH_Drawing_Typography*, double /* maxWidth */); /** - * @brief 显示文本. + * @brief 显示文本 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -434,7 +434,7 @@ void OH_Drawing_TypographyPaint(OH_Drawing_Typography*, OH_Drawing_Canvas*, double /* potisionX */, double /* potisionY */); /** - * @brief 获取排版的最大宽度. + * @brief 获取排版的最大宽度 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -445,7 +445,7 @@ void OH_Drawing_TypographyPaint(OH_Drawing_Typography*, OH_Drawing_Canvas*, double OH_Drawing_TypographyGetMaxWidth(OH_Drawing_Typography*); /** - * @brief 获取排版的高度. + * @brief 获取排版的高度 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -456,7 +456,7 @@ double OH_Drawing_TypographyGetMaxWidth(OH_Drawing_Typography*); double OH_Drawing_TypographyGetHeight(OH_Drawing_Typography*); /** - * @brief 获取最长行. + * @brief 获取最长行 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -467,7 +467,7 @@ double OH_Drawing_TypographyGetHeight(OH_Drawing_Typography*); double OH_Drawing_TypographyGetLongestLine(OH_Drawing_Typography*); /** - * @brief 获取内部最小宽度. + * @brief 获取内部最小宽度 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -478,7 +478,7 @@ double OH_Drawing_TypographyGetLongestLine(OH_Drawing_Typography*); double OH_Drawing_TypographyGetMinIntrinsicWidth(OH_Drawing_Typography*); /** - * @brief 获取内部最大宽度. + * @brief 获取内部最大宽度 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -489,7 +489,7 @@ double OH_Drawing_TypographyGetMinIntrinsicWidth(OH_Drawing_Typography*); double OH_Drawing_TypographyGetMaxIntrinsicWidth(OH_Drawing_Typography*); /** - * @brief 获取表音文字的基线. + * @brief 获取表音文字的基线 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 @@ -500,7 +500,7 @@ double OH_Drawing_TypographyGetMaxIntrinsicWidth(OH_Drawing_Typography*); double OH_Drawing_TypographyGetAlphabeticBaseline(OH_Drawing_Typography*); /** - * @brief 获取表意文字的基线. + * @brief 获取表意文字的基线 * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_Typography 指向OH_Drawing_Typography对象的指针 -- Gitee From 076add67c108afaa3f473ebde509fc712b59459a Mon Sep 17 00:00:00 2001 From: stella-ren Date: Wed, 9 Mar 2022 12:00:08 +0800 Subject: [PATCH 4/4] add explanations Signed-off-by: stella-ren --- zh-cn/native_sdk/graphic/drawing_text_typography.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/native_sdk/graphic/drawing_text_typography.h b/zh-cn/native_sdk/graphic/drawing_text_typography.h index 8ce65e03..a7186c73 100644 --- a/zh-cn/native_sdk/graphic/drawing_text_typography.h +++ b/zh-cn/native_sdk/graphic/drawing_text_typography.h @@ -69,7 +69,7 @@ enum OH_Drawing_TextAlign { /** 居中对齐 */ TEXT_ALIGN_CENTER, /** - * 两端对齐,即靠紧左和右边缘,中间单词空隙由空格填充 + * 两端对齐,即紧靠左和右边缘,中间单词空隙由空格填充 * 最后一行除外 */ TEXT_ALIGN_JUSTIFY, -- Gitee