Text - Add the color to the vertex info.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-view-interface.h
index d8e2ae6..409f9d7 100644 (file)
@@ -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,7 +33,7 @@ namespace Toolkit
 namespace Text
 {
 
-struct LineRun;
+struct GlyphRun;
 
 /**
  * @brief Abstract interface to provide the information necessary displaying text.
@@ -60,6 +58,13 @@ public:
   virtual ~ViewInterface();
 
   /**
+   * @brief Retrieves the target size of the UI control.
+   *
+   * @return The text's size.
+   */
+  virtual const Vector2& GetControlSize() const = 0;
+
+  /**
    * Retrieves the number of glyphs.
    *
    * @return The number of glyphs.
@@ -73,7 +78,8 @@ public:
    * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
    *
    * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
-   * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
+   * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied.
+   * @param[out] colors Pointer to a buffer where the glyph's colors are copied.
    * @param[in] glyphIndex Index to the first glyph.
    * @param[in] numberOfGlyphs Number of glyphs to be copied.
    *
@@ -81,6 +87,7 @@ public:
    */
   virtual Length GetGlyphs( GlyphInfo* glyphs,
                             Vector2* glyphPositions,
+                            Vector4* glyphColors,
                             GlyphIndex glyphIndex,
                             Length numberOfGlyphs ) const = 0;
 
@@ -126,6 +133,23 @@ 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;
 };
 
 } // namespace Text