1 #ifndef __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__
2 #define __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_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/public-api/object/base-handle.h>
24 #include <dali-toolkit/internal/text/font-run.h>
25 #include <dali-toolkit/internal/text/script-run.h>
36 namespace Internal DALI_INTERNAL
39 class MultilanguageSupport;
46 * @brief Sets the character's scripts to the model and validates the fonts set by the user or assigns default ones.
48 class MultilanguageSupport : public BaseHandle
53 * @brief Create an uninitialized MultilanguageSupport handle.
55 MultilanguageSupport();
60 * This is non-virtual since derived Handle types must not contain data or virtual methods.
62 ~MultilanguageSupport();
65 * @brief This constructor is used by MultilanguageSupport::Get().
67 * @param[in] implementation A pointer to the internal multi-language support object.
69 explicit DALI_INTERNAL MultilanguageSupport( Internal::MultilanguageSupport* implementation );
72 * @brief Retrieve a handle to the MultilanguageSupport instance.
74 * @return A handle to the MultilanguageSupport.
76 static MultilanguageSupport Get();
79 * @brief Sets the scripts of the whole text.
81 * Scripts are used to validate and set default fonts and to shape the text in further steps.
83 * Some characters (like white spaces) are valid for many scripts. The rules to set a script
85 * - If they are at the begining of a paragraph they get the script of the first character with
86 * a defined script. If they are at the end, they get the script of the last one.
87 * - If they are between two scripts with the same direction, they get the script of the previous
88 * character with a defined script. If the two scripts have different directions, they get the
89 * script of the first character of the paragraph with a defined script.
91 * @param[in] text Vector of UTF-32 characters.
92 * @param[in] lineBreakInfo Vector with the line break info.
93 * @param[out] scripts Vector containing the script runs for the whole text.
95 void SetScripts( const Vector<Character>& text,
96 const Vector<LineBreakInfo>& lineBreakInfo,
97 Vector<ScriptRun>& scripts );
100 * Replaces the scrips of the given range of characters.
102 * @pre The @p model needs to have a text set.
104 * If the @p numberOfCharactersToRemove is zero, this operation is like an insert.
105 * If the @p numberOfCharactersToInsert is zero, this operation is like a remove.
107 * @param[in,out] model The text's logical model.
108 * @param[in] characterIndex Index to the first character.
109 * @param[in] numberOfCharactersToRemove The number of characters removed from the text.
110 * @param[in] numberOfCharactersToInsert The number of characters inserted in the text.
112 void ReplaceScripts( LogicalModel& model,
113 CharacterIndex characterIndex,
114 Length numberOfCharactersToRemove,
115 Length numberOfCharactersToInsert );
118 * @brief Validates the character's font of the whole text.
120 * It may update fonts set by application developers.
122 * This method ensures all characters are going to be rendered using an appropriate font. Provided a valid font
123 * exists in the platform.
125 * For those characters with no font set, it sets a default one.
127 * If a font has been set by the application developer, this method checks if the font supports the character.
128 * If it doesn't, this method replaces it by a default one.
130 * @param[in] text Vector of UTF-32 characters.
131 * @param[in] scripts Vector containing the script runs for the whole text.
132 * @param[in,out] fonts Initially contains the fonts set by the application developers. Returns the validated fonts.
134 void ValidateFonts( const Vector<Character>& text,
135 const Vector<ScriptRun>& scripts,
136 Vector<FontRun>& fonts );
139 * Validates the character's font of the given range of characters.
141 * It may update fonts set by the mark-up processor.
142 * It sets default fonts based on the script to those characters without a font set.
144 * @pre The @p model needs to have a text set.
145 * @pre The @p model needs to have the scripts set.
147 * If the @p numberOfCharactersToRemove is zero, this operation is like an insert.
148 * If the @p numberOfCharactersToInsert is zero, this operation is like a remove.
150 * @param[in,out] model The text's logical model.
151 * @param[in] characterIndex Index to the first character.
152 * @param[in] numberOfCharactersToRemove The number of characters removed from the text.
153 * @param[in] numberOfCharactersToInsert The number of characters inserted in the text.
155 void ValidateFonts( LogicalModel& model,
156 CharacterIndex characterIndex,
157 Length numberOfCharactersToRemove,
158 Length numberOfCharactersToInsert );
163 } // namespace Toolkit
167 #endif // __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__