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

   1 #ifndef DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_STRIKETHROUGH_H
   2 #define DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_STRIKETHROUGH_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/text/strikethrough-character-run.h>
  26
  27 namespace Dali
  28 {
  29 namespace Toolkit
  30 {
  31 namespace Text
  32 {
  33 struct Tag;
  34 struct Attribute;
  35 struct StrikethroughCharacterRun;
  36
  37 /**
  38  * @brief Fill the strikethrough character run with the color attribute value.
  39  *
  40  * @param[in] attribute the color attribute.
  41  * @param[out] strikethroughCharacterRun The strikethrough character run
  42  */
  43 void ProcessColorAttribute(const Attribute& attribute, StrikethroughCharacterRun& strikethroughCharacterRun);
  44
  45 /**
  46  * @brief Fill the strikethrough character run with the height attribute value.
  47  *
  48  * @param[in] attribute the height attribute.
  49  * @param[out] strikethroughRun The strikethrough character run
  50  */
  51 void ProcessHeightAttribute(const Attribute& attribute, StrikethroughCharacterRun& strikethroughRun);
  52
  53 /**
  54  * @brief Retrieves the strikethrough run info from the tag and sets it to the strikethrough run.
  55  *
  56  * @param[in] tag The strikethrough tag and its attributes.
  57  * @param[in,out] strikethroughRun The strikethrough run.
  58  */
  59 void ProcessStrikethroughTag(const Tag& tag, StrikethroughCharacterRun& strikethroughRun);
  60
  61 /**
  62  * @brief Override the run's attributes which contained in the previous run. This is to handle the nested tags.
  63  *
  64  * @param[in,out] strikethroughCharacterRun The list of strikethrough character run
  65  */
  66 void OverrideNestedStrikethroughCharacterRuns(Vector<StrikethroughCharacterRun>& strikethroughCharacterRun);
  67
  68 } // namespace Text
  69
  70 } // namespace Toolkit
  71
  72 } // namespace Dali
  73
  74 #endif // DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_STRIKETHROUGH_H