dali-toolkit/public-api/text/text-definitions.h

   1 #ifndef __DALI_TEXT_ABSTRACTION_TEXT_TYPE_DEFINITIONS_H__
   2 #define __DALI_TEXT_ABSTRACTION_TEXT_TYPE_DEFINITIONS_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/text-abstraction/text-abstraction.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Text
  31 {
  32
  33 typedef TextAbstraction::FontId          FontId;          ///< The unique identifier for a font face (generated by FontClient)
  34 typedef TextAbstraction::FontMetrics     FontMetrics;     ///< The metrics for a Font expressed in 26.6 fractional pixel format
  35 typedef TextAbstraction::PointSize26Dot6 PointSize26Dot6; ///< The point size in 26.6 fractional points
  36 typedef TextAbstraction::FaceIndex       FaceIndex;       ///< Used with fonts which allow several font faces
  37 typedef TextAbstraction::GlyphIndex      GlyphIndex;      ///< Uniquely identifies a glyph within a particular font
  38 typedef TextAbstraction::Character       Character;       ///< A UTF-32 representation of a character
  39 typedef TextAbstraction::GlyphInfo       GlyphInfo;       ///< The information describing a glyph (font ID, index, metrics)
  40 typedef TextAbstraction::CharacterIndex  CharacterIndex;  ///< An index into an array of characters
  41 typedef TextAbstraction::Length          Length;          ///< The length of an array
  42 typedef TextAbstraction::BidiInfoIndex   BidiInfoIndex;   ///< Index to the bidirectional info for a paragraph.
  43 typedef TextAbstraction::Script          Script;          ///< The character's script.
  44 typedef TextAbstraction::LineBreakInfo   LineBreakInfo;   ///< Line break info (must break, allow break, no break). Possible values are: @e LINE_MUST_BREAK, @e LINE_ALLOW_BREAK and @e LINE_NO_BREAK (in the TextAbstraction namespace).
  45 typedef TextAbstraction::WordBreakInfo   WordBreakInfo;   ///< Word break info (break, no break). Possible values are: @e WORD_BREAK and @e WORD_NO_BREAK (in the TextAbstraction namespace).
  46
  47 typedef uint32_t GlyphIndex;         ///< An index into an array of glyphs
  48 typedef bool     CharacterDirection; ///< The character's direction: @e false is left to right, @e true is right to left.
  49
  50 } // namespace Text
  51
  52 } // namespace Toolkit
  53
  54 } // namespace Dali
  55
  56 #endif // __DALI_TEXT_ABSTRACTION_TEXT_TYPE_DEFINITIONS_H__