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