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 #include <dali-toolkit/internal/text/font-description-run.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Text
  36 {
  37
  38 /**
  39  * @brief Keeps the plain text and references to vectors from the model which stores runs with text styles.
  40  */
  41 struct MarkupProcessData
  42 {
  43 MarkupProcessData( Vector<ColorRun>& colorRuns,
  44                    Vector<FontDescriptionRun>& fontRuns )
  45   : colorRuns( colorRuns ),
  46     fontRuns( fontRuns ),
  47     markupProcessedText()
  48   {}
  49
  50   Vector<ColorRun>&           colorRuns;           ///< The color runs.
  51   Vector<FontDescriptionRun>& fontRuns;            ///< The font description runs.
  52
  53   std::string                 markupProcessedText; ///< The mark-up string.
  54 };
  55
  56 /**
  57  * @brief Process the mark-up string.
  58  *
  59  * @param[in] markupString The mark-up string.
  60  * @param[out] markupProcessData The plain text and the style.
  61  */
  62 void ProcessMarkupString( const std::string& markupString, MarkupProcessData& markupProcessData );
  63
  64 } // namespace Text
  65
  66 } // namespace Toolkit
  67
  68 } // namespace Dali
  69
  70 #endif // __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_H__