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>
26 #include <dali-toolkit/internal/text/font-run.h>
27 #include <dali-toolkit/internal/text/font-description-run.h>
28 #include <dali-toolkit/internal/text/script-run.h>
39 namespace Internal DALI_INTERNAL
42 class MultilanguageSupport;
47 * @brief Sets the character's scripts to the model and validates the fonts set by the user or assigns default ones.
49 class MultilanguageSupport : public BaseHandle
54 * @brief Create an uninitialized MultilanguageSupport handle.
56 MultilanguageSupport();
61 * This is non-virtual since derived Handle types must not contain data or virtual methods.
63 ~MultilanguageSupport();
66 * @brief This constructor is used by MultilanguageSupport::Get().
68 * @param[in] implementation A pointer to the internal multi-language support object.
70 explicit DALI_INTERNAL MultilanguageSupport( Internal::MultilanguageSupport* implementation );
73 * @brief Retrieve a handle to the MultilanguageSupport instance.
75 * @return A handle to the MultilanguageSupport.
77 static MultilanguageSupport Get();
80 * @brief Sets the scripts of the whole text.
82 * Scripts are used to validate and set default fonts and to shape the text in further steps.
84 * Some characters (like white spaces) are valid for many scripts. The rules to set a script
86 * - If they are at the begining of a paragraph they get the script of the first character with
87 * a defined script. If they are at the end, they get the script of the last one.
88 * - If they are between two scripts with the same direction, they get the script of the previous
89 * character with a defined script. If the two scripts have different directions, they get the
90 * script of the first character of the paragraph with a defined script.
92 * @param[in] text Vector of UTF-32 characters.
93 * @param[in] startIndex The character from where the script info is set.
94 * @param[in] numberOfCharacters The number of characters to set the script.
95 * @param[out] scripts Vector containing the script runs for the whole text.
97 void SetScripts( const Vector<Character>& text,
98 CharacterIndex startIndex,
99 Length numberOfCharacters,
100 Vector<ScriptRun>& scripts );
103 * @brief Validates the character's font of the whole text.
105 * This method ensures all characters are going to be rendered using an appropriate font. Provided a valid font
106 * exists in the platform.
108 * For those characters with no font set, it sets a default one.
110 * If a font has been set by the application developer, this method checks if the font supports the character.
111 * If it doesn't, this method replaces it by a default one.
113 * @param[in] text Vector of UTF-32 characters.
114 * @param[in] scripts Vector containing the script runs for the whole text.
115 * @param[in] fontDescriptions The fonts set through the mark-up string or the input style set through the property system.
116 * @param[in] defaultFontDescription The default font's description set through the property system.
117 * @param[in] defaultFontPointSize The default font's point size set through the property system.
118 * @param[in] startIndex The character from where the font info is set.
119 * @param[in] numberOfCharacters The number of characters to set the font.
120 * @param[out] fonts The validated fonts.
122 void ValidateFonts( const Vector<Character>& text,
123 const Vector<ScriptRun>& scripts,
124 const Vector<FontDescriptionRun>& fontDescriptions,
125 const TextAbstraction::FontDescription& defaultFontDescription,
126 TextAbstraction::PointSize26Dot6 defaultFontPointSize,
127 CharacterIndex startIndex,
128 Length numberOfCharacters,
129 Vector<FontRun>& fonts );
134 } // namespace Toolkit
138 #endif // __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__