1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H__
2 #define __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_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/internal/text/text-controller.h>
37 DEFAULT, ///< The default text effect style.
38 INPUT ///< The input text effect style.
43 * @brief Parses the shadow properties.
45 * @param[out] colorDefined Whether the shadow's color is defined.
46 * @param[out] color The shadow's color.
47 * @param[out] offsetDefined Whether the shadow's offset is defined.
48 * @param[out] offset The shadow's offset.
50 bool ParseProperties( const std::string& shadowProperties,
57 * @brief Parses the underline properties.
59 * @param[out] enabled Whether the underline is enabled.
60 * @param[out] colorDefined Whether the underline's color is defined.
61 * @param[out] color The underline's color.
62 * @param[out] heightDefined Whether the underline's height is defined.
63 * @param[out] height The underline's height.
65 bool ParseProperties( const std::string& underlineProperties,
73 * @brief Sets the underline properties.
75 * @param[in] controller The text's controller.
76 * @param[in] value The values of the underline's properties.
77 * @param[in] type Whether the property is for the default underline or the input underline.
79 * @return Whether the underline properties have been updated.
81 bool SetUnderlineProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
84 * @brief Retrieves the underline's properties.
86 * @param[in] controller The text's controller.
87 * @param[out] value The value of the underline's properties.
88 * @param[in] type Whether the property is for the default underline or the input underline.
90 void GetUnderlineProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
93 * @brief Sets the shadow properties.
95 * @param[in] controller The text's controller.
96 * @param[in] value The values of the shadow's style.
97 * @param[in] type Whether the property is for the default shadow's style or the input shadow's style.
99 * @return Whether the shadow properties have been updated.
101 bool SetShadowProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
104 * @brief Retrieves the shadow's properties.
106 * @param[in] controller The text's controller.
107 * @param[out] value The value of the shadow's properties.
108 * @param[in] type Whether the property is for the default shadow or the input shadow.
110 void GetShadowProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
113 * @brief Sets the emboss properties.
115 * @param[in] controller The text's controller.
116 * @param[in] value The values of the emboss's properties.
117 * @param[in] type Whether the property is for the default emboss or the input emboss.
119 * @return Whether the emboss properties have been updated.
121 bool SetEmbossProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
124 * @brief Retrieves the emboss's properties.
126 * @param[in] controller The text's controller.
127 * @param[out] value The value of the emboss's properties.
128 * @param[in] type Whether the property is for the default emboss or the input emboss.
130 void GetEmbossProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
133 * @brief Sets the outline properties.
135 * @param[in] controller The text's controller.
136 * @param[in] value The values of the outline's properties.
137 * @param[in] type Whether the property is for the default outline or the input outline.
139 * @return Whether the outline properties have been updated.
141 bool SetOutlineProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
144 * @brief Retrieves the outline's properties.
146 * @param[in] controller The text's controller.
147 * @param[out] value The value of the outline's properties.
148 * @param[in] type Whether the property is for the default outline or the input outline.
150 void GetOutlineProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
154 } // namespace Toolkit
158 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H__