dali-toolkit/public-api/visuals/text-visual-properties.h

   1 #ifndef DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H
   2 #define DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H
   3
   4 /*
   5  * Copyright (c) 2017 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/toolkit-property-index-ranges.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29 /**
  30  * @addtogroup dali_toolkit_visuals
  31  * @{
  32  */
  33
  34 /**
  35  * @brief TextVisual Properties
  36  * @SINCE_1_2.60
  37  */
  38 namespace TextVisual
  39 {
  40
  41 namespace Property
  42 {
  43
  44 enum
  45 {
  46   /**
  47    * @brief The text to display in UTF-8 format.
  48    * @details name "text", type Property::STRING.
  49    * @SINCE_1_2.60
  50    */
  51   TEXT = VISUAL_PROPERTY_START_INDEX,
  52
  53   /**
  54    * @brief The requested font family to use.
  55    * @details name "fontFamily", type Property::STRING.
  56    * @SINCE_1_2.60
  57    */
  58   FONT_FAMILY,
  59
  60   /**
  61    * @brief The requested font style to use.
  62    * @details name "fontStyle", type Property::MAP.
  63    * @SINCE_1_2.60
  64    */
  65   FONT_STYLE,
  66
  67   /**
  68    * @brief The size of font in points.
  69    * @details name "pointSize", type Property::FLOAT.
  70    * @SINCE_1_2.60
  71    */
  72   POINT_SIZE,
  73
  74   /**
  75    * @brief The single-line or multi-line layout option.
  76    * @details name "multiLine", type Property::BOOLEAN, default false.
  77    * @SINCE_1_2.60
  78    */
  79   MULTI_LINE,
  80
  81   /**
  82    * @brief The line horizontal alignment.
  83    * @details name "horizontalAlignment", type Property::STRING,  values "BEGIN", "CENTER", "END", default BEGIN.
  84    * @SINCE_1_2.60
  85    */
  86   HORIZONTAL_ALIGNMENT,
  87
  88   /**
  89    * @brief The line vertical alignment.
  90    * @details name "verticalAlignment", type Property::STRING,  values "TOP",   "CENTER", "BOTTOM", default TOP.
  91    * @SINCE_1_2.60
  92    */
  93   VERTICAL_ALIGNMENT,
  94
  95   /**
  96    * @brief The color of the text.
  97    * @details name "textColor", type Property::VECTOR4.
  98    * @SINCE_1_2.60
  99    */
 100   TEXT_COLOR,
 101
 102   /**
 103    * @brief  Whether the mark-up processing is enabled.
 104    * @details name "enableMarkup", type Property::BOOLEAN.
 105    * @SINCE_1_2.60
 106    */
 107   ENABLE_MARKUP,
 108
 109   /**
 110    * @brief The shadow parameters.
 111    * @details name "shadow", type Property::MAP.
 112    * @SINCE_1_2.60
 113    */
 114   SHADOW,
 115
 116   /**
 117    * @brief The default underline parameters.
 118    * @details name "underline", type Property::MAP.
 119    * @SINCE_1_2.60
 120    */
 121   UNDERLINE,
 122 };
 123
 124 } // namespace Property
 125
 126 } // namespace TextVisual
 127
 128 /**
 129  * @}
 130  */
 131
 132 } // namespace Toolkit
 133
 134 } // namespace Dali
 135
 136 #endif // DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H