Fix text outline property related native TCT

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-view-interface.h

diff --git a/dali-toolkit/internal/text/text-view-interface.h b/dali-toolkit/internal/text/text-view-interface.h
index 116ad50..efa88ad 100644 (file)
--- a/dali-toolkit/internal/text/text-view-interface.h
+++ b/dali-toolkit/internal/text/text-view-interface.h
@@ -18,9 +18,6 @@
  *
  */
 
-// EXTERNAL INCLUDES
-#include <dali/public-api/math/vector4.h>
-
 // INTERNAL INCLUDES
 #include <dali-toolkit/internal/text/text-definitions.h>
 
@@ -28,6 +25,7 @@ namespace Dali
 {
 
 struct Vector2;
+struct Vector4;
 
 namespace Toolkit
 {
@@ -35,8 +33,10 @@ 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
@@ -58,6 +58,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 +80,38 @@ 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 void GetGlyphs( GlyphInfo* glyphs,
-                          GlyphIndex glyphIndex,
-                          Length numberOfGlyphs ) const = 0;
+  virtual const Vector4* const GetColors() const = 0;
 
   /**
-   * @brief Retrieves the glyph positions.
+   * @brief Retrieves the vector of indices to the vector of 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 colors.
    */
-  virtual void GetGlyphPositions( Vector2* glyphPositions,
-                                  GlyphIndex glyphIndex,
-                                  Length numberOfGlyphs ) const = 0;
+  virtual const ColorIndex* const GetColorIndices() const = 0;
 
   /**
    * @brief Retrieves the text color
@@ -117,12 +142,36 @@ public:
   virtual const Vector4& GetUnderlineColor() const = 0;
 
   /**
-   * @brief Returns whether is underline is enabled or not.
+   * @brief Returns whether underline is enabled or not.
    *
    * @return The underline state.
    */
   virtual bool IsUnderlineEnabled() const = 0;
 
+  /**
+   * @brief Retrieves the underline height override
+   *
+   * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
+   */
+  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;
 };
 
 } // namespace Text