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>
39 struct LayoutParameters;
42 * @brief LayoutEngine is responsible for calculating the visual position of glyphs in layout.
54 enum HorizontalAlignment
56 HORIZONTAL_ALIGN_BEGIN,
57 HORIZONTAL_ALIGN_CENTER,
61 enum VerticalAlignment
64 VERTICAL_ALIGN_CENTER,
69 * @brief Create a new instance of a LayoutEngine.
74 * @brief Virtual destructor.
79 * @brief Choose the required layout.
81 * @param[in] layout The required layout.
83 void SetLayout( Layout layout );
86 * @brief Query the required layout.
88 * @return The required layout.
90 unsigned int GetLayout() const;
93 * @brief Enable or disable the text ellipsis.
95 * @param[in] enabled Whether to enable the text ellipsis.
97 void SetTextEllipsisEnabled( bool enabled );
100 * @return Whether the text ellipsis is enabled.
102 bool GetTextEllipsisEnabled() const;
105 * @brief Choose the required text horizontal alignment.
107 * @param[in] alignment The required alignment.
109 void SetHorizontalAlignment( HorizontalAlignment alignment );
112 * @brief Query the required text horizontal alignment.
114 * @return The required alignment.
116 HorizontalAlignment GetHorizontalAlignment() const;
119 * @brief Choose the required text vertical alignment.
121 * @param[in] alignment The required alignment.
123 void SetVerticalAlignment( VerticalAlignment alignment );
126 * @brief Query the required text vertical alignment.
128 * @return The required alignment.
130 VerticalAlignment GetVerticalAlignment() const;
133 * @brief Store the visual position of glyphs in the VisualModel.
135 * @param[in] layoutParameters The parameters needed to layout the text.
136 * @param[out] glyphPositions The positions of all the glyphs.
137 * @param[out] lines The laid-out lines.
138 * @param[out] actualSize The size of the text after it has been laid-out.
140 * @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.
142 bool LayoutText( const LayoutParameters& layoutParameters,
143 Vector<Vector2>& glyphPositions,
144 Vector<LineRun>& lines,
148 * @brief Re-lays out those lines with right to left characters.
150 * It doesn't change the phisical position of the glyphs in the model but sets their new position.
152 * @param[in] layoutParameters The parameters needed to layout the text.
153 * @param[in,out] glyphPositions The positions of all the glyphs.
155 void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
156 Vector<Vector2>& glyphPositions );
159 * @brief Aligns the laid out lines.
161 * @param[in] layoutSize The size of the laid out the text.
162 * @param[in,out] lines The laid-out lines.
164 void Align( const Size& layoutSize,
165 Vector<LineRun>& lines );
170 LayoutEngine( const LayoutEngine& handle );
173 LayoutEngine& operator=( const LayoutEngine& handle );
182 } // namespace Toolkit
186 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__