1
\alias{pango-Bidirectional-Text}
4
\name{pango-Bidirectional-Text}
5
\title{Bidirectional Text}
6
\description{Types and functions to help with handling bidirectional text}
7
\section{Methods and Functions}{
8
\code{\link{pangoUnicharDirection}(ch)}\cr
9
\code{\link{pangoFindBaseDir}(text, length = -1)}\cr
10
\code{\link{pangoGetMirrorChar}(ch)}\cr
11
\code{\link{pangoBidiTypeForUnichar}(ch)}\cr
13
\section{Detailed Description}{Pango supports bidirectional text (like Arabic and Hebrew) automatically.
14
Some applications however, need some help to correctly handle bidirectional
17
The \code{\link{PangoDirection}} type can be used with \code{\link{pangoContextSetBaseDir}} to
18
instruct Pango about direction of text, though in most cases Pango detects
19
that correctly and automatically. The rest of the facilities in this section
20
are used internally by Pango already, and are provided to help applications
21
that need more direct control over bidirectional setting of text.}
22
\section{Enums and Flags}{\describe{
23
\item{\verb{PangoDirection}}{
24
The \code{\link{PangoDirection}} type represents a direction in the
25
Unicode bidirectional algorithm; not every value in this
26
enumeration makes sense for every usage of \code{\link{PangoDirection}};
27
for example, the return value of \code{\link{pangoUnicharDirection}}
28
and \code{\link{pangoFindBaseDir}} cannot be \code{PANGO_DIRECTION_WEAK_LTR}
29
or \code{PANGO_DIRECTION_WEAK_RTL}, since every character is either
30
neutral or has a strong direction; on the other hand
31
\code{PANGO_DIRECTION_NEUTRAL} doesn't make sense to pass
32
to \code{\link{pangoItemizeWithBaseDir}}.
34
The \code{PANGO_DIRECTION_TTB_LTR}, \code{PANGO_DIRECTION_TTB_RTL}
35
values come from an earlier interpretation of this
36
enumeration as the writing direction of a block of
37
text and are no longer used; See \code{\link{PangoGravity}} for how
38
vertical text is handled in Pango.
41
\item{\verb{ltr}}{A strong left-to-right direction}
42
\item{\verb{rtl}}{A strong right-to-left direction}
43
\item{\verb{ttb-ltr}}{Deprecated value; treated the
44
same as \code{PANGO_DIRECTION_RTL}.}
45
\item{\verb{ttb-rtl}}{Deprecated value; treated the
46
same as \code{PANGO_DIRECTION_LTR}}
50
\item{\verb{PangoBidiType}}{
51
The \code{\link{PangoBidiType}} type represents the bidirectional character
52
type of a Unicode character as specified by the
53
Unicode bidirectional algorithm (\url{http://www.unicode.org/reports/tr9/}).
57
\item{\verb{l}}{Left-to-Right}
58
\item{\verb{lre}}{Left-to-Right Embedding}
59
\item{\verb{lro}}{Left-to-Right Override}
60
\item{\verb{r}}{Right-to-Left}
61
\item{\verb{al}}{Right-to-Left Arabic}
62
\item{\verb{rle}}{Right-to-Left Embedding}
63
\item{\verb{rlo}}{Right-to-Left Override}
64
\item{\verb{pdf}}{Pop Directional Format}
65
\item{\verb{en}}{European Number}
66
\item{\verb{es}}{European Number Separator}
67
\item{\verb{et}}{European Number Terminator}
68
\item{\verb{an}}{Arabic Number}
69
\item{\verb{cs}}{Common Number Separator}
70
\item{\verb{nsm}}{Nonspacing Mark}
71
\item{\verb{bn}}{Boundary Neutral}
72
\item{\verb{b}}{Paragraph Separator}
73
\item{\verb{s}}{Segment Separator}
74
\item{\verb{ws}}{Whitespace}
75
\item{\verb{on}}{Other Neutrals}
80
\references{\url{http://library.gnome.org/devel//pango/pango-Bidirectional-Text.html}}
81
\author{Derived by RGtkGen from GTK+ documentation}