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

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

diff --git a/dali-toolkit/internal/text/text-model.h b/dali-toolkit/internal/text/text-model.h
index 443f9ab..e738784 100644 (file)
--- a/dali-toolkit/internal/text/text-model.h
+++ b/dali-toolkit/internal/text/text-model.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_MODEL_H
 
 /*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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.
@@ -22,6 +22,8 @@
 #include <dali/public-api/object/ref-object.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/internal/text/bounded-paragraph-run.h>
+#include <dali-toolkit/internal/text/character-spacing-glyph-run.h>
 #include <dali-toolkit/internal/text/logical-model-impl.h>
 #include <dali-toolkit/internal/text/text-model-interface.h>
 #include <dali-toolkit/internal/text/visual-model-impl.h>
@@ -100,7 +102,7 @@ public:
   /**
    * @copydoc ModelInterface::GetLines()
    */
-  const LineRun* const GetLines() const override;
+  const LineRun* GetLines() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfScripts()
@@ -110,7 +112,12 @@ public:
   /**
    * @copydoc ModelInterface::GetScriptRuns()
    */
-  const ScriptRun* const GetScriptRuns() const override;
+  const ScriptRun* GetScriptRuns() const override;
+
+  /**
+   * @copydoc ModelInterface::GetNumberOfCharacters()
+   */
+  Length GetNumberOfCharacters() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfGlyphs()
@@ -140,37 +147,37 @@ public:
   /**
    * @copydoc ModelInterface::GetGlyphs()
    */
-  const GlyphInfo* const GetGlyphs() const override;
+  const GlyphInfo* GetGlyphs() const override;
 
   /**
    * @copydoc ModelInterface::GetLayout()
    */
-  const Vector2* const GetLayout() const override;
+  const Vector2* GetLayout() const override;
 
   /**
    * @copydoc ModelInterface::GetColors()
    */
-  const Vector4* const GetColors() const override;
+  const Vector4* GetColors() const override;
 
   /**
    * @copydoc ModelInterface::GetColorIndices()
    */
-  const ColorIndex* const GetColorIndices() const override;
+  const ColorIndex* GetColorIndices() const override;
 
   /**
    * @copydoc ModelInterface::GetBackgroundColors()
    */
-  const Vector4* const GetBackgroundColors() const override;
+  const Vector4* GetBackgroundColors() const override;
 
   /**
    * @copydoc ModelInterface::GetBackgroundColorIndices()
    */
-  const ColorIndex* const GetBackgroundColorIndices() const override;
+  const ColorIndex* GetBackgroundColorIndices() const override;
 
   /**
    * @copydoc ModelInterface::IsMarkupBackgroundColorSet()
    */
-  bool const IsMarkupBackgroundColorSet() const override;
+  bool IsMarkupBackgroundColorSet() const override;
 
   /**
    * @copydoc ModelInterface::GetDefaultColor()
@@ -203,6 +210,11 @@ public:
   bool IsUnderlineEnabled() const override;
 
   /**
+   * @copydoc ModelInterface::IsMarkupUnderlineSet()
+   */
+  bool IsMarkupUnderlineSet() const override;
+
+  /**
    * @copydoc ModelInterface::GetUnderlineHeight()
    */
   float GetUnderlineHeight() const override;
@@ -230,7 +242,7 @@ public:
   /**
    * @copydoc ModelInterface::GetUnderlineRuns()
    */
-  void GetUnderlineRuns(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const override;
+  void GetUnderlineRuns(UnderlinedGlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const override;
 
   /**
    * @copydoc ModelInterface::GetOutlineColor()
@@ -258,6 +270,11 @@ public:
   bool IsMarkupProcessorEnabled() const override;
 
   /**
+   * @copydoc ModelInterface::IsSpannedTextPlaced()
+   */
+  bool IsSpannedTextPlaced() const override;
+
+  /**
   * @copydoc ModelInterface::GetHyphens()
   */
   const GlyphInfo* GetHyphens() const override;
@@ -272,13 +289,42 @@ public:
   */
   Length GetHyphensCount() const override;
 
+  /**
+   * @copydoc ModelInterface::GetStrikethroughHeight()
+   */
   float GetStrikethroughHeight() const override;
 
+  /**
+   * @copydoc ModelInterface::GetStrikethroughColor()
+   */
   const Vector4& GetStrikethroughColor() const override;
 
+  /**
+   * @copydoc ModelInterface::IsStrikethroughEnabled()
+   */
   bool IsStrikethroughEnabled() const override;
 
   /**
+   * @copydoc ModelInterface::IsMarkupStrikethroughSet()
+   */
+  bool IsMarkupStrikethroughSet() const override;
+
+  /**
+   * @copydoc ModelInterface::GetCharacterSpacing()
+   */
+  float GetCharacterSpacing() const override;
+
+  /**
+   * @copydoc ModelInterface::GetTextBuffer()
+   */
+  const Character* GetTextBuffer() const override;
+
+  /**
+   * @copydoc ModelInterface::GetGlyphsToCharacters()
+   */
+  const Vector<CharacterIndex>& GetGlyphsToCharacters() const override;
+
+  /**
    * @copydoc ModelInterface::GetNumberOfStrikethroughRuns()
    */
   Length GetNumberOfStrikethroughRuns() const override;
@@ -288,6 +334,36 @@ public:
    */
   void GetStrikethroughRuns(StrikethroughGlyphRun* strikethroughRuns, StrikethroughRunIndex index, Length numberOfRuns) const override;
 
+  /**
+   * @copydoc ModelInterface::GetNumberOfBoundedParagraphRuns()
+   */
+  virtual Length GetNumberOfBoundedParagraphRuns() const override;
+
+  /**
+   * @copydoc ModelInterface::GetBoundedParagraphRuns()
+   */
+  virtual const Vector<BoundedParagraphRun>& GetBoundedParagraphRuns() const override;
+
+  /**
+   * @copydoc ModelInterface::GetNumberOfCharacterSpacingGlyphRuns()
+   */
+  Length GetNumberOfCharacterSpacingGlyphRuns() const override;
+
+  /**
+   * @copydoc ModelInterface::GetCharacterSpacingGlyphRuns()
+   */
+  const Vector<CharacterSpacingGlyphRun>& GetCharacterSpacingGlyphRuns() const override;
+
+  /**
+   * @copydoc ModelInterface::GetFontRuns()
+   */
+  const Vector<FontRun>& GetFontRuns() const override;
+
+  /**
+   * @copydoc ModelInterface::GetFontDescriptionRuns()
+   */
+  const Vector<FontDescriptionRun>& GetFontDescriptionRuns() const override;
+
 private: // Private contructors & copy operator.
   /**
    * @brief Private constructor.
@@ -322,8 +398,11 @@ public:
   float                                  mAlignmentOffset;           ///< The alignment offset.
   bool                                   mElideEnabled : 1;          ///< Whether the text's elide is enabled.
   bool                                   mIgnoreSpacesAfterText : 1; ///< Whether ignoring spaces after text or not. Default is true.
+  bool                                   mRemoveFrontInset : 1;      ///< Whether to ignore xBearing of the first glyph. Default is true.
+  bool                                   mRemoveBackInset : 1;       ///< Whether to ignore advance of the last glyph. Default is true.
   DevelText::MatchLayoutDirection        mMatchLayoutDirection;      ///< Whether to match text alignment with layout direction or not.
   DevelText::EllipsisPosition::Type      mEllipsisPosition;          ///< Where is the location the text elide
+  Vector2                                mVisualTransformOffset;     ///< The offset of the layout based on the controller due to alignment.
 };
 
 } // namespace Text