dali-toolkit/internal/text/rendering/styles/underline-helper-functions.h

   1 #ifndef DALI_TOOLKIT_TEXT_RENDERING_STYLES_UNDERLINE_HELPER_FUNCTIONS_H
   2 #define DALI_TOOLKIT_TEXT_RENDERING_STYLES_UNDERLINE_HELPER_FUNCTIONS_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/devel-api/text-abstraction/font-metrics.h>
  23 #include <dali/public-api/common/dali-vector.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/underlined-glyph-run.h>
  27 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 namespace Text
  34 {
  35 /**
  36  * @brief Whether the glyph at index is underlined or not. If true then return iterator to the run containes index.
  37  *
  38  * @param[in] index the index of glyph.
  39  * @param[in] underlineRuns the underline runs.
  40  * @param[out] currentUnderlinedGlyphRunIt the iterator of current underlined glyph run.
  41  *
  42  * @return true if glyph at index is underlined
  43  */
  44 bool IsGlyphUnderlined(GlyphIndex                                 index,
  45                        const Vector<UnderlinedGlyphRun>&          underlineRuns,
  46                        Vector<UnderlinedGlyphRun>::ConstIterator& currentUnderlinedGlyphRunIt);
  47
  48 /**
  49  * @brief Check the current underlined glyph run iterator if not empty and its height is defined then return ts height. Otherwise return the common underline height.
  50  *
  51  * @param[in] underlineRuns the underline runs.
  52  * @param[in] currentUnderlinedGlyphRunIt the iterator of current underlined glyph run.
  53  * @param[in] underlineHeight the common underline height.
  54  *
  55  * @return the determined underline height
  56  */
  57 float GetCurrentUnderlineHeight(const Vector<UnderlinedGlyphRun>&         underlineRuns,
  58                                 Vector<UnderlinedGlyphRun>::ConstIterator currentUnderlinedGlyphRunIt,
  59                                 const float                               underlineHeight);
  60
  61 /**
  62  * @brief Check the current underlined glyph run iterator if not empty and isGlyphUnderlined is true then return its UnderlineProperties. Otherwise return the common underline properties.
  63  *
  64  * @param[in] isGlyphUnderlined whether the glyph is underlined.
  65  * @param[in] underlineRuns the underline runs.
  66  * @param[in] currentUnderlinedGlyphRunIt the iterator of current underlined glyph run.
  67  * @param[in] commonUnderlineProperties the common underline properties.
  68  *
  69  * @return the determined underline properties
  70  */
  71 UnderlineStyleProperties GetCurrentUnderlineProperties(const bool&                               isGlyphUnderlined,
  72                                                        const Vector<UnderlinedGlyphRun>&         underlineRuns,
  73                                                        Vector<UnderlinedGlyphRun>::ConstIterator currentUnderlinedGlyphRunIt,
  74                                                        const UnderlineStyleProperties&           commonUnderlineProperties);
  75
  76 /**
  77  * @brief Fetch and calculate underline Position using font-metrics
  78  *
  79  * @param[in] fontMetrics the font metrics of glyph.
  80  *
  81  * @return the underline position
  82  */
  83 float FetchUnderlinePositionFromFontMetrics(const FontMetrics& fontMetrics);
  84
  85 /**
  86  * @brief Calculate the current underline height using font-metrics and update maximum underline height
  87  *
  88  * @param[in] fontMetrics the font metrics of glyph.
  89  * @param[inout] currentUnderlineHeight the current underline height.
  90  * @param[inout] maxUnderlineHeight the maximum underline height.
  91  *
  92  */
  93 void CalcualteUnderlineHeight(const FontMetrics& fontMetrics, float& currentUnderlineHeight, float& maxUnderlineHeight);
  94
  95 } // namespace Text
  96
  97 } // namespace Toolkit
  98
  99 } // namespace Dali
 100
 101 #endif // DALI_TOOLKIT_TEXT_RENDERING_STYLES_UNDERLINE_HELPER_FUNCTIONS_H