doc/fribidi_get_joining_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_joining_type_name" 3 "20 July 2018" "c2man fribidi-joining-types.h" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_joining_type_name \- get joining type name
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 extern const char *fribidi_get_joining_type_name(FriBidiJoiningType j);
  11 .ft R
  12 .SH "PARAMETERS"
  13 .TP
  14 .B "FriBidiJoiningType j"
  15 Input joining type.
  16 .sp
  17 Possible values for a \fBFriBidiJoiningType\fR are as follows:
  18 .RS 0.75in
  19 .PD 0
  20 .ft B
  21 .nr TL \w'FRIBIDI_JOINING_TYPE_U'u+0.2i
  22 .ft R
  23 .TP \n(TLu
  24 \fBFRIBIDI_JOINING_TYPE_U\fR
  25 NUn-joining, e.g. Full Stop.
  26 .TP \n(TLu
  27 \fBFRIBIDI_JOINING_TYPE_R\fR
  28 Right-joining, e.g. Arabic Letter Dal.
  29 .TP \n(TLu
  30 \fBFRIBIDI_JOINING_TYPE_D\fR
  31 Dual-joining, e.g. Arabic Letter Ain.
  32 .TP \n(TLu
  33 \fBFRIBIDI_JOINING_TYPE_C\fR
  34 Join-Causing, e.g. Tatweel, ZWJ.
  35 .TP \n(TLu
  36 \fBFRIBIDI_JOINING_TYPE_T\fR
  37 Transparent, e.g. Arabic Fatha.
  38 .TP \n(TLu
  39 \fBFRIBIDI_JOINING_TYPE_L\fR
  40 Left-joining, i.e. Fictional.
  41 .TP \n(TLu
  42 \fBFRIBIDI_JOINING_TYPE_G\fR
  43 IGnored, e.g. LRE, RLE, ZWNBSP.
  44 .RE
  45 .PD
  46 .SH "DESCRIPTION"
  47 This function returns the joining type name of a joining type.  The
  48 returned string is a static string and should not be freed.
  49
  50 The type names are the same as ones defined in Table 8-2  Primary Arabic
  51 Joining Classes of the Unicode standard available at
  52 http://www.unicode.org/versions/Unicode4.0.0/ch08.pdf#G7462.
  53 .SH "SEE ALSO"
  54 fribidi_shape_arabic(3),
  55 fribidi_get_par_direction(3),
  56 fribidi_get_par_embedding_levels_ex(3),
  57 fribidi_reorder_line(3),
  58 fribidi_get_bidi_type(3),
  59 fribidi_get_bidi_types(3),
  60 fribidi_get_bidi_type_name(3),
  61 fribidi_debug_status(3),
  62 fribidi_set_debug(3),
  63 fribidi_charset_to_unicode(3),
  64 fribidi_unicode_to_charset(3),
  65 fribidi_parse_charset(3),
  66 fribidi_mirroring_status(3),
  67 fribidi_set_mirroring(3),
  68 fribidi_reorder_nsm_status(3),
  69 fribidi_set_reorder_nsm(3),
  70 fribidi_log2vis_get_embedding_levels(3),
  71 fribidi_get_type(3),
  72 fribidi_get_type_internal(3),
  73 fribidi_get_par_embedding_levels(3),
  74 fribidi_join_arabic(3),
  75 fribidi_get_joining_type(3),
  76 fribidi_get_joining_types(3),
  77 fribidi_get_mirror_char(3),
  78 fribidi_shape_mirroring(3),
  79 fribidi_get_bracket(3),
  80 fribidi_get_bracket_types(3),
  81 fribidi_shape(3),
  82 fribidi_remove_bidi_marks(3)