1 #ifndef __DALI_TOOLKIT_MARKUP_PROCESSOR_H__
2 #define __DALI_TOOLKIT_MARKUP_PROCESSOR_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE
26 #include <dali/public-api/common/vector-wrapper.h>
28 #include <dali/public-api/text/text.h>
29 #include <dali/public-api/text/text-style.h>
31 namespace Dali DALI_IMPORT_API
38 * @brief Markup Processor enumerations, structures and functions.
40 namespace MarkupProcessor
44 * @brief A pair of Dali::Text and Dali::TextStyle.
46 * mText is a Dali::Text object which can store text in different
47 * languages. mStyle is a Dali::TextStyle object which can store all
48 * text styling features provided by Dali::TextActor.
64 * @param[in] text A Text object
65 * @param[in] style A Style object
67 StyledText( const Text& text, const TextStyle& style )
73 Text mText; ///< Store text. Could be a mix of different languages.
74 TextStyle mStyle; ///< Store the style for the text.
78 * @brief This type defines a vector of StyledText.
80 * It's used to store a whole text with its style and set it to a
81 * Dali::Toolkit::TextView. It could be used in other UI
82 * Dali::Toolkit::Control classes which need text with style.
84 typedef std::vector<StyledText> StyledTextArray;
87 * @brief Creates a text array with its style from a markup string.
89 * The syntax of a markup string is html-ish. It contains open, close
90 * and empty tags and some of them can contain parameters.
93 * <li>\e \<b\>\</b\> Bold text.
94 * <li>\e \<i\>\</i\> Italic text.
95 * <li>\e \<u\>\</u\> Underlined text.
96 * <li>\e \<br /\> New line.
97 * <li>\e \<font\>\</font\> Specifies font properties:
99 * <li> \e face Font face.
100 * <li> \e size Font size.
101 * <li> \e color Font color.
103 * <li>\e \<shadow\>\</shadow\> Specifies shadow properties @see Dali::TextActor::SetShadow().
105 * <li> \e paramx X offset.
106 * <li> \e paramy Y offset.
107 * <li> \e color Shadow color.
109 * <li>\e \<glow\>\</glow\> Specifies glow properties @see Dali::TextActor::SetGlow().
111 * <li> \e param Glow around the text.
112 * <li> \e color Glow color.
114 * <li>\e \<outline\>\</outline\> Specifies outline properties @see Dali::TextActor::SetOutline().
116 * <li> \e paramx X thickness.
117 * <li> \e paramy Y thickness.
118 * <li> \e color Outline color.
120 * <li>\e \<smooth\>\</smooth\> Specify the smooth edge @see Dali::TextActor::SetSmoothEdge().
122 * <li> \e paramx Distance field.
126 * It transform any pair CR+LF new line characters into a single LF new line character.
127 * @param [in] markupString A string with style.
128 * @param [out] styledTextArray A text array split in characters, each one with its style.
129 * @param [in] scanForMarkup If true will check to see string contains markup, else assume not
131 void GetStyledTextArray( const std::string& markupString, StyledTextArray& styledTextArray, bool scanForMarkup );
134 * @brief Creates a plain string from a text array (thus stripping the style meta).
136 * @param [in] styledTextArray A text array split in characters, each one with its style.
137 * @param [out] plainString A string without style.
139 void GetPlainString( const StyledTextArray& styledTextArray, std::string& plainString );
142 * @brief Creates a markup string from a text array with its style.
144 * @param [in] styledTextArray A text array split in characters, each one with its style.
145 * @param [out] markupString A string with style.
147 void GetMarkupString( const StyledTextArray& styledTextArray, std::string& markupString );
150 * @brief Sets a text style to the given text.
152 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
153 * @param[in,out] styledTextArray The given text
154 * @param[in] style The given style
155 * @param[in] mask The bit mask.
157 void SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, const TextStyle::Mask mask = TextStyle::ALL );
160 * @see SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, StyleMask mask )
161 * @param[in] text The input text.
162 * @param[out] styledTextArray The input text with the given style.
163 * @param[in] style The given style.
164 * @param[in] mask The bit mask.
166 void SetTextStyle( const Text& text, StyledTextArray& styledTextArray, const TextStyle& style, const TextStyle::Mask mask = TextStyle::ALL );
169 * @brief Sets a text style to a range of characters of the given text.
171 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
172 * @param[in,out] styledTextArray The given text
173 * @param[in] style The given style
174 * @param[in] mask The bit mask.
175 * @param[in] begin The first character of the range.
176 * @param[in] end The last character of the range.
177 * @note It will assert if begin or end are out of range, or if begin > end.
179 void SetTextStyleToRange( StyledTextArray& styledTextArray, const TextStyle& style, const TextStyle::Mask mask, const std::size_t begin, const std::size_t end );
181 } // namespace MarkupProcessor
183 } // namespace Toolkit
190 #endif // __DALI_TOOLKIT_MARKUP_PROCESSOR_H__