docs/tmpl/bidi.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Bidirectional Text
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Types and functions to help with handling bidirectional text
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Pango supports bidirectional text (like Arabic and Hebrew) automatically.
  10 Some applications however, need some help to correctly handle bidirectional
  11 text.
  12 </para>
  13 <para>
  14 The #PangoDirection type can be used with pango_context_set_base_dir() to
  15 instruct Pango about direction of text, though in most cases Pango detects
  16 that correctly and automatically.  The rest of the facilities in this section
  17 are used internally by Pango already, and are provided to help applications
  18 that need more direct control over bidirectional setting of text.
  19 </para>
  20
  21 <!-- ##### SECTION See_Also ##### -->
  22 <para>
  23 pango_context_get_base_dir(),
  24 pango_context_set_base_dir(),
  25 pango_itemize_with_base_dir()
  26 </para>
  27
  28 <!-- ##### SECTION Stability_Level ##### -->
  29
  30
  31 <!-- ##### ENUM PangoDirection ##### -->
  32 <para>
  33 </para>
  34
  35 @PANGO_DIRECTION_LTR:
  36 @PANGO_DIRECTION_RTL:
  37 @PANGO_DIRECTION_TTB_LTR:
  38 @PANGO_DIRECTION_TTB_RTL:
  39 @PANGO_DIRECTION_WEAK_LTR:
  40 @PANGO_DIRECTION_WEAK_RTL:
  41 @PANGO_DIRECTION_NEUTRAL:
  42
  43 <!-- ##### FUNCTION pango_unichar_direction ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @ch:
  49 @Returns:
  50
  51
  52 <!-- ##### FUNCTION pango_find_base_dir ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @text:
  58 @length:
  59 @Returns:
  60
  61
  62 <!-- ##### FUNCTION pango_get_mirror_char ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @ch:
  68 @mirrored_ch:
  69 @Returns:
  70
  71
  72 <!-- ##### ENUM PangoBidiType ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @PANGO_BIDI_TYPE_L:
  78 @PANGO_BIDI_TYPE_LRE:
  79 @PANGO_BIDI_TYPE_LRO:
  80 @PANGO_BIDI_TYPE_R:
  81 @PANGO_BIDI_TYPE_AL:
  82 @PANGO_BIDI_TYPE_RLE:
  83 @PANGO_BIDI_TYPE_RLO:
  84 @PANGO_BIDI_TYPE_PDF:
  85 @PANGO_BIDI_TYPE_EN:
  86 @PANGO_BIDI_TYPE_ES:
  87 @PANGO_BIDI_TYPE_ET:
  88 @PANGO_BIDI_TYPE_AN:
  89 @PANGO_BIDI_TYPE_CS:
  90 @PANGO_BIDI_TYPE_NSM:
  91 @PANGO_BIDI_TYPE_BN:
  92 @PANGO_BIDI_TYPE_B:
  93 @PANGO_BIDI_TYPE_S:
  94 @PANGO_BIDI_TYPE_WS:
  95 @PANGO_BIDI_TYPE_ON:
  96
  97 <!-- ##### FUNCTION pango_bidi_type_for_unichar ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @ch:
 103 @Returns:
 104
 105