1 #ifndef DALI_TOOLKIT_TEXT_VIEW_MODEL_H
2 #define DALI_TOOLKIT_TEXT_VIEW_MODEL_H
5 * Copyright (c) 2018 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/public-api/text/text-enumerations.h>
26 #include <dali-toolkit/internal/text/text-model-interface.h>
27 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
39 * @brief Responsible of creating and store temporary modifications of the text model.
40 * i.e. The elide of text.
42 class ViewModel : public ModelInterface
48 * Keeps the pointer to the text's model. It initializes all the members of the class to their defaults.
50 * @param[in] model Pointer to the text's model interface.
52 ViewModel( const ModelInterface* const model );
55 * @brief Virtual destructor.
57 * It's a default destructor.
62 * @copydoc ModelInterface::GetControlSize()
64 const Size& GetControlSize() const override;
67 * @copydoc ModelInterface::GetLayoutSize()
69 const Size& GetLayoutSize() const override;
72 * @copydoc ModelInterface::GetScrollPosition()
74 const Vector2& GetScrollPosition() const override;
77 * @copydoc ModelInterface::GetHorizontalAlignment()
79 Text::HorizontalAlignment::Type GetHorizontalAlignment() const override;
82 * @copydoc ModelInterface::GetVerticalAlignment()
84 Text::VerticalAlignment::Type GetVerticalAlignment() const override;
87 * @copydoc ModelInterface::GetVerticalLineAlignment()
89 DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const override;
92 * @copydoc ModelInterface::IsTextElideEnabled()
94 bool IsTextElideEnabled() const override;
97 * @copydoc ModelInterface::GetNumberOfLines()
99 Length GetNumberOfLines() const override;
102 * @copydoc ModelInterface::GetLines()
104 const LineRun* const GetLines() const override;
107 * @copydoc ModelInterface::GetNumberOfScripts()
109 Length GetNumberOfScripts() const override;
112 * @copydoc ModelInterface::GetScriptRuns()
114 const ScriptRun* const GetScriptRuns() const override;
117 * @copydoc ModelInterface::GetNumberOfGlyphs()
119 Length GetNumberOfGlyphs() const override;
122 * @copydoc ModelInterface::GetGlyphs()
124 const GlyphInfo* const GetGlyphs() const override;
127 * @copydoc ModelInterface::GetLayout()
129 const Vector2* const GetLayout() const override;
132 * @copydoc ModelInterface::GetColors()
134 const Vector4* const GetColors() const override;
137 * @copydoc ModelInterface::GetColorIndices()
139 const ColorIndex* const GetColorIndices() const override;
142 * @copydoc ModelInterface::GetBackgroundColors()
144 const Vector4* const GetBackgroundColors() const override;
147 * @copydoc ModelInterface::GetBackgroundColorIndices()
149 const ColorIndex* const GetBackgroundColorIndices() const override;
152 * @copydoc ModelInterface::GetDefaultColor()
154 const Vector4& GetDefaultColor() const override;
157 * @copydoc ModelInterface::GetShadowOffset()
159 const Vector2& GetShadowOffset() const override;
162 * @copydoc ModelInterface::GetShadowColor()
164 const Vector4& GetShadowColor() const override;
167 * @copydoc ModelInterface::GetShadowBlurRadius()
169 const float& GetShadowBlurRadius() const override;
172 * @copydoc ModelInterface::GetUnderlineColor()
174 const Vector4& GetUnderlineColor() const override;
177 * @copydoc ModelInterface::IsUnderlineEnabled()
179 bool IsUnderlineEnabled() const override;
182 * @copydoc ModelInterface::GetUnderlineHeight()
184 float GetUnderlineHeight() const override;
187 * @copydoc ModelInterface::GetNumberOfUnderlineRuns()
189 Length GetNumberOfUnderlineRuns() const override;
192 * @copydoc ModelInterface::GetUnderlineRuns()
194 void GetUnderlineRuns( GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns ) const override;
197 * @copydoc ModelInterface::GetOutlineColor()
199 const Vector4& GetOutlineColor() const override;
202 * @copydoc ModelInterface::GetOutlineWidth()
204 uint16_t GetOutlineWidth() const override;
207 * @copydoc ModelInterface::GetBackgroundColor()
209 const Vector4& GetBackgroundColor() const override;
212 * @copydoc ModelInterface::IsBackgroundEnabled()
214 bool IsBackgroundEnabled() const override;
217 * @brief Does the text elide.
219 * It stores a copy of the visible glyphs and removes as many glyphs as needed
220 * from the last visible line to add the ellipsis glyph.
222 * It stores as well a copy of the positions for each visible glyph.
227 const ModelInterface* const mModel; ///< Pointer to the text's model.
228 Vector<GlyphInfo> mElidedGlyphs; ///< Stores the glyphs of the elided text.
229 Vector<Vector2> mElidedLayout; ///< Stores the positions of each glyph of the elided text.
230 bool mIsTextElided : 1; ///< Whether the text has been elided.
235 } // namespace Toolkit
239 #endif // DALI_TOOLKIT_TEXT_VIEW_MODEL_H