Stop setting crazy Z value with controls (at the moment depth is ignored by Size...
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / multi-language-support.h
1 #ifndef __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__
2 #define __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__
3
4 /*
5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/common/dali-vector.h>
23 #include <dali/public-api/object/base-handle.h>
24
25 // INTERNAL INCLUDES
26 #include <dali-toolkit/internal/text/font-run.h>
27 #include <dali-toolkit/internal/text/script-run.h>
28
29 namespace Dali
30 {
31
32 namespace Toolkit
33 {
34
35 namespace Text
36 {
37
38 namespace Internal DALI_INTERNAL
39 {
40
41 class MultilanguageSupport;
42
43 } // Internal
44
45 class LogicalModel;
46
47 /**
48  * @brief Sets the character's scripts to the model and validates the fonts set by the user or assigns default ones.
49  */
50 class MultilanguageSupport : public BaseHandle
51 {
52 public:
53
54   /**
55    * @brief Create an uninitialized MultilanguageSupport handle.
56    */
57   MultilanguageSupport();
58
59   /**
60    * @brief Destructor
61    *
62    * This is non-virtual since derived Handle types must not contain data or virtual methods.
63    */
64   ~MultilanguageSupport();
65
66   /**
67    * @brief This constructor is used by MultilanguageSupport::Get().
68    *
69    * @param[in] implementation A pointer to the internal multi-language support object.
70    */
71   explicit DALI_INTERNAL MultilanguageSupport( Internal::MultilanguageSupport* implementation );
72
73   /**
74    * @brief Retrieve a handle to the MultilanguageSupport instance.
75    *
76    * @return A handle to the MultilanguageSupport.
77    */
78   static MultilanguageSupport Get();
79
80   /**
81    * @brief Sets the scripts of the whole text.
82    *
83    * Scripts are used to validate and set default fonts and to shape the text in further steps.
84    *
85    * Some characters (like white spaces) are valid for many scripts. The rules to set a script
86    * for them are:
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.
92    *
93    * @param[in] text Vector of UTF-32 characters.
94    * @param[out] scripts Vector containing the script runs for the whole text.
95    */
96   void SetScripts( const Vector<Character>& text,
97                    Vector<ScriptRun>& scripts );
98
99   /**
100    * @brief Validates the character's font of the whole text.
101    *
102    * It may update fonts set by application developers.
103    *
104    * This method ensures all characters are going to be rendered using an appropriate font. Provided a valid font
105    * exists in the platform.
106    *
107    * For those characters with no font set, it sets a default one.
108    *
109    * If a font has been set by the application developer, this method checks if the font supports the character.
110    * If it doesn't, this method replaces it by a default one.
111    *
112    * @param[in] text Vector of UTF-32 characters.
113    * @param[in] scripts Vector containing the script runs for the whole text.
114    * @param[in,out] fonts Initially contains the fonts set by the application developers. Returns the validated fonts.
115    */
116   void ValidateFonts( const Vector<Character>& text,
117                       const Vector<ScriptRun>& scripts,
118                       Vector<FontRun>& fonts );
119 };
120
121 } // namespace Text
122
123 } // namespace Toolkit
124
125 } // namespace Dali
126
127 #endif // __DALI_TOOLKIT_TEXT_MULTI_LANGUAGE_SUPPORT_H__