1 #ifndef __DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H__
2 #define __DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_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-toolkit/internal/text/bidirectional-line-info-run.h>
24 #include <dali-toolkit/internal/text/bidirectional-paragraph-info-run.h>
39 * Sets the bidirectional info into the logical model.
41 * @param[in] text Vector of UTF-32 characters.
42 * @param[in] lineBreakInfo The line break info.
43 * @param[out] bidirectionalInfo Vector with the bidirectional infor for each paragraph.
45 void SetBidirectionalInfo( const Vector<Character>& text,
46 const Vector<LineBreakInfo>& lineBreakInfo,
47 Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo );
50 * Replaces the bidirectional info from the logical model.
52 * @pre The @p model needs to have a text set.
53 * @pre The @p model needs to have the line break info set.
55 * If the @p numberOfCharactersToRemove is zero, this operation is like an insert.
56 * If the @p numberOfCharactersToInsert is zero, this operation is like a remove.
58 * @param[in,out] model The text's logical model.
59 * @param[in] characterIndex Index to the first character.
60 * @param[in] numberOfCharactersToRemove The number of characters removed from the text.
61 * @param[in] numberOfCharactersToInsert The number of characters inserted in the text.
63 void ReplaceBidirectionalInfo( LogicalModel& model,
64 CharacterIndex characterIndex,
65 Length numberOfCharactersToRemove,
66 Length numberOfCharactersToInsert );
69 * Sets the visual to logical and logical to visual map tables.
71 * Any map tables previously set are removed.
73 * @pre The @p logicalModel needs to have a text set.
74 * @pre The @p logicalModel needs to have the bidirectional info indices for each paragraph set.
75 * @pre The @p visualModel needs to have the laid-out lines info set.
77 * @param[in] bidirectionalInfo Vector with the bidirectional infor for each paragraph.
78 * @param[in] lineRuns The line runs converted to characters.
79 * @param[out] lineInfoRuns line runs with the visual to logical and logical to visual conversion maps.
81 void ReorderLines( const Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo,
82 const Vector<CharacterRun>& lineRuns,
83 Vector<BidirectionalLineInfoRun>& lineInfoRuns );
86 * Replaces the visual to logical and logical to visual map tables.
88 * @pre The @p logicalModel needs to have a text set.
89 * @pre The @p logicalModel needs to have the line break info set.
90 * @pre The @p visualModel needs to have the laid-out lines info set.
92 * If the @p numberOfCharactersToRemove is zero, this operation is like an insert.
93 * If the @p numberOfCharactersToInsert is zero, this operation is like a remove.
95 * @param[in,out] logicalModel The text's logical model.
96 * @param[in] visualModel The text's visual model.
97 * @param[in] characterIndex Index to the first character.
98 * @param[in] numberOfCharactersToRemove The number of characters removed from the text.
99 * @param[in] numberOfCharactersToInsert The number of characters inserted in the text.
101 void ReorderLines( LogicalModel& logicalModel,
102 const VisualModel& visualModel,
103 CharacterIndex characterIndex,
104 Length numberOfCharactersToRemove,
105 Length numberOfCharactersToInsert );
109 } // namespace Toolkit
113 #endif // __DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H__