[dali_1.1.15] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / markup-processor.h
1 #ifndef __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H__
2 #define __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H__
3
4 /*
5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/common/dali-vector.h>
23 #include <string>
24
25 // INTERNAL INCLUDES
26 #include <dali-toolkit/internal/text/color-run.h>
27
28 namespace Dali
29 {
30
31 namespace Toolkit
32 {
33
34 namespace Text
35 {
36
37 /**
38  * @brief Keeps the plain text and references to vectors from the model which stores runs with text styles.
39  */
40 struct MarkupProcessData
41 {
42   MarkupProcessData( Vector<ColorRun>& colorRuns )
43   : colorRuns( colorRuns ),
44     markupProcessedText()
45   {}
46
47   Vector<ColorRun>&           colorRuns;
48
49   std::string                 markupProcessedText;
50 };
51
52 /**
53  * @brief Process the mark-up string.
54  *
55  * @param[in] markupString The mark-up string.
56  * @param[out] markupProcessData The plain text and the style.
57  */
58 void ProcessMarkupString( const std::string& markupString, MarkupProcessData& markupProcessData );
59
60 } // namespace Text
61
62 } // namespace Toolkit
63
64 } // namespace Dali
65
66 #endif // __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H__