1 #ifndef DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_MODEL_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/public-api/math/vector2.h>
25 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
26 #include <dali-toolkit/internal/text/line-run.h>
27 #include <dali-toolkit/internal/text/script-run.h>
28 #include <dali-toolkit/internal/text/text-definitions.h>
29 #include <dali-toolkit/public-api/text/text-enumerations.h>
38 * @brief Interface class used to retrieve the text's model from the text-controller.
44 * @brief Virtual destructor.
46 virtual ~ModelInterface()
51 * @brief Retrives the control's size.
53 * @return The control's size.
55 virtual const Size& GetControlSize() const = 0;
58 * @brief Retrives the layout's size.
60 * @return The layout's size.
62 virtual const Size& GetLayoutSize() const = 0;
65 * @brief Retrieves the text's scroll position.
67 * @return The scroll position.
69 virtual const Vector2& GetScrollPosition() const = 0;
72 * @brief Retrieves the text's horizontal alignment.
74 * @return The horizontal alignment.
76 virtual HorizontalAlignment::Type GetHorizontalAlignment() const = 0;
79 * @brief Retrieves the text's vertical alignment.
81 * @return The vertical alignment.
83 virtual VerticalAlignment::Type GetVerticalAlignment() const = 0;
86 * @brief Retrieves the text's vertical line alignment.
88 * @return The vertical line alignment.
90 virtual DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const = 0;
93 * @brief Whether the text elide property is enabled.
95 * @return @e true if the text elide property is enabled, @e false otherwise.
97 virtual bool IsTextElideEnabled() const = 0;
100 * @brief Retrieves the number of laid-out lines.
102 * @return The number of laid-out lines.
104 virtual Length GetNumberOfLines() const = 0;
107 * @brief Retrieves the laid-out lines.
109 * @return A pointer to the vector with the laid-out lines.
111 virtual const LineRun* const GetLines() const = 0;
114 * @brief Retrieves the number of script runs.
116 * @return The number of script runs.
118 virtual Length GetNumberOfScripts() const = 0;
121 * @brief Retrieves the script runs.
123 * @return A pointer to the vector with the runs of characters with the same script..
125 virtual const ScriptRun* const GetScriptRuns() const = 0;
128 * @brief Retrieves the number of laid-out glyphs.
130 * @return The number of laid-out glyphs.
132 virtual Length GetNumberOfGlyphs() const = 0;
135 * @brief Retrieves the laid-out glyphs.
137 * @return A pointer to the vector with the laid-out glyphs.
139 virtual const GlyphInfo* const GetGlyphs() const = 0;
142 * @brief Retrieves the text layout.
144 * @return A pointer to the vector with the positions for each glyph.
146 virtual const Vector2* const GetLayout() const = 0;
149 * @brief Retrieves the vector of colors.
151 * @return Pointer to the vector of colors.
153 virtual const Vector4* const GetColors() const = 0;
156 * @brief Retrieves the vector of indices to the vector of colors.
158 * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
160 virtual const ColorIndex* const GetColorIndices() const = 0;
163 * @brief Retrieves the vector of background colors.
165 * @return Pointer to the vector of background colors.
167 virtual const Vector4* const GetBackgroundColors() const = 0;
170 * @brief Retrieves the vector of indices to the vector of background colors.
172 * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
174 virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
177 * @brief Retrieves the text's default color.
179 * @return The default color.
181 virtual const Vector4& GetDefaultColor() const = 0;
184 * @brief Retrieves the shadow offset, 0 indicates no shadow.
186 * @return The shadow offset.
188 virtual const Vector2& GetShadowOffset() const = 0;
191 * @brief Retrieves the shadow color.
193 * @return The shadow color.
195 virtual const Vector4& GetShadowColor() const = 0;
198 * @brief Retrieve the shadow blur radius.
200 * @return The shadow blur radius.
202 virtual const float& GetShadowBlurRadius() const = 0;
205 * @brief Retrieves the underline color.
207 * @return The underline color.
209 virtual const Vector4& GetUnderlineColor() const = 0;
212 * @brief Returns whether underline is enabled or not.
214 * @return The underline state.
216 virtual bool IsUnderlineEnabled() const = 0;
219 * @brief Retrieves the underline height override
221 * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
223 virtual float GetUnderlineHeight() 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(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const = 0;
242 * @brief Retrieve the outline color.
244 * @return The outline color.
246 virtual const Vector4& GetOutlineColor() const = 0;
249 * @brief Retrieves the width of an outline
251 * @return The width of the outline.
253 virtual uint16_t GetOutlineWidth() const = 0;
256 * @brief Retrieves the background color.
258 * @return The background color.
260 virtual const Vector4& GetBackgroundColor() const = 0;
263 * @brief Returns whether background is enabled or not.
265 * @return The background state.
267 virtual bool IsBackgroundEnabled() const = 0;
272 } // namespace Toolkit
276 #endif // DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H