X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-model-interface.h;h=aafd4306ddcc6777504aeb41fe2625945763142a;hp=d9520f1c9bc7e3fff238be07bb639cb2949a9b5d;hb=HEAD;hpb=22fd3cd73ef12d4ef88f12eed11a2d6665a34c5a diff --git a/dali-toolkit/internal/text/text-model-interface.h b/dali-toolkit/internal/text/text-model-interface.h index d9520f1..8327534 100644 --- a/dali-toolkit/internal/text/text-model-interface.h +++ b/dali-toolkit/internal/text/text-model-interface.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H /* - * Copyright (c) 2021 Samsung Electronics Co., Ltd. + * Copyright (c) 2023 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,9 +23,15 @@ // INTERNAL INCLUDES #include +#include +#include +#include +#include #include #include +#include #include +#include #include namespace Dali @@ -115,7 +121,7 @@ public: * * @return A pointer to the vector with the laid-out lines. */ - virtual const LineRun* const GetLines() const = 0; + virtual const LineRun* GetLines() const = 0; /** * @brief Retrieves the number of script runs. @@ -129,7 +135,14 @@ public: * * @return A pointer to the vector with the runs of characters with the same script.. */ - virtual const ScriptRun* const GetScriptRuns() const = 0; + virtual const ScriptRun* GetScriptRuns() const = 0; + + /** + * @brief Retrieves number of characters. + * + * @return The number of characters. + */ + virtual Length GetNumberOfCharacters() const = 0; /** * @brief Retrieves the number of laid-out glyphs. @@ -171,49 +184,49 @@ public: * * @return A pointer to the vector with the laid-out glyphs. */ - virtual const GlyphInfo* const GetGlyphs() const = 0; + virtual const GlyphInfo* GetGlyphs() const = 0; /** * @brief Retrieves the text layout. * * @return A pointer to the vector with the positions for each glyph. */ - virtual const Vector2* const GetLayout() const = 0; + virtual const Vector2* GetLayout() const = 0; /** * @brief Retrieves the vector of colors. * * @return Pointer to the vector of colors. */ - virtual const Vector4* const GetColors() const = 0; + virtual const Vector4* GetColors() const = 0; /** * @brief Retrieves the vector of indices to the vector of colors. * * @return Pointer to a vector which stores for each glyph the index to the vector of colors. */ - virtual const ColorIndex* const GetColorIndices() const = 0; + virtual const ColorIndex* GetColorIndices() const = 0; /** * @brief Retrieves the vector of background colors. * * @return Pointer to the vector of background colors. */ - virtual const Vector4* const GetBackgroundColors() const = 0; + virtual const Vector4* GetBackgroundColors() const = 0; /** * @brief Retrieves the vector of indices to the vector of background colors. * * @return Pointer to a vector which stores for each glyph the index to the vector of background colors. */ - virtual const ColorIndex* const GetBackgroundColorIndices() const = 0; + virtual const ColorIndex* GetBackgroundColorIndices() const = 0; /** * @brief checks if there is background colors set using markup. * * @return boolean if there is background colors set using markup . */ - virtual bool const IsMarkupBackgroundColorSet() const = 0; + virtual bool IsMarkupBackgroundColorSet() const = 0; /** * @brief Retrieves the text's default color. @@ -258,6 +271,13 @@ public: virtual bool IsUnderlineEnabled() const = 0; /** + * @brief checks if there is underline set using markup. + * + * @return boolean if there is underline set using markup. + */ + virtual bool IsMarkupUnderlineSet() const = 0; + + /** * @brief Retrieves the underline height override * * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height @@ -265,6 +285,27 @@ public: virtual float GetUnderlineHeight() const = 0; /** + * @brief Retrieves the underline type override. + * + * @return Returns the override type for an underline. + */ + virtual Text::Underline::Type GetUnderlineType() const = 0; + + /** + * @brief Retrieves the dashed underline width override + * + * @return Returns the override width for the dashed underline. + */ + virtual float GetDashedUnderlineWidth() const = 0; + + /** + * @brief Retrieves the dashed underline gap override + * + * @return Returns the override gap for the dashed underline. + */ + virtual float GetDashedUnderlineGap() const = 0; + + /** * @brief Retrieves the number of underline runs. * * @return The number of underline runs. @@ -278,7 +319,14 @@ public: * @param[in] index Index of the first underline run to be copied. * @param[in] numberOfRuns Number of underline runs to be copied. */ - virtual void GetUnderlineRuns(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const = 0; + virtual void GetUnderlineRuns(UnderlinedGlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const = 0; + + /** + * @brief Retrieves the outline offset. + * + * @return The outline offset. + */ + virtual const Vector2& GetOutlineOffset() const = 0; /** * @brief Retrieve the outline color. @@ -316,6 +364,15 @@ public: virtual bool IsMarkupProcessorEnabled() const = 0; /** + * @brief Retrieves whether the spanned-text is placed. + * + * By default is disabled. + * + * @return @e true if the spanned-text is placed, otherwise returns @e false. + */ + virtual bool IsSpannedTextPlaced() const = 0; + + /** * @brief Returns the hyphens glyph info. * * @return hyphens glyph info. @@ -335,6 +392,115 @@ public: * @return number of hyphens. */ virtual Length GetHyphensCount() const = 0; + + /** + * @brief Retrieves the strikethrough color. + * + * @return The strikethrough color. + */ + virtual const Vector4& GetStrikethroughColor() const = 0; + + /** + * @brief Returns whether strikethrough is enabled or not. + * + * @return The strikethrough state. + */ + virtual bool IsStrikethroughEnabled() const = 0; + + /** + * @brief checks if there is strikethrough set using markup. + * + * @return boolean if there is strikethrough set using markup. + */ + virtual bool IsMarkupStrikethroughSet() const = 0; + + /** + * @brief Retrieves the strikethrough height override + * + * @return Returns the override height for a strikethrough, 0 indicates that adaptor will determine the height + */ + virtual float GetStrikethroughHeight() const = 0; + + /** + * @brief Retrieves the number of strikethrough runs. + * + * @return The number of strikethrough runs. + */ + virtual Length GetNumberOfStrikethroughRuns() const = 0; + + /** + * @brief Retrieves the number of bounded paragraph runs. + * + * @return The number of bounded paragraph runs. + */ + virtual Length GetNumberOfBoundedParagraphRuns() const = 0; + + /** + * @brief Retrieves the reference for bounded paragraph runs. + * + * @return The reference for bounded paragraph runs. + */ + virtual const Vector& GetBoundedParagraphRuns() const = 0; + + /** + * @brief Retrieves the number of character-spacing glyph runs. + * + * @return The number of character-spacing glyph runs. + */ + virtual Length GetNumberOfCharacterSpacingGlyphRuns() const = 0; + + /** + * @brief Retrieves the reference for character-spacing glyph runs. + * + * @return The reference for character-spacing glyph runs. + */ + virtual const Vector& GetCharacterSpacingGlyphRuns() const = 0; + + /** + * @brief Retrieves the strikethrough runs. + * + * @param[out] strikethroughRuns Pointer to a buffer where the strikethrough runs are copied. + * @param[in] index Index of the first strikethrough run to be copied. + * @param[in] numberOfRuns Number of strikethrough runs to be copied. + */ + virtual void GetStrikethroughRuns(StrikethroughGlyphRun* strikethroughRuns, StrikethroughRunIndex index, Length numberOfRuns) const = 0; + + /** + * @brief Retrieves the character spacing. + * + * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed). + * + * @return The character spacing. + */ + virtual float GetCharacterSpacing() const = 0; + + /** + * @brief Retrieves the text buffer. + * + * @return The text buffer. + */ + virtual const Character* GetTextBuffer() const = 0; + + /** + * @brief Retrieves the Glyphs to Characters Array. + * + * @return The GlyphsToCharacters. + */ + virtual const Vector& GetGlyphsToCharacters() const = 0; + + /** + * @brief Retrieves the reference for font runs. + * + * @return The reference for font runs. + */ + virtual const Vector& GetFontRuns() const = 0; + + /** + * @brief Retrieves the reference for font description runs. + * + * @return The reference for font description runs. + */ + virtual const Vector& GetFontDescriptionRuns() const = 0; }; } // namespace Text