1 #ifndef DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H
2 #define DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H
5 * Copyright (c) 2020 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>
29 * @addtogroup dali_toolkit_visuals
34 * @brief TextVisual is to render a text.
40 * @brief TextVisual Property.
46 * @brief Enumeration for the instance of properties belonging to the TextVisual.
52 * @brief The text to display in UTF-8 format.
53 * @details name "text", type Property::STRING.
56 TEXT = VISUAL_PROPERTY_START_INDEX,
59 * @brief The requested font family to use.
60 * @details name "fontFamily", type Property::STRING.
66 * @brief The requested font style to use.
67 * @details name "fontStyle", type Property::MAP.
73 * @brief The size of font in points.
74 * @details name "pointSize", type Property::FLOAT.
80 * @brief The single-line or multi-line layout option.
81 * @details name "multiLine", type Property::BOOLEAN, default false.
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)
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)`
105 * @brief The color of the text.
106 * @details name "textColor", type Property::VECTOR4.
112 * @brief Whether the mark-up processing is enabled.
113 * @details name "enableMarkup", type Property::BOOLEAN.
119 * @brief The shadow parameters.
120 * @details name "shadow", type Property::MAP.
126 * @brief The default underline parameters.
127 * @details name "underline", type Property::MAP.
133 * @brief The default strikethrough parameters.
134 * @details name "strikethrough", type Property::MAP.
139 } // namespace Property
141 } // namespace TextVisual
147 } // namespace Toolkit
151 #endif // DALI_TOOLKIT_TEXT_VISUAL_PROPERTIES_H