summaryrefslogtreecommitdiff
path: root/pango2/pango-tabs.h
blob: c84fc6df297cd45c635e69a81df63535bfc52e00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
 * Copyright (C) 2000 Red Hat Software
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <pango2/pango-types.h>

G_BEGIN_DECLS

typedef struct _Pango2TabArray Pango2TabArray;

/**
 * Pango2TabAlign:
 * @PANGO2_TAB_LEFT: the text appears to the right of the tab stop position
 * @PANGO2_TAB_RIGHT: the text appears to the left of the tab stop position
 *   until the available space is filled.
 * @PANGO2_TAB_CENTER: the text is centered at the tab stop position
 *   until the available space is filled.
 * @PANGO2_TAB_DECIMAL: text before the first occurrence of the decimal point
 *   character appears to the left of the tab stop position (until the available
 *   space is filled), the rest to the right.
 *
 * `Pango2TabAlign` specifies where the text appears relative to the tab stop
 * position.
 */
typedef enum
{
  PANGO2_TAB_LEFT,
  PANGO2_TAB_RIGHT,
  PANGO2_TAB_CENTER,
  PANGO2_TAB_DECIMAL
} Pango2TabAlign;

/**
 * Pango2TabPositions:
 * @PANGO2_TAB_POSITIONS_DEFAULT: Positions are in Pango units
 * @PANGO2_TAB_POSITIONS_PIXELS: Positions are in pixls
 * @PANGO2_TAB_POSITIONS_SPACES: Positions are in spaces
 *
 * `Pango2TabPositions` specifies the unit for tab positions.
 */
typedef enum {
  PANGO2_TAB_POSITIONS_DEFAULT,
  PANGO2_TAB_POSITIONS_PIXELS,
  PANGO2_TAB_POSITIONS_SPACES,
} Pango2TabPositions;

#define PANGO2_TYPE_TAB_ARRAY (pango2_tab_array_get_type ())

PANGO2_AVAILABLE_IN_ALL
GType                   pango2_tab_array_get_type                (void) G_GNUC_CONST;

PANGO2_AVAILABLE_IN_ALL
Pango2TabArray *        pango2_tab_array_new                     (int                 initial_size,
                                                                  Pango2TabPositions  positions);
PANGO2_AVAILABLE_IN_ALL
Pango2TabArray *        pango2_tab_array_new_with_positions      (int              size,
                                                                  Pango2TabPositions positions,
                                                                  Pango2TabAlign   first_alignment,
                                                                  int              first_position,
                                                                  ...);
PANGO2_AVAILABLE_IN_ALL
Pango2TabArray *        pango2_tab_array_copy                    (Pango2TabArray  *src);
PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_free                    (Pango2TabArray  *tab_array);
PANGO2_AVAILABLE_IN_ALL
int                     pango2_tab_array_get_size                (Pango2TabArray  *tab_array);
PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_resize                  (Pango2TabArray  *tab_array,
                                                                  int              new_size);
PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_set_tab                 (Pango2TabArray  *tab_array,
                                                                  int              tab_index,
                                                                  Pango2TabAlign   alignment,
                                                                  int              location);
PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_get_tab                 (Pango2TabArray  *tab_array,
                                                                  int              tab_index,
                                                                  Pango2TabAlign  *alignment,
                                                                  int             *location);
PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_get_tabs                (Pango2TabArray  *tab_array,
                                                                  Pango2TabAlign **alignments,
                                                                  int            **locations);

PANGO2_AVAILABLE_IN_ALL
Pango2TabPositions      pango2_tab_array_get_positions           (Pango2TabArray  *tab_array);

PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_set_positions           (Pango2TabArray  *tab_array,
                                                                  Pango2TabPositions positions);

PANGO2_AVAILABLE_IN_ALL
char *                  pango2_tab_array_to_string               (Pango2TabArray  *tab_array);
PANGO2_AVAILABLE_IN_ALL
Pango2TabArray *        pango2_tab_array_from_string             (const char      *text);

PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_set_decimal_point       (Pango2TabArray  *tab_array,
                                                                  int              tab_index,
                                                                  gunichar         decimal_point);
PANGO2_AVAILABLE_IN_ALL
gunichar                pango2_tab_array_get_decimal_point       (Pango2TabArray  *tab_array,
                                                                  int              tab_index);

PANGO2_AVAILABLE_IN_ALL
void                    pango2_tab_array_sort                    (Pango2TabArray  *tab_array);

G_DEFINE_AUTOPTR_CLEANUP_FUNC(Pango2TabArray, pango2_tab_array_free)

G_END_DECLS