doc/fribidi_get_joining_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_joining_types" 3 "25 August 2012" "GNU FriBidi 0.19.3" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_joining_types \- get joining types for an string of characters
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 void fribidi_get_joining_types
  11 .br
  12 (
  13 .br
  14         const FriBidiChar *str,
  15 .br
  16         const FriBidiStrIndex len,
  17 .br
  18         FriBidiJoiningType *jtypes
  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 "FriBidiJoiningType *jtypes"
  31 Output joining types.
  32 .sp
  33 Possible values for a \fBFriBidiJoiningType\fR are as follows:
  34 .RS 0.75in
  35 .PD 0
  36 .ft B
  37 .nr TL \w'FRIBIDI_JOINING_TYPE_U'u+0.2i
  38 .ft R
  39 .TP \n(TLu
  40 \fBFRIBIDI_JOINING_TYPE_U\fR
  41 NUn-joining, e.g. Full Stop.
  42 .TP \n(TLu
  43 \fBFRIBIDI_JOINING_TYPE_R\fR
  44 Right-joining, e.g. Arabic Letter Dal.
  45 .TP \n(TLu
  46 \fBFRIBIDI_JOINING_TYPE_D\fR
  47 Dual-joining, e.g. Arabic Letter Ain.
  48 .TP \n(TLu
  49 \fBFRIBIDI_JOINING_TYPE_C\fR
  50 Join-Causing, e.g. Tatweel, ZWJ.
  51 .TP \n(TLu
  52 \fBFRIBIDI_JOINING_TYPE_T\fR
  53 Transparent, e.g. Arabic Fatha.
  54 .TP \n(TLu
  55 \fBFRIBIDI_JOINING_TYPE_L\fR
  56 Left-joining, i.e. Fictional.
  57 .TP \n(TLu
  58 \fBFRIBIDI_JOINING_TYPE_G\fR
  59 IGnored, e.g. LRE, RLE, ZWNBSP.
  60 .RE
  61 .PD
  62 .SH "DESCRIPTION"
  63 This function finds the joining types of an string of characters.  See
  64 fribidi_get_joining_type for more information about the joining types
  65 returned by this function.
  66 .SH "SEE ALSO"
  67 fribidi_charset_to_unicode(3),
  68 fribidi_unicode_to_charset(3),
  69 fribidi_parse_charset(3),
  70 fribidi_shape_arabic(3),
  71 fribidi_get_par_direction(3),
  72 fribidi_get_par_embedding_levels(3),
  73 fribidi_reorder_line(3),
  74 fribidi_get_bidi_type(3),
  75 fribidi_get_bidi_types(3),
  76 fribidi_get_bidi_type_name(3),
  77 fribidi_debug_status(3),
  78 fribidi_mirroring_status(3),
  79 fribidi_set_mirroring(3),
  80 fribidi_reorder_nsm_status(3),
  81 fribidi_set_reorder_nsm(3),
  82 fribidi_log2vis_get_embedding_levels(3),
  83 fribidi_get_type(3),
  84 fribidi_get_type_internal(3),
  85 fribidi_remove_bidi_marks(3),
  86 fribidi_log2vis(3),
  87 fribidi_join_arabic(3),
  88 fribidi_get_joining_type(3),
  89 fribidi_get_joining_type_name(3),
  90 fribidi_get_mirror_char(3),
  91 fribidi_shape_mirroring(3),
  92 fribidi_shape(3)