summaryrefslogtreecommitdiff
path: root/pango2/pango-attributes.h
blob: 98e89d7ba4d745e0fcae4d1f2e6beee99805fc9e (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
/*
 * 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-font.h>
#include <pango2/pango-color.h>
#include <pango2/pango-attr.h>

G_BEGIN_DECLS

#ifndef __GI_SCANNER__

#define PANGO2_ATTR_TYPE(value, affects, merge) (PANGO2_ATTR_VALUE_##value | (PANGO2_ATTR_AFFECTS_##affects << 8) | (PANGO2_ATTR_MERGE_##merge << 12) | (__COUNTER__ << 16))

#endif

/**
 * Pango2AttrType:
 * @PANGO2_ATTR_INVALID: does not happen
 * @PANGO2_ATTR_LANGUAGE: language
 * @PANGO2_ATTR_FAMILY: font family name
 * @PANGO2_ATTR_STYLE: font style
 * @PANGO2_ATTR_WEIGHT: font weight
 * @PANGO2_ATTR_VARIANT: font variant
 * @PANGO2_ATTR_STRETCH: font stretch
 * @PANGO2_ATTR_SIZE: font size in points scaled by `PANGO2_SCALE`
 * @PANGO2_ATTR_FONT_DESC: font description
 * @PANGO2_ATTR_FOREGROUND: foreground color
 * @PANGO2_ATTR_BACKGROUND: background color
 * @PANGO2_ATTR_UNDERLINE: underline style
 * @PANGO2_ATTR_UNDERLINE_POSITION: underline position
 * @PANGO2_ATTR_STRIKETHROUGH: whether the text is struck-through
 * @PANGO2_ATTR_RISE: baseline displacement
 * @PANGO2_ATTR_SCALE: font size scale factor
 * @PANGO2_ATTR_FALLBACK: whether font fallback is enabled
 * @PANGO2_ATTR_LETTER_SPACING: letter spacing in Pango2 units
 * @PANGO2_ATTR_UNDERLINE_COLOR: underline color
 * @PANGO2_ATTR_STRIKETHROUGH_COLOR: strikethrough color
 * @PANGO2_ATTR_ABSOLUTE_SIZE: font size in pixels scaled by `PANGO2_SCALE`
 * @PANGO2_ATTR_GRAVITY: base text gravity
 * @PANGO2_ATTR_GRAVITY_HINT: gravity hint
 * @PANGO2_ATTR_FONT_FEATURES: OpenType font features
 * @PANGO2_ATTR_ALLOW_BREAKS: whether line breaks are allowed
 * @PANGO2_ATTR_SHOW: how to render invisible characters
 * @PANGO2_ATTR_INSERT_HYPHENS: whether to insert hyphens at intra-word line breaks
 * @PANGO2_ATTR_OVERLINE: whether the text has an overline
 * @PANGO2_ATTR_OVERLINE_COLOR: overline color
 * @PANGO2_ATTR_LINE_HEIGHT: line height factor
 * @PANGO2_ATTR_ABSOLUTE_LINE_HEIGHT: line height in Pango2 units
 * @PANGO2_ATTR_WORD: mark the range of the attribute as a single word
 * @PANGO2_ATTR_SENTENCE: mark the range of the attribute as a single sentence
 * @PANGO2_ATTR_PARAGRAPH: mark the range of the attribute as a single paragraph
 * @PANGO2_ATTR_BASELINE_SHIFT: baseline displacement
 * @PANGO2_ATTR_FONT_SCALE: font-relative size change
 * @PANGO2_ATTR_LINE_SPACING: space to add to the leading from the
 *   font metrics (if not overridden by a line height attribute)
 * @PANGO2_ATTR_SHAPE: override glyph shapes (requires renderer support)
 *
 * `Pango2AttrType` contains predefined attribute types.
 *
 * Along with the predefined values, it is possible to allocate additional
 * values for custom attributes using [func@AttrType.register]. The predefined
 * values are given below.
 */
typedef enum
{
  PANGO2_ATTR_INVALID,
  PANGO2_ATTR_LANGUAGE             = PANGO2_ATTR_TYPE (LANGUAGE, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_FAMILY               = PANGO2_ATTR_TYPE (STRING, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_STYLE                = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_WEIGHT               = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_VARIANT              = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_STRETCH              = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_SIZE                 = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_FONT_DESC            = PANGO2_ATTR_TYPE (FONT_DESC, ITEMIZATION, ACCUMULATES),
  PANGO2_ATTR_FOREGROUND           = PANGO2_ATTR_TYPE (COLOR, RENDERING, OVERRIDES),
  PANGO2_ATTR_BACKGROUND           = PANGO2_ATTR_TYPE (COLOR, RENDERING, OVERRIDES),
  PANGO2_ATTR_UNDERLINE            = PANGO2_ATTR_TYPE (INT, RENDERING, OVERRIDES),
  PANGO2_ATTR_UNDERLINE_POSITION   = PANGO2_ATTR_TYPE (INT, RENDERING, OVERRIDES),
  PANGO2_ATTR_STRIKETHROUGH        = PANGO2_ATTR_TYPE (INT, RENDERING, OVERRIDES),
  PANGO2_ATTR_RISE                 = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_SCALE                = PANGO2_ATTR_TYPE (FLOAT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_FALLBACK             = PANGO2_ATTR_TYPE (BOOLEAN, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_LETTER_SPACING       = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_UNDERLINE_COLOR      = PANGO2_ATTR_TYPE (COLOR, RENDERING, OVERRIDES),
  PANGO2_ATTR_STRIKETHROUGH_COLOR  = PANGO2_ATTR_TYPE (COLOR, RENDERING, OVERRIDES),
  PANGO2_ATTR_ABSOLUTE_SIZE        = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_GRAVITY              = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_GRAVITY_HINT         = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_FONT_FEATURES        = PANGO2_ATTR_TYPE (STRING, SHAPING, ACCUMULATES),
  PANGO2_ATTR_ALLOW_BREAKS         = PANGO2_ATTR_TYPE (BOOLEAN, BREAKING, OVERRIDES),
  PANGO2_ATTR_SHOW                 = PANGO2_ATTR_TYPE (INT, SHAPING, OVERRIDES),
  PANGO2_ATTR_INSERT_HYPHENS       = PANGO2_ATTR_TYPE (BOOLEAN, SHAPING, OVERRIDES),
  PANGO2_ATTR_OVERLINE             = PANGO2_ATTR_TYPE (INT, RENDERING, OVERRIDES),
  PANGO2_ATTR_OVERLINE_COLOR       = PANGO2_ATTR_TYPE (COLOR, RENDERING, OVERRIDES),
  PANGO2_ATTR_LINE_HEIGHT          = PANGO2_ATTR_TYPE (FLOAT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_ABSOLUTE_LINE_HEIGHT = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_TEXT_TRANSFORM       = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_WORD                 = PANGO2_ATTR_TYPE (BOOLEAN, BREAKING, OVERRIDES),
  PANGO2_ATTR_SENTENCE             = PANGO2_ATTR_TYPE (BOOLEAN, BREAKING, OVERRIDES),
  PANGO2_ATTR_PARAGRAPH            = PANGO2_ATTR_TYPE (BOOLEAN, BREAKING, OVERRIDES),
  PANGO2_ATTR_BASELINE_SHIFT       = PANGO2_ATTR_TYPE (INT, ITEMIZATION, ACCUMULATES),
  PANGO2_ATTR_FONT_SCALE           = PANGO2_ATTR_TYPE (INT, ITEMIZATION, ACCUMULATES),
  PANGO2_ATTR_LINE_SPACING         = PANGO2_ATTR_TYPE (INT, ITEMIZATION, OVERRIDES),
  PANGO2_ATTR_SHAPE                = PANGO2_ATTR_TYPE (POINTER, ITEMIZATION, OVERRIDES),
} Pango2AttrType;

#undef PANGO2_ATTR_TYPE

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_language_new                 (Pango2Language              *language);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_family_new                   (const char                  *family);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_foreground_new               (Pango2Color                 *color);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_background_new               (Pango2Color                 *color);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_size_new                     (int                          size);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_size_new_absolute            (int                          size);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_style_new                    (Pango2Style                  style);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_weight_new                   (Pango2Weight                 weight);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_variant_new                  (Pango2Variant                variant);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_stretch_new                  (Pango2Stretch                stretch);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_font_desc_new                (const Pango2FontDescription *desc);

/**
 * Pango2LineStyle:
 * @PANGO2_LINE_STYLE_NONE: No visible line
 * @PANGO2_LINE_STYLE_SOLID: A single line
 * @PANGO2_LINE_STYLE_DOUBLE: A double line
 * @PANGO2_LINE_STYLE_DASHED: A dashed line
 * @PANGO2_LINE_STYLE_DOTTED: A dotted line
 * @PANGO2_LINE_STYLE_WAVY: A wavy line
 *
 * `Pango2LineStyle specifies how lines should be drawn.
 */
typedef enum {
  PANGO2_LINE_STYLE_NONE,
  PANGO2_LINE_STYLE_SOLID,
  PANGO2_LINE_STYLE_DOUBLE,
  PANGO2_LINE_STYLE_DASHED,
  PANGO2_LINE_STYLE_DOTTED,
  PANGO2_LINE_STYLE_WAVY,
} Pango2LineStyle;

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_underline_new                (Pango2LineStyle              style);

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_underline_color_new          (Pango2Color                 *color);

/**
 * Pango2UnderlinePosition:
 * @PANGO2_UNDERLINE_POSITION_NORMAL: As specified by font metrics
 * @PANGO2_UNDERLINE_POSITION_UNDER: Below the ink extents of the run
 *
 * `Pango2UnderlinePosition` specifies where underlines should be drawn.
 */
typedef enum {
  PANGO2_UNDERLINE_POSITION_NORMAL,
  PANGO2_UNDERLINE_POSITION_UNDER
} Pango2UnderlinePosition;

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_underline_position_new       (Pango2UnderlinePosition      position);

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_strikethrough_new            (Pango2LineStyle              style);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_strikethrough_color_new      (Pango2Color                 *color);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_rise_new                     (int                          rise);

/**
 * Pango2BaselineShift:
 * @PANGO2_BASELINE_SHIFT_NONE: Leave the baseline unchanged
 * @PANGO2_BASELINE_SHIFT_SUPERSCRIPT: Shift the baseline to the superscript position,
 *   relative to the previous run
 * @PANGO2_BASELINE_SHIFT_SUBSCRIPT: Shift the baseline to the subscript position,
 *   relative to the previous run
 *
 * `Pango2BaselineShift` influences how baselines are changed between runs.
 */
typedef enum {
  PANGO2_BASELINE_SHIFT_NONE,
  PANGO2_BASELINE_SHIFT_SUPERSCRIPT,
  PANGO2_BASELINE_SHIFT_SUBSCRIPT,
} Pango2BaselineShift;

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_baseline_shift_new           (int                          shift);

/**
 * Pango2FontScale:
 * @PANGO2_FONT_SCALE_NONE: Leave the font size unchanged
 * @PANGO2_FONT_SCALE_SUPERSCRIPT: Change the font to a size suitable for superscripts
 * @PANGO2_FONT_SCALE_SUBSCRIPT: Change the font to a size suitable for subscripts
 * @PANGO2_FONT_SCALE_SMALL_CAPS: Change the font to a size suitable for Small Caps
 *
 * `Pango2FontScale` influences the font size of a run.
 */
typedef enum {
  PANGO2_FONT_SCALE_NONE,
  PANGO2_FONT_SCALE_SUPERSCRIPT,
  PANGO2_FONT_SCALE_SUBSCRIPT,
  PANGO2_FONT_SCALE_SMALL_CAPS,
} Pango2FontScale;

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_font_scale_new               (Pango2FontScale              scale);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_scale_new                    (double                       scale_factor);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_fallback_new                 (gboolean                     enable_fallback);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_letter_spacing_new           (int                          letter_spacing);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_gravity_new                  (Pango2Gravity                gravity);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_gravity_hint_new             (Pango2GravityHint            hint);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_font_features_new            (const char                  *features);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_allow_breaks_new             (gboolean                     allow_breaks);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_word_new                     (void);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_sentence_new                 (void);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_paragraph_new                (void);

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_insert_hyphens_new           (gboolean                     insert_hyphens);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_overline_new                 (Pango2LineStyle              style);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_overline_color_new           (Pango2Color                 *color);

/**
 * Pango2ShowFlags:
 * @PANGO2_SHOW_NONE: No special treatment for invisible characters
 * @PANGO2_SHOW_SPACES: Render spaces, tabs and newlines visibly
 * @PANGO2_SHOW_LINE_BREAKS: Render line breaks visibly
 * @PANGO2_SHOW_IGNORABLES: Render default-ignorable Unicode
 *   characters visibly
 *
 * `Pango2ShowFlags` affect how Pango2 treats characters that are normally
 * not visible in the output.
 */
typedef enum {
  PANGO2_SHOW_NONE        = 0,
  PANGO2_SHOW_SPACES      = 1 << 0,
  PANGO2_SHOW_LINE_BREAKS = 1 << 1,
  PANGO2_SHOW_IGNORABLES  = 1 << 2
} Pango2ShowFlags;

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_show_new                     (Pango2ShowFlags              flags);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_line_height_new              (double                       factor);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_line_height_new_absolute     (int                          height);
PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_line_spacing_new             (int                          spacing);

/**
 * Pango2TextTransform:
 * @PANGO2_TEXT_TRANSFORM_NONE: Leave text unchanged
 * @PANGO2_TEXT_TRANSFORM_LOWERCASE: Display letters and numbers as lowercase
 * @PANGO2_TEXT_TRANSFORM_UPPERCASE: Display letters and numbers as uppercase
 * @PANGO2_TEXT_TRANSFORM_CAPITALIZE: Display the first character of a word
 *   in titlecase
 *
 * `Pango2TextTransform` determines if Pango2 changes the case of characters
 * during shaping.
  */
typedef enum {
  PANGO2_TEXT_TRANSFORM_NONE,
  PANGO2_TEXT_TRANSFORM_LOWERCASE,
  PANGO2_TEXT_TRANSFORM_UPPERCASE,
  PANGO2_TEXT_TRANSFORM_CAPITALIZE,
} Pango2TextTransform;

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_text_transform_new           (Pango2TextTransform     transform);

PANGO2_AVAILABLE_IN_ALL
Pango2Attribute *        pango2_attr_shape_new                    (Pango2Rectangle        *ink_rect,
                                                                   Pango2Rectangle        *logical_rect,
                                                                   gpointer                data,
                                                                   Pango2AttrDataCopyFunc  copy,
                                                                   GDestroyNotify          destroy);

G_END_DECLS