[dali_2.3.24] Merge branch 'devel/master'

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / visual-model-impl.h

diff --git a/dali-toolkit/internal/text/visual-model-impl.h b/dali-toolkit/internal/text/visual-model-impl.h
index 4bae17c..7ef55b5 100644 (file)
--- a/dali-toolkit/internal/text/visual-model-impl.h
+++ b/dali-toolkit/internal/text/visual-model-impl.h
@@ -26,6 +26,7 @@
 #include <dali/public-api/object/ref-object.h>
 
 // INTERNAL INCLUDES
 #include <dali/public-api/object/ref-object.h>
 
 // INTERNAL INCLUDES

+#include <dali-toolkit/internal/text/character-spacing-glyph-run.h>

 #include <dali-toolkit/internal/text/color-run.h>
 #include <dali-toolkit/internal/text/line-run.h>
 #include <dali-toolkit/internal/text/strikethrough-glyph-run.h>
 #include <dali-toolkit/internal/text/color-run.h>
 #include <dali-toolkit/internal/text/line-run.h>
 #include <dali-toolkit/internal/text/strikethrough-glyph-run.h>


@@ -143,6 +144,15 @@ public:
                         Length&    numberOfLines) const;
 
   /**
                         Length&    numberOfLines) const;
 
   /**

+   * @brief Retrieves the line index where the glyph is laid-out.
+   *
+   * @param[in] glyphIndex The glyph's index.
+   *
+   * @return The line index.
+   */
+  LineIndex GetLineOfGlyph(GlyphIndex glyphIndex);
+
+  /**

    * @brief Retrieves the lines where the given range of glyphs is laid out.
    *
    * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.
    * @brief Retrieves the lines where the given range of glyphs is laid out.
    *
    * The size of the @p lines buffer needs to be big enough to copy the @p numberOfLines.


@@ -208,6 +218,20 @@ public:
   const Vector2& GetLayoutSize() const;
 
   /**
   const Vector2& GetLayoutSize() const;
 
   /**

+   * @brief Sets the size of height for width.
+   *
+   * @param[in] size The text's height for width size.
+   */
+  void SetHeightForWidth(const Vector2& size);
+
+  /**
+   * @brief Retrieves the height for width size.
+   *
+   * @return The text's height for width size.
+   */
+  const Vector2& GetHeightForWidth() const;
+
+  /**

    * @brief Set the text's color
    *
    * @param[in] textColor The text's color
    * @brief Set the text's color
    *
    * @param[in] textColor The text's color


@@ -360,6 +384,13 @@ public:
   Length GetNumberOfUnderlineRuns() const;
 
   /**
   Length GetNumberOfUnderlineRuns() const;
 
   /**

+   * @brief Sets the text's outline offset.
+   *
+   * @param[in] outlineOffset The outline offset.
+   */
+  void SetOutlineOffset(const Vector2& outlineOffset);
+
+  /**

    * @brief Set the outline color.
    *
    * @param[in] color color of outline.
    * @brief Set the outline color.
    *
    * @param[in] color color of outline.


@@ -367,6 +398,13 @@ public:
   void SetOutlineColor(const Vector4& color);
 
   /**
   void SetOutlineColor(const Vector4& color);
 
   /**

+   * @brief Retrieves the text's outline offset.
+   *
+   * @return The text's outline offset.
+   */
+  const Vector2& GetOutlineOffset() const;
+
+  /**

    * @brief Retrieve the outline color.
    *
    * @return The outline color.
    * @brief Retrieve the outline color.
    *
    * @return The outline color.


@@ -388,6 +426,20 @@ public:
   uint16_t GetOutlineWidth() const;
 
   /**
   uint16_t GetOutlineWidth() const;
 
   /**

+   * @brief Set the outline blur radius.
+   *
+   * @param[in] outlineBlurRadius The outline blur radius, 0,0 indicates no blur.
+   */
+  void SetOutlineBlurRadius(const float& outlineBlurRadius);
+
+  /**
+   * @brief Retrieve the outline blur radius.
+   *
+   * @return The outline blur radius.
+   */
+  const float& GetOutlineBlurRadius() const;
+
+  /**

    * @brief Sets the text's background color.
    *
    * @param[in] color The text's background color.
    * @brief Sets the text's background color.
    *
    * @param[in] color The text's background color.


@@ -596,6 +648,62 @@ public:
    */
   Length GetNumberOfStrikethroughRuns() const;
 
    */
   Length GetNumberOfStrikethroughRuns() const;
 

