1 #ifndef DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H
2 #define DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_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.
26 * @addtogroup dali_toolkit_controls
35 * @brief Used by Text controls to show different styles of text.
43 * @brief The color of the shadow.
44 * @details Name "color", type Property::STRING or Property::VECTOR4.
45 * @note Optional. If not provided the default color (BLACK) is used.
50 * @brief The offset in pixels of the shadow.
51 * @details Name "offset", type Property::STRING or Property::VECTOR2. i.e "3.0 3.0" or Vector2( 3.f, 3.f )
52 * @note Optional. If not provided then the shadow is not enabled.
57 * @brief The radius of the Gaussian blur for the soft shadow.
58 * @details Name "blurRadius", type Property::STRING or Property::FLOAT. i.e "5.0" or 5.f
59 * @note Optional. If not provided then the soft shadow is not enabled.
64 } // namespace Property
75 * @brief Whether the underline is enabled.
76 * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
77 * @note Optional. By default is disabled.
82 * @brief The color of the underline.
83 * @details Name "color", type Property::STRING or Property::VECTOR4
84 * @note Optional. If not provided then the color of the text is used.
89 * @brief The height in pixels of the underline.
90 * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
91 * @note Optional. If not provided then the default height is used (1 pixel).
96 * @brief The type of the underline.
97 * @details Name "type", type Property::STRING or type Text::Underline::Type. i.e "dashed" or Text::Underline::DASHED
98 * Values "SOLID", "DASHED", "DOUBLE" , default SOLID.
99 * @note Optional. If not provided then the default type is used (solid underline).
104 * @brief The width in pixels of the dashes of the dashed underline. Only valid when "DASHED" underline type is used.
105 * @details Name "dashWidth", type Property::STRING or Property::FLOAT. e.g. "1.0" or 1.f
106 * @note Optional. If not provided then the default width is used (2 pixel).
111 * @brief The gap in pixels between the dashes of the dashed underline. Only valid when "DASHED" underline type is used.
112 * @details Name "dashGap", type Property::STRING or Property::FLOAT. e.g. "1.0" or 1.f
113 * @note Optional. If not provided then the default gap is used (1 pixel).
118 } // namespace Property
120 } // namespace Underline
129 * @brief The color of the outline.
130 * @details Name "color", type Property::STRING or Property::VECTOR4
131 * @note Optional. If not provided the default color (WHITE) is used.
136 * @brief The width in pixels of the outline.
137 * @details Name "width", type Property::STRING or Property::FLOAT i.e. "1.0" or 1.f
138 * @note Optional. If not provided then the outline is not enabled.
143 * @brief The offset in pixels of the outline.
144 * @details Name "offset", type Property::STRING or Property::VECTOR2. i.e "3.0 3.0" or Vector2( 3.f, 3.f )
145 * @note Optional. If not provided then the outline is not enabled.
150 * @brief The radius of the Gaussian blur for the outline.
151 * @details Name "blurRadius", type Property::STRING or Property::FLOAT. i.e "5.0" or 5.f
152 * @note Optional. If not provided then the outline is not enabled.
157 } // namespace Property
159 } // namespace Outline
168 * @brief Whether to paint the text's background.
169 * @details Name "enable", type Property::STRING or Property::BOOLEAN i.e. "true", "false", true or false
170 * @note Optional. By default is disabled.
175 * @brief The color of the background.
176 * @details Name "color", type Property::STRING or Property::VECTOR4
177 * @note Optional. If not provided the default color (CYAN) is used.
182 } // namespace Property
184 } // namespace Background
186 namespace Strikethrough
193 * @brief Whether the strikethrough is enabled.
194 * @details Name "enable", type Property::STRING or Property::BOOLEAN. i.e. "true", "false", true or false
195 * @note Optional. By default is disabled.
200 * @brief The color of the strikethrough.
201 * @details Name "color", type Property::STRING or Property::VECTOR4
202 * @note Optional. If not provided then the default color is black.
207 * @brief The height in pixels of the strikethrough.
208 * @details Name "height", type Property::STRING or Property::FLOAT. i.e. "1.0" or 1.f
209 * @note Optional. If not provided then the default height is used (1 pixel).
214 } // namespace Property
216 } // namespace Strikethrough
218 } // namespace DevelText
224 } // namespace Toolkit
228 #endif // DALI_TOOLKIT_TEXT_STYLE_PROPERTIES_DEVEL_H