1 #ifndef DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H
2 #define DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/toolkit-property-index-ranges.h>
39 * @brief The type of rendering e.g. bitmap-based
40 * @details name "renderingBackend", type INTEGER, default RENDERING_SHARED_ATLAS
43 RENDERING_BACKEND = VISUAL_PROPERTY_START_INDEX,
46 * @brief The text to display in UTF-8 format,
47 * @details name "text", type STRING
53 * @brief The requested font family to use,
54 * @details name "fontFamily", type STRING
60 * @brief The requested font style to use,
61 * @details name "fontStyle", type STRING or MAP
67 * @brief The size of font in points
68 * @details name "pointSize", type FLOAT
74 * @brief The single-line or multi-line layout option
75 * @details name "multiLine", type BOOLEAN, default false
81 * @brief The line horizontal alignment
82 * @details name "horizontalAlignment", type STRING, values "BEGIN", "CENTER", "END", default BEGIN
88 * @brief The line vertical alignment
89 * @details name "verticalAlignment", type STRING, values "TOP", "CENTER", "BOTTOM", default TOP
95 * @brief The color of the text
96 * @details name "textColor", type VECTOR4
102 * @brief Whether the mark-up processing is enabled
103 * @details name "enableMarkup", type BOOLEAN
109 * @brief Start or stop auto scrolling,
110 * @details name "enableAutoScroll", type BOOLEAN, default is false
116 * @brief Sets the speed of scrolling in pixels per second,
117 * @details name "autoScrollSpeed", type INTEGER, default in style sheet
123 * @brief Number of complete loops when scrolling enabled
124 * @details name "autoScrollLoopCount", type INTEGER, default in style sheet
127 AUTO_SCROLL_LOOP_COUNT,
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.
137 * @brief The default extra space between lines in points.
138 * @details name "lineSpacing", type FLOAT.
144 * @brief The default underline parameters.
145 * @details name "underline", type STRING or MAP.
151 * @brief The default shadow parameters.
152 * @details name "shadow", type STRING or MAP.
158 * @brief The default emboss parameters.
159 * @details name "emboss", type STRING or MAP.
165 * @brief The default outline parameters.
166 * @details name "outline", type STRING or MAP.
172 * @brief This enables Text visuals to automatically be converted to Batch-Text visuals.
173 * @details Name "batchingEnabled", type Property::BOOLEAN.
175 * @note Optional. If not specified, the default is false.
180 } // namespace Property
182 } // namespace TextVisual
184 } // namespace Toolkit
188 #endif // DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H