+  /**
+   * @brief Retrieves the number of character-spacing glyph runs.
+   *
+   * @return The number of character-spacing glyph runs.
+   */
+  Length GetNumberOfCharacterSpacingGlyphRuns() const;
+
+  /**
+   * @brief Retrieves the reference for character-spacing glyph runs.
+   *
+   * @return The reference for character-spacing glyph runs.
+   */
+  const Vector<CharacterSpacingGlyphRun>& GetCharacterSpacingGlyphRuns() const;
+
+  /**
+   * @brief Sets the cutout flag.
+   *
+   * @param[in] enable true if cutouted.
+   */
+  void SetCutoutEnabled(bool enable);
+
+  /**
+   * @brief Returns whether the text is cutouted or not.
+   *
+   * @return cutout state.
+   */
+  bool IsCutoutEnabled() const;
+
+  /**
+   * @brief Sets the background with cutout flag.
+   *
+   * @param[in] enable true if background enabled.
+   */
+  void SetBackgroundWithCutoutEnabled(bool enable);
+
+  /**
+   * @brief Returns whether the text is cutouted or not.
+   *
+   * @return True if enabled.
+   */
+  bool IsBackgroundWithCutoutEnabled() const;
+
+  /**
+   * @brief Sets the Color of background with cutout.
+   *
+   * @param[in] color The color to set.
+   */
+  void SetBackgroundColorWithCutout(const Vector4& color);
+
+  /**
+   * @brief Retrieves the Color of background with cutout.
+   *
+   * @return The color.
+   */
+  const Vector4& GetBackgroundColorWithCutout() const;
+

 protected:
   /**
    * @brief A reference counted object may only be deleted by calling Unreference().
 protected:
   /**
    * @brief A reference counted object may only be deleted by calling Unreference().


@@ -615,38 +723,43 @@ private:
   VisualModel& operator=(const VisualModel& handle);
 
 public:
   VisualModel& operator=(const VisualModel& handle);
 
 public:

-  Vector<GlyphInfo>             mGlyphs;                 ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
-  Vector<CharacterIndex>        mGlyphsToCharacters;     ///< For each glyph, the index of the first character.
-  Vector<GlyphIndex>            mCharactersToGlyph;      ///< For each character, the index of the first glyph.
-  Vector<Length>                mCharactersPerGlyph;     ///< For each glyph, the number of characters that form the glyph.
-  Vector<Length>                mGlyphsPerCharacter;     ///< For each character, the number of glyphs that are shaped.
-  Vector<Vector2>               mGlyphPositions;         ///< For each glyph, the position.
-  Vector<LineRun>               mLines;                  ///< The laid out lines.
-  Vector<UnderlinedGlyphRun>    mUnderlineRuns;          ///< Runs of glyphs that are underlined.
-  Vector<Vector4>               mColors;                 ///< Colors of the glyphs.
-  Vector<ColorIndex>            mColorIndices;           ///< Indices to the vector of colors for each glyphs.
-  Vector<Vector4>               mBackgroundColors;       ///< Background colors of the glyphs.
-  Vector<ColorIndex>            mBackgroundColorIndices; ///< Indices to the vector of background colors for each glyphs.
-  Vector4                       mTextColor;              ///< The text color
-  Vector4                       mShadowColor;            ///< Color of drop shadow
-  Vector4                       mUnderlineColor;         ///< Color of underline
-  Vector4                       mOutlineColor;           ///< Color of outline
-  Vector4                       mBackgroundColor;        ///< Color of text background
-  Vector4                       mStrikethroughColor;     ///< Color of text background
-  Size                          mControlSize;            ///< The size of the UI control.
-  Vector2                       mShadowOffset;           ///< Offset for drop shadow, 0 indicates no shadow
-  float                         mUnderlineHeight;        ///< Fixed height for underline to override font metrics.
-  float                         mStrikethroughHeight;    ///< Fixed height for strikethrough to override font metrics.
-  Text::Underline::Type         mUnderlineType;          ///< The type of the underline.
-  float                         mDashedUnderlineWidth;   ///< The width of the dashes of the dashed underline.
-  float                         mDashedUnderlineGap;     ///< The gap between the dashes of the dashed underline.
-  float                         mShadowBlurRadius;       ///< Blur radius of shadow, 0 indicates no blur.
-  uint16_t                      mOutlineWidth;           ///< Width of outline.
-  Vector<StrikethroughGlyphRun> mStrikethroughRuns;      ///< Runs of glyphs that have strikethrough.
+  Vector<GlyphInfo>                mGlyphs;                     ///< For each glyph, the font's id, glyph's index within the font and glyph's metrics.
+  Vector<CharacterIndex>           mGlyphsToCharacters;         ///< For each glyph, the index of the first character.
+  Vector<GlyphIndex>               mCharactersToGlyph;          ///< For each character, the index of the first glyph.
+  Vector<Length>                   mCharactersPerGlyph;         ///< For each glyph, the number of characters that form the glyph.
+  Vector<Length>                   mGlyphsPerCharacter;         ///< For each character, the number of glyphs that are shaped.
+  Vector<Vector2>                  mGlyphPositions;             ///< For each glyph, the position.
+  Vector<LineRun>                  mLines;                      ///< The laid out lines.
+  Vector<UnderlinedGlyphRun>       mUnderlineRuns;              ///< Runs of glyphs that are underlined.
+  Vector<Vector4>                  mColors;                     ///< Colors of the glyphs.
+  Vector<ColorIndex>               mColorIndices;               ///< Indices to the vector of colors for each glyphs.
+  Vector<Vector4>                  mBackgroundColors;           ///< Background colors of the glyphs.
+  Vector<ColorIndex>               mBackgroundColorIndices;     ///< Indices to the vector of background colors for each glyphs.
+  Vector4                          mTextColor;                  ///< The text color
+  Vector4                          mShadowColor;                ///< Color of drop shadow
+  Vector4                          mUnderlineColor;             ///< Color of underline
+  Vector4                          mOutlineColor;               ///< Color of outline
+  Vector4                          mBackgroundColor;            ///< Color of text background
+  Vector4                          mStrikethroughColor;         ///< Color of text background
+  Size                             mControlSize;                ///< The size of the UI control.
+  Vector2                          mShadowOffset;               ///< Offset for drop shadow, 0 indicates no shadow
+  Vector2                          mOutlineOffset;              ///< Offset for outline
+  float                            mUnderlineHeight;            ///< Fixed height for underline to override font metrics.
+  float                            mStrikethroughHeight;        ///< Fixed height for strikethrough to override font metrics.
+  Text::Underline::Type            mUnderlineType;              ///< The type of the underline.
+  float                            mDashedUnderlineWidth;       ///< The width of the dashes of the dashed underline.
+  float                            mDashedUnderlineGap;         ///< The gap between the dashes of the dashed underline.
+  float                            mShadowBlurRadius;           ///< Blur radius of shadow, 0 indicates no blur.
+  float                            mOutlineBlurRadius;      ///< Blur radius of outline, 0 indicates no blur.
+  uint16_t                         mOutlineWidth;               ///< Width of outline.
+  Vector<StrikethroughGlyphRun>    mStrikethroughRuns;          ///< Runs of glyphs that have strikethrough.
+  Vector<CharacterSpacingGlyphRun> mCharacterSpacingRuns;       ///< Runs of glyphs that have character-spacing.
+  Vector4                          mBackgroundColorWithCutout;  ///< Background color with cutout.

 
 private:
 
 private:

-  Size mNaturalSize; ///< Size of the text with no line wrapping.
-  Size mLayoutSize;  ///< Size of the laid-out text considering the layout properties set.
+  Size mNaturalSize;    ///< Size of the text with no line wrapping.
+  Size mLayoutSize;     ///< Size of the laid-out text considering the layout properties set.
+  Size mHeightForWidth; ///< Size of the text last calculated using GetHeightForWidth.

 
   // Caches to increase performance in some consecutive operations.
   LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.
 
   // Caches to increase performance in some consecutive operations.
   LineIndex mCachedLineIndex; ///< Used to increase performance in consecutive calls to GetLineOfGlyph() or GetLineOfCharacter() with consecutive glyphs or characters.


@@ -659,13 +772,15 @@ private:
   bool                              mTextElideEnabled : 1;            ///< Whether the text's elide is enabled.
 
 public:
   bool                              mTextElideEnabled : 1;            ///< Whether the text's elide is enabled.
 
 public:

-  bool       mUnderlineEnabled : 1;       ///< Underline enabled flag
-  bool       mUnderlineColorSet : 1;      ///< Has the underline color been explicitly set?
-  bool       mBackgroundEnabled : 1;      ///< Background enabled flag
-  bool       mMarkupProcessorEnabled : 1; ///< Markup-processor enabled flag
-  HyphenInfo mHyphen;                     ///< Contains hyphen glyph info & the character index to draw hyphen after.
-  bool       mStrikethroughEnabled : 1;   ///< Strikethrough enabled flag
-  float      mCharacterSpacing;           ///< Contains the value of the character spacing.
+  bool       mUnderlineEnabled : 1;             ///< Underline enabled flag
+  bool       mUnderlineColorSet : 1;            ///< Has the underline color been explicitly set?
+  bool       mBackgroundEnabled : 1;            ///< Background enabled flag
+  bool       mMarkupProcessorEnabled : 1;       ///< Markup-processor enabled flag
+  HyphenInfo mHyphen;                           ///< Contains hyphen glyph info & the character index to draw hyphen after.
+  bool       mStrikethroughEnabled : 1;         ///< Strikethrough enabled flag
+  float      mCharacterSpacing;                 ///< Contains the value of the character spacing.
+  bool       mCutoutEnabled : 1;                ///< Cutout enabled flag
+  bool       mBackgroundWithCutoutEnabled : 1;  ///< Background with cutout enabled flag.

 };
 
 } // namespace Text
 };
 
 } // namespace Text