pango-1.0/pango/pango-direction.h

0001 /* Pango
0002  * pango-direction.h: Unicode text direction
0003  *
0004  * Copyright (C) 2018 Matthias Clasen
0005  *
0006  * This library is free software; you can redistribute it and/or
0007  * modify it under the terms of the GNU Library General Public
0008  * License as published by the Free Software Foundation; either
0009  * version 2 of the License, or (at your option) any later version.
0010  *
0011  * This library is distributed in the hope that it will be useful,
0012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0014  * Library General Public License for more details.
0015  *
0016  * You should have received a copy of the GNU Library General Public
0017  * License along with this library; if not, write to the
0018  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0019  * Boston, MA 02111-1307, USA.
0020  */
0021
0022 #ifndef __PANGO_DIRECTION_H__
0023 #define __PANGO_DIRECTION_H__
0024
0025 #include <glib.h>
0026
0027 G_BEGIN_DECLS
0028
0029 /**
0030  * PangoDirection:
0031  * @PANGO_DIRECTION_LTR: A strong left-to-right direction
0032  * @PANGO_DIRECTION_RTL: A strong right-to-left direction
0033  * @PANGO_DIRECTION_TTB_LTR: Deprecated value; treated the
0034  *   same as `PANGO_DIRECTION_RTL`.
0035  * @PANGO_DIRECTION_TTB_RTL: Deprecated value; treated the
0036  *   same as `PANGO_DIRECTION_LTR`
0037  * @PANGO_DIRECTION_WEAK_LTR: A weak left-to-right direction
0038  * @PANGO_DIRECTION_WEAK_RTL: A weak right-to-left direction
0039  * @PANGO_DIRECTION_NEUTRAL: No direction specified
0040  *
0041  * `PangoDirection` represents a direction in the Unicode bidirectional
0042  * algorithm.
0043  *
0044  * Not every value in this enumeration makes sense for every usage of
0045  * `PangoDirection`; for example, the return value of [func@unichar_direction]
0046  * and [func@find_base_dir] cannot be `PANGO_DIRECTION_WEAK_LTR` or
0047  * `PANGO_DIRECTION_WEAK_RTL`, since every character is either neutral
0048  * or has a strong direction; on the other hand `PANGO_DIRECTION_NEUTRAL`
0049  * doesn't make sense to pass to [func@itemize_with_base_dir].
0050  *
0051  * The `PANGO_DIRECTION_TTB_LTR`, `PANGO_DIRECTION_TTB_RTL` values come from
0052  * an earlier interpretation of this enumeration as the writing direction
0053  * of a block of text and are no longer used. See `PangoGravity` for how
0054  * vertical text is handled in Pango.
0055  *
0056  * If you are interested in text direction, you should really use fribidi
0057  * directly. `PangoDirection` is only retained because it is used in some
0058  * public apis.
0059  */
0060 typedef enum {
0061   PANGO_DIRECTION_LTR,
0062   PANGO_DIRECTION_RTL,
0063   PANGO_DIRECTION_TTB_LTR,
0064   PANGO_DIRECTION_TTB_RTL,
0065   PANGO_DIRECTION_WEAK_LTR,
0066   PANGO_DIRECTION_WEAK_RTL,
0067   PANGO_DIRECTION_NEUTRAL
0068 } PangoDirection;
0069
0070 G_END_DECLS
0071
0072 #endif /* __PANGO_DIRECTION_H__ */