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