[dali_2.3.21] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-model.h
old mode 100755 (executable)
new mode 100644 (file)
index 219aae8..e738784
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_MODEL_H
 
 /*
- * Copyright (c) 2019 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.
 #include <dali/public-api/object/ref-object.h>
 
 // INTERNAL INCLUDES
-#include <dali-toolkit/public-api/text/text-enumerations.h>
+#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>
+#include <dali-toolkit/public-api/text/text-enumerations.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Text
 {
-
 // Forward declarations.
 class Model;
 
@@ -46,9 +45,7 @@ typedef IntrusivePtr<Model> ModelPtr;
  */
 class Model : public RefObject, public ModelInterface
 {
-
 public: // Constructor.
-
   /**
    * @brief Create a new instance of a text Model.
    *
@@ -57,7 +54,6 @@ public: // Constructor.
   static ModelPtr New();
 
 public:
-
   /**
    * @copydoc ModelInterface::GetControlSize()
    */
@@ -89,6 +85,11 @@ public:
   DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const override;
 
   /**
+   * @copydoc ModelInterface::GetEllipsisPosition()
+   */
+  DevelText::EllipsisPosition::Type GetEllipsisPosition() const override;
+
+  /**
    * @copydoc ModelInterface::IsTextElideEnabled()
    */
   bool IsTextElideEnabled() const override;
@@ -101,7 +102,7 @@ public:
   /**
    * @copydoc ModelInterface::GetLines()
    */
-  const LineRun* const GetLines() const override;
+  const LineRun* GetLines() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfScripts()
@@ -111,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()
@@ -119,34 +125,59 @@ public:
   Length GetNumberOfGlyphs() const override;
 
   /**
+   * @copydoc ModelInterface::GetStartIndexOfElidedGlyphs()
+   */
+  GlyphIndex GetStartIndexOfElidedGlyphs() const override;
+
+  /**
+   * @copydoc ModelInterface::GetEndIndexOfElidedGlyphs()
+   */
+  GlyphIndex GetEndIndexOfElidedGlyphs() const override;
+
+  /**
+   * @copydoc ModelInterface::GetFirstMiddleIndexOfElidedGlyphs()
+   */
+  GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const override;
+
+  /**
+   * @copydoc ModelInterface::GetSecondMiddleIndexOfElidedGlyphs()
+   */
+  GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const override;
+
+  /**
    * @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 IsMarkupBackgroundColorSet() const override;
 
   /**
    * @copydoc ModelInterface::GetDefaultColor()
@@ -179,11 +210,31 @@ public:
   bool IsUnderlineEnabled() const override;
 
   /**
+   * @copydoc ModelInterface::IsMarkupUnderlineSet()
+   */
+  bool IsMarkupUnderlineSet() const override;
+
+  /**
    * @copydoc ModelInterface::GetUnderlineHeight()
    */
   float GetUnderlineHeight() const override;
 
   /**
+   * @copydoc ModelInterface::GetUnderlineType()
+   */
+  Text::Underline::Type GetUnderlineType() const override;
+
+  /**
+   * @copydoc ModelInterface::GetDashedUnderlineWidth()
+   */
+  float GetDashedUnderlineWidth() const override;
+
+  /**
+   * @copydoc ModelInterface::GetDashedUnderlineGap()
+   */
+  float GetDashedUnderlineGap() const override;
+
+  /**
    * @copydoc ModelInterface::GetNumberOfUnderlineRuns()
    */
   Length GetNumberOfUnderlineRuns() const override;
@@ -191,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()
@@ -213,43 +264,145 @@ public:
    */
   bool IsBackgroundEnabled() const override;
 
-private: // Private contructors & copy operator.
+  /**
+   * @copydoc ModelInterface::IsMarkupProcessorEnabled()
+   */
+  bool IsMarkupProcessorEnabled() const override;
+
+  /**
+   * @copydoc ModelInterface::IsSpannedTextPlaced()
+   */
+  bool IsSpannedTextPlaced() const override;
+
+  /**
+  * @copydoc ModelInterface::GetHyphens()
+  */
+  const GlyphInfo* GetHyphens() const override;
+
+  /**
+  * @copydoc ModelInterface::GetHyphens()
+  */
+  const Length* GetHyphenIndices() const override;
+
+  /**
+  * @copydoc ModelInterface::GetHyphens()
+  */
+  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;
 
   /**
+   * @copydoc ModelInterface::GetStrikethroughRuns()
+   */
+  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.
    */
   Model();
 
   // Undefined.
-  Model( const Model& handle );
+  Model(const Model& handle);
 
   // Undefined.
-  Model& operator=( const Model& handle );
+  Model& operator=(const Model& handle);
 
 protected:
-
   /**
    * @brief A reference counted object may only be deleted by calling Unreference().
    */
   virtual ~Model();
 
 public:
-  LogicalModelPtr             mLogicalModel;        ///< Pointer to the logical model.
-  VisualModelPtr              mVisualModel;         ///< Pointer to the visual model.
+  LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
+  VisualModelPtr  mVisualModel;  ///< Pointer to the visual model.
   /**
    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
    * Typically this will have a negative value with scrolling occurs.
    */
-  Vector2                                   mScrollPosition;          ///< The text is offset by this position when scrolling.
-  Vector2                                   mScrollPositionLast;      ///< The last offset value of mScrollPosition
-  HorizontalAlignment::Type                 mHorizontalAlignment;     ///< The layout's horizontal alignment.
-  VerticalAlignment::Type                   mVerticalAlignment;       ///< The layout's vertical alignment.
-  DevelText::VerticalLineAlignment::Type    mVerticalLineAlignment;   ///< The layout's vertical line alignment.
-  Text::LineWrap::Mode                      mLineWrapMode;            ///< The text wrap mode
-  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                                      mMatchSystemLanguageDirection:1; ///< Whether match align for system language direction or not. Default is false.
+  Vector2                                mScrollPosition;            ///< The text is offset by this position when scrolling.
+  Vector2                                mScrollPositionLast;        ///< The last offset value of mScrollPosition
+  HorizontalAlignment::Type              mHorizontalAlignment;       ///< The layout's horizontal alignment.
+  VerticalAlignment::Type                mVerticalAlignment;         ///< The layout's vertical alignment.
+  DevelText::VerticalLineAlignment::Type mVerticalLineAlignment;     ///< The layout's vertical line alignment.
+  Text::LineWrap::Mode                   mLineWrapMode;              ///< The text wrap mode
+  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