1 #ifndef DALI_TOOLKIT_TEXT_METRICS_H
2 #define DALI_TOOLKIT_TEXT_METRICS_H
5 * Copyright (c) 2021 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/devel-api/text-abstraction/font-client.h>
23 #include <dali/public-api/common/intrusive-ptr.h>
26 #include <dali-toolkit/internal/text/text-definitions.h>
35 typedef IntrusivePtr<Metrics> MetricsPtr;
38 * @brief A wrapper around FontClient used to get metrics.
40 class Metrics : public RefObject
44 * Create a new Metrics object
46 static Metrics* New(TextAbstraction::FontClient& fontClient)
48 return new Metrics(fontClient);
52 * @brief Used to switch between bitmap & vector based glyphs
54 * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
56 void SetGlyphType(TextAbstraction::GlyphType glyphType)
58 mGlyphType = glyphType;
62 * @brief Query the metrics for a font.
64 * @param[in] fontId The ID of the font for the required glyph.
65 * @param[out] metrics The font metrics.
67 void GetFontMetrics(FontId fontId, FontMetrics& metrics)
69 mFontClient.GetFontMetrics(fontId, metrics); // inline for performance
73 * @brief Retrieve the metrics for a series of glyphs.
75 * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
76 * It may contain the advance and an offset set into the bearing from the shaping tool.
77 * 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.
78 * @param[in] size The size of the array.
79 * @return True if all of the requested metrics were found.
81 bool GetGlyphMetrics(GlyphInfo* array, uint32_t size)
83 return mFontClient.GetGlyphMetrics(array, size, mGlyphType, true); // inline for performance
87 * @brief Whether the font has Italic style.
89 * @param[in] fontId The font identifier.
91 * @return true if the font has italic style.
93 bool HasItalicStyle(FontId fontId) const
95 return mFontClient.HasItalicStyle(fontId);
100 * A reference counted object may only be deleted by calling Unreference()
110 Metrics(TextAbstraction::FontClient& fontClient)
111 : mFontClient(fontClient),
112 mGlyphType(TextAbstraction::BITMAP_GLYPH)
117 Metrics(const Metrics&);
120 Metrics& operator=(const Metrics& rhs);
123 TextAbstraction::FontClient mFontClient;
124 TextAbstraction::GlyphType mGlyphType;
129 } // namespace Toolkit
133 #endif // DALI_TOOLKIT_TEXT_METRICS_H