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/character-spacing-glyph-run.h>
28 #include <dali-toolkit/internal/text/text-definitions.h>
29 #include <dali-toolkit/internal/text/underlined-glyph-run.h>
30 #include <dali-toolkit/public-api/text/text-enumerations.h>
42 struct StrikethroughGlyphRun;
45 * @brief Abstract interface to provide the information necessary to display text.
48 * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction
49 * - The visual position of each glyph within the layout
50 * - A window into the text layout e.g. which page of a document to view
61 * @brief Virtual destructor
63 virtual ~ViewInterface();
66 * @brief Retrieves the target size of the UI control.
68 * @return The control's size.
70 virtual const Vector2& GetControlSize() const = 0;
73 * @brief Retrieves the text's layout size.
75 * @return The text's size. Note that this may be larger than the control size,
76 * in the case where text is scrolling/clipped.
78 virtual const Vector2& GetLayoutSize() const = 0;
81 * Retrieves the number of glyphs.
83 * @return The number of glyphs.
85 virtual Length GetNumberOfGlyphs() const = 0;
88 * @brief Retrieves glyphs and positions in the given buffers.
90 * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions.
91 * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
93 * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
94 * @param[out] glyphPositions Pointer to a buffer where the glyph's positions are copied.
95 * @param[out] minLineOffset The minimum line offset.
96 * @param[in] glyphIndex Index to the first glyph.
97 * @param[in] numberOfGlyphs Number of glyphs to be copied.
99 * @return The number of glyphs.
101 virtual Length GetGlyphs(GlyphInfo* glyphs,
102 Vector2* glyphPositions,
103 float& minLineOffset,
104 GlyphIndex glyphIndex,
105 Length numberOfGlyphs) const = 0;
108 * @brief Retrieves the vector of colors.
110 * @return Pointer to the vector of colors.
112 virtual const Vector4* const GetColors() const = 0;
115 * @brief Retrieves the vector of indices to the vector of colors.
117 * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
119 virtual const ColorIndex* const GetColorIndices() const = 0;
122 * @brief Retrieves the vector of background colors.
124 * @return Pointer to the vector of background colors.
126 virtual const Vector4* const GetBackgroundColors() const = 0;
129 * @brief Retrieves the vector of indices to the vector of background colors.
131 * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
133 virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
136 * @brief checks if there is background colors set using markup.
138 * @return boolean if there is background colors set using markup .
140 virtual bool const IsMarkupBackgroundColorSet() const = 0;
143 * @brief Retrieves the text color
145 * @return The text color
147 virtual const Vector4& GetTextColor() const = 0;
150 * @brief Retrieves the shadow offset, 0 indicates no shadow.
152 * @return The shadow offset.
154 virtual const Vector2& GetShadowOffset() const = 0;
157 * @brief Retrieves the shadow color.
159 * @return The shadow color.
161 virtual const Vector4& GetShadowColor() const = 0;
164 * @brief Retrieves the underline color.
166 * @return The underline color.
168 virtual const Vector4& GetUnderlineColor() const = 0;
171 * @brief Returns whether underline is enabled or not.
173 * @return The underline state.
175 virtual bool IsUnderlineEnabled() const = 0;
178 * @brief Returns the hyphens glyph info.
180 * @return hyphens glyph info.
182 virtual const GlyphInfo* GetHyphens() const = 0;
185 * @brief Returns the indices of the hyphen in the text.
187 * @return the hyphen indices.
189 virtual const Length* GetHyphenIndices() const = 0;
192 * @brief Returns number of hyphens to add in text.
194 * @return number of hyphens.
196 virtual Length GetHyphensCount() const = 0;
198 * @brief Retrieves the underline height override
200 * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
202 virtual float GetUnderlineHeight() const = 0;
205 * @brief Retrieves the underline type override
207 * @return Returns the override type for an underline.
209 virtual Text::Underline::Type GetUnderlineType() const = 0;
212 * @brief Retrieves the dashed underline width override.
214 * @return Returns the override width for the dashed underline.
216 virtual float GetDashedUnderlineWidth() const = 0;
219 * @brief Retrieves the dashed underline gap override.
221 * @return Returns the override gap for the dashed underline.
223 virtual float GetDashedUnderlineGap() const = 0;
226 * @brief Retrieves the number of underline runs.
228 * @return The number of underline runs.
230 virtual Length GetNumberOfUnderlineRuns() const = 0;
233 * @brief Retrieves the underline runs.
235 * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
236 * @param[in] index Index of the first underline run to be copied.
237 * @param[in] numberOfRuns Number of underline runs to be copied.
239 virtual void GetUnderlineRuns(UnderlinedGlyphRun* underlineRuns,
240 UnderlineRunIndex index,
241 Length numberOfRuns) const = 0;
244 * @brief Retrieve the outline color.
246 * @return The outline color.
248 virtual const Vector4& GetOutlineColor() const = 0;
251 * @brief Retrieves the width of an outline
253 * @return The width of the outline.
255 virtual uint16_t GetOutlineWidth() const = 0;
258 * @brief Retrieves ellipsis position for text.
260 * @return The ellipsis position.
262 virtual DevelText::EllipsisPosition::Type GetEllipsisPosition() const = 0;
265 * @brief Whether the text elide property is enabled.
267 * @return @e true if the text elide property is enabled, @e false otherwise.
269 virtual bool IsTextElideEnabled() const = 0;
272 * @brief Retrieves the start index of laid-out glyphs.
274 * @return The start index of laid-out glyphs.
276 virtual GlyphIndex GetStartIndexOfElidedGlyphs() const = 0;
279 * @brief Retrieves the end index of laid-out glyphs.
281 * @return The end index of laid-out glyphs.
283 virtual GlyphIndex GetEndIndexOfElidedGlyphs() const = 0;
286 * @brief Retrieves the first middle index of elided glyphs, index before ellipsis of middle.
288 * @return The first middle index of elided glyphs, index before ellipsis of middle.
290 virtual GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const = 0;
293 * @brief Retrieves the second middle index of elided glyphs, index of ellipsis of middle.
295 * @return The second middle index of elided glyphs, index of ellipsis of middle.
297 virtual GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const = 0;
300 * @brief Retrieves the strikethrough color.
302 * @return The strikethrough color.
304 virtual const Vector4& GetStrikethroughColor() const = 0;
307 * @brief Returns whether strikethrough is enabled or not.
309 * @return The strikethrough state.
311 virtual bool IsStrikethroughEnabled() const = 0;
314 * @brief Retrieves the strikethrough height override
316 * @return Returns the override height for a strikethrough, 0 indicates that adaptor will determine the height
318 virtual float GetStrikethroughHeight() const = 0;
321 * @brief Retrieves the number of strikethrough runs.
323 * @return The number of strikethrough runs.
325 virtual Length GetNumberOfStrikethroughRuns() const = 0;
328 * @brief Retrieves the number of bounded paragraph runs.
330 * @return The number of bounded paragraph runs.
332 virtual Length GetNumberOfBoundedParagraphRuns() const = 0;
335 * @brief Retrieves the reference for bounded paragraph runs.
337 * @return The reference for bounded paragraph runs.
339 virtual const Vector<BoundedParagraphRun>& GetBoundedParagraphRuns() const = 0;
342 * @brief Retrieves the number of character-spacing glyph runs.
344 * @return The number of character-spacing glyph runs.
346 virtual Length GetNumberOfCharacterSpacingGlyphRuns() const = 0;
349 * @brief Retrieves the reference for character-spacing glyph runs.
351 * @return The reference for character-spacing glyph runs.
353 virtual const Vector<CharacterSpacingGlyphRun>& GetCharacterSpacingGlyphRuns() const = 0;
356 * @brief Retrieves the strikethrough runs.
358 * @param[out] strikethroughRuns Pointer to a buffer where the strikethrough runs are copied.
359 * @param[in] index Index of the first strikethrough run to be copied.
360 * @param[in] numberOfRuns Number of strikethrough runs to be copied.
362 virtual void GetStrikethroughRuns(StrikethroughGlyphRun* strikethroughRuns,
363 StrikethroughRunIndex index,
364 Length numberOfRuns) const = 0;
367 * @brief The spaces between characters in Pixels.
369 * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
371 * @return characterSpacing.
373 virtual const float GetCharacterSpacing() const = 0;
376 * @brief The text buffer.
378 * @return The text buffer.
380 virtual const Character* GetTextBuffer() const = 0;
383 * @brief The text Glyph to Characters Array.
385 * @return GetGlyphsToCharacters.
387 virtual const Vector<CharacterIndex>& GetGlyphsToCharacters() const = 0;
392 } // namespace Toolkit
396 #endif // DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H