X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-effects-style.h;h=a1b7bea2580ac37ba2897c16442b2660429f9d3c;hp=e2b0f0c39edf30d0ab4204e6a59d49511ef1cbfd;hb=3a6adcbec75784b051cb9ebaf204d72b553ea355;hpb=70d097e215f27a8b6602d4a41e037567ea0c2a04 diff --git a/dali-toolkit/internal/text/text-effects-style.h b/dali-toolkit/internal/text/text-effects-style.h old mode 100755 new mode 100644 index e2b0f0c..a1b7bea --- a/dali-toolkit/internal/text/text-effects-style.h +++ b/dali-toolkit/internal/text/text-effects-style.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H__ -#define __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H__ +#ifndef DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H +#define DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,20 +23,17 @@ namespace Dali { - namespace Toolkit { - namespace Text { - namespace EffectStyle { - enum Type - { - DEFAULT, ///< The default text effect style. - INPUT ///< The input text effect style. - }; +enum Type +{ + DEFAULT, ///< The default text effect style. + INPUT ///< The input text effect style. +}; }; /** @@ -48,11 +45,11 @@ namespace EffectStyle * @param[out] offsetDefined Whether the shadow's offset is defined. * @param[out] offset The shadow's offset. */ -bool ParseShadowProperties( const Property::Map& shadowProperties, - bool& colorDefined, - Vector4& color, - bool& offsetDefined, - Vector2& offset ); +bool ParseShadowProperties(const Property::Map& shadowProperties, + bool& colorDefined, + Vector4& color, + bool& offsetDefined, + Vector2& offset); /** * @brief Parses the underline properties. @@ -63,13 +60,22 @@ bool ParseShadowProperties( const Property::Map& shadowProperties, * @param[out] color The underline's color. * @param[out] heightDefined Whether the underline's height is defined. * @param[out] height The underline's height. + * @param[out] type The underline's type; DASHED, DOUBLE, etc. Default is a solid underline. + * @param[out] dashWidth The dashed underline's width. + * @param[out] dashGap The dashed underline's gap. */ -bool ParseUnderlineProperties( const Property::Map& underlineProperties, - bool& enabled, - bool& colorDefined, - Vector4& color, - bool& heightDefined, - float& height ); +bool ParseUnderlineProperties(const Property::Map& underlineProperties, + bool& enabled, + bool& colorDefined, + Vector4& color, + bool& heightDefined, + float& height, + bool& typeDefined, + Text::Underline::Type& type, + bool& widthDefined, + float& dashWidth, + bool& dashGapDefined, + float& dashGap); /** * @brief Parses the outline properties. @@ -80,11 +86,41 @@ bool ParseUnderlineProperties( const Property::Map& underlineProperties, * @param[out] widthDefined Whether the outline's width is defined. * @param[out] width The outline's width. */ -bool ParseOutlineProperties( const Property::Map& outlineProperties, - bool& colorDefined, - Vector4& color, - bool& widthDefined, - unsigned int& width ); +bool ParseOutlineProperties(const Property::Map& outlineProperties, + bool& colorDefined, + Vector4& color, + bool& widthDefined, + unsigned int& width); + +/** + * @brief Parses the background properties. + * + * @param[in] backgroundProperties The map with the background properties. + * @param[out] enabled Whether the background is enabled. + * @param[out] colorDefined Whether the background color is defined. + * @param[out] color The background color. + */ +bool ParseBackgroundProperties(const Property::Map& backgroundProperties, + bool& enabled, + bool& colorDefined, + Vector4& color); + +/** + * @brief Parses the strikethrough properties. + * + * @param[in] strikethroughProperties The map with the strikethrough properties. + * @param[out] enabled Whether the strikethrough is enabled. + * @param[out] colorDefined Whether the strikethrough's color is defined. + * @param[out] color The strikethrough's color. + * @param[out] heightDefined Whether the strikethrough's height is defined. + * @param[out] height The strikethrough's height. + */ +bool ParseStrikethroughProperties(const Property::Map& strikethroughProperties, + bool& enabled, + bool& colorDefined, + Vector4& color, + bool& heightDefined, + float& height); /** * @brief Sets the underline properties. @@ -95,7 +131,18 @@ bool ParseOutlineProperties( const Property::Map& outlineProperties, * * @return Whether the underline properties have been updated. */ -bool SetUnderlineProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type ); +bool SetUnderlineProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type); + +/** + * @brief Sets the strikethrough properties. + * + * @param[in] controller The text's controller. + * @param[in] value The values of the strikethrough's properties. + * @param[in] type Whether the property is for the default strikethrough or the input strikethrough. + * + * @return Whether the strikethrough properties have been updated. + */ +bool SetStrikethroughProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type); /** * @brief Retrieves the underline's properties. @@ -104,7 +151,16 @@ bool SetUnderlineProperties( ControllerPtr controller, const Property::Value& va * @param[out] value The value of the underline's properties. * @param[in] type Whether the property is for the default underline or the input underline. */ -void GetUnderlineProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type ); +void GetUnderlineProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type); + +/** + * @brief Retrieves the strikethrough's properties. + * + * @param[in] controller The text's controller. + * @param[out] value The value of the strikethrough's properties. + * @param[in] type Whether the property is for the default strikethrough or the input strikethrough. + */ +void GetStrikethroughProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type); /** * @brief Sets the shadow properties. @@ -115,7 +171,7 @@ void GetUnderlineProperties( ControllerPtr controller, Property::Value& value, E * * @return Whether the shadow properties have been updated. */ -bool SetShadowProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type ); +bool SetShadowProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type); /** * @brief Retrieves the shadow's properties. @@ -124,7 +180,7 @@ bool SetShadowProperties( ControllerPtr controller, const Property::Value& value * @param[out] value The value of the shadow's properties. * @param[in] type Whether the property is for the default shadow or the input shadow. */ -void GetShadowProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type ); +void GetShadowProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type); /** * @brief Sets the emboss properties. @@ -135,7 +191,7 @@ void GetShadowProperties( ControllerPtr controller, Property::Value& value, Effe * * @return Whether the emboss properties have been updated. */ -bool SetEmbossProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type ); +bool SetEmbossProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type); /** * @brief Retrieves the emboss's properties. @@ -144,7 +200,7 @@ bool SetEmbossProperties( ControllerPtr controller, const Property::Value& value * @param[out] value The value of the emboss's properties. * @param[in] type Whether the property is for the default emboss or the input emboss. */ -void GetEmbossProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type ); +void GetEmbossProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type); /** * @brief Sets the outline properties. @@ -155,7 +211,7 @@ void GetEmbossProperties( ControllerPtr controller, Property::Value& value, Effe * * @return Whether the outline properties have been updated. */ -bool SetOutlineProperties( ControllerPtr controller, const Property::Value& value, EffectStyle::Type type ); +bool SetOutlineProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type); /** * @brief Retrieves the outline's properties. @@ -164,7 +220,27 @@ bool SetOutlineProperties( ControllerPtr controller, const Property::Value& valu * @param[out] value The value of the outline's properties. * @param[in] type Whether the property is for the default outline or the input outline. */ -void GetOutlineProperties( ControllerPtr controller, Property::Value& value, EffectStyle::Type type ); +void GetOutlineProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type); + +/** + * @brief Sets the background properties. + * + * @param[in] controller The text's controller. + * @param[in] value The values of the background's properties. + * @param[in] type Whether the property is for the default background or the input background. + * + * @return Whether the background properties have been updated. + */ +bool SetBackgroundProperties(ControllerPtr controller, const Property::Value& value, EffectStyle::Type type); + +/** + * @brief Retrieves the background's properties. + * + * @param[in] controller The text's controller. + * @param[out] value The value of the underline's properties. + * @param[in] type Whether the property is for the default background or the input background. + */ +void GetBackgroundProperties(ControllerPtr controller, Property::Value& value, EffectStyle::Type type); } // namespace Text @@ -172,4 +248,4 @@ void GetOutlineProperties( ControllerPtr controller, Property::Value& value, Eff } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H__ +#endif // DALI_TOOLKIT_INTERNAL_TEXT_EFFECTS_STYLE_H