doc/fribidi_get_par_direction.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_direction" 3 "20 July 2018" "c2man fribidi-bidi.h" "Programmer's Manual"
   4 .SH "NAME"
   5 fribidi_get_par_direction \- get base paragraph direction
   6 .SH "SYNOPSIS"
   7 .ft B
   8 #include <fribidi.h>
   9 .sp
  10 extern FriBidiParType fribidi_get_par_direction
  11 .br
  12 (
  13 .br
  14         const FriBidiCharType *bidi_types,
  15 .br
  16         const FriBidiStrIndex len
  17 .br
  18 );
  19 .ft R
  20 .SH "PARAMETERS"
  21 .TP
  22 .B "const FriBidiCharType *bidi_types"
  23 Input list of bidi types as returned by
  24 fribidi_get_bidi_types().
  25 .sp
  26 Since there are 23 possible values for a \fBconst FriBidiCharType\fR, they are not all listed here.
  27 .TP
  28 .B "const FriBidiStrIndex len"
  29 Input string length.
  30 .SH "DESCRIPTION"
  31 This function finds the base direction of a single paragraph,
  32 as defined by rule P2 of the Unicode Bidirectional Algorithm available at
  33 http://www.unicode.org/reports/tr9/#P2.
  34
  35 You typically do not need this function as
  36 fribidi_get_par_embedding_levels() knows how to compute base direction
  37 itself, but you may need this to implement a more sophisticated paragraph
  38 direction handling.  Note that you can pass more than a paragraph to this
  39 function and the direction of the first non-neutral paragraph is returned,
  40 which is a very good heuristic to set direction of the neutral paragraphs
  41 at the beginning of text.  For other neutral paragraphs, you better use the
  42 direction of the previous paragraph.
  43 .SH "RETURNS"
  44 Base pargraph direction.  No weak paragraph direction is returned,
  45 only LTR, RTL, or ON.
  46 .sp
  47 Possible values for an \fBextern FriBidiParType\fR are as follows:
  48 .RS 0.75in
  49 .PD 0
  50 .ft B
  51 .nr TL \w'FRIBIDI_PAR_WLTR'u+0.2i
  52 .ft R
  53 .TP \n(TLu
  54 \fBFRIBIDI_PAR_LTR\fR
  55 Left-To-Right paragraph.
  56 .TP \n(TLu
  57 \fBFRIBIDI_PAR_RTL\fR
  58 Right-To-Left paragraph.
  59 .TP \n(TLu
  60 \fBFRIBIDI_PAR_ON\fR
  61 DirectiOn-Neutral paragraph.
  62 .TP \n(TLu
  63 \fBFRIBIDI_PAR_WLTR\fR
  64 Weak Left To Right paragraph.
  65 .TP \n(TLu
  66 \fBFRIBIDI_PAR_WRTL\fR
  67 Weak Right To Left paragraph.
  68 .RE
  69 .PD
  70 .SH "SEE ALSO"
  71 fribidi_shape_arabic(3),
  72 fribidi_get_par_embedding_levels_ex(3),
  73 fribidi_reorder_line(3),
  74 fribidi_get_bidi_type(3),
  75 fribidi_get_bidi_types(3),
  76 fribidi_get_bidi_type_name(3),
  77 fribidi_debug_status(3),
  78 fribidi_set_debug(3),
  79 fribidi_charset_to_unicode(3),
  80 fribidi_unicode_to_charset(3),
  81 fribidi_parse_charset(3),
  82 fribidi_mirroring_status(3),
  83 fribidi_set_mirroring(3),
  84 fribidi_reorder_nsm_status(3),
  85 fribidi_set_reorder_nsm(3),
  86 fribidi_log2vis_get_embedding_levels(3),
  87 fribidi_get_type(3),
  88 fribidi_get_type_internal(3),
  89 fribidi_get_par_embedding_levels(3),
  90 fribidi_join_arabic(3),
  91 fribidi_get_joining_type(3),
  92 fribidi_get_joining_types(3),
  93 fribidi_get_joining_type_name(3),
  94 fribidi_get_mirror_char(3),
  95 fribidi_shape_mirroring(3),
  96 fribidi_get_bracket(3),
  97 fribidi_get_bracket_types(3),
  98 fribidi_shape(3),
  99 fribidi_remove_bidi_marks(3)