diff options
author | Behdad Esfahbod <behdad@gnome.org> | 2008-04-22 00:18:41 +0000 |
---|---|---|
committer | Behdad Esfahbod <behdad@src.gnome.org> | 2008-04-22 00:18:41 +0000 |
commit | f9343aa01ff8e71406a167de3ae186b615804f57 (patch) | |
tree | a4b7704133b2c044b85d7c9d928cd57032c71d6d /docs/tmpl | |
parent | 03cab3cab0ca0a48dc712ffce290a259bc2b49c5 (diff) | |
download | pango-f9343aa01ff8e71406a167de3ae186b615804f57.tar.gz |
Group bidi stuff together. Add a section in the docs for them.
2008-04-21 Behdad Esfahbod <behdad@gnome.org>
* docs/pango-docs.sgml:
* docs/pango-sections.txt:
* docs/tmpl/bidi.sgml:
* docs/tmpl/main.sgml:
* docs/tmpl/vertical.sgml:
* pango/pango-bidi-type.c (pango_log2vis_get_embedding_levels),
(pango_unichar_direction), (pango_get_mirror_char):
* pango/pango-bidi-type.h:
* pango/pango-types.h:
* pango/pango-utils.c:
Group bidi stuff together. Add a section in the docs for them.
svn path=/trunk/; revision=2608
Diffstat (limited to 'docs/tmpl')
-rw-r--r-- | docs/tmpl/bidi.sgml | 105 | ||||
-rw-r--r-- | docs/tmpl/main.sgml | 75 | ||||
-rw-r--r-- | docs/tmpl/vertical.sgml | 14 |
3 files changed, 105 insertions, 89 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: + + diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index 221bef43..fe37ff91 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -66,18 +66,6 @@ Since: 1.16 -<!-- ##### 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: - <!-- ##### MACRO PANGO_TYPE_DIRECTION ##### --> <para> The #GObject type for #PangoDirection. @@ -344,69 +332,6 @@ The #GObject type for #PangoDirection. @n_families: -<!-- ##### FUNCTION pango_get_mirror_char ##### --> -<para> - -</para> - -@ch: -@mirrored_ch: -@Returns: - - -<!-- ##### FUNCTION pango_unichar_direction ##### --> -<para> - -</para> - -@ch: -@Returns: - - -<!-- ##### FUNCTION pango_find_base_dir ##### --> -<para> - -</para> - -@text: -@length: -@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: - - <!-- ##### FUNCTION pango_break ##### --> <para> diff --git a/docs/tmpl/vertical.sgml b/docs/tmpl/vertical.sgml index 917641da..5a75d991 100644 --- a/docs/tmpl/vertical.sgml +++ b/docs/tmpl/vertical.sgml @@ -84,13 +84,6 @@ pango_attr_gravity_hint_new() @PANGO_GRAVITY_WEST: @PANGO_GRAVITY_AUTO: -<!-- ##### MACRO PANGO_TYPE_GRAVITY ##### --> -<para> -The #GObject type for #PangoGravity. -</para> - - - <!-- ##### ENUM PangoGravityHint ##### --> <para> @@ -100,13 +93,6 @@ The #GObject type for #PangoGravity. @PANGO_GRAVITY_HINT_STRONG: @PANGO_GRAVITY_HINT_LINE: -<!-- ##### MACRO PANGO_TYPE_GRAVITY_HINT ##### --> -<para> -The #GObject type for #PangoGravity. -</para> - - - <!-- ##### MACRO PANGO_GRAVITY_IS_VERTICAL ##### --> <para> |