man-pages/man3/fribidi_get_par_direction.3.html
2021-03-31 01:06:50 +01:00

142 lines
5.6 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of fribidi_get_par_direction</TITLE>
</HEAD><BODY>
<H1>fribidi_get_par_direction</H1>
Section: Programmer's Manual (3)<BR>Updated: 20 July 2018<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
fribidi_get_par_direction - get base paragraph direction
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>
#include &lt;<A HREF="file:///usr/include/fribidi.h">fribidi.h</A>&gt;
<P>
extern FriBidiParType fribidi_get_par_direction
<BR>
(
<BR>
<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>const FriBidiCharType *bidi_types,<BR>
<BR>
<TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TT>const FriBidiStrIndex len<BR>
<BR>
);
</B>
<A NAME="lbAD">&nbsp;</A>
<H2>PARAMETERS</H2>
<DL COMPACT>
<DT id="1"><B>const FriBidiCharType *bidi_types</B>
<DD>
Input list of bidi types as returned by
fribidi_get_bidi_types().
<P>
Since there are 23 possible values for a <B>const FriBidiCharType</B>, they are not all listed here.
<DT id="2"><B>const FriBidiStrIndex len</B>
<DD>
Input string length.
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>DESCRIPTION</H2>
This function finds the base direction of a single paragraph,
as defined by rule P2 of the Unicode Bidirectional Algorithm available at
<A HREF="http://www.unicode.org/reports/tr9/#P2.">http://www.unicode.org/reports/tr9/#P2.</A>
<P>
You typically do not need this function as
fribidi_get_par_embedding_levels() knows how to compute base direction
itself, but you may need this to implement a more sophisticated paragraph
direction handling. Note that you can pass more than a paragraph to this
function and the direction of the first non-neutral paragraph is returned,
which is a very good heuristic to set direction of the neutral paragraphs
at the beginning of text. For other neutral paragraphs, you better use the
direction of the previous paragraph.
<A NAME="lbAF">&nbsp;</A>
<H2>RETURNS</H2>
Base pargraph direction. No weak paragraph direction is returned,
only LTR, RTL, or ON.
<P>
Possible values for an <B>extern FriBidiParType</B> are as follows:
<DL COMPACT><DT id="3"><DD>
<B>
</B>
<DL COMPACT>
<DT id="4"><B>FRIBIDI_PAR_LTR</B><DD>
Left-To-Right paragraph.
<DT id="5"><B>FRIBIDI_PAR_RTL</B><DD>
Right-To-Left paragraph.
<DT id="6"><B>FRIBIDI_PAR_ON</B><DD>
DirectiOn-Neutral paragraph.
<DT id="7"><B>FRIBIDI_PAR_WLTR</B><DD>
Weak Left To Right paragraph.
<DT id="8"><B>FRIBIDI_PAR_WRTL</B><DD>
Weak Right To Left paragraph.
</DL>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<A HREF="/cgi-bin/man/man2html?3+fribidi_shape_arabic">fribidi_shape_arabic</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_par_embedding_levels_ex">fribidi_get_par_embedding_levels_ex</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_reorder_line">fribidi_reorder_line</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_bidi_type">fribidi_get_bidi_type</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_bidi_types">fribidi_get_bidi_types</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_bidi_type_name">fribidi_get_bidi_type_name</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_debug_status">fribidi_debug_status</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_set_debug">fribidi_set_debug</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_charset_to_unicode">fribidi_charset_to_unicode</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_unicode_to_charset">fribidi_unicode_to_charset</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_parse_charset">fribidi_parse_charset</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_mirroring_status">fribidi_mirroring_status</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_set_mirroring">fribidi_set_mirroring</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_reorder_nsm_status">fribidi_reorder_nsm_status</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_set_reorder_nsm">fribidi_set_reorder_nsm</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_log2vis_get_embedding_levels">fribidi_log2vis_get_embedding_levels</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_type">fribidi_get_type</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_type_internal">fribidi_get_type_internal</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_par_embedding_levels">fribidi_get_par_embedding_levels</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_join_arabic">fribidi_join_arabic</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_joining_type">fribidi_get_joining_type</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_joining_types">fribidi_get_joining_types</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_joining_type_name">fribidi_get_joining_type_name</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_mirror_char">fribidi_get_mirror_char</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_shape_mirroring">fribidi_shape_mirroring</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_bracket">fribidi_get_bracket</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_get_bracket_types">fribidi_get_bracket_types</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_shape">fribidi_shape</A>(3),
<A HREF="/cgi-bin/man/man2html?3+fribidi_remove_bidi_marks">fribidi_remove_bidi_marks</A>(3)
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">PARAMETERS</A><DD>
<DT id="12"><A HREF="#lbAE">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAF">RETURNS</A><DD>
<DT id="14"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:43 GMT, March 31, 2021
</BODY>
</HTML>