text/dali/public-api/text-abstraction/font-client.h

   1 #ifndef __DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H__
   2 #define __DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_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 #include <dali/public-api/object/base-handle.h>
  22 #include <dali/public-api/images/bitmap-image.h>
  23 #include <dali/public-api/common/dali-vector.h>
  24 #include <dali/public-api/text-abstraction/text-abstraction-definitions.h>
  25 #include <dali/public-api/text-abstraction/glyph-info.h>
  26 #include <dali/public-api/text-abstraction/font-list.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace TextAbstraction
  32 {
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class FontClient;
  37 }
  38
  39 /**
  40  * @brief FontClient provides access to font information and resources.
  41  *
  42  * <h3>Querying the System Fonts</h3>
  43  *
  44  * A "system font" is described by a "path" to a font file on the native filesystem, along with a "family" and "style".
  45  * For example on the Ubuntu system a "Regular" style font from the "Ubuntu Mono" family can be accessed from "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf".
  46  *
  47  * <h3>Accessing Fonts</h3>
  48  *
  49  * A "font" is created from the system for a specific point size. A "FontId" is used to identify each font.
  50  * For example two different fonts with point sizes 10 & 12 can be created from the "Ubuntu Mono" family:
  51  * @code
  52  * FontClient fontClient   = FontClient::Get();
  53  * FontId ubuntuMonoTen    = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 10 );
  54  * FontId ubuntuMonoTwelve = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 12 );
  55  * @endcode
  56  * Glyph metrics and bitmap resources can then be retrieved using the FontId.
  57  */
  58 class DALI_IMPORT_API FontClient : public BaseHandle
  59 {
  60 public:
  61
  62   /**
  63    * @brief Retrieve a handle to the FontClient instance.
  64    *
  65    * @return A handle to the FontClient
  66    */
  67   static FontClient Get();
  68
  69   /**
  70    * @brief Create an uninitialized TextAbstraction handle.
  71    */
  72   FontClient();
  73
  74   /**
  75    * @brief Destructor
  76    *
  77    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  78    */
  79   ~FontClient();
  80
  81   /**
  82    * @brief This copy constructor is required for (smart) pointer semantics.
  83    *
  84    * @param[in] handle A reference to the copied handle.
  85    */
  86   FontClient( const FontClient& handle );
  87
  88   /**
  89    * @brief This assignment operator is required for (smart) pointer semantics.
  90    *
  91    * @param [in] handle  A reference to the copied handle.
  92    * @return A reference to this.
  93    */
  94   FontClient& operator=( const FontClient& handle );
  95
  96   /**
  97    * @brief Set the DPI of the target window.
  98    *
  99    * @note Multiple windows are not currently supported.
 100    * @param[in] horizontalDpi The horizontal resolution in DPI.
 101    * @param[in] verticalDpi The vertical resolution in DPI.
 102    */
 103   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
 104
 105   /**
 106    * @brief Retrieve the list of fonts supported by the system.
 107    *
 108    * @param[out] systemFonts A list of font paths, family & style strings.
 109    */
 110   void GetSystemFonts( FontList& systemFonts );
 111
 112   /**
 113    * @brief Find an appropriate system-font for displaying a UTF-32 character.
 114    *
 115    * This is useful when localised strings are provided for multiple languages
 116    * i.e. when a single default font does not work for all languages.
 117    * @param[in] charcode The character for which a font is needed.
 118    * @param[out] systemFont The path, family & style describing the font.
 119    * @return True if an appropriate system font was found.
 120    */
 121   bool FindSystemFont( Character charcode, FontDescription& systemFont );
 122
 123   /**
 124    * @brief Retrieve the unique identifier for a font.
 125    *
 126    * @param[in] path The path to a font file.
 127    * @param[in] pointSize The point size in 26.6 fractional points; the default point size is 12.
 128    * @param[in] faceIndex The index of the font face (optional).
 129    * @return A valid font ID, or zero if the font does not exist.
 130    */
 131   FontId GetFontId( const FontPath& path, PointSize26Dot6 pointSize = 12*64, FaceIndex faceIndex = 0 );
 132
 133   /**
 134    * @brief Retrieve the ID of the default font for displaying a UTF-32 character.
 135    *
 136    * This is useful when localised strings are provided for multiple languages
 137    * i.e. when a single default font does not work for all languages.
 138    * @param[in] charcode The character for which a font is needed.
 139    * @return A valid font ID, or zero if no appropriate font was found.
 140    */
 141   FontId FindDefaultFont( Character charcode );
 142
 143   /**
 144    * @brief Retrieve the glyph index for a UTF-32 character code.
 145    *
 146    * @param[in] fontId The ID of the font for the required glyph.
 147    * @param[in] charcode The UTF-32 character code.
 148    * @return The glyph index, or zero if the character code is undefined.
 149    */
 150   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
 151
 152   /**
 153    * @brief Retrieve the metrics for a series of glyphs.
 154    *
 155    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
 156    * On return, the remaining metrics values will be initialized e.g. glyph size & bearing values.
 157    * @param[in] size The size of the array.
 158    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
 159    * @return True if all of the requested metrics were found.
 160    */
 161   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, bool horizontal = true );
 162
 163   /**
 164    * @brief Render a bitmap representation of a glyph.
 165    *
 166    * @param[in] fontId The ID of the font.
 167    * @param[in] glyphIndex The index of a glyph within the specified font.
 168    * @return A valid BitmapImage, or an empty handle if the glyph could not be rendered.
 169    */
 170   BitmapImage CreateBitmap( FontId fontId, GlyphIndex glyphIndex );
 171
 172 public: // Not intended for application developers
 173   /**
 174    * @brief This constructor is used by FontClient::Get().
 175    *
 176    * @param[in] fontClient  A pointer to the internal fontClient object.
 177    */
 178   explicit DALI_INTERNAL FontClient( Internal::FontClient* fontClient );
 179 };
 180
 181 } // namespace TextAbstraction
 182
 183 } // namespace Dali
 184
 185 #endif // __DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H__