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) 2016 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 namespace TextVisual
  31 {
  32
  33 namespace Property
  34 {
  35
  36 enum
  37 {
  38   /**
  39    * @brief The type of rendering e.g. bitmap-based
  40    * @details name "renderingBackend", type INTEGER, default RENDERING_SHARED_ATLAS
  41    * @SINCE_1_2.11
  42    */
  43   RENDERING_BACKEND = VISUAL_PROPERTY_START_INDEX,
  44
  45   /**
  46    * @brief The text to display in UTF-8 format,
  47    * @details name "text", type STRING
  48    * @SINCE_1_2.11
  49    */
  50   TEXT,
  51
  52   /**
  53    * @brief The requested font family to use,
  54    * @details name "fontFamily", type STRING
  55    * @SINCE_1_2.11
  56    */
  57   FONT_FAMILY,
  58
  59   /**
  60    * @brief The requested font style to use,
  61    * @details name "fontStyle", type STRING or MAP
  62    * @SINCE_1_2.13
  63    */
  64   FONT_STYLE,
  65
  66   /**
  67    * @brief The size of font in points
  68    * @details name "pointSize", type FLOAT
  69    * @SINCE_1_2.11
  70    */
  71   POINT_SIZE,
  72
  73   /**
  74    * @brief The single-line or multi-line layout option
  75    * @details name "multiLine", type BOOLEAN, default false
  76    * @SINCE_1_2.11
  77    */
  78   MULTI_LINE,
  79
  80   /**
  81    * @brief The line horizontal alignment
  82    * @details name "horizontalAlignment", type STRING,  values "BEGIN", "CENTER", "END", default BEGIN
  83    * @SINCE_1_2.11
  84    */
  85   HORIZONTAL_ALIGNMENT,
  86
  87   /**
  88    * @brief The line vertical alignment
  89    * @details name "verticalAlignment", type STRING,  values "TOP",   "CENTER", "BOTTOM", default TOP
  90    * @SINCE_1_2.11
  91    */
  92   VERTICAL_ALIGNMENT,
  93
  94   /**
  95    * @brief The color of the text
  96    * @details name "textColor", type VECTOR4
  97    * @SINCE_1_2.11
  98    */
  99   TEXT_COLOR,
 100
 101   /**
 102    * @brief  Whether the mark-up processing is enabled
 103    * @details name "enableMarkup", type BOOLEAN
 104    * @SINCE_1_2.11
 105    */
 106   ENABLE_MARKUP,
 107
 108   /**
 109    * @brief  Start or stop auto scrolling,
 110    * @details name "enableAutoScroll", type BOOLEAN, default is false
 111    * @SINCE_1_2.11
 112    */
 113   ENABLE_AUTO_SCROLL,
 114
 115   /**
 116    * @brief Sets the speed of scrolling in pixels per second,
 117    * @details name "autoScrollSpeed", type INTEGER, default in style sheet
 118    * @SINCE_1_2.11
 119    */
 120   AUTO_SCROLL_SPEED,
 121
 122   /**
 123    * @brief  Number of complete loops when scrolling enabled
 124    * @details name "autoScrollLoopCount", type INTEGER, default in style sheet
 125    * @SINCE_1_2.11
 126    */
 127   AUTO_SCROLL_LOOP_COUNT,
 128
 129   /**
 130    * @brief  Gap before before scrolling wraps
 131    * @details name "autoScrollGap", type INTEGER, default in style sheet but can be overridden to prevent same text being show at start and end.
 132    * @SINCE_1_2.11
 133    */
 134   AUTO_SCROLL_GAP,
 135
 136   /**
 137    * @brief The default extra space between lines in points.
 138    * @details name "lineSpacing", type FLOAT.
 139    * @SINCE_1_2.11
 140    */
 141   LINE_SPACING,
 142
 143   /**
 144    * @brief The default underline parameters.
 145    * @details name "underline", type STRING or MAP.
 146    * @SINCE_1_2.13
 147    */
 148   UNDERLINE,
 149
 150   /**
 151    * @brief The default shadow parameters.
 152    * @details name "shadow", type STRING or MAP.
 153    * @SINCE_1_2.13
 154    */
 155   SHADOW,
 156
 157   /**
 158    * @brief The default emboss parameters.
 159    * @details name "emboss", type STRING or MAP.
 160    * @SINCE_1_2.13
 161    */
 162   EMBOSS,
 163
 164   /**
 165    * @brief The default outline parameters.
 166    * @details name "outline", type STRING or MAP.
 167    * @SINCE_1_2.13
 168    */
 169   OUTLINE,
 170
 171   /**
 172    * @brief This enables Text visuals to automatically be converted to Batch-Text visuals.
 173    * @details Name "batchingEnabled", type Property::BOOLEAN.
 174    * @SINCE_1_2.11
 175    * @note Optional. If not specified, the default is false.
 176    */
 177   BATCHING_ENABLED,
 178 };
 179
 180 } // namespace Property
 181
 182 } // namespace TextVisual
 183
 184 } // namespace Toolkit
 185
 186 } // namespace Dali
 187
 188 #endif // DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H