summaryrefslogtreecommitdiff
path: root/doc/fribidi_get_joining_types.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fribidi_get_joining_types.3')
-rw-r--r--doc/fribidi_get_joining_types.392
1 files changed, 92 insertions, 0 deletions
diff --git a/doc/fribidi_get_joining_types.3 b/doc/fribidi_get_joining_types.3
new file mode 100644
index 0000000..4c4bcd0
--- /dev/null
+++ b/doc/fribidi_get_joining_types.3
@@ -0,0 +1,92 @@
+.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
+.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
+.TH "fribidi_get_joining_types" 3 "25 August 2012" "GNU FriBidi 0.19.3" "Programmer's Manual"
+.SH "NAME"
+fribidi_get_joining_types \- get joining types for an string of characters
+.SH "SYNOPSIS"
+.ft B
+#include <fribidi.h>
+.sp
+void fribidi_get_joining_types
+.br
+(
+.br
+ const FriBidiChar *str,
+.br
+ const FriBidiStrIndex len,
+.br
+ FriBidiJoiningType *jtypes
+.br
+);
+.ft R
+.SH "PARAMETERS"
+.TP
+.B "const FriBidiChar *str"
+Input string.
+.TP
+.B "const FriBidiStrIndex len"
+Input string length.
+.TP
+.B "FriBidiJoiningType *jtypes"
+Output joining types.
+.sp
+Possible values for a \fBFriBidiJoiningType\fR are as follows:
+.RS 0.75in
+.PD 0
+.ft B
+.nr TL \w'FRIBIDI_JOINING_TYPE_U'u+0.2i
+.ft R
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_U\fR
+NUn-joining, e.g. Full Stop.
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_R\fR
+Right-joining, e.g. Arabic Letter Dal.
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_D\fR
+Dual-joining, e.g. Arabic Letter Ain.
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_C\fR
+Join-Causing, e.g. Tatweel, ZWJ.
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_T\fR
+Transparent, e.g. Arabic Fatha.
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_L\fR
+Left-joining, i.e. Fictional.
+.TP \n(TLu
+\fBFRIBIDI_JOINING_TYPE_G\fR
+IGnored, e.g. LRE, RLE, ZWNBSP.
+.RE
+.PD
+.SH "DESCRIPTION"
+This function finds the joining types of an string of characters. See
+fribidi_get_joining_type for more information about the joining types
+returned by this function.
+.SH "SEE ALSO"
+fribidi_charset_to_unicode(3),
+fribidi_unicode_to_charset(3),
+fribidi_parse_charset(3),
+fribidi_shape_arabic(3),
+fribidi_get_par_direction(3),
+fribidi_get_par_embedding_levels(3),
+fribidi_reorder_line(3),
+fribidi_get_bidi_type(3),
+fribidi_get_bidi_types(3),
+fribidi_get_bidi_type_name(3),
+fribidi_debug_status(3),
+fribidi_mirroring_status(3),
+fribidi_set_mirroring(3),
+fribidi_reorder_nsm_status(3),
+fribidi_set_reorder_nsm(3),
+fribidi_log2vis_get_embedding_levels(3),
+fribidi_get_type(3),
+fribidi_get_type_internal(3),
+fribidi_remove_bidi_marks(3),
+fribidi_log2vis(3),
+fribidi_join_arabic(3),
+fribidi_get_joining_type(3),
+fribidi_get_joining_type_name(3),
+fribidi_get_mirror_char(3),
+fribidi_shape_mirroring(3),
+fribidi_shape(3)