doc/fribidi_get_joining_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_joining_type" 3 "2 December 2012" "GNU FriBidi 0.19.4" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_joining_type \- get character joining type
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 FriBidiJoiningType fribidi_get_joining_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 joining type of a character as defined in Table
  18 8-2 Primary Arabic Joining Classes of the Unicode standard available at
  19 http://www.unicode.org/versions/Unicode4.0.0/ch08.pdf#G7462, using data
  20 provided in file ArabicShaping.txt and UnicodeData.txt of the Unicode
  21 Character Database available at
  22 http://www.unicode.org/Public/UNIDATA/ArabicShaping.txt and
  23 http://www.unicode.org/Public/UNIDATA/UnicodeData.txt.
  24
  25 There are a few macros defined in fribidi-joining-types.h for querying a
  26 joining type.
  27 .SH "RETURNS"
  28 Possible values for a \fBFriBidiJoiningType\fR are as follows:
  29 .RS 0.75in
  30 .PD 0
  31 .ft B
  32 .nr TL \w'FRIBIDI_JOINING_TYPE_U'u+0.2i
  33 .ft R
  34 .TP \n(TLu
  35 \fBFRIBIDI_JOINING_TYPE_U\fR
  36 NUn-joining, e.g. Full Stop.
  37 .TP \n(TLu
  38 \fBFRIBIDI_JOINING_TYPE_R\fR
  39 Right-joining, e.g. Arabic Letter Dal.
  40 .TP \n(TLu
  41 \fBFRIBIDI_JOINING_TYPE_D\fR
  42 Dual-joining, e.g. Arabic Letter Ain.
  43 .TP \n(TLu
  44 \fBFRIBIDI_JOINING_TYPE_C\fR
  45 Join-Causing, e.g. Tatweel, ZWJ.
  46 .TP \n(TLu
  47 \fBFRIBIDI_JOINING_TYPE_T\fR
  48 Transparent, e.g. Arabic Fatha.
  49 .TP \n(TLu
  50 \fBFRIBIDI_JOINING_TYPE_L\fR
  51 Left-joining, i.e. Fictional.
  52 .TP \n(TLu
  53 \fBFRIBIDI_JOINING_TYPE_G\fR
  54 IGnored, e.g. LRE, RLE, ZWNBSP.
  55 .RE
  56 .PD
  57 .SH "SEE ALSO"
  58 fribidi_charset_to_unicode(3),
  59 fribidi_unicode_to_charset(3),
  60 fribidi_parse_charset(3),
  61 fribidi_shape_arabic(3),
  62 fribidi_get_par_direction(3),
  63 fribidi_get_par_embedding_levels(3),
  64 fribidi_reorder_line(3),
  65 fribidi_get_bidi_type(3),
  66 fribidi_get_bidi_types(3),
  67 fribidi_get_bidi_type_name(3),
  68 fribidi_debug_status(3),
  69 fribidi_mirroring_status(3),
  70 fribidi_set_mirroring(3),
  71 fribidi_reorder_nsm_status(3),
  72 fribidi_set_reorder_nsm(3),
  73 fribidi_log2vis_get_embedding_levels(3),
  74 fribidi_get_type(3),
  75 fribidi_get_type_internal(3),
  76 fribidi_remove_bidi_marks(3),
  77 fribidi_log2vis(3),
  78 fribidi_join_arabic(3),
  79 fribidi_get_joining_types(3),
  80 fribidi_get_joining_type_name(3),
  81 fribidi_get_mirror_char(3),
  82 fribidi_shape_mirroring(3),
  83 fribidi_shape(3)