5cb557e2a5f39b74b903db6e44b25c1d83068769
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / text / bidirectional-support.h
1 #ifndef __DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H__
2 #define __DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H__
3
4 /*
5  * Copyright (c) 2015 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/public-api/text/text-definitions.h>
23
24 namespace Dali
25 {
26
27 namespace Toolkit
28 {
29
30 namespace Text
31 {
32
33 class LogicalModel;
34 class VisualModel;
35
36 /**
37  * Sets the bidirectional info into the logical model.
38  *
39  * Any bidirectional info previously set is removed.
40  *
41  * @pre The @p model needs to have a text set.
42  * @pre The @p model needs to have the line break info set.
43  *
44  * @param[in,out] model The text's logical model.
45  */
46 void SetBidirectionalInfo( LogicalModel& model );
47
48 /**
49  * Sets the visual to logical and logical to visual map tables.
50  *
51  * Any map tables previously set are removed.
52  *
53  * @pre The @p logicalModel needs to have a text set.
54  * @pre The @p logicalModel needs to have the line break info set.
55  * @pre The @p visualModel needs to have the laid-out lines info set.
56  *
57  * @param[in,out] logicalModel The text's logical model.
58  * @param[in] visualModel The text's visual model.
59  */
60 void ReorderLines( LogicalModel& logicalModel,
61                    const VisualModel& visualModel );
62
63 } // namespace Text
64
65 } // namespace Toolkit
66
67 } // namespace Dali
68
69 #endif // __DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H__