1 #ifndef DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_VIEW_INTERFACE_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/public-api/common/dali-vector.h>
25 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
26 #include <dali-toolkit/internal/text/bounded-paragraph-run.h>
27 #include <dali-toolkit/internal/text/text-definitions.h>
28 #include <dali-toolkit/internal/text/underlined-glyph-run.h>
29 #include <dali-toolkit/public-api/text/text-enumerations.h>
41 struct StrikethroughGlyphRun;
44 * @brief Abstract interface to provide the information necessary to display text.
47 * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction
48 * - The visual position of each glyph within the layout
49 * - A window into the text layout e.g. which page of a document to view
60 * @brief Virtual destructor
62 virtual ~ViewInterface();
65 * @brief Retrieves the target size of the UI control.
67 * @return The control's size.
69 virtual const Vector2& GetControlSize() const = 0;
72 * @brief Retrieves the text's layout size.
74 * @return The text's size. Note that this may be larger than the control size,
75 * in the case where text is scrolling/clipped.
77 virtual const Vector2& GetLayoutSize() const = 0;
80 * Retrieves the number of glyphs.
82 * @return The number of glyphs.
84 virtual Length GetNumberOfGlyphs() const = 0;
87 * @brief Retrieves glyphs and positions in the given buffers.
89 * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions.
90 * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
92 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
93 * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied.
94 * @param[out] minLineOffset The minimum line offset.
95 * @param[in] glyphIndex Index to the first glyph.
96 * @param[in] numberOfGlyphs Number of glyphs to be copied.
98 * @return The number of glyphs.
100 virtual Length GetGlyphs(GlyphInfo* glyphs,
101 Vector2* glyphPositions,
102 float& minLineOffset,
103 GlyphIndex glyphIndex,
104 Length numberOfGlyphs) const = 0;
107 * @brief Retrieves the vector of colors.
109 * @return Pointer to the vector of colors.
111 virtual const Vector4* const GetColors() const = 0;
114 * @brief Retrieves the vector of indices to the vector of colors.
116 * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
118 virtual const ColorIndex* const GetColorIndices() const = 0;
121 * @brief Retrieves the vector of background colors.
123 * @return Pointer to the vector of background colors.
125 virtual const Vector4* const GetBackgroundColors() const = 0;
128 * @brief Retrieves the vector of indices to the vector of background colors.
130 * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
132 virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
135 * @brief checks if there is background colors set using markup.
137 * @return boolean if there is background colors set using markup .
139 virtual bool const IsMarkupBackgroundColorSet() const = 0;
142 * @brief Retrieves the text color
144 * @return The text color
146 virtual const Vector4& GetTextColor() const = 0;
149 * @brief Retrieves the shadow offset, 0 indicates no shadow.
151 * @return The shadow offset.
153 virtual const Vector2& GetShadowOffset() const = 0;
156 * @brief Retrieves the shadow color.
158 * @return The shadow color.
160 virtual const Vector4& GetShadowColor() const = 0;
163 * @brief Retrieves the underline color.
165 * @return The underline color.
167 virtual const Vector4& GetUnderlineColor() const = 0;
170 * @brief Returns whether underline is enabled or not.
172 * @return The underline state.
174 virtual bool IsUnderlineEnabled() const = 0;
177 * @brief Returns the hyphens glyph info.
179 * @return hyphens glyph info.
181 virtual const GlyphInfo* GetHyphens() const = 0;
184 * @brief Returns the indices of the hyphen in the text.
186 * @return the hyphen indices.
188 virtual const Length* GetHyphenIndices() const = 0;
191 * @brief Returns number of hyphens to add in text.
193 * @return number of hyphens.
195 virtual Length GetHyphensCount() const = 0;
197 * @brief Retrieves the underline height override
199 * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
201 virtual float GetUnderlineHeight() const = 0;
204 * @brief Retrieves the underline type override
206 * @return Returns the override type for an underline.
208 virtual Text::Underline::Type GetUnderlineType() const = 0;
211 * @brief Retrieves the dashed underline width override.
213 * @return Returns the override width for the dashed underline.
215 virtual float GetDashedUnderlineWidth() const = 0;
218 * @brief Retrieves the dashed underline gap override.
220 * @return Returns the override gap for the dashed underline.
222 virtual float GetDashedUnderlineGap() const = 0;
225 * @brief Retrieves the number of underline runs.
227 * @return The number of underline runs.
229 virtual Length GetNumberOfUnderlineRuns() const = 0;
232 * @brief Retrieves the underline runs.
234 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
235 * @param[in] index Index of the first underline run to be copied.
236 * @param[in] numberOfRuns Number of underline runs to be copied.
238 virtual void GetUnderlineRuns(UnderlinedGlyphRun* underlineRuns,
239 UnderlineRunIndex index,
240 Length numberOfRuns) const = 0;
243 * @brief Retrieve the outline color.
245 * @return The outline color.
247 virtual const Vector4& GetOutlineColor() const = 0;
250 * @brief Retrieves the width of an outline
252 * @return The width of the outline.
254 virtual uint16_t GetOutlineWidth() const = 0;
257 * @brief Retrieves ellipsis position for text.
259 * @return The ellipsis position.
261 virtual DevelText::EllipsisPosition::Type GetEllipsisPosition() const = 0;
264 * @brief Whether the text elide property is enabled.
266 * @return @e true if the text elide property is enabled, @e false otherwise.
268 virtual bool IsTextElideEnabled() const = 0;
271 * @brief Retrieves the start index of laid-out glyphs.
273 * @return The start index of laid-out glyphs.
275 virtual GlyphIndex GetStartIndexOfElidedGlyphs() const = 0;
278 * @brief Retrieves the end index of laid-out glyphs.
280 * @return The end index of laid-out glyphs.
282 virtual GlyphIndex GetEndIndexOfElidedGlyphs() const = 0;
285 * @brief Retrieves the first middle index of elided glyphs, index before ellipsis of middle.
287 * @return The first middle index of elided glyphs, index before ellipsis of middle.
289 virtual GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const = 0;
292 * @brief Retrieves the second middle index of elided glyphs, index of ellipsis of middle.
294 * @return The second middle index of elided glyphs, index of ellipsis of middle.
296 virtual GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const = 0;
299 * @brief Retrieves the strikethrough color.
301 * @return The strikethrough color.
303 virtual const Vector4& GetStrikethroughColor() const = 0;
306 * @brief Returns whether strikethrough is enabled or not.
308 * @return The strikethrough state.
310 virtual bool IsStrikethroughEnabled() const = 0;
313 * @brief Retrieves the strikethrough height override
315 * @return Returns the override height for a strikethrough, 0 indicates that adaptor will determine the height
317 virtual float GetStrikethroughHeight() const = 0;
320 * @brief Retrieves the number of strikethrough runs.
322 * @return The number of strikethrough runs.
324 virtual Length GetNumberOfStrikethroughRuns() const = 0;
327 * @brief Retrieves the number of bounded paragraph runs.
329 * @return The number of bounded paragraph runs.
331 virtual Length GetNumberOfBoundedParagraphRuns() const = 0;
334 * @brief Retrieves the reference for bounded paragraph runs.
336 * @return The reference for bounded paragraph runs.
338 virtual const Vector<BoundedParagraphRun>& GetBoundedParagraphRuns() const = 0;
341 * @brief Retrieves the strikethrough runs.
343 * @param[out] strikethroughRuns Pointer to a buffer where the strikethrough runs are copied.
344 * @param[in] index Index of the first strikethrough run to be copied.
345 * @param[in] numberOfRuns Number of strikethrough runs to be copied.
347 virtual void GetStrikethroughRuns(StrikethroughGlyphRun* strikethroughRuns,
348 StrikethroughRunIndex index,
349 Length numberOfRuns) const = 0;
352 * @brief The spaces between characters in Pixels.
354 * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
356 * @return characterSpacing.
358 virtual const float GetCharacterSpacing() const = 0;
361 * @brief The text buffer.
363 * @return The text buffer.
365 virtual const Character* GetTextBuffer() const = 0;
368 * @brief The text Glyph to Characters Array.
370 * @return GetGlyphsToCharacters.
372 virtual const Vector<CharacterIndex>& GetGlyphsToCharacters() const = 0;
377 } // namespace Toolkit
381 #endif // DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H