capi/dali-toolkit/public-api/markup-processor/markup-processor.h

   1 #ifndef __DALI_TOOLKIT_MARKUP_PROCESSOR_H__
   2 #define __DALI_TOOLKIT_MARKUP_PROCESSOR_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_MARKUP_PROCESSOR_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/common/vector-wrapper.h>
  28
  29 #include <dali/public-api/text/text.h>
  30 #include <dali/public-api/text/text-style.h>
  31
  32 namespace Dali DALI_IMPORT_API
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 /**
  39  * @brief Markup Processor enumerations, structures and functions.
  40  *
  41  * See the \link markup-processor Markup Processor \endlink page in the Programming Guide.
  42  */
  43 namespace MarkupProcessor
  44 {
  45
  46 /**
  47  * @brief A pair of Dali::Text and Dali::TextStyle.
  48  *
  49  * mText is a Dali::Text object which can store text in different
  50  * languages. mStyle is a Dali::TextStyle object which can store all
  51  * text styling features provided by Dali::TextActor.
  52  */
  53 struct StyledText
  54 {
  55   /**
  56    * @brief Constructor
  57    */
  58   StyledText()
  59   : mText(),
  60     mStyle()
  61   {
  62   }
  63
  64   /**
  65    * @brief Constructor
  66    *
  67    * @param[in] text  A Text object
  68    * @param[in] style A Style object
  69    */
  70   StyledText( const Text& text, const TextStyle& style )
  71   : mText( text ),
  72     mStyle( style )
  73   {
  74   }
  75
  76   Text      mText;  ///< Store text. Could be a mix of different languages.
  77   TextStyle mStyle; ///< Store the style for the text.
  78 };
  79
  80 /**
  81  * @brief This type defines a vector of StyledText.
  82  *
  83  * It's used to store a whole text with its style and set it to a
  84  * Dali::Toolkit::TextView. It could be used in other UI
  85  * Dali::Toolkit::Control classes which need text with style.
  86  */
  87 typedef std::vector<StyledText> StyledTextArray;
  88
  89 /**
  90  * @brief Creates a text array with its style from a markup string.
  91  *
  92  * Refer to the \link markup-processor Markup Processor \endlink page in the Programming Guide
  93  * to see the html-ish sintax and some examples.
  94  *
  95  * @param [in] markupString A string with style.
  96  * @param [out] styledTextArray A text array split in characters, each one with its style.
  97  * @param [in] scanForMarkup If true will check to see string contains markup, else assume not
  98  */
  99 void GetStyledTextArray( const std::string& markupString, StyledTextArray& styledTextArray, bool scanForMarkup );
 100
 101 /**
 102  * @brief Creates a plain string from a text array (thus stripping the style meta).
 103  *
 104  * @param [in] styledTextArray A text array split in characters, each one with its style.
 105  * @param [out] plainString A string without style.
 106  */
 107 void GetPlainString( const StyledTextArray& styledTextArray, std::string& plainString );
 108
 109 /**
 110  * @brief Creates a markup string from a text array with its style.
 111  *
 112  * @param [in] styledTextArray A text array split in characters, each one with its style.
 113  * @param [out] markupString A string with style.
 114  */
 115 void GetMarkupString( const StyledTextArray& styledTextArray, std::string& markupString );
 116
 117 /**
 118  * @brief Sets a text style to the given text.
 119  *
 120  * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
 121  * @param[in,out] styledTextArray The given text
 122  * @param[in] style The given style
 123  * @param[in] mask The bit mask.
 124  */
 125 void SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
 126
 127 /**
 128  * @brief Sets a text style to the given text.
 129  *
 130  * @see SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask )
 131  *
 132  * @param[in] text The input text.
 133  * @param[out] styledTextArray The input text with the given style.
 134  * @param[in] style The given style.
 135  * @param[in] mask The bit mask.
 136  */
 137 void SetTextStyle( const Text& text, StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
 138
 139 /**
 140  * @brief Sets a text style to a range of characters of the given text.
 141  *
 142  * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
 143  * @param[in,out] styledTextArray The given text
 144  * @param[in] style The given style
 145  * @param[in] mask The bit mask.
 146  * @param[in] begin The first character of the range.
 147  * @param[in] end The last character of the range.
 148  * @note It will assert if begin or end are out of range, or if begin > end.
 149  */
 150 void SetTextStyleToRange( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask, std::size_t begin, std::size_t end );
 151
 152 } // namespace MarkupProcessor
 153
 154 } // namespace Toolkit
 155
 156 } // namespace Dali
 157
 158 /**
 159  * @}
 160  */
 161 #endif // __DALI_TOOLKIT_MARKUP_PROCESSOR_H__