1 #ifndef DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H
5 * Copyright (c) 2021 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-toolkit/internal/text/text-definitions.h>
36 * @brief Abstract interface to provide the information necessary to display text.
39 * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction
40 * - The visual position of each glyph within the layout
41 * - A window into the text layout e.g. which page of a document to view
52 * @brief Virtual destructor
54 virtual ~ViewInterface();
57 * @brief Retrieves the target size of the UI control.
59 * @return The control's size.
61 virtual const Vector2& GetControlSize() const = 0;
64 * @brief Retrieves the text's layout size.
66 * @return The text's size. Note that this may be larger than the control size,
67 * in the case where text is scrolling/clipped.
69 virtual const Vector2& GetLayoutSize() const = 0;
72 * Retrieves the number of glyphs.
74 * @return The number of glyphs.
76 virtual Length GetNumberOfGlyphs() const = 0;
79 * @brief Retrieves glyphs and positions in the given buffers.
81 * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions.
82 * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
84 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
85 * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied.
86 * @param[out] minLineOffset The minimum line offset.
87 * @param[in] glyphIndex Index to the first glyph.
88 * @param[in] numberOfGlyphs Number of glyphs to be copied.
90 * @return The number of glyphs.
92 virtual Length GetGlyphs(GlyphInfo* glyphs,
93 Vector2* glyphPositions,
95 GlyphIndex glyphIndex,
96 Length numberOfGlyphs) const = 0;
99 * @brief Retrieves the vector of colors.
101 * @return Pointer to the vector of colors.
103 virtual const Vector4* const GetColors() const = 0;
106 * @brief Retrieves the vector of indices to the vector of colors.
108 * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
110 virtual const ColorIndex* const GetColorIndices() const = 0;
113 * @brief Retrieves the vector of background colors.
115 * @return Pointer to the vector of background colors.
117 virtual const Vector4* const GetBackgroundColors() const = 0;
120 * @brief Retrieves the vector of indices to the vector of background colors.
122 * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
124 virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
127 * @brief checks if there is background colors set using markup.
129 * @return boolean if there is background colors set using markup .
131 virtual bool const IsMarkupBackgroundColorSet() const = 0;
134 * @brief Retrieves the text color
136 * @return The text color
138 virtual const Vector4& GetTextColor() const = 0;
141 * @brief Retrieves the shadow offset, 0 indicates no shadow.
143 * @return The shadow offset.
145 virtual const Vector2& GetShadowOffset() const = 0;
148 * @brief Retrieves the shadow color.
150 * @return The shadow color.
152 virtual const Vector4& GetShadowColor() const = 0;
155 * @brief Retrieves the underline color.
157 * @return The underline color.
159 virtual const Vector4& GetUnderlineColor() const = 0;
162 * @brief Returns whether underline is enabled or not.
164 * @return The underline state.
166 virtual bool IsUnderlineEnabled() const = 0;
169 * @brief Returns the hyphens glyph info.
171 * @return hyphens glyph info.
173 virtual const GlyphInfo* GetHyphens() const = 0;
176 * @brief Returns the indices of the hyphen in the text.
178 * @return the hyphen indices.
180 virtual const Length* GetHyphenIndices() const = 0;
183 * @brief Returns number of hyphens to add in text.
185 * @return number of hyphens.
187 virtual Length GetHyphensCount() const = 0;
189 * @brief Retrieves the underline height override
191 * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
193 virtual float GetUnderlineHeight() const = 0;
196 * @brief Retrieves the number of underline runs.
198 * @return The number of underline runs.
200 virtual Length GetNumberOfUnderlineRuns() const = 0;
203 * @brief Retrieves the underline runs.
205 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
206 * @param[in] index Index of the first underline run to be copied.
207 * @param[in] numberOfRuns Number of underline runs to be copied.
209 virtual void GetUnderlineRuns(GlyphRun* underlineRuns,
210 UnderlineRunIndex index,
211 Length numberOfRuns) const = 0;
214 * @brief Retrieve the outline color.
216 * @return The outline color.
218 virtual const Vector4& GetOutlineColor() const = 0;
221 * @brief Retrieves the width of an outline
223 * @return The width of the outline.
225 virtual uint16_t GetOutlineWidth() const = 0;
230 } // namespace Toolkit
234 #endif // DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H