1 #ifndef __DALI_TOOLKIT_TEXT_SEGMENTATION_H__
2 #define __DALI_TOOLKIT_TEXT_SEGMENTATION_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/text-definitions.h>
37 * Sets line break info.
39 * Possible values for LineBreakInfo are:
41 * - 0 is a LINE_MUST_BREAK. Text must be broken into a new line.
42 * - 1 is a LINE_ALLOW_BREAK. Is possible to break the text into a new line.
43 * - 2 is a LINE_NO_BREAK. Text can't be broken into a new line.
45 * @param[in] text Vector of UTF-32 characters.
46 * @param[out] lineBreakInfo The line break info
48 void SetLineBreakInfo( const Vector<Character>& text,
49 Vector<LineBreakInfo>& lineBreakInfo );
52 * Replaces line break info.
54 * @pre The @p model needs to have a text set.
56 * If the @p numberOfCharactersToRemove is zero, this operation is like an insert.
57 * If the @p numberOfCharactersToInsert is zero, this operation is like a remove.
59 * @param[in,out] model The text's logical model.
60 * @param[in] characterIndex Index to the first character.
61 * @param[in] numberOfCharactersToRemove The number of characters removed from the text.
62 * @param[in] numberOfCharactersToInsert The number of characters inserted in the text.
64 void ReplaceLineBreakInfo( LogicalModel& model,
65 CharacterIndex characterIndex,
66 Length numberOfCharactersToRemove,
67 Length numberOfCharactersToInsert );
70 * Sets word break info.
72 * - 0 is a WORD_BREAK. Text can be broken into a new word.
73 * - 1 is a WORD_NO_BREAK. Text can't be broken into a new word.
75 * @param[in] text Vector of UTF-32 characters.
76 * @param[out] wordBreakInfo The word break info.
78 void SetWordBreakInfo( const Vector<Character>& text,
79 Vector<WordBreakInfo>& wordBreakInfo );
82 * Replaces word break info.
84 * @pre The @p model needs to have a text set.
86 * If the @p numberOfCharactersToRemove is zero, this operation is like an insert.
87 * If the @p numberOfCharactersToInsert is zero, this operation is like a remove.
89 * @param[in,out] model The text's logical model.
90 * @param[in] characterIndex Index to the first character.
91 * @param[in] numberOfCharactersToRemove The number of characters removed from the text.
92 * @param[in] numberOfCharactersToInsert The number of characters inserted in the text.
94 void ReplaceWordBreakInfo( LogicalModel& model,
95 CharacterIndex characterIndex,
96 Length numberOfCharactersToRemove,
97 Length numberOfCharactersToInsert );
101 } // namespace Toolkit
105 #endif // __DALI_TOOLKIT_TEXT_SEGMENTATION_H__