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=1a0413564d39428bc77cf8e0f3ccd823f818cc6e;hp=68d5e97e78ba7e339261bdfa8916ee52e121d2ff;hb=7018f61b640b6fcf9cb576b537bafcb6bb8240e8;hpb=52117490d94d8242addbe1608efe64364fdb308a diff --git a/dali-toolkit/internal/text/text-view-interface.h b/dali-toolkit/internal/text/text-view-interface.h index 68d5e97..1a04135 100644 --- a/dali-toolkit/internal/text/text-view-interface.h +++ b/dali-toolkit/internal/text/text-view-interface.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H__ -#define __DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H__ +#ifndef DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H +#define DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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,25 +18,22 @@ * */ -// EXTERNAL INCLUDES -#include - // INTERNAL INCLUDES #include namespace Dali { - struct Vector2; +struct Vector4; namespace Toolkit { - namespace Text { +struct GlyphRun; /** - * @brief Abstract interface to provide the information necessary displaying text. + * @brief Abstract interface to provide the information necessary to display text. * * This includes: * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction @@ -46,7 +43,6 @@ namespace Text class ViewInterface { public: - /** * @brief Constructor. */ @@ -58,6 +54,21 @@ public: virtual ~ViewInterface(); /** + * @brief Retrieves the target size of the UI control. + * + * @return The control's size. + */ + virtual const Vector2& GetControlSize() const = 0; + + /** + * @brief Retrieves the text's layout size. + * + * @return The text's size. Note that this may be larger than the control size, + * in the case where text is scrolling/clipped. + */ + virtual const Vector2& GetLayoutSize() const = 0; + + /** * Retrieves the number of glyphs. * * @return The number of glyphs. @@ -65,28 +76,52 @@ public: virtual Length GetNumberOfGlyphs() const = 0; /** - * @brief Retrieves glyphs in the given buffer. + * @brief Retrieves glyphs and positions in the given buffers. + * + * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions. + * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis. * - * The size of the @p glyphs buffer needs to be big enough to copy the @p numberOfGlyphs. * @param[out] glyphs Pointer to a buffer where the glyphs are copied. + * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied. + * @param[out] minLineOffset The minimum line offset. * @param[in] glyphIndex Index to the first glyph. * @param[in] numberOfGlyphs Number of glyphs to be copied. + * + * @return The number of glyphs. + */ + virtual Length GetGlyphs(GlyphInfo* glyphs, + Vector2* glyphPositions, + float& minLineOffset, + GlyphIndex glyphIndex, + Length numberOfGlyphs) const = 0; + + /** + * @brief Retrieves the vector of colors. + * + * @return Pointer to the vector of colors. + */ + virtual const Vector4* const 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; + + /** + * @brief Retrieves the vector of background colors. + * + * @return Pointer to the vector of background colors. */ - virtual void GetGlyphs( GlyphInfo* glyphs, - GlyphIndex glyphIndex, - Length numberOfGlyphs ) const = 0; + virtual const Vector4* const GetBackgroundColors() const = 0; /** - * @brief Retrieves the glyph positions. + * @brief Retrieves the vector of indices to the vector of background colors. * - * @pre The size of the @p positions buffer needs to be big enough to copy the @p numberOfGlyphs positions. - * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied. - * @param[in] glyphIndex Index to the first glyph position. - * @param[in] numberOfGlyphs The number of positions to be copied. + * @return Pointer to a vector which stores for each glyph the index to the vector of background colors. */ - virtual void GetGlyphPositions( Vector2* glyphPositions, - GlyphIndex glyphIndex, - Length numberOfGlyphs ) const = 0; + virtual const ColorIndex* const GetBackgroundColorIndices() const = 0; /** * @brief Retrieves the text color @@ -130,6 +165,37 @@ public: */ virtual float GetUnderlineHeight() const = 0; + /** + * @brief Retrieves the number of underline runs. + * + * @return The number of underline runs. + */ + virtual Length GetNumberOfUnderlineRuns() const = 0; + + /** + * @brief Retrieves the underline runs. + * + * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied. + * @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; + + /** + * @brief Retrieve the outline color. + * + * @return The outline color. + */ + virtual const Vector4& GetOutlineColor() const = 0; + + /** + * @brief Retrieves the width of an outline + * + * @return The width of the outline. + */ + virtual uint16_t GetOutlineWidth() const = 0; }; } // namespace Text @@ -138,4 +204,4 @@ public: } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H__ +#endif // DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H