1 #ifndef __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__
2 #define __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__
5 * Copyright (c) 2015 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>
23 #include <dali/public-api/math/vector2.h>
26 #include <dali-toolkit/internal/text/line-run.h>
37 struct LayoutParameters;
40 * @brief LayoutEngine is responsible for calculating the visual position of glyphs in layout.
52 enum HorizontalAlignment
54 HORIZONTAL_ALIGN_BEGIN,
55 HORIZONTAL_ALIGN_CENTER,
59 enum VerticalAlignment
62 VERTICAL_ALIGN_CENTER,
67 * @brief Create a new instance of a LayoutEngine.
72 * @brief Virtual destructor.
77 * @brief Choose the required layout.
79 * @param[in] layout The required layout.
81 void SetLayout( Layout layout );
84 * @brief Query the required layout.
86 * @return The required layout.
88 unsigned int GetLayout() const;
91 * @brief Enable or disable the text ellipsis.
93 * @param[in] enabled Whether to enable the text ellipsis.
95 void SetTextEllipsisEnabled( bool enabled );
98 * @return Whether the text ellipsis is enabled.
100 bool GetTextEllipsisEnabled() const;
103 * @brief Choose the required text horizontal alignment.
105 * @param[in] alignment The required alignment.
107 void SetHorizontalAlignment( HorizontalAlignment alignment );
110 * @brief Query the required text horizontal alignment.
112 * @return The required alignment.
114 HorizontalAlignment GetHorizontalAlignment() const;
117 * @brief Choose the required text vertical alignment.
119 * @param[in] alignment The required alignment.
121 void SetVerticalAlignment( VerticalAlignment alignment );
124 * @brief Query the required text vertical alignment.
126 * @return The required alignment.
128 VerticalAlignment GetVerticalAlignment() const;
131 * @brief Sets the width of the cursor.
133 * @param[in] width The width of the cursor in pixels.
135 void SetCursorWidth( int width );
138 * @brief Retrieves the width of the cursor.
140 * @return The width of the cursor in pixels.
142 int GetCursorWidth() const;
145 * @brief Store the visual position of glyphs in the VisualModel.
147 * @param[in] layoutParameters The parameters needed to layout the text.
148 * @param[out] glyphPositions The positions of all the glyphs.
149 * @param[out] lines The laid-out lines.
150 * @param[out] actualSize The size of the text after it has been laid-out.
152 * @return \e true if the text has been re-laid-out. \e false means the given width is too small to layout even a single character.
154 bool LayoutText( const LayoutParameters& layoutParameters,
155 Vector<Vector2>& glyphPositions,
156 Vector<LineRun>& lines,
160 * @brief Re-lays out those lines with right to left characters.
162 * It doesn't change the phisical position of the glyphs in the model but sets their new position.
164 * @param[in] layoutParameters The parameters needed to layout the text.
165 * @param[in,out] glyphPositions The positions of all the glyphs.
167 void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
168 Vector<Vector2>& glyphPositions );
171 * @brief Aligns the laid out lines.
173 * @param[in] layoutSize The size of the laid out the text.
174 * @param[in,out] lines The laid-out lines.
176 void Align( const Size& layoutSize,
177 Vector<LineRun>& lines );
182 LayoutEngine( const LayoutEngine& handle );
185 LayoutEngine& operator=( const LayoutEngine& handle );
194 } // namespace Toolkit
198 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__