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

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / text-controls / text-style-properties-devel.h

diff --git a/dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h
index b663105..2e2ed08 100644 (file)
--- a/dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h
+++ b/dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
 
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -20,10 +20,8 @@
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 /**
  * @addtogroup dali_toolkit_controls
  * @{
@@ -31,17 +29,14 @@ namespace Toolkit
 
 namespace DevelText
 {
-
 namespace Shadow
 {
-
 /**
  * @brief Used by Text controls to show different styles of text.
  *
  */
 namespace Property
 {
-
 enum
 {
   /**
@@ -72,10 +67,8 @@ enum
 
 namespace Underline
 {
-
 namespace Property
 {
-
 enum
 {
   /**
@@ -97,7 +90,29 @@ enum
    * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
    * @note Optional. If not provided then the default height is used (1 pixel).
    */
-  HEIGHT
+  HEIGHT,
+
+  /**
+   * @brief The type of the underline.
+   * @details Name "type", type Property::STRING or type Text::Underline::Type. i.e "dashed" or Text::Underline::DASHED
+   *          Values "SOLID", "DASHED", "DOUBLE" , default SOLID.
+   * @note Optional. If not provided then the default type is used (solid underline).
+   */
+  TYPE,
+
+  /**
+   * @brief The width in pixels of the dashes of the dashed underline. Only valid when "DASHED" underline type is used.
+   * @details Name "dashWidth", type Property::STRING or Property::FLOAT. e.g. "1.0" or 1.f
+   * @note Optional. If not provided then the default width is used (2 pixel).
+   */
+  DASH_WIDTH,
+
+  /**
+   * @brief The gap in pixels between the dashes of the dashed underline. Only valid when "DASHED" underline type is used.
+   * @details Name "dashGap", type Property::STRING or Property::FLOAT. e.g. "1.0" or 1.f
+   * @note Optional. If not provided then the default gap is used (1 pixel).
+   */
+  DASH_GAP
 };
 
 } // namespace Property
@@ -106,10 +121,8 @@ enum
 
 namespace Outline
 {
-
 namespace Property
 {
-
 enum
 {
   /**
@@ -124,7 +137,14 @@ enum
    * @details Name "width", type Property::STRING or Property::FLOAT i.e. "1.0" or 1.f
    * @note Optional. If not provided then the outline is not enabled.
    */
-  WIDTH
+  WIDTH,
+
+  /**
+   * @brief The offset in pixels of the outline.
+   * @details Name "offset", type Property::STRING or Property::VECTOR2. i.e "3.0 3.0" or Vector2( 3.f, 3.f )
+   * @note Optional. If not provided then the outline is not enabled.
+   */
+  OFFSET
 };
 
 } // namespace Property
@@ -133,10 +153,8 @@ enum
 
 namespace Background
 {
-
 namespace Property
 {
-
 enum
 {
   /**
@@ -158,6 +176,38 @@ enum
 
 } // namespace Background
 
+namespace Strikethrough
+{
+namespace Property
+{
+enum
+{
+  /**
+   * @brief Whether the strikethrough is enabled.
+   * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
+   * @note Optional. By default is disabled.
+   */
+  ENABLE,
+
+  /**
+   * @brief The color of the strikethrough.
+   * @details Name "color", type Property::STRING or Property::VECTOR4
+   * @note Optional. If not provided then the default color is black.
+   */
+  COLOR,
+
+  /**
+   * @brief The height in pixels of the strikethrough.
+   * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
+   * @note Optional. If not provided then the default height is used (1 pixel).
+   */
+  HEIGHT
+};
+
+} // namespace Property
+
+} // namespace Strikethrough
+
 } // namespace DevelText
 
 /**