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/devel-api/scripting/scripting.h>
25 #include <dali-toolkit/internal/text/text-controller.h>
26 #include <dali-toolkit/internal/text/text-definitions.h>
41 DEFAULT, ///< The default text effect style.
42 INPUT ///< The input text effect style.
47 * @brief Sets the underline properties.
49 * @param[in] controller The text's controller.
50 * @param[in] value The values of the underline's properties.
51 * @param[in] type Whether the property is for the default underline or the input underline.
53 * @return Whether the underline properties have been updated.
55 bool SetUnderlineProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
58 * @brief Retrieves the underline's properties.
60 * @param[in] controller The text's controller.
61 * @param[out] value The value of the underline's properties.
62 * @param[in] type Whether the property is for the default underline or the input underline.
64 void GetUnderlineProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
67 * @brief Sets the shadow properties.
69 * @param[in] controller The text's controller.
70 * @param[in] value The values of the shadow's style.
71 * @param[in] type Whether the property is for the default shadow's style or the input shadow's style.
73 * @return Whether the shadow properties have been updated.
75 bool SetShadowProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
78 * @brief Retrieves the shadow's properties.
80 * @param[in] controller The text's controller.
81 * @param[out] value The value of the shadow's properties.
82 * @param[in] type Whether the property is for the default shadow or the input shadow.
84 void GetShadowProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
87 * @brief Sets the emboss properties.
89 * @param[in] controller The text's controller.
90 * @param[in] value The values of the emboss's properties.
91 * @param[in] type Whether the property is for the default emboss or the input emboss.
93 * @return Whether the emboss properties have been updated.
95 bool SetEmbossProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
98 * @brief Retrieves the emboss's properties.
100 * @param[in] controller The text's controller.
101 * @param[out] value The value of the emboss's properties.
102 * @param[in] type Whether the property is for the default emboss or the input emboss.
104 void GetEmbossProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
107 * @brief Sets the outline properties.
109 * @param[in] controller The text's controller.
110 * @param[in] value The values of the outline's properties.
111 * @param[in] type Whether the property is for the default outline or the input outline.
113 * @return Whether the outline properties have been updated.
115 bool SetOutlineProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type );
118 * @brief Retrieves the outline's properties.
120 * @param[in] controller The text's controller.
121 * @param[out] value The value of the outline's properties.
122 * @param[in] type Whether the property is for the default outline or the input outline.
124 void GetOutlineProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type );
128 } // namespace Toolkit
132 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H__