1/* Pango
2 * pango-direction.h: Unicode text direction
3 *
4 * Copyright (C) 2018 Matthias Clasen
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
20 */
21
22#ifndef __PANGO_DIRECTION_H__
23#define __PANGO_DIRECTION_H__
24
25#include <glib.h>
26
27G_BEGIN_DECLS
28
29/**
30 * PangoDirection:
31 * @PANGO_DIRECTION_LTR: A strong left-to-right direction
32 * @PANGO_DIRECTION_RTL: A strong right-to-left direction
33 * @PANGO_DIRECTION_TTB_LTR: Deprecated value; treated the
34 * same as %PANGO_DIRECTION_RTL.
35 * @PANGO_DIRECTION_TTB_RTL: Deprecated value; treated the
36 * same as %PANGO_DIRECTION_LTR
37 * @PANGO_DIRECTION_WEAK_LTR: A weak left-to-right direction
38 * @PANGO_DIRECTION_WEAK_RTL: A weak right-to-left direction
39 * @PANGO_DIRECTION_NEUTRAL: No direction specified
40 *
41 * The #PangoDirection type represents a direction in the
42 * Unicode bidirectional algorithm; not every value in this
43 * enumeration makes sense for every usage of #PangoDirection;
44 * for example, the return value of pango_unichar_direction()
45 * and pango_find_base_dir() cannot be %PANGO_DIRECTION_WEAK_LTR
46 * or %PANGO_DIRECTION_WEAK_RTL, since every character is either
47 * neutral or has a strong direction; on the other hand
48 * %PANGO_DIRECTION_NEUTRAL doesn't make sense to pass
49 * to pango_itemize_with_base_dir().
50 *
51 * The %PANGO_DIRECTION_TTB_LTR, %PANGO_DIRECTION_TTB_RTL
52 * values come from an earlier interpretation of this
53 * enumeration as the writing direction of a block of
54 * text and are no longer used; See #PangoGravity for how
55 * vertical text is handled in Pango.
56 *
57 * If you are interested in text direction, you should
58 * really use fribidi directly. PangoDirection is only
59 * retained because it is used in some public apis.
60 **/
61typedef enum {
62 PANGO_DIRECTION_LTR,
63 PANGO_DIRECTION_RTL,
64 PANGO_DIRECTION_TTB_LTR,
65 PANGO_DIRECTION_TTB_RTL,
66 PANGO_DIRECTION_WEAK_LTR,
67 PANGO_DIRECTION_WEAK_RTL,
68 PANGO_DIRECTION_NEUTRAL
69} PangoDirection;
70
71G_END_DECLS
72
73#endif /* __PANGO_DIRECTION_H__ */
74