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) 2019 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
  24 namespace Toolkit
  25 {
  26
  27 /**
  28  * @addtogroup dali_toolkit_controls
  29  * @{
  30  */
  31
  32 namespace DevelText
  33 {
  34
  35 namespace Shadow
  36 {
  37
  38 /**
  39  * @brief Used by Text controls to show different styles of text.
  40  *
  41  */
  42 namespace Property
  43 {
  44
  45 enum
  46 {
  47   /**
  48    * @brief The color of the shadow.
  49    * @details Name "color", type Property::STRING or Property::VECTOR4.
  50    * @note Optional. If not provided the default color (BLACK) is used.
  51    */
  52   COLOR,
  53
  54   /**
  55    * @brief The offset in pixels of the shadow.
  56    * @details Name "offset", type Property::STRING or Property::VECTOR2. i.e "3.0 3.0" or Vector2( 3.f, 3.f )
  57    * @note Optional. If not provided then the shadow is not enabled.
  58    */
  59   OFFSET,
  60
  61   /**
  62    * @brief The radius of the Gaussian blur for the soft shadow.
  63    * @details Name "blurRadius", type Property::STRING or Property::FLOAT. i.e "5.0" or 5.f
  64    * @note Optional. If not provided then the soft shadow is not enabled.
  65    */
  66   BLUR_RADIUS
  67 };
  68
  69 } // namespace Property
  70
  71 } // namespace Shadow
  72
  73 namespace Underline
  74 {
  75
  76 namespace Property
  77 {
  78
  79 enum
  80 {
  81   /**
  82    * @brief Whether the underline is enabled.
  83    * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
  84    * @note Optional. By default is disabled.
  85    */
  86   ENABLE,
  87
  88   /**
  89    * @brief The color of the underline.
  90    * @details Name "color", type Property::STRING or Property::VECTOR4
  91    * @note Optional. If not provided then the color of the text is used.
  92    */
  93   COLOR,
  94
  95   /**
  96    * @brief The height in pixels of the underline.
  97    * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
  98    * @note Optional. If not provided then the default height is used (1 pixel).
  99    */
 100   HEIGHT
 101 };
 102
 103 } // namespace Property
 104
 105 } // namespace Underline
 106
 107 namespace Outline
 108 {
 109
 110 namespace Property
 111 {
 112
 113 enum
 114 {
 115   /**
 116    * @brief The color of the outline.
 117    * @details Name "color", type Property::STRING or Property::VECTOR4
 118    * @note Optional. If not provided the default color (WHITE) is used.
 119    */
 120   COLOR,
 121
 122   /**
 123    * @brief The width in pixels of the outline.
 124    * @details Name "width", type Property::STRING or Property::FLOAT i.e. "1.0" or 1.f
 125    * @note Optional. If not provided then the outline is not enabled.
 126    */
 127   WIDTH
 128 };
 129
 130 } // namespace Property
 131
 132 } // namespace Outline
 133
 134 namespace Background
 135 {
 136
 137 namespace Property
 138 {
 139
 140 enum
 141 {
 142   /**
 143    * @brief Whether to paint the text's background.
 144    * @details Name "enable", type Property::STRING or Property::BOOLEAN i.e. "true", "false", true or false
 145    * @note Optional. By default is disabled.
 146    */
 147   ENABLE,
 148
 149   /**
 150    * @brief The color of the background.
 151    * @details Name "color", type Property::STRING or Property::VECTOR4
 152    * @note Optional. If not provided the default color (CYAN) is used.
 153    */
 154   COLOR
 155 };
 156
 157 } // namespace Property
 158
 159 } // namespace Background
 160
 161 } // namespace DevelText
 162
 163 /**
 164  * @}
 165  */
 166
 167 } // namespace Toolkit
 168
 169 } // namespace Dali
 170
 171 #endif // DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H