docs/tmpl/coverage-maps.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Coverage Maps
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Unicode character range coverage storage
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 It is often necessary in Pango to determine if a particular font can
  10 represent a particular character, and also how well it can represent
  11 that character. The #PangoCoverage is a data structure that is used
  12 to represent that information.
  13 </para>
  14
  15 <!-- ##### SECTION See_Also ##### -->
  16 <para>
  17
  18 </para>
  19
  20 <!-- ##### SECTION Stability_Level ##### -->
  21
  22
  23 <!-- ##### ENUM PangoCoverageLevel ##### -->
  24 <para>
  25 Used to indicate how well a font can represent a particular Unicode
  26 character point for a particular script.
  27 </para>
  28
  29 @PANGO_COVERAGE_NONE: The character is not representable with the font.
  30 @PANGO_COVERAGE_FALLBACK: The character is represented in a way that may be
  31                           comprehensible but is not the correct graphical form.
  32                           For instance, a Hangul character represented as a
  33                           a sequence of Jamos, or a Latin transliteration of
  34                           a Cyrillic word.
  35 @PANGO_COVERAGE_APPROXIMATE: The character is represented as basically the correct
  36                              graphical form, but with a stylistic variant inappropriate for
  37                              the current script.
  38 @PANGO_COVERAGE_EXACT: The character is represented as the correct graphical form.
  39
  40 <!-- ##### MACRO PANGO_TYPE_COVERAGE_LEVEL ##### -->
  41 <para>
  42 The #GObject type for #PangoCoverageLevel.
  43 </para>
  44
  45
  46
  47 <!-- ##### STRUCT PangoCoverage ##### -->
  48 <para>
  49 The #PangoCoverage structure represents a map from Unicode characters
  50 to #PangoCoverageLevel. It is an opaque structure with no public fields.
  51 </para>
  52
  53
  54 <!-- ##### FUNCTION pango_coverage_new ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @Returns:
  60
  61
  62 <!-- ##### FUNCTION pango_coverage_ref ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @coverage:
  68 @Returns:
  69
  70
  71 <!-- ##### FUNCTION pango_coverage_unref ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @coverage:
  77
  78
  79 <!-- ##### FUNCTION pango_coverage_copy ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @coverage:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION pango_coverage_get ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @coverage:
  94 @index_:
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION pango_coverage_max ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @coverage:
 104 @other:
 105
 106
 107 <!-- ##### FUNCTION pango_coverage_set ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @coverage:
 113 @index_:
 114 @level:
 115
 116
 117 <!-- ##### FUNCTION pango_coverage_to_bytes ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @coverage:
 123 @bytes:
 124 @n_bytes:
 125
 126
 127 <!-- ##### FUNCTION pango_coverage_from_bytes ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @bytes:
 133 @n_bytes:
 134 @Returns:
 135
 136