1 #ifndef DALI_TOOLKIT_TEXT_RENDERING_STYLES_STRIKETHROUGH_HELPER_FUNCTIONS_H
2 #define DALI_TOOLKIT_TEXT_RENDERING_STYLES_STRIKETHROUGH_HELPER_FUNCTIONS_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/devel-api/text-abstraction/font-metrics.h>
23 #include <dali/public-api/common/dali-vector.h>
26 #include <dali-toolkit/internal/text/strikethrough-glyph-run.h>
27 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
36 * @brief Whether the glyph at index is strikethrough or not. If true then return iterator to the run containes index.
38 * @param[in] index the index of glyph.
39 * @param[in] strikethroughRuns the strikethrough runs.
40 * @param[out] currentStrikethroughGlyphRunIt the iterator of current strikethrough glyph run.
42 * @return true if glyph at index is strikethrough
44 bool IsGlyphStrikethrough(GlyphIndex index,
45 const Vector<StrikethroughGlyphRun>& strikethroughRuns,
46 Vector<StrikethroughGlyphRun>::ConstIterator& currentStrikethroughGlyphRunIt);
49 * @brief Check the current strikethrough glyph run iterator if not empty and isGlyphStrikethrough is true then return its StrikethroughProperties. Otherwise return the common strikethrough properties.
51 * @param[in] index the index of glyph.
52 * @param[in] isGlyphStrikethrough whether the glyph is strikethrough.
53 * @param[in] strikethroughRuns the strikethrough runs.
54 * @param[in] currentStrikethroughGlyphRunIt the iterator of current strikethrough glyph run.
55 * @param[in] commonStrikethroughProperties the common strikethrough properties.
57 * @return the determined strikethrough properties
59 StrikethroughStyleProperties GetCurrentStrikethroughProperties(GlyphIndex index,
60 const bool& isGlyphStrikethrough,
61 const Vector<StrikethroughGlyphRun>& strikethroughRuns,
62 Vector<StrikethroughGlyphRun>::ConstIterator& currentStrikethroughGlyphRunIt,
63 const StrikethroughStyleProperties& commonStrikethroughProperties);
66 * @brief Calculate the current strikethrough height and update maximum strikethrough height
68 * @param[inout] currentStrikethroughHeight the current strikethrough height.
69 * @param[inout] maxStrikethroughHeight the maximum strikethrough height.
72 void CalcualteStrikethroughHeight(float& currentStrikethroughHeight, float& maxStrikethroughHeight);
76 } // namespace Toolkit
80 #endif // DALI_TOOLKIT_TEXT_RENDERING_STYLES_STRIKETHROUGH_HELPER_FUNCTIONS_H