Dali-Text: Keyboard Shortcuts
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / metrics.h
1 #ifndef DALI_TOOLKIT_TEXT_METRICS_H
2 #define DALI_TOOLKIT_TEXT_METRICS_H
3
4 /*
5  * Copyright (c) 2019 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/intrusive-ptr.h>
23 #include <dali/devel-api/text-abstraction/font-client.h>
24
25 // INTERNAL INCLUDES
26 #include <dali-toolkit/internal/text/text-definitions.h>
27
28 namespace Dali
29 {
30
31 namespace Toolkit
32 {
33
34 namespace Text
35 {
36
37 class Metrics;
38 typedef IntrusivePtr<Metrics> MetricsPtr;
39
40 /**
41  * @brief A wrapper around FontClient used to get metrics.
42  */
43 class Metrics : public RefObject
44 {
45 public:
46
47   /**
48    * Create a new Metrics object
49    */
50   static Metrics* New( TextAbstraction::FontClient& fontClient )
51   {
52     return new Metrics( fontClient );
53   }
54
55   /**
56    * @brief Used to switch between bitmap & vector based glyphs
57    *
58    * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
59    */
60   void SetGlyphType( TextAbstraction::GlyphType glyphType )
61   {
62     mGlyphType = glyphType;
63   }
64
65   /**
66    * @brief Query the metrics for a font.
67    *
68    * @param[in] fontId The ID of the font for the required glyph.
69    * @param[out] metrics The font metrics.
70    */
71   void GetFontMetrics( FontId fontId, FontMetrics& metrics )
72   {
73     mFontClient.GetFontMetrics( fontId, metrics ); // inline for performance
74   }
75
76   /**
77    * @brief Retrieve the metrics for a series of glyphs.
78    *
79    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
80    * It may contain the advance and an offset set into the bearing from the shaping tool.
81    * On return, the glyph's size value will be initialized. The bearing value will be updated by adding the font's glyph bearing to the one set by the shaping tool.
82    * @param[in] size The size of the array.
83    * @return True if all of the requested metrics were found.
84    */
85   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size )
86   {
87     return mFontClient.GetGlyphMetrics( array, size, mGlyphType, true ); // inline for performance
88   }
89
90   /**
91    * @brief Whether the font has Italic style.
92    *
93    * @param[in] fontId The font identifier.
94    *
95    * @return true if the font has italic style.
96    */
97   bool HasItalicStyle( FontId fontId ) const
98   {
99     return mFontClient.HasItalicStyle( fontId );
100   }
101
102 protected:
103
104   /**
105    * A reference counted object may only be deleted by calling Unreference()
106    */
107   virtual ~Metrics() {}
108
109 private:
110
111   /**
112    * Constructor.
113    */
114   Metrics( TextAbstraction::FontClient& fontClient )
115   : mFontClient( fontClient ),
116     mGlyphType( TextAbstraction::BITMAP_GLYPH )
117   {}
118
119   // Undefined
120   Metrics(const Metrics&);
121
122   // Undefined
123   Metrics& operator=(const Metrics& rhs);
124
125 private:
126
127   TextAbstraction::FontClient mFontClient;
128   TextAbstraction::GlyphType mGlyphType;
129 };
130
131 } // namespace Text
132
133 } // namespace Toolkit
134
135 } // namespace Dali
136
137 #endif // DALI_TOOLKIT_TEXT_METRICS_H