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=7d51b1604d609e70c0b065b3a9f4babf29b8a8f6;hp=ab21d62c616e3cf6be3cf9a8370f18876e9eaaa3;hb=2512aa2794f3c5ea5841542b9ed9c8c32973540b;hpb=96b966cf11945978a068524e45e86f9be8b19d3c diff --git a/dali-toolkit/internal/text/text-model-interface.h b/dali-toolkit/internal/text/text-model-interface.h old mode 100755 new mode 100644 index ab21d62..7d51b16 --- 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) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 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. @@ -22,21 +22,19 @@ #include // INTERNAL INCLUDES -#include +#include #include #include +#include #include -#include +#include namespace Dali { - namespace Toolkit { - namespace Text { - /** * @brief Interface class used to retrieve the text's model from the text-controller. */ @@ -47,7 +45,8 @@ public: * @brief Virtual destructor. */ virtual ~ModelInterface() - {} + { + } /** * @brief Retrives the control's size. @@ -92,6 +91,13 @@ public: virtual DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const = 0; /** + * @brief Retrieves ellipsis position for text. + * + * @return The ellipsis position. + */ + virtual DevelText::EllipsisPosition::Type GetEllipsisPosition() const = 0; + + /** * @brief Whether the text elide property is enabled. * * @return @e true if the text elide property is enabled, @e false otherwise. @@ -134,6 +140,34 @@ public: virtual Length GetNumberOfGlyphs() const = 0; /** + * @brief Retrieves the start index of laid-out glyphs. + * + * @return The start index of laid-out glyphs. + */ + virtual GlyphIndex GetStartIndexOfElidedGlyphs() const = 0; + + /** + * @brief Retrieves the end index of laid-out glyphs. + * + * @return The end index of laid-out glyphs. + */ + virtual GlyphIndex GetEndIndexOfElidedGlyphs() const = 0; + + /** + * @brief Retrieves the first middle index of elided glyphs, index before ellipsis of middle. + * + * @return The first middle index of elided glyphs, index before ellipsis of middle. + */ + virtual GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const = 0; + + /** + * @brief Retrieves the second middle index of elided glyphs, index of ellipsis of middle. + * + * @return The second middle index of elided glyphs, index of ellipsis of middle. + */ + virtual GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const = 0; + + /** * @brief Retrieves the laid-out glyphs. * * @return A pointer to the vector with the laid-out glyphs. @@ -162,6 +196,27 @@ public: virtual const ColorIndex* const 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; + + /** + * @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; + + /** + * @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; + + /** * @brief Retrieves the text's default color. * * @return The default color. @@ -211,6 +266,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. @@ -224,7 +300,7 @@ 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(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const = 0; /** * @brief Retrieve the outline color. @@ -238,8 +314,109 @@ public: * * @return The width of the outline. */ - virtual float GetOutlineWidth() const = 0; + virtual uint16_t GetOutlineWidth() const = 0; + /** + * @brief Retrieves the background color. + * + * @return The background color. + */ + virtual const Vector4& GetBackgroundColor() const = 0; + + /** + * @brief Returns whether background is enabled or not. + * + * @return The background state. + */ + virtual bool IsBackgroundEnabled() const = 0; + + /** + * @brief Returns whether markup-processor is enabled or not. + * + * @return The markup-processor state. + */ + virtual bool IsMarkupProcessorEnabled() const = 0; + + /** + * @brief Returns the hyphens glyph info. + * + * @return hyphens glyph info. + */ + virtual const GlyphInfo* GetHyphens() const = 0; + + /** + * @brief Returns the indices of the hyphen in the text. + * + * @return the hyphen indices. + */ + virtual const Length* GetHyphenIndices() const = 0; + + /** + * @brief Returns number of hyphens to add in text. + * + * @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 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 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 const 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; }; } // namespace Text