dali-toolkit/devel-api/controls/text-controls/text-style-properties-devel.h

   1 #ifndef DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
   2 #define DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 namespace Dali
  22 {
  23 namespace Toolkit
  24 {
  25 /**
  26  * @addtogroup dali_toolkit_controls
  27  * @{
  28  */
  29
  30 namespace DevelText
  31 {
  32 namespace Shadow
  33 {
  34 /**
  35  * @brief Used by Text controls to show different styles of text.
  36  *
  37  */
  38 namespace Property
  39 {
  40 enum
  41 {
  42   /**
  43    * @brief The color of the shadow.
  44    * @details Name "color", type Property::STRING or Property::VECTOR4.
  45    * @note Optional. If not provided the default color (BLACK) is used.
  46    */
  47   COLOR,
  48
  49   /**
  50    * @brief The offset in pixels of the shadow.
  51    * @details Name "offset", type Property::STRING or Property::VECTOR2. i.e "3.0 3.0" or Vector2( 3.f, 3.f )
  52    * @note Optional. If not provided then the shadow is not enabled.
  53    */
  54   OFFSET,
  55
  56   /**
  57    * @brief The radius of the Gaussian blur for the soft shadow.
  58    * @details Name "blurRadius", type Property::STRING or Property::FLOAT. i.e "5.0" or 5.f
  59    * @note Optional. If not provided then the soft shadow is not enabled.
  60    */
  61   BLUR_RADIUS
  62 };
  63
  64 } // namespace Property
  65
  66 } // namespace Shadow
  67
  68 namespace Underline
  69 {
  70 namespace Property
  71 {
  72 enum
  73 {
  74   /**
  75    * @brief Whether the underline is enabled.
  76    * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
  77    * @note Optional. By default is disabled.
  78    */
  79   ENABLE,
  80
  81   /**
  82    * @brief The color of the underline.
  83    * @details Name "color", type Property::STRING or Property::VECTOR4
  84    * @note Optional. If not provided then the color of the text is used.
  85    */
  86   COLOR,
  87
  88   /**
  89    * @brief The height in pixels of the underline.
  90    * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
  91    * @note Optional. If not provided then the default height is used (1 pixel).
  92    */
  93   HEIGHT
  94 };
  95
  96 } // namespace Property
  97
  98 } // namespace Underline
  99
 100 namespace Outline
 101 {
 102 namespace Property
 103 {
 104 enum
 105 {
 106   /**
 107    * @brief The color of the outline.
 108    * @details Name "color", type Property::STRING or Property::VECTOR4
 109    * @note Optional. If not provided the default color (WHITE) is used.
 110    */
 111   COLOR,
 112
 113   /**
 114    * @brief The width in pixels of the outline.
 115    * @details Name "width", type Property::STRING or Property::FLOAT i.e. "1.0" or 1.f
 116    * @note Optional. If not provided then the outline is not enabled.
 117    */
 118   WIDTH
 119 };
 120
 121 } // namespace Property
 122
 123 } // namespace Outline
 124
 125 namespace Background
 126 {
 127 namespace Property
 128 {
 129 enum
 130 {
 131   /**
 132    * @brief Whether to paint the text's background.
 133    * @details Name "enable", type Property::STRING or Property::BOOLEAN i.e. "true", "false", true or false
 134    * @note Optional. By default is disabled.
 135    */
 136   ENABLE,
 137
 138   /**
 139    * @brief The color of the background.
 140    * @details Name "color", type Property::STRING or Property::VECTOR4
 141    * @note Optional. If not provided the default color (CYAN) is used.
 142    */
 143   COLOR
 144 };
 145
 146 } // namespace Property
 147
 148 } // namespace Background
 149
 150 namespace Strikethrough
 151 {
 152 namespace Property
 153 {
 154 enum
 155 {
 156   /**
 157    * @brief Whether the strikethrough is enabled.
 158    * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
 159    * @note Optional. By default is disabled.
 160    */
 161   ENABLE,
 162
 163   /**
 164    * @brief The color of the strikethrough.
 165    * @details Name "color", type Property::STRING or Property::VECTOR4
 166    * @note Optional. If not provided then the default color is black.
 167    */
 168   COLOR,
 169
 170   /**
 171    * @brief The height in pixels of the strikethrough.
 172    * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
 173    * @note Optional. If not provided then the default height is used (1 pixel).
 174    */
 175   HEIGHT
 176 };
 177
 178 } // namespace Property
 179
 180 } // namespace Strikethrough
 181
 182 } // namespace DevelText
 183
 184 /**
 185  * @}
 186  */
 187
 188 } // namespace Toolkit
 189
 190 } // namespace Dali
 191
 192 #endif // DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H