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/devel-api/text/text-enumerations-devel.h>
23 #include <dali-toolkit/internal/text/text-definitions.h>
37 * @brief Abstract interface to provide the information necessary to display text.
40 * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction
41 * - The visual position of each glyph within the layout
42 * - A window into the text layout e.g. which page of a document to view
53 * @brief Virtual destructor
55 virtual ~ViewInterface();
58 * @brief Retrieves the target size of the UI control.
60 * @return The control's size.
62 virtual const Vector2& GetControlSize() const = 0;
65 * @brief Retrieves the text's layout size.
67 * @return The text's size. Note that this may be larger than the control size,
68 * in the case where text is scrolling/clipped.
70 virtual const Vector2& GetLayoutSize() const = 0;
73 * Retrieves the number of glyphs.
75 * @return The number of glyphs.
77 virtual Length GetNumberOfGlyphs() const = 0;
80 * @brief Retrieves glyphs and positions in the given buffers.
82 * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions.
83 * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
85 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
86 * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied.
87 * @param[out] minLineOffset The minimum line offset.
88 * @param[in] glyphIndex Index to the first glyph.
89 * @param[in] numberOfGlyphs Number of glyphs to be copied.
91 * @return The number of glyphs.
93 virtual Length GetGlyphs(GlyphInfo* glyphs,
94 Vector2* glyphPositions,
96 GlyphIndex glyphIndex,
97 Length numberOfGlyphs) const = 0;
100 * @brief Retrieves the vector of colors.
102 * @return Pointer to the vector of colors.
104 virtual const Vector4* const GetColors() const = 0;
107 * @brief Retrieves the vector of indices to the vector of colors.
109 * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
111 virtual const ColorIndex* const GetColorIndices() const = 0;
114 * @brief Retrieves the vector of background colors.
116 * @return Pointer to the vector of background colors.
118 virtual const Vector4* const GetBackgroundColors() const = 0;
121 * @brief Retrieves the vector of indices to the vector of background colors.
123 * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
125 virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
128 * @brief checks if there is background colors set using markup.
130 * @return boolean if there is background colors set using markup .
132 virtual bool const IsMarkupBackgroundColorSet() const = 0;
135 * @brief Retrieves the text color
137 * @return The text color
139 virtual const Vector4& GetTextColor() const = 0;
142 * @brief Retrieves the shadow offset, 0 indicates no shadow.
144 * @return The shadow offset.
146 virtual const Vector2& GetShadowOffset() const = 0;
149 * @brief Retrieves the shadow color.
151 * @return The shadow color.
153 virtual const Vector4& GetShadowColor() const = 0;
156 * @brief Retrieves the underline color.
158 * @return The underline color.
160 virtual const Vector4& GetUnderlineColor() const = 0;
163 * @brief Returns whether underline is enabled or not.
165 * @return The underline state.
167 virtual bool IsUnderlineEnabled() const = 0;
170 * @brief Returns the hyphens glyph info.
172 * @return hyphens glyph info.
174 virtual const GlyphInfo* GetHyphens() const = 0;
177 * @brief Returns the indices of the hyphen in the text.
179 * @return the hyphen indices.
181 virtual const Length* GetHyphenIndices() const = 0;
184 * @brief Returns number of hyphens to add in text.
186 * @return number of hyphens.
188 virtual Length GetHyphensCount() const = 0;
190 * @brief Retrieves the underline height override
192 * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
194 virtual float GetUnderlineHeight() const = 0;
197 * @brief Retrieves the number of underline runs.
199 * @return The number of underline runs.
201 virtual Length GetNumberOfUnderlineRuns() const = 0;
204 * @brief Retrieves the underline runs.
206 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
207 * @param[in] index Index of the first underline run to be copied.
208 * @param[in] numberOfRuns Number of underline runs to be copied.
210 virtual void GetUnderlineRuns(GlyphRun* underlineRuns,
211 UnderlineRunIndex index,
212 Length numberOfRuns) const = 0;
215 * @brief Retrieve the outline color.
217 * @return The outline color.
219 virtual const Vector4& GetOutlineColor() const = 0;
222 * @brief Retrieves the width of an outline
224 * @return The width of the outline.
226 virtual uint16_t GetOutlineWidth() const = 0;
229 * @brief Retrieves ellipsis position for text.
231 * @return The ellipsis position.
233 virtual DevelText::EllipsisPosition::Type GetEllipsisPosition() const = 0;
236 * @brief Whether the text elide property is enabled.
238 * @return @e true if the text elide property is enabled, @e false otherwise.
240 virtual bool IsTextElideEnabled() const = 0;
243 * @brief Retrieves the start index of laid-out glyphs.
245 * @return The start index of laid-out glyphs.
247 virtual GlyphIndex GetStartIndexOfElidedGlyphs() const = 0;
250 * @brief Retrieves the end index of laid-out glyphs.
252 * @return The end index of laid-out glyphs.
254 virtual GlyphIndex GetEndIndexOfElidedGlyphs() const = 0;
257 * @brief Retrieves the first middle index of elided glyphs, index before ellipsis of middle.
259 * @return The first middle index of elided glyphs, index before ellipsis of middle.
261 virtual GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const = 0;
264 * @brief Retrieves the second middle index of elided glyphs, index of ellipsis of middle.
266 * @return The second middle index of elided glyphs, index of ellipsis of middle.
268 virtual GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const = 0;
273 } // namespace Toolkit
277 #endif // DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H