Imported Upstream version 1.0.2
[platform/upstream/fribidi.git] / doc / fribidi_set_reorder_nsm.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_set_reorder_nsm" 3 "19 February 2018" "c2man fribidi-deprecated.h" "Programmer's Manual"
4 .SH "NAME"
5 fribidi_set_reorder_nsm \- set marks reordering on or off
6 .SH "SYNOPSIS"
7 .ft B
8 #include <fribidi.h>
9 .sp
10 extern fribidi_boolean fribidi_set_reorder_nsm(fribidi_boolean state);
11 .ft R
12 .SH "PARAMETERS"
13 .TP
14 .B "fribidi_boolean state"
15 New state to set.
16 .SH "DESCRIPTION"
17 This function is used to turn non-spacing marks reordering on or
18 off.  Reordering non-spacing marks is the act of placing non-spacing
19 marks (bidi class NSM) after their base character in a right-to-left
20 resolved context.  If your rendering engine expects non-spacing marks
21 always after the base character in the memory representation of the
22 visual string, you need this option on.  An example of where people
23 may need it off is when rendering in the console when non-spacing
24 marks cannot be applied on top of the base character.
25
26 This flag is on by default.
27 This function is deprecated and only used with other deprecated functions.
28 .SH "RETURNS"
29 The new marks reordering status.
30 .SH "SEE ALSO"
31 fribidi_shape_arabic(3),
32 fribidi_get_par_direction(3),
33 fribidi_get_par_embedding_levels_ex(3),
34 fribidi_reorder_line(3),
35 fribidi_get_bidi_type(3),
36 fribidi_get_bidi_types(3),
37 fribidi_get_bidi_type_name(3),
38 fribidi_debug_status(3),
39 fribidi_set_debug(3),
40 fribidi_charset_to_unicode(3),
41 fribidi_unicode_to_charset(3),
42 fribidi_parse_charset(3),
43 fribidi_mirroring_status(3),
44 fribidi_set_mirroring(3),
45 fribidi_reorder_nsm_status(3),
46 fribidi_log2vis_get_embedding_levels(3),
47 fribidi_get_type(3),
48 fribidi_get_type_internal(3),
49 fribidi_remove_bidi_marks(3),
50 fribidi_log2vis(3),
51 fribidi_get_par_embedding_levels(3),
52 fribidi_join_arabic(3),
53 fribidi_get_joining_type(3),
54 fribidi_get_joining_types(3),
55 fribidi_get_joining_type_name(3),
56 fribidi_get_mirror_char(3),
57 fribidi_shape_mirroring(3),
58 fribidi_get_bracket(3),
59 fribidi_get_bracket_types(3),
60 fribidi_shape(3)