diff --git a/graphic/graphic_2d/native_drawing/drawing_text_typography.h b/graphic/graphic_2d/native_drawing/drawing_text_typography.h index b095c22e6c85a83e7d485c4e16ac68a3fd23c6ba..3690793f212ee4f944a306028a8396b0d8c35d51 100644 --- a/graphic/graphic_2d/native_drawing/drawing_text_typography.h +++ b/graphic/graphic_2d/native_drawing/drawing_text_typography.h @@ -1557,7 +1557,8 @@ void OH_Drawing_SetTypographyTextEllipsis(OH_Drawing_TypographyStyle*, const cha * @brief Sets the locale of lines in a text file. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param char Indicates the pointer to the locale to set. * @since 12 * @version 1.0 @@ -1568,7 +1569,8 @@ void OH_Drawing_SetTypographyTextLocale(OH_Drawing_TypographyStyle*, const char* * @brief Sets the textSplitRatio of lines in a text file. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param float Indicates the textSplitRatio of lines to set. * @since 12 * @version 1.0 @@ -1579,7 +1581,8 @@ void OH_Drawing_SetTypographyTextSplitRatio(OH_Drawing_TypographyStyle*, float); * @brief Gets the TextStyle of lines in a text file. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Returns line text textstyle. * @since 12 * @version 1.0 @@ -1590,7 +1593,8 @@ OH_Drawing_TextStyle* OH_Drawing_TypographyGetTextStyle(OH_Drawing_TypographySty * @brief Gets the EffectiveAlign of lines in a text file. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Returns line text align. * @since 12 * @version 1.0 @@ -1601,8 +1605,10 @@ int OH_Drawing_TypographyGetEffectiveAlignment(OH_Drawing_TypographyStyle*); * @brief Gets the UnlimitedLines of lines in a text file. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @return Returns whether the text has a maximum line limit, with true indicating a maximum line limit and false indicating no maximum line limit. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @return Returns whether the text has a maximum line limit, + * with true indicating a maximum line limit and false indicating no maximum line limit. * @since 12 * @version 1.0 */ @@ -1612,8 +1618,10 @@ bool OH_Drawing_TypographyIsLineUnlimited(OH_Drawing_TypographyStyle*); * @brief Gets the IsEllipsized of lines in a text file. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @return Returns whether the text has ellipsis, true meaning there is an ellipsis and false meaning there is no ellipsis. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @return Returns whether the text has ellipsis, + * true meaning there is an ellipsis and false meaning there is no ellipsis. * @since 12 * @version 1.0 */ @@ -1623,7 +1631,8 @@ bool OH_Drawing_TypographyIsEllipsized(OH_Drawing_TypographyStyle*); * @brief set line textstyle. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param OH_Drawing_TextStyle Indicates the pointer to a text style object OH_Drawing_TextStyle. * @since 12 * @version 1.0 @@ -1662,8 +1671,10 @@ bool OH_Drawing_TypographyGetLineInfo(OH_Drawing_Typography*, int, bool, bool, O * @brief Sets the font weight of text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @param int Indicates the font weight of text typography to set. For details, see the enum OH_Drawing_FontWeight. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @param int Indicates the font weight of text typography to set. For details, + * see the enum OH_Drawing_FontWeight. * @since 12 * @version 1.0 */ @@ -1673,8 +1684,10 @@ void OH_Drawing_SetTypographyTextFontWeight(OH_Drawing_TypographyStyle*, int); * @brief Sets the font style of text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @param int Indicates the font style of text typography to set. For details, see the enum OH_Drawing_FontStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @param int Indicates the font style of text typography to set. For details, + * see the enum OH_Drawing_FontStyle. * @since 12 * @version 1.0 */ @@ -1684,7 +1697,8 @@ void OH_Drawing_SetTypographyTextFontStyle(OH_Drawing_TypographyStyle*, int); * @brief Sets the font family of text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param char Indicates the pointer to the font family of text typography to set. * @since 12 * @version 1.0 @@ -1695,7 +1709,8 @@ void OH_Drawing_SetTypographyTextFontFamily(OH_Drawing_TypographyStyle*, const c * @brief Sets the font size of text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param double Indicates the font size of text typography to set. * @since 12 * @version 1.0 @@ -1706,7 +1721,8 @@ void OH_Drawing_SetTypographyTextFontSize(OH_Drawing_TypographyStyle*, double); * @brief Sets the font height of text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param double Indicates the font height of text typography to set. * @since 12 * @version 1.0 @@ -1717,7 +1733,8 @@ void OH_Drawing_SetTypographyTextFontHeight(OH_Drawing_TypographyStyle*, double) * @brief Sets the half leading of text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param bool Indicates the half leading of text typography to set. * @since 12 * @version 1.0 @@ -1728,7 +1745,8 @@ void OH_Drawing_SetTypographyTextHalfLeading(OH_Drawing_TypographyStyle*, bool); * @brief Sets whether to enable line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param bool Indicates whether the line style for text typography is used. * @since 12 * @version 1.0 @@ -1739,8 +1757,10 @@ void OH_Drawing_SetTypographyTextUseLineStyle(OH_Drawing_TypographyStyle*, bool) * @brief Sets the font weight of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @param int Indicates the font weight of line style for text typography to set. For details, see the enum OH_Drawing_FontWeight. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @param int Indicates the font weight of line style for text typography to set. + * For details, see the enum OH_Drawing_FontWeight. * @since 12 * @version 1.0 */ @@ -1750,8 +1770,10 @@ void OH_Drawing_SetTypographyTextLineStyleFontWeight(OH_Drawing_TypographyStyle* * @brief Sets the font style of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @param int Indicates the font style of line style for text typography to set. For details, see the enum OH_Drawing_FontStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @param int Indicates the font style of line style for text typography to set. For details, + * see the enum OH_Drawing_FontStyle. * @since 12 * @version 1.0 */ @@ -1761,7 +1783,8 @@ void OH_Drawing_SetTypographyTextLineStyleFontStyle(OH_Drawing_TypographyStyle*, * @brief Sets the font families of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param int Indicates the number of font families to set. * @param char Indicates the pointer to the font families of line style for text typography to set. * @since 12 @@ -1773,7 +1796,8 @@ void OH_Drawing_SetTypographyTextLineStyleFontFamilies(OH_Drawing_TypographyStyl * @brief Sets the font size of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param double Indicates the font size of line style for text typography to set. * @since 12 * @version 1.0 @@ -1784,7 +1808,8 @@ void OH_Drawing_SetTypographyTextLineStyleFontSize(OH_Drawing_TypographyStyle*, * @brief Sets the font height of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param double Indicates the font height of line style for text typography to set. * @since 12 * @version 1.0 @@ -1795,7 +1820,8 @@ void OH_Drawing_SetTypographyTextLineStyleFontHeight(OH_Drawing_TypographyStyle* * @brief Sets the half leading of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param bool Indicates the half leading of line for text typography to set. * @since 12 * @version 1.0 @@ -1806,7 +1832,8 @@ void OH_Drawing_SetTypographyTextLineStyleHalfLeading(OH_Drawing_TypographyStyle * @brief Sets the spacing scale of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param double Indicates the space scale of line for text typography to set. * @since 12 * @version 1.0 @@ -1817,7 +1844,8 @@ void OH_Drawing_SetTypographyTextLineStyleSpacingScale(OH_Drawing_TypographyStyl * @brief Sets whether only line style is enabled for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param bool Indicates the line style for text typography to set only. * @since 12 * @version 1.0 @@ -1895,7 +1923,8 @@ void OH_Drawing_TextStyleClearShadows(OH_Drawing_TextStyle*); * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle Indicates the pointer to a text style object OH_Drawing_TextStyle. * @param int Indicates the index to set. - * @return Returns the pointer to element with the index in vector of the text style object OH_Drawing_TextStyle. + * @return Returns the pointer to element with the index in vector of the text style object + * OH_Drawing_TextStyle. * @since 12 * @version 1.0 */ @@ -2184,7 +2213,8 @@ double OH_Drawing_TextStyleGetFontHeight(OH_Drawing_TextStyle*); * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing * @param OH_Drawing_TextStyle Indicates the pointer to an OH_Drawing_TextStyle object. - * @return Returns true indicates that the spacing takes effect, false indicates that the spacing does not take effect. + * @return Returns true indicates that the spacing takes effect, + * false indicates that the spacing does not take effect. * @since 12 * @version 1.0 */ @@ -2479,7 +2509,8 @@ bool OH_Drawing_TypographyTextGetLineStyle(OH_Drawing_TypographyStyle*); * @brief Get the font weight of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the font weight of line style for text typography. * For details, see the enum OH_Drawing_FontWeight. * @since 12 @@ -2491,7 +2522,8 @@ OH_Drawing_FontWeight OH_Drawing_TypographyTextlineStyleGetFontWeight(OH_Drawing * @brief Get the font style of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the font style of line style for text typography. * For details, see the enum OH_Drawing_FontStyle. * @since 12 @@ -2503,7 +2535,8 @@ OH_Drawing_FontStyle OH_Drawing_TypographyTextlineStyleGetFontStyle(OH_Drawing_T * @brief Get the font families of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @param num The number of obtained font names. * @return Return the font families of line style for text typography. * @since 12 @@ -2526,7 +2559,8 @@ void OH_Drawing_TypographyTextlineStyleDestroyFontFamilies(char** fontFamilies, * @brief Get the font size of font size for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the font size of font size for text typography. * @since 12 * @version 1.0 @@ -2537,7 +2571,8 @@ double OH_Drawing_TypographyTextlineStyleGetFontSize(OH_Drawing_TypographyStyle* * @brief Get the font height scale in text layout. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Retrun the font height scale in text layout. * @since 12 * @version 1.0 @@ -2548,7 +2583,8 @@ double OH_Drawing_TypographyTextlineStyleGetHeightScale(OH_Drawing_TypographySty * @brief Get whether to enable font height for line styles in text layout only. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Whether or not to enable the font height for line styles in text layout only, * true means enable, false means disable. * @since 12 @@ -2560,7 +2596,8 @@ bool OH_Drawing_TypographyTextlineStyleGetHeightOnly(OH_Drawing_TypographyStyle* * @brief Get the half leading of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Whether to enable the text line half leading style, true means enable, false means disable. * @since 12 * @version 1.0 @@ -2571,7 +2608,8 @@ bool OH_Drawing_TypographyTextlineStyleGetHalfLeading(OH_Drawing_TypographyStyle * @brief Get the spacing scale of line style for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the spacing scale of line style for text typography. * @since 12 * @version 1.0 @@ -2582,8 +2620,10 @@ double OH_Drawing_TypographyTextlineStyleGetSpacingScale(OH_Drawing_TypographySt * @brief Get whether only line style is enabled for text typography. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. - * @return Returns whether only line style is enabled for text layout, true means it is enabled, false means it is not. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. + * @return Returns whether only line style is enabled for text layout, true means it is enabled, + * false means it is not. * @since 12 * @version 1.0 */ @@ -2593,7 +2633,8 @@ bool OH_Drawing_TypographyTextlineGetStyleOnly(OH_Drawing_TypographyStyle*); * @brief Get the text alignment mode. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the text alignment mode. For details, see the enum OH_Drawing_TextAlign. * @since 12 * @version 1.0 @@ -2604,7 +2645,8 @@ OH_Drawing_TextAlign OH_Drawing_TypographyGetTextAlign(OH_Drawing_TypographyStyl * @brief Get the text direction. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the text direction. For details, see the enum OH_Drawing_TextDirection. * @since 12 * @version 1.0 @@ -2615,7 +2657,8 @@ OH_Drawing_TextDirection OH_Drawing_TypographyGetTextDirection(OH_Drawing_Typogr * @brief Sets the maximum number of lines in a text. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the maximum number of lines in a text. * @since 12 * @version 1.0 @@ -2626,7 +2669,8 @@ size_t OH_Drawing_TypographyGetTextMaxLines(OH_Drawing_TypographyStyle*); * @brief Get the ellipsis of lines in a text. * * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing - * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object OH_Drawing_TypographyStyle. + * @param OH_Drawing_TypographyStyle Indicates the pointer to a typography style object + * OH_Drawing_TypographyStyle. * @return Return the ellipsis of lines in a text. * @since 12 * @version 1.0