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 Choose the required text horizontal alignment.
95 * @param[in] alignment The required alignment.
97 void SetHorizontalAlignment( HorizontalAlignment alignment );
100 * @brief Query the required text horizontal alignment.
102 * @return The required alignment.
104 HorizontalAlignment GetHorizontalAlignment() const;
107 * @brief Choose the required text vertical alignment.
109 * @param[in] alignment The required alignment.
111 void SetVerticalAlignment( VerticalAlignment alignment );
114 * @brief Query the required text vertical alignment.
116 * @return The required alignment.
118 VerticalAlignment GetVerticalAlignment() const;
121 * @brief Store the visual position of glyphs in the VisualModel.
123 * @param[in] layoutParameters The parameters needed to layout the text.
124 * @param[out] glyphPositions The positions of all the glyphs.
125 * @param[out] lines The laid-out lines.
126 * @param[out] actualSize The size of the text after it has been laid-out.
128 * @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.
130 bool LayoutText( const LayoutParameters& layoutParameters,
131 Vector<Vector2>& glyphPositions,
132 Vector<LineRun>& lines,
136 * @brief Re-lays out those lines with right to left characters.
138 * It doesn't change the phisical position of the glyphs in the model but sets their new position.
140 * @param[in] layoutParameters The parameters needed to layout the text.
141 * @param[in,out] glyphPositions The positions of all the glyphs.
143 void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
144 Vector<Vector2>& glyphPositions );
147 * @brief Aligns the laid out lines.
149 * @param[in] layoutParameters The parameters needed to layout the text.
150 * @param[in] layoutSize The size of the laid out the text.
151 * @param[in] lines The laid-out lines.
152 * @param[in,out] glyphPositions The positions of all the glyphs.
154 void Align( const LayoutParameters& layoutParameters,
155 const Size& layoutSize,
156 const Vector<LineRun>& lines,
157 Vector<Vector2>& glyphPositions );
162 LayoutEngine( const LayoutEngine& handle );
165 LayoutEngine& operator=( const LayoutEngine& handle );
174 } // namespace Toolkit
178 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__