Add API to font client to retreive Platform default font
[platform/core/uifw/dali-adaptor.git] / text / dali / internal / text-abstraction / font-client-impl.h
1 #ifndef __DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H__
2 #define __DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_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/object/base-object.h>
23
24 // INTERNAL INCLUDES
25 #include <dali/devel-api/text-abstraction/font-client.h>
26
27 namespace Dali
28 {
29
30 namespace TextAbstraction
31 {
32
33 namespace Internal
34 {
35
36 /**
37  * Implementation of the FontClient
38  */
39 class FontClient : public BaseObject
40 {
41 public:
42
43   /**
44    * Constructor
45    */
46   FontClient();
47
48   /**
49    * Destructor
50    */
51   ~FontClient();
52
53   /**
54    * @copydoc Dali::FontClient::Get()
55    */
56   static Dali::TextAbstraction::FontClient Get();
57
58   /**
59    * @copydoc Dali::FontClient::SetDpi()
60    */
61   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
62
63   /**
64    * @copydoc Dali::FontClient::GetDpi()
65    */
66   void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
67
68   /**
69    * @copydoc Dali::FontClient::SetDefaultFont()
70    */
71   void SetDefaultFont( const FontDescription& fontDescription );
72
73   /**
74    * @copydoc Dali::FontClient::GetDefaultFonts()
75    */
76   void GetDefaultFonts( FontList& defaultFonts );
77
78   /**
79    * @copydoc Dali::FontClient::GetDefaultPlatformFontDescription()
80    */
81   void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
82
83   /**
84    * @copydoc Dali::FontClient::GetSystemFonts()
85    */
86   void GetSystemFonts( FontList& systemFonts );
87
88   /**
89    * @copydoc Dali::FontClient::GetDescription()
90    */
91   void GetDescription( FontId id, FontDescription& fontDescription );
92
93   /**
94    * @copydoc Dali::FontClient::GetPointSize()
95    */
96   PointSize26Dot6 GetPointSize( FontId id );
97
98   /**
99    * @copydoc Dali::FontClient::FindDefaultFont()
100    */
101   FontId FindDefaultFont( Character charcode, PointSize26Dot6 pointSize, bool preferColor );
102
103   /**
104    * @copydoc Dali::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 pointSize, FaceIndex faceIndex )
105    */
106   FontId GetFontId( const FontPath& path, PointSize26Dot6 pointSize, FaceIndex faceIndex );
107
108   /**
109    * @copydoc Dali::FontClient::GetFontId( const FontDescription& fontDescription, PointSize26Dot6 pointSize, FaceIndex faceIndex )
110    */
111   FontId GetFontId( const FontDescription& fontDescription,
112                     PointSize26Dot6 pointSize,
113                     FaceIndex faceIndex );
114
115   /**
116    * @copydoc Dali::FontClient::IsScalable( const FontPath& path )
117    */
118   bool IsScalable( const FontPath& path );
119
120   /**
121    * @copydoc Dali::FontClient::IsScalable( const FontDescription& fontDescription )
122    */
123   bool IsScalable( const FontDescription& fontDescription );
124
125   /**
126    * @copydoc Dali::FontClient::GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes )
127    */
128   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
129
130   /**
131    * @copydoc Dali::FontClient::GetFixedSizes()
132    */
133   void GetFixedSizes( const FontDescription& fontDescription,
134                       Dali::Vector< PointSize26Dot6 >& sizes );
135
136   /**
137    * @copydoc Dali::FontClient::GetFontMetrics()
138    */
139   void GetFontMetrics( FontId fontId, FontMetrics& metrics, int maxFixedSize );
140
141   /**
142    * @copydoc Dali::FontClient::GetGlyphIndex()
143    */
144   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
145
146   /**
147    * @copydoc Dali::FontClient::GetGlyphMetrics()
148    */
149   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, bool horizontal, int maxFixedSize );
150
151   /**
152    * @copydoc Dali::FontClient::CreateBitmap()
153    */
154   BufferImage CreateBitmap( FontId fontId, GlyphIndex glyphIndex );
155
156   /**
157    * @copydoc Dali::FontClient::GetEllipsisGlyph()
158    */
159   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 pointSize );
160
161 private:
162
163   /**
164    * Helper for lazy initialization.
165    */
166   void CreatePlugin();
167
168   // Undefined copy constructor.
169   FontClient( const FontClient& );
170
171   // Undefined assignment constructor.
172   FontClient& operator=( FontClient& );
173
174 private:
175
176   struct Plugin;
177   Plugin* mPlugin;
178
179   // Allows DPI to be set without loading plugin
180   unsigned int mDpiHorizontal;
181   unsigned int mDpiVertical;
182
183 }; // class FontClient
184
185 } // namespace Internal
186
187 inline static Internal::FontClient& GetImplementation(FontClient& fontClient)
188 {
189   DALI_ASSERT_ALWAYS( fontClient && "fontClient handle is empty" );
190   BaseObject& handle = fontClient.GetBaseObject();
191   return static_cast<Internal::FontClient&>(handle);
192 }
193
194 inline static const Internal::FontClient& GetImplementation(const FontClient& fontClient)
195 {
196   DALI_ASSERT_ALWAYS( fontClient && "fontClient handle is empty" );
197   const BaseObject& handle = fontClient.GetBaseObject();
198   return static_cast<const Internal::FontClient&>(handle);
199 }
200
201 } // namespace TextAbstraction
202
203 } // namespace Dali
204
205 #endif // __DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H__