summaryrefslogtreecommitdiff
path: root/docs/tmpl/bidi.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tmpl/bidi.sgml')
-rw-r--r--docs/tmpl/bidi.sgml105
1 files changed, 105 insertions, 0 deletions
diff --git a/docs/tmpl/bidi.sgml b/docs/tmpl/bidi.sgml
new file mode 100644
index 00000000..7e5171e9
--- /dev/null
+++ b/docs/tmpl/bidi.sgml
@@ -0,0 +1,105 @@
+<!-- ##### SECTION Title ##### -->
+Bidirectional Text
+
+<!-- ##### SECTION Short_Description ##### -->
+Types and functions to help with handling bidirectional text
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Pango supports bidirectional text (like Arabic and Hebrew) automatically.
+Some applications however, need some help to correctly handle bidirectional
+text.
+</para>
+<para>
+The #PangoDirection type can be used with pango_context_set_base_dir() to
+instruct Pango about direction of text, though in most cases Pango detects
+that correctly and automatically. The rest of the facilities in this section
+are used internally by Pango already, and are provided to help applications
+that need more direct control over bidirectional setting of text.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+pango_context_get_base_dir(),
+pango_context_set_base_dir(),
+pango_itemize_with_base_dir()
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM PangoDirection ##### -->
+<para>
+</para>
+
+@PANGO_DIRECTION_LTR:
+@PANGO_DIRECTION_RTL:
+@PANGO_DIRECTION_TTB_LTR:
+@PANGO_DIRECTION_TTB_RTL:
+@PANGO_DIRECTION_WEAK_LTR:
+@PANGO_DIRECTION_WEAK_RTL:
+@PANGO_DIRECTION_NEUTRAL:
+
+<!-- ##### FUNCTION pango_unichar_direction ##### -->
+<para>
+
+</para>
+
+@ch:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_find_base_dir ##### -->
+<para>
+
+</para>
+
+@text:
+@length:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_get_mirror_char ##### -->
+<para>
+
+</para>
+
+@ch:
+@mirrored_ch:
+@Returns:
+
+
+<!-- ##### ENUM PangoBidiType ##### -->
+<para>
+
+</para>
+
+@PANGO_BIDI_TYPE_L:
+@PANGO_BIDI_TYPE_LRE:
+@PANGO_BIDI_TYPE_LRO:
+@PANGO_BIDI_TYPE_R:
+@PANGO_BIDI_TYPE_AL:
+@PANGO_BIDI_TYPE_RLE:
+@PANGO_BIDI_TYPE_RLO:
+@PANGO_BIDI_TYPE_PDF:
+@PANGO_BIDI_TYPE_EN:
+@PANGO_BIDI_TYPE_ES:
+@PANGO_BIDI_TYPE_ET:
+@PANGO_BIDI_TYPE_AN:
+@PANGO_BIDI_TYPE_CS:
+@PANGO_BIDI_TYPE_NSM:
+@PANGO_BIDI_TYPE_BN:
+@PANGO_BIDI_TYPE_B:
+@PANGO_BIDI_TYPE_S:
+@PANGO_BIDI_TYPE_WS:
+@PANGO_BIDI_TYPE_ON:
+
+<!-- ##### FUNCTION pango_bidi_type_for_unichar ##### -->
+<para>
+
+</para>
+
+@ch:
+@Returns:
+
+