2cd08e9154866f19521756f30bbfa970289e073e
[platform/upstream/fribidi.git] / doc / fribidi_get_mirror_char.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_mirror_char" 3 "2 December 2012" "GNU FriBidi 0.19.4" "Programmer's Manual"
4 .SH "NAME"
5 fribidi_get_mirror_char \- get mirrored character
6 .SH "SYNOPSIS"
7 .ft B
8 #include <fribidi.h>
9 .sp
10 fribidi_boolean fribidi_get_mirror_char
11 .br
12 (
13 .br
14         FriBidiChar ch,
15 .br
16         FriBidiChar *mirrored_ch
17 .br
18 );
19 .ft R
20 .SH "PARAMETERS"
21 .TP
22 .B "FriBidiChar ch"
23 Input character.
24 .TP
25 .B "FriBidiChar *mirrored_ch"
26 Output mirrored character.
27 .SH "DESCRIPTION"
28 This function finds the mirrored equivalent of a character as defined in
29 the file BidiMirroring.txt of the Unicode Character Database available at
30 http://www.unicode.org/Public/UNIDATA/BidiMirroring.txt.
31
32 If  the input character is a declared as a mirroring character in the
33 Unicode standard and has a mirrored equivalent.  The matching mirrored
34 character is put in the output, otherwise the input character itself is
35 put.
36 .SH "RETURNS"
37 If the character has a mirroring equivalent or not.
38 .SH "SEE ALSO"
39 fribidi_charset_to_unicode(3),
40 fribidi_unicode_to_charset(3),
41 fribidi_parse_charset(3),
42 fribidi_shape_arabic(3),
43 fribidi_get_par_direction(3),
44 fribidi_get_par_embedding_levels(3),
45 fribidi_reorder_line(3),
46 fribidi_get_bidi_type(3),
47 fribidi_get_bidi_types(3),
48 fribidi_get_bidi_type_name(3),
49 fribidi_debug_status(3),
50 fribidi_mirroring_status(3),
51 fribidi_set_mirroring(3),
52 fribidi_reorder_nsm_status(3),
53 fribidi_set_reorder_nsm(3),
54 fribidi_log2vis_get_embedding_levels(3),
55 fribidi_get_type(3),
56 fribidi_get_type_internal(3),
57 fribidi_remove_bidi_marks(3),
58 fribidi_log2vis(3),
59 fribidi_join_arabic(3),
60 fribidi_get_joining_type(3),
61 fribidi_get_joining_types(3),
62 fribidi_get_joining_type_name(3),
63 fribidi_shape_mirroring(3),
64 fribidi_shape(3)