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>
24 #include <dali/public-api/text/text.h>
25 #include <dali/public-api/text/text-style.h>
27 namespace Dali DALI_IMPORT_API
34 * @brief Markup Processor enumerations, structures and functions.
36 * See the \link markup-processor Markup Processor \endlink page in the Programming Guide.
38 namespace MarkupProcessor
42 * @brief A pair of Dali::Text and Dali::TextStyle.
44 * mText is a Dali::Text object which can store text in different
45 * languages. mStyle is a Dali::TextStyle object which can store all
46 * text styling features provided by Dali::TextActor.
62 * @param[in] text A Text object
63 * @param[in] style A Style object
65 StyledText( const Text& text, const TextStyle& style )
71 Text mText; ///< Store text. Could be a mix of different languages.
72 TextStyle mStyle; ///< Store the style for the text.
76 * @brief This type defines a vector of StyledText.
78 * It's used to store a whole text with its style and set it to a
79 * Dali::Toolkit::TextView. It could be used in other UI
80 * Dali::Toolkit::Control classes which need text with style.
82 typedef std::vector<StyledText> StyledTextArray;
85 * @brief Creates a text array with its style from a markup string.
87 * Refer to the \link markup-processor Markup Processor \endlink page in the Programming Guide
88 * to see the html-ish sintax and some examples.
90 * @param [in] markupString A string with style.
91 * @param [out] styledTextArray A text array split in characters, each one with its style.
92 * @param [in] scanForMarkup If true will check to see string contains markup, else assume not
94 void GetStyledTextArray( const std::string& markupString, StyledTextArray& styledTextArray, bool scanForMarkup );
97 * @brief Creates a plain string from a text array (thus stripping the style meta).
99 * @param [in] styledTextArray A text array split in characters, each one with its style.
100 * @param [out] plainString A string without style.
102 void GetPlainString( const StyledTextArray& styledTextArray, std::string& plainString );
105 * @brief Creates a markup string from a text array with its style.
107 * @param [in] styledTextArray A text array split in characters, each one with its style.
108 * @param [out] markupString A string with style.
110 void GetMarkupString( const StyledTextArray& styledTextArray, std::string& markupString );
113 * @brief Sets a text style to the given text.
115 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
116 * @param[in,out] styledTextArray The given text
117 * @param[in] style The given style
118 * @param[in] mask The bit mask.
120 void SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
123 * @brief Sets a text style to the given text.
125 * @see SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask )
127 * @param[in] text The input text.
128 * @param[out] styledTextArray The input text with the given style.
129 * @param[in] style The given style.
130 * @param[in] mask The bit mask.
132 void SetTextStyle( const Text& text, StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
135 * @brief Sets a text style to a range of characters of the given text.
137 * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
138 * @param[in,out] styledTextArray The given text
139 * @param[in] style The given style
140 * @param[in] mask The bit mask.
141 * @param[in] begin The first character of the range.
142 * @param[in] end The last character of the range.
143 * @note It will assert if begin or end are out of range, or if begin > end.
145 void SetTextStyleToRange( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask, std::size_t begin, std::size_t end );
147 } // namespace MarkupProcessor
149 } // namespace Toolkit
153 #endif // __DALI_TOOLKIT_MARKUP_PROCESSOR_H__