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 is to render a text.
  36  * @SINCE_1_2.60
  37  */
  38 namespace TextVisual
  39 {
  40
  41 /**
  42  * @brief TextVisual Property.
  43  * @SINCE_1_2.60
  44  */
  45 namespace Property
  46 {
  47
  48 /**
  49  * @brief Enumeration for the instance of properties belonging to the TextVisual.
  50  * @SINCE_1_2.60
  51  */
  52 enum
  53 {
  54   /**
  55    * @brief The text to display in UTF-8 format.
  56    * @details name "text", type Property::STRING.
  57    * @SINCE_1_2.60
  58    */
  59   TEXT = VISUAL_PROPERTY_START_INDEX,
  60
  61   /**
  62    * @brief The requested font family to use.
  63    * @details name "fontFamily", type Property::STRING.
  64    * @SINCE_1_2.60
  65    */
  66   FONT_FAMILY,
  67
  68   /**
  69    * @brief The requested font style to use.
  70    * @details name "fontStyle", type Property::MAP.
  71    * @SINCE_1_2.60
  72    */
  73   FONT_STYLE,
  74
  75   /**
  76    * @brief The size of font in points.
  77    * @details name "pointSize", type Property::FLOAT.
  78    * @SINCE_1_2.60
  79    */
  80   POINT_SIZE,
  81
  82   /**
  83    * @brief The single-line or multi-line layout option.
  84    * @details name "multiLine", type Property::BOOLEAN, default false.
  85    * @SINCE_1_2.60
  86    */
  87   MULTI_LINE,
  88
  89   /**
  90    * @brief The line horizontal alignment.
  91    * @details Name "horizontalAlignment", type HorizontalAlignment::Type (Property::INTEGER) or Property::STRING.
  92    * @note Optional. If not specified, the default is HorizontalAlignment::BEGIN
  93    * @note Return type is HorizontalAlignment::Type (Property::INTEGER)
  94    * @SINCE_1_2.60
  95    */
  96   HORIZONTAL_ALIGNMENT,
  97
  98   /**
  99    * @brief The line vertical alignment.
 100    * @details name "verticalAlignment", VerticalAlignment::Type (Property::INTEGER) or  Property::STRING
 101    * @note Optional. If not specified, the default is VerticalAlignment::TOP
 102    * @note Return type is VerticalAlignment::Type (Property::INTEGER)`
 103    * @SINCE_1_2.60
 104    */
 105   VERTICAL_ALIGNMENT,
 106
 107   /**
 108    * @brief The color of the text.
 109    * @details name "textColor", type Property::VECTOR4.
 110    * @SINCE_1_2.60
 111    */
 112   TEXT_COLOR,
 113
 114   /**
 115    * @brief  Whether the mark-up processing is enabled.
 116    * @details name "enableMarkup", type Property::BOOLEAN.
 117    * @SINCE_1_2.60
 118    */
 119   ENABLE_MARKUP,
 120
 121   /**
 122    * @brief The shadow parameters.
 123    * @details name "shadow", type Property::MAP.
 124    * @SINCE_1_2.60
 125    */
 126   SHADOW,
 127
 128   /**
 129    * @brief The default underline parameters.
 130    * @details name "underline", type Property::MAP.
 131    * @SINCE_1_2.60
 132    */
 133   UNDERLINE,
 134 };
 135
 136 } // namespace Property
 137
 138 } // namespace TextVisual
 139
 140 /**
 141  * @}
 142  */
 143
 144 } // namespace Toolkit
 145
 146 } // namespace Dali
 147
 148 #endif // DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H