Imported Upstream version 1.0.10
[platform/upstream/fribidi.git] / doc / fribidi_get_bidi_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_bidi_type_name" 3 "24 July 2018" "c2man fribidi-bidi-types.h" "Programmer's Manual"
4 .SH "NAME"
5 fribidi_get_bidi_type_name \- get bidi type name
6 .SH "SYNOPSIS"
7 .ft B
8 #include <fribidi.h>
9 .sp
10 extern const char *fribidi_get_bidi_type_name(FriBidiCharType t);
11 .ft R
12 .SH "PARAMETERS"
13 .TP
14 .B "FriBidiCharType t"
15 Input bidi type.
16 .sp
17 Since there are 23 possible values for a \fBFriBidiCharType\fR, they are not all listed here.
18 .SH "DESCRIPTION"
19 This function returns the bidi type name of a character type.  The
20 returned string is a static string and should not be freed.
21
22 The type names are the same as ones defined in Table 3.7 Bidirectional
23 Character Types of the Unicode Bidirectional Algorithm available at
24 http://www.unicode.org/reports/tr9/#Bidirectional_Character_Types, with a
25 few modifications: L->LTR, R->RTL, B->BS, S->SS.
26 .SH "SEE ALSO"
27 fribidi_shape_arabic(3),
28 fribidi_get_par_direction(3),
29 fribidi_get_par_embedding_levels_ex(3),
30 fribidi_reorder_line(3),
31 fribidi_get_bidi_type(3),
32 fribidi_get_bidi_types(3),
33 fribidi_debug_status(3),
34 fribidi_set_debug(3),
35 fribidi_charset_to_unicode(3),
36 fribidi_unicode_to_charset(3),
37 fribidi_parse_charset(3),
38 fribidi_mirroring_status(3),
39 fribidi_set_mirroring(3),
40 fribidi_reorder_nsm_status(3),
41 fribidi_set_reorder_nsm(3),
42 fribidi_log2vis_get_embedding_levels(3),
43 fribidi_get_type(3),
44 fribidi_get_type_internal(3),
45 fribidi_get_par_embedding_levels(3),
46 fribidi_join_arabic(3),
47 fribidi_get_joining_type(3),
48 fribidi_get_joining_types(3),
49 fribidi_get_joining_type_name(3),
50 fribidi_get_mirror_char(3),
51 fribidi_shape_mirroring(3),
52 fribidi_get_bracket(3),
53 fribidi_get_bracket_types(3),
54 fribidi_shape(3),
55 fribidi_remove_bidi_marks(3),
56 fribidi_log2vis(3)