X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-view-interface.h;h=9caf0682f9ef3e40f56b03419e72146844f5af88;hp=24994bf0fbfc7e9a0dc2e8f6272bb287fc5743ca;hb=29bbe2381a1cfdd96757dfd441e7f9747560b2c8;hpb=22fd3cd73ef12d4ef88f12eed11a2d6665a34c5a diff --git a/dali-toolkit/internal/text/text-view-interface.h b/dali-toolkit/internal/text/text-view-interface.h index 24994bf..9caf068 100644 --- a/dali-toolkit/internal/text/text-view-interface.h +++ b/dali-toolkit/internal/text/text-view-interface.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H /* - * Copyright (c) 2021 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. @@ -18,9 +18,15 @@ * */ +// EXTERNAL INCLUDES +#include + // INTERNAL INCLUDES #include +#include #include +#include +#include namespace Dali { @@ -32,6 +38,7 @@ namespace Toolkit namespace Text { struct GlyphRun; +struct StrikethroughGlyphRun; /** * @brief Abstract interface to provide the information necessary to display text. @@ -194,6 +201,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. @@ -207,9 +235,9 @@ 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 Retrieve the outline color. @@ -266,6 +294,82 @@ public: * @return The second middle index of elided glyphs, index of ellipsis of middle. */ virtual GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() 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 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 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 The spaces between characters in Pixels. + * + * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed). + * + * @return characterSpacing. + */ + virtual const float GetCharacterSpacing() const = 0; + + /** + * @brief The text buffer. + * + * @return The text buffer. + */ + virtual const Character* GetTextBuffer() const = 0; + + /** + * @brief The text Glyph to Characters Array. + * + * @return GetGlyphsToCharacters. + */ + virtual const Vector& GetGlyphsToCharacters() const = 0; }; } // namespace Text