doc/fribidi_get_par_embedding_levels.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_par_embedding_levels" 3 "13 October 2019" "c2man fribidi-deprecated.h" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_par_embedding_levels \- get bidi embedding levels of a paragraph
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 extern FriBidiLevel fribidi_get_par_embedding_levels
  11 .br
  12 (
  13 .br
  14         const FriBidiCharType *bidi_types,
  15 .br
  16         const FriBidiStrIndex len,
  17 .br
  18         FriBidiParType *pbase_dir,
  19 .br
  20         FriBidiLevel *embedding_levels
  21 .br
  22 );
  23 .ft R
  24 .SH "PARAMETERS"
  25 .TP
  26 .B "const FriBidiCharType *bidi_types"
  27 Input list of bidi types as returned by
  28 fribidi_get_bidi_types().
  29 .sp
  30 Since there are 23 possible values for a \fBconst FriBidiCharType\fR, they are not all listed here.
  31 .TP
  32 .B "const FriBidiStrIndex len"
  33 Input string length of the paragraph.
  34 .TP
  35 .B "FriBidiParType *pbase_dir"
  36 Requested and resolved paragraph
  37 base direction.
  38 .sp
  39 Possible values for a \fBFriBidiParType\fR are as follows:
  40 .RS 0.75in
  41 .PD 0
  42 .ft B
  43 .nr TL \w'FRIBIDI_PAR_WLTR'u+0.2i
  44 .ft R
  45 .TP \n(TLu
  46 \fBFRIBIDI_PAR_LTR\fR
  47 Left-To-Right paragraph.
  48 .TP \n(TLu
  49 \fBFRIBIDI_PAR_RTL\fR
  50 Right-To-Left paragraph.
  51 .TP \n(TLu
  52 \fBFRIBIDI_PAR_ON\fR
  53 DirectiOn-Neutral paragraph.
  54 .TP \n(TLu
  55 \fBFRIBIDI_PAR_WLTR\fR
  56 Weak Left To Right paragraph.
  57 .TP \n(TLu
  58 \fBFRIBIDI_PAR_WRTL\fR
  59 Weak Right To Left paragraph.
  60 .RE
  61 .PD
  62 .TP
  63 .B "FriBidiLevel *embedding_levels"
  64 Output list of embedding levels.
  65 .SH "DESCRIPTION"
  66 Deprecated interface to fribidi_get_par_embedding_levels_ex(). Refer to
  67 it for documentation.
  68 .SH "SEE ALSO"
  69 fribidi_shape_arabic(3),
  70 fribidi_get_par_direction(3),
  71 fribidi_get_par_embedding_levels_ex(3),
  72 fribidi_reorder_line(3),
  73 fribidi_get_bidi_type(3),
  74 fribidi_get_bidi_types(3),
  75 fribidi_get_bidi_type_name(3),
  76 fribidi_debug_status(3),
  77 fribidi_set_debug(3),
  78 fribidi_charset_to_unicode(3),
  79 fribidi_unicode_to_charset(3),
  80 fribidi_parse_charset(3),
  81 fribidi_mirroring_status(3),
  82 fribidi_set_mirroring(3),
  83 fribidi_reorder_nsm_status(3),
  84 fribidi_set_reorder_nsm(3),
  85 fribidi_log2vis_get_embedding_levels(3),
  86 fribidi_get_type(3),
  87 fribidi_get_type_internal(3),
  88 fribidi_join_arabic(3),
  89 fribidi_get_joining_type(3),
  90 fribidi_get_joining_types(3),
  91 fribidi_get_joining_type_name(3),
  92 fribidi_get_mirror_char(3),
  93 fribidi_shape_mirroring(3),
  94 fribidi_get_bracket(3),
  95 fribidi_get_bracket_types(3),
  96 fribidi_shape(3),
  97 fribidi_remove_bidi_marks(3)