add support for background markup tag

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

diff --git a/dali-toolkit/internal/text/rendering/view-model.h b/dali-toolkit/internal/text/rendering/view-model.h
index e15fa9c..e51a075 100644 (file)
--- a/dali-toolkit/internal/text/rendering/view-model.h
+++ b/dali-toolkit/internal/text/rendering/view-model.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_VIEW_MODEL_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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,17 +22,16 @@
 #include <dali/public-api/common/dali-vector.h>
 
 // INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
 #include <dali-toolkit/internal/text/text-model-interface.h>
+#include <dali-toolkit/public-api/text/text-enumerations.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 namespace Text
 {
-
 /**
  * @brief Responsible of creating and store temporary modifications of the text model.
  * i.e. The elide of text.
@@ -47,7 +46,7 @@ public:
    *
    * @param[in] model Pointer to the text's model interface.
    */
-  ViewModel( const ModelInterface* const model );
+  ViewModel(const ModelInterface* const model);
 
   /**
    * @brief Virtual destructor.
@@ -59,117 +58,182 @@ public:
   /**
    * @copydoc ModelInterface::GetControlSize()
    */
-  virtual const Size& GetControlSize() const;
+  const Size& GetControlSize() const override;
 
   /**
    * @copydoc ModelInterface::GetLayoutSize()
    */
-  virtual const Size& GetLayoutSize() const;
+  const Size& GetLayoutSize() const override;
 
   /**
    * @copydoc ModelInterface::GetScrollPosition()
    */
-  virtual const Vector2& GetScrollPosition() const;
+  const Vector2& GetScrollPosition() const override;
 
   /**
    * @copydoc ModelInterface::GetHorizontalAlignment()
    */
-  virtual Layout::HorizontalAlignment GetHorizontalAlignment() const;
+  Text::HorizontalAlignment::Type GetHorizontalAlignment() const override;
 
   /**
    * @copydoc ModelInterface::GetVerticalAlignment()
    */
-  virtual Layout::VerticalAlignment GetVerticalAlignment() const;
+  Text::VerticalAlignment::Type GetVerticalAlignment() const override;
+
+  /**
+ * @copydoc ModelInterface::GetVerticalLineAlignment()
+ */
+  DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const override;
 
   /**
    * @copydoc ModelInterface::IsTextElideEnabled()
    */
-  virtual bool IsTextElideEnabled() const;
+  bool IsTextElideEnabled() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfLines()
    */
-  virtual Length GetNumberOfLines() const;
+  Length GetNumberOfLines() const override;
 
   /**
    * @copydoc ModelInterface::GetLines()
    */
-  virtual const LineRun* const GetLines() const;
+  const LineRun* const GetLines() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfScripts()
    */
-  virtual Length GetNumberOfScripts() const;
+  Length GetNumberOfScripts() const override;
 
   /**
    * @copydoc ModelInterface::GetScriptRuns()
    */
-  virtual const ScriptRun* const GetScriptRuns() const;
+  const ScriptRun* const GetScriptRuns() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfGlyphs()
    */
-  virtual Length GetNumberOfGlyphs() const;
+  Length GetNumberOfGlyphs() const override;
 
   /**
    * @copydoc ModelInterface::GetGlyphs()
    */
-  virtual const GlyphInfo* const GetGlyphs() const;
+  const GlyphInfo* const GetGlyphs() const override;
 
   /**
    * @copydoc ModelInterface::GetLayout()
    */
-  virtual const Vector2* const GetLayout() const;
+  const Vector2* const GetLayout() const override;
 
   /**
    * @copydoc ModelInterface::GetColors()
    */
-  virtual const Vector4* const GetColors() const;
+  const Vector4* const GetColors() const override;
 
   /**
    * @copydoc ModelInterface::GetColorIndices()
    */
-  virtual const ColorIndex* const GetColorIndices() const;
+  const ColorIndex* const GetColorIndices() const override;
+
+  /**
+   * @copydoc ModelInterface::GetBackgroundColors()
+   */
+  const Vector4* const GetBackgroundColors() const override;
+
+  /**
+   * @copydoc ModelInterface::GetBackgroundColorIndices()
+   */
+  const ColorIndex* const GetBackgroundColorIndices() const override;
+
+  /**
+   * @copydoc ModelInterface::IsMarkupBackgroundColorSet()
+   */
+  bool const IsMarkupBackgroundColorSet() const override;
 
   /**
    * @copydoc ModelInterface::GetDefaultColor()
    */
-  virtual const Vector4& GetDefaultColor() const;
+  const Vector4& GetDefaultColor() const override;
 
   /**
    * @copydoc ModelInterface::GetShadowOffset()
    */
-  virtual const Vector2& GetShadowOffset() const;
+  const Vector2& GetShadowOffset() const override;
 
   /**
    * @copydoc ModelInterface::GetShadowColor()
    */
-  virtual const Vector4& GetShadowColor() const;
+  const Vector4& GetShadowColor() const override;
+
+  /**
+   * @copydoc ModelInterface::GetShadowBlurRadius()
+   */
+  const float& GetShadowBlurRadius() const override;
 
   /**
    * @copydoc ModelInterface::GetUnderlineColor()
    */
-  virtual const Vector4& GetUnderlineColor() const;
+  const Vector4& GetUnderlineColor() const override;
 
   /**
    * @copydoc ModelInterface::IsUnderlineEnabled()
    */
-  virtual bool IsUnderlineEnabled() const;
+  bool IsUnderlineEnabled() const override;
 
   /**
    * @copydoc ModelInterface::GetUnderlineHeight()
    */
-  virtual float GetUnderlineHeight() const;
+  float GetUnderlineHeight() const override;
 
   /**
    * @copydoc ModelInterface::GetNumberOfUnderlineRuns()
    */
-  virtual Length GetNumberOfUnderlineRuns() const;
+  Length GetNumberOfUnderlineRuns() const override;
 
   /**
    * @copydoc ModelInterface::GetUnderlineRuns()
    */
-  virtual void GetUnderlineRuns( GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns ) const;
+  void GetUnderlineRuns(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const override;
+
+  /**
+   * @copydoc ModelInterface::GetOutlineColor()
+   */
+  const Vector4& GetOutlineColor() const override;
+
+  /**
+   * @copydoc ModelInterface::GetOutlineWidth()
+   */
+  uint16_t GetOutlineWidth() const override;
+
+  /**
+   * @copydoc ModelInterface::GetBackgroundColor()
+   */
+  const Vector4& GetBackgroundColor() const override;
+
+  /**
+   * @copydoc ModelInterface::IsBackgroundEnabled()
+   */
+  bool IsBackgroundEnabled() const override;
+
+  /**
+   * @copydoc ModelInterface::IsMarkupProcessorEnabled()
+   */
+  bool IsMarkupProcessorEnabled() 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;
 
   /**
    * @brief Does the text elide.