diff options
author | Matthias Clasen <mclasen@redhat.com> | 2021-02-17 01:10:49 -0500 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2021-03-11 13:17:36 -0500 |
commit | 6ac8ad77700090dd1caf21192f3e3e4eb0c948b3 (patch) | |
tree | ff12881c509cf50a57d3d3a1a729ca36d5c14628 /pango/pango-gravity.c | |
parent | 9f5733a7e34b88d85248cd6e6b214f261b1e66fc (diff) | |
download | pango-6ac8ad77700090dd1caf21192f3e3e4eb0c948b3.tar.gz |
docs: Convert bidi and vertical sections to pango_bidi.md
Diffstat (limited to 'pango/pango-gravity.c')
-rw-r--r-- | pango/pango-gravity.c | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/pango/pango-gravity.c b/pango/pango-gravity.c index 2d48c45e..ea6ef9e2 100644 --- a/pango/pango-gravity.c +++ b/pango/pango-gravity.c @@ -19,62 +19,6 @@ * Boston, MA 02111-1307, USA. */ -/** - * SECTION:vertical - * @short_description:Laying text out in vertical directions - * @title:Vertical Text - * @see_also: pango_context_get_base_gravity(), - * pango_context_set_base_gravity(), - * pango_context_get_gravity(), - * pango_context_get_gravity_hint(), - * pango_context_set_gravity_hint(), - * pango_font_description_set_gravity(), - * pango_font_description_get_gravity(), - * pango_attr_gravity_new(), - * pango_attr_gravity_hint_new() - * - * Since 1.16, Pango is able to correctly lay vertical text out. In fact, it can - * set layouts of mixed vertical and non-vertical text. This section describes - * the types used for setting vertical text parameters. - * - * The way this is implemented is through the concept of *gravity*. Gravity of - * normal Latin text is south. A gravity value of east means that glyphs will be - * rotated ninety degrees counterclockwise. So, to render vertical text one needs - * to set the gravity and rotate the layout using the matrix machinery already in - * place. This has the huge advantage that most algorithms working on a #PangoLayout - * do not need any change as the assumption that lines run in the X direction and - * stack in the Y direction holds even for vertical text layouts. - * - * Applications should only need to set base gravity on #PangoContext in use, and - * let Pango decide the gravity assigned to each run of text. This automatically - * handles text with mixed scripts. A very common use is to set the context base - * gravity to auto using pango_context_set_base_gravity() and rotate the layout - * normally. Pango will make sure that Asian languages take the right form, while - * other scripts are rotated normally. - * - * The correct way to set gravity on a layout is to set it on the context - * associated with it using pango_context_set_base_gravity(). The context - * of a layout can be accessed using pango_layout_get_context(). The currently - * set base gravity of the context can be accessed using - * pango_context_get_base_gravity() and the *resolved* gravity of it using - * pango_context_get_gravity(). The resolved gravity is the same as the base - * gravity for the most part, except that if the base gravity is set to - * %PANGO_GRAVITY_AUTO, the resolved gravity will depend on the current matrix - * set on context, and is derived using pango_gravity_get_for_matrix(). - * - * The next thing an application may want to set on the context is the - * *gravity hint*. A #PangoGravityHint instructs how different scripts should - * react to the set base gravity. - * - * Font descriptions have a gravity property too, that can be set using - * pango_font_description_set_gravity() and accessed using - * pango_font_description_get_gravity(). However, those are rarely useful - * from application code and are mainly used by #PangoLayout internally. - * - * Last but not least, one can create #PangoAttributes for gravity - * and gravity hint using pango_attr_gravity_new() and - * pango_attr_gravity_hint_new(). - */ #include "config.h" #include "pango-gravity.h" |