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