doc/fribidi_get_bidi_type_name.3

   1 .\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
   2 .\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
   3 .TH "fribidi_get_bidi_type_name" 3 "2 December 2012" "GNU FriBidi 0.19.4" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_bidi_type_name \- get bidi type name
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 const char *fribidi_get_bidi_type_name(FriBidiCharType t);
  11 .ft R
  12 .SH "PARAMETERS"
  13 .TP
  14 .B "FriBidiCharType t"
  15 Input bidi type.
  16 .sp
  17 Possible values for a \fBFriBidiCharType\fR are as follows:
  18 .RS 0.75in
  19 .PD 0
  20 .ft B
  21 .nr TL \w'FRIBIDI_TYPE_LTR'u+0.2i
  22 .ft R
  23 .TP \n(TLu
  24 \fBFRIBIDI_TYPE_LTR\fR
  25 Left-To-Right letter.
  26 .TP \n(TLu
  27 \fBFRIBIDI_TYPE_RTL\fR
  28 Right-To-Left letter.
  29 .TP \n(TLu
  30 \fBFRIBIDI_TYPE_AL\fR
  31 Arabic Letter.
  32 .TP \n(TLu
  33 \fBFRIBIDI_TYPE_EN\fR
  34 European Numeral.
  35 .TP \n(TLu
  36 \fBFRIBIDI_TYPE_AN\fR
  37 Arabic Numeral.
  38 .TP \n(TLu
  39 \fBFRIBIDI_TYPE_ES\fR
  40 European number Separator.
  41 .TP \n(TLu
  42 \fBFRIBIDI_TYPE_ET\fR
  43 European number Terminator.
  44 .TP \n(TLu
  45 \fBFRIBIDI_TYPE_CS\fR
  46 Common Separator.
  47 .TP \n(TLu
  48 \fBFRIBIDI_TYPE_NSM\fR
  49 Non Spacing Mark.
  50 .TP \n(TLu
  51 \fBFRIBIDI_TYPE_BN\fR
  52 Boundary Neutral.
  53 .TP \n(TLu
  54 \fBFRIBIDI_TYPE_BS\fR
  55 Block Separator.
  56 .TP \n(TLu
  57 \fBFRIBIDI_TYPE_SS\fR
  58 Segment Separator.
  59 .TP \n(TLu
  60 \fBFRIBIDI_TYPE_WS\fR
  61 WhiteSpace.
  62 .TP \n(TLu
  63 \fBFRIBIDI_TYPE_ON\fR
  64 Other Neutral.
  65 .TP \n(TLu
  66 \fBFRIBIDI_TYPE_LRE\fR
  67 Left-to-Right Embedding.
  68 .TP \n(TLu
  69 \fBFRIBIDI_TYPE_RLE\fR
  70 Right-to-Left Embedding.
  71 .TP \n(TLu
  72 \fBFRIBIDI_TYPE_LRO\fR
  73 Left-to-Right Override.
  74 .TP \n(TLu
  75 \fBFRIBIDI_TYPE_RLO\fR
  76 Right-to-Left Override.
  77 .TP \n(TLu
  78 \fBFRIBIDI_TYPE_PDF\fR
  79 Pop Directional Flag.
  80 .RE
  81 .PD
  82 .SH "DESCRIPTION"
  83 This function returns the bidi type name of a character type.  The
  84 returned string is a static string and should not be freed.
  85
  86 The type names are the same as ones defined in Table 3.7 Bidirectional
  87 Character Types of the Unicode Bidirectional Algorithm available at
  88 http://www.unicode.org/reports/tr9/#Bidirectional_Character_Types, with a
  89 few modifications: L->LTR, R->RTL, B->BS, S->SS.
  90 .SH "SEE ALSO"
  91 fribidi_charset_to_unicode(3),
  92 fribidi_unicode_to_charset(3),
  93 fribidi_parse_charset(3),
  94 fribidi_shape_arabic(3),
  95 fribidi_get_par_direction(3),
  96 fribidi_get_par_embedding_levels(3),
  97 fribidi_reorder_line(3),
  98 fribidi_get_bidi_type(3),
  99 fribidi_get_bidi_types(3),
 100 fribidi_debug_status(3),
 101 fribidi_mirroring_status(3),
 102 fribidi_set_mirroring(3),
 103 fribidi_reorder_nsm_status(3),
 104 fribidi_set_reorder_nsm(3),
 105 fribidi_log2vis_get_embedding_levels(3),
 106 fribidi_get_type(3),
 107 fribidi_get_type_internal(3),
 108 fribidi_remove_bidi_marks(3),
 109 fribidi_log2vis(3),
 110 fribidi_join_arabic(3),
 111 fribidi_get_joining_type(3),
 112 fribidi_get_joining_types(3),
 113 fribidi_get_joining_type_name(3),
 114 fribidi_get_mirror_char(3),
 115 fribidi_shape_mirroring(3),
 116 fribidi_shape(3)