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 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/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/text/text.h>
24 #include <dali/public-api/text/text-style.h>
33 * @brief Markup Processor enumerations, structures and functions.
35 * See the \link markup-processor Markup Processor \endlink page in the Programming Guide.
37 namespace MarkupProcessor
41 * @brief A pair of Dali::Text and Dali::TextStyle.
43 * mText is a Dali::Text object which can store text in different
44 * languages. mStyle is a Dali::TextStyle object which can store all
45 * text styling features provided by Dali::TextActor.
61 * @param[in] text A Text object
62 * @param[in] style A Style object
64 StyledText( const Text& text, const TextStyle& style )
70 Text mText; ///< Store text. Could be a mix of different languages.
71 TextStyle mStyle; ///< Store the style for the text.
75 * @brief This type defines a vector of StyledText.
77 * It's used to store a whole text with its style and set it to a
78 * Dali::Toolkit::TextView. It could be used in other UI
79 * Dali::Toolkit::Control classes which need text with style.
81 typedef std::vector<StyledText> StyledTextArray;
84 * @brief Creates a text array with its style from a markup string.
86 * Refer to the \link markup-processor Markup Processor \endlink page in the Programming Guide
87 * to see the html-ish sintax and some examples.
89 * @param [in] markupString A string with style.
90 * @param [out] styledTextArray A text array split in characters, each one with its style.
91 * @param [in] scanForMarkup If true will check to see string contains markup, else assume not
93 DALI_IMPORT_API void GetStyledTextArray( const std::string& markupString, StyledTextArray& styledTextArray, bool scanForMarkup );
96 * @brief Creates a plain string from a text array (thus stripping the style meta).
98 * @param [in] styledTextArray A text array split in characters, each one with its style.
99 * @param [out] plainString A string without style.
101 DALI_IMPORT_API void GetPlainString( const StyledTextArray& styledTextArray, std::string& plainString );
104 * @brief Creates a markup string from a text array with its style.
106 * @param [in] styledTextArray A text array split in characters, each one with its style.
107 * @param [out] markupString A string with style.
109 DALI_IMPORT_API void GetMarkupString( const StyledTextArray& styledTextArray, std::string& markupString );
112 * @brief Sets a text style to the given text.
114 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
115 * @param[in,out] styledTextArray The given text
116 * @param[in] style The given style
117 * @param[in] mask The bit mask.
119 DALI_IMPORT_API void SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
122 * @brief Sets a text style to the given text.
124 * @see SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask )
126 * @param[in] text The input text.
127 * @param[out] styledTextArray The input text with the given style.
128 * @param[in] style The given style.
129 * @param[in] mask The bit mask.
131 DALI_IMPORT_API void SetTextStyle( const Text& text, StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
134 * @brief Sets a text style to a range of characters of the given text.
136 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
137 * @param[in,out] styledTextArray The given text
138 * @param[in] style The given style
139 * @param[in] mask The bit mask.
140 * @param[in] begin The first character of the range.
141 * @param[in] end The last character of the range.
142 * @note It will assert if begin or end are out of range, or if begin > end.
144 DALI_IMPORT_API void SetTextStyleToRange( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask, std::size_t begin, std::size_t end );
146 } // namespace MarkupProcessor
148 } // namespace Toolkit
152 #endif // __DALI_TOOLKIT_MARKUP_PROCESSOR_H__