1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H
5 * Copyright (c) 2021 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/internal/text/text-controller.h>
34 DEFAULT, ///< The default text effect style.
35 INPUT ///< The input text effect style.
40 * @brief Parses the shadow properties.
42 * @param[in] shadowProperties The map with the shadow properties.
43 * @param[out] colorDefined Whether the shadow's color is defined.
44 * @param[out] color The shadow's color.
45 * @param[out] offsetDefined Whether the shadow's offset is defined.
46 * @param[out] offset The shadow's offset.
48 bool ParseShadowProperties(const Property::Map& shadowProperties,
55 * @brief Parses the underline properties.
57 * @param[in] underlineProperties The map with the underline properties.
58 * @param[out] enabled Whether the underline is enabled.
59 * @param[out] colorDefined Whether the underline's color is defined.
60 * @param[out] color The underline's color.
61 * @param[out] heightDefined Whether the underline's height is defined.
62 * @param[out] height The underline's height.
64 bool ParseUnderlineProperties(const Property::Map& underlineProperties,
72 * @brief Parses the outline properties.
74 * @param[in] outlineProperties The map with the outline properties.
75 * @param[out] colorDefined Whether the outline's color is defined.
76 * @param[out] color The outline's color.
77 * @param[out] widthDefined Whether the outline's width is defined.
78 * @param[out] width The outline's width.
80 bool ParseOutlineProperties(const Property::Map& outlineProperties,
87 * @brief Parses the background properties.
89 * @param[in] backgroundProperties The map with the background properties.
90 * @param[out] enabled Whether the background is enabled.
91 * @param[out] colorDefined Whether the background color is defined.
92 * @param[out] color The background color.
94 bool ParseBackgroundProperties(const Property::Map& backgroundProperties,
100 * @brief Sets the underline properties.
102 * @param[in] controller The text's controller.
103 * @param[in] value The values of the underline's properties.
104 * @param[in] type Whether the property is for the default underline or the input underline.
106 * @return Whether the underline properties have been updated.
108 bool SetUnderlineProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type);
111 * @brief Retrieves the underline's properties.
113 * @param[in] controller The text's controller.
114 * @param[out] value The value of the underline's properties.
115 * @param[in] type Whether the property is for the default underline or the input underline.
117 void GetUnderlineProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type);
120 * @brief Sets the shadow properties.
122 * @param[in] controller The text's controller.
123 * @param[in] value The values of the shadow's style.
124 * @param[in] type Whether the property is for the default shadow's style or the input shadow's style.
126 * @return Whether the shadow properties have been updated.
128 bool SetShadowProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type);
131 * @brief Retrieves the shadow's properties.
133 * @param[in] controller The text's controller.
134 * @param[out] value The value of the shadow's properties.
135 * @param[in] type Whether the property is for the default shadow or the input shadow.
137 void GetShadowProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type);
140 * @brief Sets the emboss properties.
142 * @param[in] controller The text's controller.
143 * @param[in] value The values of the emboss's properties.
144 * @param[in] type Whether the property is for the default emboss or the input emboss.
146 * @return Whether the emboss properties have been updated.
148 bool SetEmbossProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type);
151 * @brief Retrieves the emboss's properties.
153 * @param[in] controller The text's controller.
154 * @param[out] value The value of the emboss's properties.
155 * @param[in] type Whether the property is for the default emboss or the input emboss.
157 void GetEmbossProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type);
160 * @brief Sets the outline properties.
162 * @param[in] controller The text's controller.
163 * @param[in] value The values of the outline's properties.
164 * @param[in] type Whether the property is for the default outline or the input outline.
166 * @return Whether the outline properties have been updated.
168 bool SetOutlineProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type);
171 * @brief Retrieves the outline's properties.
173 * @param[in] controller The text's controller.
174 * @param[out] value The value of the outline's properties.
175 * @param[in] type Whether the property is for the default outline or the input outline.
177 void GetOutlineProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type);
180 * @brief Sets the background properties.
182 * @param[in] controller The text's controller.
183 * @param[in] value The values of the background's properties.
184 * @param[in] type Whether the property is for the default background or the input background.
186 * @return Whether the background properties have been updated.
188 bool SetBackgroundProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type);
191 * @brief Retrieves the background's properties.
193 * @param[in] controller The text's controller.
194 * @param[out] value The value of the underline's properties.
195 * @param[in] type Whether the property is for the default background or the input background.
197 void GetBackgroundProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type);
201 } // namespace Toolkit
205 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H