summaryrefslogtreecommitdiff
path: root/doc/fribidi_get_bidi_types.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/fribidi_get_bidi_types.3')
-rw-r--r--doc/fribidi_get_bidi_types.3128
1 files changed, 128 insertions, 0 deletions
diff --git a/doc/fribidi_get_bidi_types.3 b/doc/fribidi_get_bidi_types.3
new file mode 100644
index 0000000..4db29dd
--- /dev/null
+++ b/doc/fribidi_get_bidi_types.3
@@ -0,0 +1,128 @@
+.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
+.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
+.TH "fribidi_get_bidi_types" 3 "25 August 2012" "GNU FriBidi 0.19.3" "Programmer's Manual"
+.SH "NAME"
+fribidi_get_bidi_types \- get bidi types for an string of characters
+.SH "SYNOPSIS"
+.ft B
+#include <fribidi.h>
+.sp
+void fribidi_get_bidi_types
+.br
+(
+.br
+ const FriBidiChar *str,
+.br
+ const FriBidiStrIndex len,
+.br
+ FriBidiCharType *btypes
+.br
+);
+.ft R
+.SH "PARAMETERS"
+.TP
+.B "const FriBidiChar *str"
+Input string.
+.TP
+.B "const FriBidiStrIndex len"
+Input string length.
+.TP
+.B "FriBidiCharType *btypes"
+Output bidi types.
+.sp
+Possible values for a \fBFriBidiCharType\fR are as follows:
+.RS 0.75in
+.PD 0
+.ft B
+.nr TL \w'FRIBIDI_TYPE_LTR'u+0.2i
+.ft R
+.TP \n(TLu
+\fBFRIBIDI_TYPE_LTR\fR
+Left-To-Right letter.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_RTL\fR
+Right-To-Left letter.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_AL\fR
+Arabic Letter.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_EN\fR
+European Numeral.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_AN\fR
+Arabic Numeral.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_ES\fR
+European number Separator.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_ET\fR
+European number Terminator.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_CS\fR
+Common Separator.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_NSM\fR
+Non Spacing Mark.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_BN\fR
+Boundary Neutral.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_BS\fR
+Block Separator.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_SS\fR
+Segment Separator.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_WS\fR
+WhiteSpace.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_ON\fR
+Other Neutral.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_LRE\fR
+Left-to-Right Embedding.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_RLE\fR
+Right-to-Left Embedding.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_LRO\fR
+Left-to-Right Override.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_RLO\fR
+Right-to-Left Override.
+.TP \n(TLu
+\fBFRIBIDI_TYPE_PDF\fR
+Pop Directional Flag.
+.RE
+.PD
+.SH "DESCRIPTION"
+This function finds the bidi types of an string of characters. See
+fribidi_get_bidi_type() for more information about the bidi 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_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_types(3),
+fribidi_get_joining_type_name(3),
+fribidi_get_mirror_char(3),
+fribidi_shape_mirroring(3),
+fribidi_shape(3)