1 #ifndef DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H
2 #define DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H
5 * Copyright (c) 2019 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/object/base-object.h>
25 #include <dali/devel-api/text-abstraction/font-client.h>
33 namespace TextAbstraction
40 * Implementation of the FontClient
42 class FontClient : public BaseObject
57 * @copydoc Dali::TextAbstraction::FontClient::Get()
59 static Dali::TextAbstraction::FontClient Get();
62 * @copydoc Dali::TextAbstraction::FontClient::SetDpi()
64 void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
67 * @copydoc Dali::TextAbstraction::FontClient::GetDpi()
69 void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
72 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFontSize()
74 int GetDefaultFontSize();
77 * @copydoc Dali::TextAbstraction::FontClient::ResetSystemDefaults()
79 void ResetSystemDefaults();
82 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFonts()
84 void GetDefaultFonts( FontList& defaultFonts );
87 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
89 void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
92 * @copydoc Dali::TextAbstraction::FontClient::GetSystemFonts()
94 void GetSystemFonts( FontList& systemFonts );
97 * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
99 void GetDescription( FontId id, FontDescription& fontDescription );
102 * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
104 PointSize26Dot6 GetPointSize( FontId id );
107 * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
109 bool IsCharacterSupportedByFont( FontId fontId, Character character );
112 * @copydoc Dali::TextAbstraction::FontClient::FindDefaultFont()
114 FontId FindDefaultFont( Character charcode,
115 PointSize26Dot6 requestedPointSize,
119 * @copydoc Dali::TextAbstraction::FontClient::FindFallbackFont()
121 FontId FindFallbackFont( Character charcode,
122 const FontDescription& preferredFontDescription,
123 PointSize26Dot6 requestedPointSize,
127 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
129 FontId GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex );
132 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontDescription& fontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
134 FontId GetFontId( const FontDescription& fontDescription,
135 PointSize26Dot6 requestedPointSize,
136 FaceIndex faceIndex );
139 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const BitmapFont& bitmapFont )
141 FontId GetFontId( const BitmapFont& bitmapFont );
144 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontPath& path )
146 bool IsScalable( const FontPath& path );
149 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontDescription& fontDescription )
151 bool IsScalable( const FontDescription& fontDescription );
154 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes )
156 void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
159 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
161 void GetFixedSizes( const FontDescription& fontDescription,
162 Dali::Vector< PointSize26Dot6 >& sizes );
165 * @copydoc Dali::TextAbstraction::FontClient::HasItalicStyle()
167 bool HasItalicStyle( FontId fontId ) const;
170 * @copydoc Dali::TextAbstraction::FontClient::GetFontMetrics()
172 void GetFontMetrics( FontId fontId, FontMetrics& metrics );
175 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
177 GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
180 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
182 bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal );
185 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth )
187 void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth );
190 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth )
192 PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth );
195 * @copydoc Dali::TextAbstraction::FontClient::CreateVectorBlob()
197 void CreateVectorBlob( FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight );
200 * @copydoc Dali::TextAbstraction::FontClient::GetEllipsisGlyph()
202 const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
205 * @copydoc Dali::TextAbstraction::FontClient::IsColorGlyph()
207 bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex );
210 * @copydoc Dali::TextAbstraction::FontClient::CreateEmbeddedItem()
212 GlyphIndex CreateEmbeddedItem( const TextAbstraction::FontClient::EmbeddedItemDescription& description, Pixel::Format& pixelFormat );
215 * @brief Retrieves the pointer to the FreeType Font Face for the given @p fontId.
217 * @param[in] fontId The font id.
219 * @return The pointer to the FreeType Font Face.
221 FT_FaceRec_* GetFreetypeFace( FontId fontId );
224 * @brief Retrieves the type of font.
226 * @param[in] fontId The font id.
228 * @return FACE_FONT if the font has been loaded by FreeType, BITMAP_FONT if it's a font that has been loaded from images or INVALID if it's a non valid font.
230 FontDescription::Type GetFontType( FontId fontId );
233 * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
235 bool AddCustomFontDirectory( const FontPath& path );
240 * Helper for lazy initialization.
244 // Undefined copy constructor.
245 FontClient( const FontClient& );
247 // Undefined assignment constructor.
248 FontClient& operator=( const FontClient& );
255 // Allows DPI to be set without loading plugin
256 unsigned int mDpiHorizontal;
257 unsigned int mDpiVertical;
259 }; // class FontClient
261 } // namespace Internal
263 inline static Internal::FontClient& GetImplementation(FontClient& fontClient)
265 DALI_ASSERT_ALWAYS( fontClient && "fontClient handle is empty" );
266 BaseObject& handle = fontClient.GetBaseObject();
267 return static_cast<Internal::FontClient&>(handle);
270 inline static const Internal::FontClient& GetImplementation(const FontClient& fontClient)
272 DALI_ASSERT_ALWAYS( fontClient && "fontClient handle is empty" );
273 const BaseObject& handle = fontClient.GetBaseObject();
274 return static_cast<const Internal::FontClient&>(handle);
277 } // namespace TextAbstraction
281 #endif // DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H