[dali_2.3.20] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-geometry.h
1 #ifndef DALI_TOOLKIT_TEXT_GEOMETRY_H
2 #define DALI_TOOLKIT_TEXT_GEOMETRY_H
3
4 /*
5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali-toolkit/internal/text/text-model.h>
23
24 namespace Dali
25 {
26 namespace Toolkit
27 {
28 namespace Text
29 {
30 /**
31    * @brief Get the rendered size & position of a specific text range.
32    * if the requested text is at multilines, multiple sizes/positions will be returned for each text located in a separate line.
33    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
34    *
35    * @param[in] textModel text model containing text info.
36    * @param[in] startIndex start index of the text requested to get position/size for.
37    * @param[in] endIndex end index(included) of the text requested to get position/size for.
38    * @param[in] sizesList list of sizes for the reuested text.
39    * @param[in] positionsList list of positions for the requested text
40    */
41 void GetTextGeometry(ModelPtr textModel, CharacterIndex startIndex, CharacterIndex endIndex, Vector<Vector2>& sizesList, Vector<Vector2>& positionsList);
42
43 } // namespace Text
44
45 } // namespace Toolkit
46
47 } // namespace Dali
48
49 #endif // DALI_TOOLKIT_TEXT_GEOMETRY_H