dali-toolkit/internal/text/markup-processor-span.h

   1 #ifndef DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_SPAN_H
   2 #define DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_SPAN_H
   3
   4 /*
   5  * Copyright (c) 2022 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 namespace Dali
  22 {
  23 namespace Toolkit
  24 {
  25 namespace Text
  26 {
  27 struct Tag;
  28 struct MarkupProcessData;
  29
  30 /**
  31  * @brief process the span from the tag and process all styles in it.
  32  *
  33  * @param[in] tag The span tag and its attributes.
  34  * @param[out] colorRun the color run to be filled.
  35  * @param[out] fontRun the font run to be filled.
  36  * @param[out] underlinedCharacterRun the underlined character run to be filled.
  37  * @param[out] backgroundColorRun the background color run to be filled.
  38  * @param[out] strikethroughRun the strikethrough run to be filled.
  39  * @param[out] characterSpacingCharacterRun the character-spacing run to be filled.
  40  * @param[out] isColorDefined if the span has color defined.
  41  * @param[out] isFontDefined if the span has font defined.
  42  * @param[out] isUnderlinedCharacterDefined if the span has underlined-character defined.
  43  * @param[out] isBackgroundColorDefined if the span has background color defined.
  44  * @param[out] isStrikethroughDefined if the span has strikethrough defined.
  45  * @param[out] isCharacterSpacingDefined if the span has character-spacing defined.
  46  */
  47 void ProcessSpanTag(const Tag&                    tag,
  48                     ColorRun&                     colorRun,
  49                     FontDescriptionRun&           fontRun,
  50                     UnderlinedCharacterRun&       underlinedCharacterRun,
  51                     ColorRun&                     backgroundColorRun,
  52                     StrikethroughCharacterRun&    strikethroughRun,
  53                     CharacterSpacingCharacterRun& characterSpacingCharacterRun,
  54                     bool&                         isColorDefined,
  55                     bool&                         isFontDefined,
  56                     bool&                         isUnderlinedCharacterDefined,
  57                     bool&                         isBackgroundColorDefined,
  58                     bool&                         isStrikethroughDefined,
  59                     bool&                         isCharacterSpacingDefined);
  60
  61 } // namespace Text
  62
  63 } // namespace Toolkit
  64
  65 } // namespace Dali
  66
  67 #endif // DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_SPAN_H