doc/fribidi_get_bidi_types.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_types" 3 "2 December 2012" "GNU FriBidi 0.19.4" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_bidi_types \- get bidi types for an string of characters
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 void fribidi_get_bidi_types
  11 .br
  12 (
  13 .br
  14         const FriBidiChar *str,
  15 .br
  16         const FriBidiStrIndex len,
  17 .br
  18         FriBidiCharType *btypes
  19 .br
  20 );
  21 .ft R
  22 .SH "PARAMETERS"
  23 .TP
  24 .B "const FriBidiChar *str"
  25 Input string.
  26 .TP
  27 .B "const FriBidiStrIndex len"
  28 Input string length.
  29 .TP
  30 .B "FriBidiCharType *btypes"
  31 Output bidi types.
  32 .sp
  33 Possible values for a \fBFriBidiCharType\fR are as follows:
  34 .RS 0.75in
  35 .PD 0
  36 .ft B
  37 .nr TL \w'FRIBIDI_TYPE_LTR'u+0.2i
  38 .ft R
  39 .TP \n(TLu
  40 \fBFRIBIDI_TYPE_LTR\fR
  41 Left-To-Right letter.
  42 .TP \n(TLu
  43 \fBFRIBIDI_TYPE_RTL\fR
  44 Right-To-Left letter.
  45 .TP \n(TLu
  46 \fBFRIBIDI_TYPE_AL\fR
  47 Arabic Letter.
  48 .TP \n(TLu
  49 \fBFRIBIDI_TYPE_EN\fR
  50 European Numeral.
  51 .TP \n(TLu
  52 \fBFRIBIDI_TYPE_AN\fR
  53 Arabic Numeral.
  54 .TP \n(TLu
  55 \fBFRIBIDI_TYPE_ES\fR
  56 European number Separator.
  57 .TP \n(TLu
  58 \fBFRIBIDI_TYPE_ET\fR
  59 European number Terminator.
  60 .TP \n(TLu
  61 \fBFRIBIDI_TYPE_CS\fR
  62 Common Separator.
  63 .TP \n(TLu
  64 \fBFRIBIDI_TYPE_NSM\fR
  65 Non Spacing Mark.
  66 .TP \n(TLu
  67 \fBFRIBIDI_TYPE_BN\fR
  68 Boundary Neutral.
  69 .TP \n(TLu
  70 \fBFRIBIDI_TYPE_BS\fR
  71 Block Separator.
  72 .TP \n(TLu
  73 \fBFRIBIDI_TYPE_SS\fR
  74 Segment Separator.
  75 .TP \n(TLu
  76 \fBFRIBIDI_TYPE_WS\fR
  77 WhiteSpace.
  78 .TP \n(TLu
  79 \fBFRIBIDI_TYPE_ON\fR
  80 Other Neutral.
  81 .TP \n(TLu
  82 \fBFRIBIDI_TYPE_LRE\fR
  83 Left-to-Right Embedding.
  84 .TP \n(TLu
  85 \fBFRIBIDI_TYPE_RLE\fR
  86 Right-to-Left Embedding.
  87 .TP \n(TLu
  88 \fBFRIBIDI_TYPE_LRO\fR
  89 Left-to-Right Override.
  90 .TP \n(TLu
  91 \fBFRIBIDI_TYPE_RLO\fR
  92 Right-to-Left Override.
  93 .TP \n(TLu
  94 \fBFRIBIDI_TYPE_PDF\fR
  95 Pop Directional Flag.
  96 .RE
  97 .PD
  98 .SH "DESCRIPTION"
  99 This function finds the bidi types of an string of characters.  See
 100 fribidi_get_bidi_type() for more information about the bidi types returned
 101 by this function.
 102 .SH "SEE ALSO"
 103 fribidi_charset_to_unicode(3),
 104 fribidi_unicode_to_charset(3),
 105 fribidi_parse_charset(3),
 106 fribidi_shape_arabic(3),
 107 fribidi_get_par_direction(3),
 108 fribidi_get_par_embedding_levels(3),
 109 fribidi_reorder_line(3),
 110 fribidi_get_bidi_type(3),
 111 fribidi_get_bidi_type_name(3),
 112 fribidi_debug_status(3),
 113 fribidi_mirroring_status(3),
 114 fribidi_set_mirroring(3),
 115 fribidi_reorder_nsm_status(3),
 116 fribidi_set_reorder_nsm(3),
 117 fribidi_log2vis_get_embedding_levels(3),
 118 fribidi_get_type(3),
 119 fribidi_get_type_internal(3),
 120 fribidi_remove_bidi_marks(3),
 121 fribidi_log2vis(3),
 122 fribidi_join_arabic(3),
 123 fribidi_get_joining_type(3),
 124 fribidi_get_joining_types(3),
 125 fribidi_get_joining_type_name(3),
 126 fribidi_get_mirror_char(3),
 127 fribidi_shape_mirroring(3),
 128 fribidi_shape(3)