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/script-run.h>
38 namespace Internal DALI_INTERNAL
41 class MultilanguageSupport;
48 * @brief Sets the character's scripts to the model and validates the fonts set by the user or assigns default ones.
50 class MultilanguageSupport : public BaseHandle
55 * @brief Create an uninitialized MultilanguageSupport handle.
57 MultilanguageSupport();
62 * This is non-virtual since derived Handle types must not contain data or virtual methods.
64 ~MultilanguageSupport();
67 * @brief This constructor is used by MultilanguageSupport::Get().
69 * @param[in] implementation A pointer to the internal multi-language support object.
71 explicit DALI_INTERNAL MultilanguageSupport( Internal::MultilanguageSupport* implementation );
74 * @brief Retrieve a handle to the MultilanguageSupport instance.
76 * @return A handle to the MultilanguageSupport.
78 static MultilanguageSupport Get();
81 * @brief Sets the scripts of the whole text.
83 * Scripts are used to validate and set default fonts and to shape the text in further steps.
85 * Some characters (like white spaces) are valid for many scripts. The rules to set a script
87 * - If they are at the begining of a paragraph they get the script of the first character with
88 * a defined script. If they are at the end, they get the script of the last one.
89 * - If they are between two scripts with the same direction, they get the script of the previous
90 * character with a defined script. If the two scripts have different directions, they get the
91 * script of the first character of the paragraph with a defined script.
93 * @param[in] text Vector of UTF-32 characters.
94 * @param[in] lineBreakInfo Vector with the line break info.
95 * @param[out] scripts Vector containing the script runs for the whole text.
97 void SetScripts( const Vector<Character>& text,
98 const Vector<LineBreakInfo>& lineBreakInfo,
99 Vector<ScriptRun>& scripts );
102 * @brief Validates the character's font of the whole text.
104 * It may update fonts set by application developers.
106 * This method ensures all characters are going to be rendered using an appropriate font. Provided a valid font
107 * exists in the platform.
109 * For those characters with no font set, it sets a default one.
111 * If a font has been set by the application developer, this method checks if the font supports the character.
112 * If it doesn't, this method replaces it by a default one.
114 * @param[in] text Vector of UTF-32 characters.
115 * @param[in] scripts Vector containing the script runs for the whole text.
116 * @param[in,out] fonts Initially contains the fonts set by the application developers. Returns the validated fonts.
118 void ValidateFonts( const Vector<Character>& text,
119 const Vector<ScriptRun>& scripts,
120 Vector<FontRun>& fonts );
125 } // namespace Toolkit
129 #endif // __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__