summaryrefslogtreecommitdiff
path: root/pango/pango-font-description.h
blob: 6643131c3c8ec00ba3ed86b97ca6efa42f5682d7 (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
319
320
321
322
323
324
/*
 * 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 <pango/pango-types.h>

#include <glib-object.h>
#include <hb.h>

G_BEGIN_DECLS

/**
 * PangoFontDescription:
 *
 * A `PangoFontDescription` describes a font in an implementation-independent
 * manner.
 *
 * `PangoFontDescription` structures are used both to list what fonts are
 * available on the system and also for specifying the characteristics of
 * a font to load.
 */

/**
 * PangoStyle:
 * @PANGO_STYLE_NORMAL: the font is upright.
 * @PANGO_STYLE_OBLIQUE: the font is slanted, but in a roman style.
 * @PANGO_STYLE_ITALIC: the font is slanted in an italic style.
 *
 * An enumeration specifying the various slant styles possible for a font.
 **/
typedef enum {
  PANGO_STYLE_NORMAL,
  PANGO_STYLE_OBLIQUE,
  PANGO_STYLE_ITALIC
} PangoStyle;

/**
 * PangoVariant:
 * @PANGO_VARIANT_NORMAL: A normal font.
 * @PANGO_VARIANT_SMALL_CAPS: A font with the lower case characters
 *   replaced by smaller variants of the capital characters.
 * @PANGO_VARIANT_ALL_SMALL_CAPS: A font with all characters
 *   replaced by smaller variants of the capital characters.
 * @PANGO_VARIANT_PETITE_CAPS: A font with the lower case characters
 *   replaced by smaller variants of the capital characters.
 *   Petite Caps can be even smaller than Small Caps.
 * @PANGO_VARIANT_ALL_PETITE_CAPS: A font with all characters
 *   replaced by smaller variants of the capital characters.
 *   Petite Caps can be even smaller than Small Caps.
 * @PANGO_VARIANT_UNICASE: A font with the upper case characters
 *   replaced by smaller variants of the capital letters.
 * @PANGO_VARIANT_TITLE_CAPS: A font with capital letters that
 *   are more suitable for all-uppercase titles.
 *
 * An enumeration specifying capitalization variant of the font.
 */
typedef enum {
  PANGO_VARIANT_NORMAL,
  PANGO_VARIANT_SMALL_CAPS,
  PANGO_VARIANT_ALL_SMALL_CAPS,
  PANGO_VARIANT_PETITE_CAPS,
  PANGO_VARIANT_ALL_PETITE_CAPS,
  PANGO_VARIANT_UNICASE,
  PANGO_VARIANT_TITLE_CAPS
} PangoVariant;

/**
 * PangoWeight:
 * @PANGO_WEIGHT_THIN: the thin weight (= 100)
 * @PANGO_WEIGHT_ULTRALIGHT: the ultralight weight (= 200)
 * @PANGO_WEIGHT_LIGHT: the light weight (= 300)
 * @PANGO_WEIGHT_SEMILIGHT: the semilight weight (= 350)
 * @PANGO_WEIGHT_BOOK: the book weight (= 380)
 * @PANGO_WEIGHT_NORMAL: the default weight (= 400)
 * @PANGO_WEIGHT_MEDIUM: the normal weight (= 500)
 * @PANGO_WEIGHT_SEMIBOLD: the semibold weight (= 600)
 * @PANGO_WEIGHT_BOLD: the bold weight (= 700)
 * @PANGO_WEIGHT_ULTRABOLD: the ultrabold weight (= 800)
 * @PANGO_WEIGHT_HEAVY: the heavy weight (= 900)
 * @PANGO_WEIGHT_ULTRAHEAVY: the ultraheavy weight (= 1000)
 *
 * A `PangoWeight` specifes the weight (boldness) of a font.
 *
 * Weight is specified as a numeric value ranging from 100 to 1000.
 * This enumeration simply provides some common, predefined values.
 */
typedef enum {
  PANGO_WEIGHT_THIN = 100,
  PANGO_WEIGHT_ULTRALIGHT = 200,
  PANGO_WEIGHT_LIGHT = 300,
  PANGO_WEIGHT_SEMILIGHT = 350,
  PANGO_WEIGHT_BOOK = 380,
  PANGO_WEIGHT_NORMAL = 400,
  PANGO_WEIGHT_MEDIUM = 500,
  PANGO_WEIGHT_SEMIBOLD = 600,
  PANGO_WEIGHT_BOLD = 700,
  PANGO_WEIGHT_ULTRABOLD = 800,
  PANGO_WEIGHT_HEAVY = 900,
  PANGO_WEIGHT_ULTRAHEAVY = 1000
} PangoWeight;

/**
 * PangoStretch:
 * @PANGO_STRETCH_ULTRA_CONDENSED: ultra-condensed width (= 500)
 * @PANGO_STRETCH_EXTRA_CONDENSED: extra-condensed width (= 625)
 * @PANGO_STRETCH_CONDENSED: condensed width (= 750)
 * @PANGO_STRETCH_SEMI_CONDENSED: semi-condensed width (= 875)
 * @PANGO_STRETCH_NORMAL: the normal width (= 1000)
 * @PANGO_STRETCH_SEMI_EXPANDED: semi-expanded width (= 1125)
 * @PANGO_STRETCH_EXPANDED: expanded width (= 1250)
 * @PANGO_STRETCH_EXTRA_EXPANDED: extra-expanded width (= 1500)
 * @PANGO_STRETCH_ULTRA_EXPANDED: ultra-expanded width (= 2000)
 *
 * A `PangoStretch` specifes the width of the font relative
 * to other designs within a family.
 *
 * Stretch is specified as a numeric value ranging from 500 to 2000.
 * This enumeration simply provides some common, predefined values.
 */
typedef enum {
  PANGO_STRETCH_ULTRA_CONDENSED =  500,
  PANGO_STRETCH_EXTRA_CONDENSED =  625,
  PANGO_STRETCH_CONDENSED       =  750,
  PANGO_STRETCH_SEMI_CONDENSED  =  875,
  PANGO_STRETCH_NORMAL          = 1000,
  PANGO_STRETCH_SEMI_EXPANDED   = 1125,
  PANGO_STRETCH_EXPANDED        = 1250,
  PANGO_STRETCH_EXTRA_EXPANDED  = 1500,
  PANGO_STRETCH_ULTRA_EXPANDED  = 2000
} PangoStretch;

/**
 * PangoFontMask:
 * @PANGO_FONT_MASK_FAMILY: the font family is specified.
 * @PANGO_FONT_MASK_STYLE: the font style is specified.
 * @PANGO_FONT_MASK_VARIANT: the font variant is specified.
 * @PANGO_FONT_MASK_WEIGHT: the font weight is specified.
 * @PANGO_FONT_MASK_STRETCH: the font stretch is specified.
 * @PANGO_FONT_MASK_SIZE: the font size is specified.
 * @PANGO_FONT_MASK_GRAVITY: the font gravity is specified
 * @PANGO_FONT_MASK_VARIATIONS: OpenType font variations are specified
 * @PANGO_FONT_MASK_FACEID: the face ID is specified
 *
 * The bits in a `PangoFontMask` correspond to the set fields in a
 * `PangoFontDescription`.
 */
typedef enum {
  PANGO_FONT_MASK_FAMILY     = 1 << 0,
  PANGO_FONT_MASK_STYLE      = 1 << 1,
  PANGO_FONT_MASK_VARIANT    = 1 << 2,
  PANGO_FONT_MASK_WEIGHT     = 1 << 3,
  PANGO_FONT_MASK_STRETCH    = 1 << 4,
  PANGO_FONT_MASK_SIZE       = 1 << 5,
  PANGO_FONT_MASK_GRAVITY    = 1 << 6,
  PANGO_FONT_MASK_VARIATIONS = 1 << 7,
  PANGO_FONT_MASK_FACEID     = 1 << 8,
} PangoFontMask;

/* CSS scale factors (1.2 factor between each size) */
/**
 * PANGO_SCALE_XX_SMALL:
 *
 * The scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).
 */
/**
 * PANGO_SCALE_X_SMALL:
 *
 * The scale factor for two shrinking steps (1 / (1.2 * 1.2)).
 */
/**
 * PANGO_SCALE_SMALL:
 *
 * The scale factor for one shrinking step (1 / 1.2).
 */
/**
 * PANGO_SCALE_MEDIUM:
 *
 * The scale factor for normal size (1.0).
 */
/**
 * PANGO_SCALE_LARGE:
 *
 * The scale factor for one magnification step (1.2).
 */
/**
 * PANGO_SCALE_X_LARGE:
 *
 * The scale factor for two magnification steps (1.2 * 1.2).
 */
/**
 * PANGO_SCALE_XX_LARGE:
 *
 * The scale factor for three magnification steps (1.2 * 1.2 * 1.2).
 */
#define PANGO_SCALE_XX_SMALL ((double)0.5787037037037)
#define PANGO_SCALE_X_SMALL  ((double)0.6944444444444)
#define PANGO_SCALE_SMALL    ((double)0.8333333333333)
#define PANGO_SCALE_MEDIUM   ((double)1.0)
#define PANGO_SCALE_LARGE    ((double)1.2)
#define PANGO_SCALE_X_LARGE  ((double)1.44)
#define PANGO_SCALE_XX_LARGE ((double)1.728)


#define PANGO_TYPE_FONT_DESCRIPTION (pango_font_description_get_type ())

PANGO_AVAILABLE_IN_ALL
GType                   pango_font_description_get_type          (void) G_GNUC_CONST;
PANGO_AVAILABLE_IN_ALL
PangoFontDescription *  pango_font_description_new               (void);
PANGO_AVAILABLE_IN_ALL
PangoFontDescription *  pango_font_description_copy              (const PangoFontDescription  *desc);
PANGO_AVAILABLE_IN_ALL
PangoFontDescription *  pango_font_description_copy_static       (const PangoFontDescription  *desc);
PANGO_AVAILABLE_IN_ALL
guint                   pango_font_description_hash              (const PangoFontDescription  *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
gboolean                pango_font_description_equal             (const PangoFontDescription  *desc1,
                                                                  const PangoFontDescription  *desc2) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_free              (PangoFontDescription        *desc);

PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_family        (PangoFontDescription *desc,
                                                                  const char           *family);
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_family_static (PangoFontDescription *desc,
                                                                  const char           *family);
PANGO_AVAILABLE_IN_ALL
const char *            pango_font_description_get_family        (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_style         (PangoFontDescription *desc,
                                                                  PangoStyle            style);
PANGO_AVAILABLE_IN_ALL
PangoStyle              pango_font_description_get_style         (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_variant       (PangoFontDescription *desc,
                                                                  PangoVariant          variant);
PANGO_AVAILABLE_IN_ALL
PangoVariant            pango_font_description_get_variant       (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_weight        (PangoFontDescription *desc,
                                                                  PangoWeight           weight);
PANGO_AVAILABLE_IN_ALL
PangoWeight             pango_font_description_get_weight        (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_stretch       (PangoFontDescription *desc,
                                                                  PangoStretch          stretch);
PANGO_AVAILABLE_IN_ALL
PangoStretch            pango_font_description_get_stretch       (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_size          (PangoFontDescription *desc,
                                                                  int                   size);
PANGO_AVAILABLE_IN_ALL
int                     pango_font_description_get_size          (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_absolute_size (PangoFontDescription *desc,
                                                                  double                size);
PANGO_AVAILABLE_IN_ALL
gboolean                pango_font_description_get_size_is_absolute (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_gravity       (PangoFontDescription *desc,
                                                                  PangoGravity          gravity);
PANGO_AVAILABLE_IN_ALL
PangoGravity            pango_font_description_get_gravity       (const PangoFontDescription *desc) G_GNUC_PURE;

PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_variations_static (PangoFontDescription       *desc,
                                                                      const char                 *variations);
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_set_variations    (PangoFontDescription       *desc,
                                                                  const char                 *variations);
PANGO_AVAILABLE_IN_ALL
const char *            pango_font_description_get_variations    (const PangoFontDescription *desc) G_GNUC_PURE;

PANGO_AVAILABLE_IN_ALL
void                 pango_font_description_set_faceid         (PangoFontDescription     *desc,
                                                                const char               *faceid);
PANGO_AVAILABLE_IN_ALL
void                 pango_font_description_set_faceid_static  (PangoFontDescription *desc,
                                                                const char           *faceid);
PANGO_AVAILABLE_IN_ALL
const char *         pango_font_description_get_faceid         (const PangoFontDescription *desc) G_GNUC_PURE;

PANGO_AVAILABLE_IN_ALL
PangoFontMask           pango_font_description_get_set_fields    (const PangoFontDescription *desc) G_GNUC_PURE;
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_unset_fields      (PangoFontDescription       *desc,
                                                                  PangoFontMask               to_unset);

PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_merge             (PangoFontDescription       *desc,
                                                                  const PangoFontDescription *desc_to_merge,
                                                                  gboolean                    replace_existing);
PANGO_AVAILABLE_IN_ALL
void                    pango_font_description_merge_static      (PangoFontDescription       *desc,
                                                                  const PangoFontDescription *desc_to_merge,
                                                                  gboolean                    replace_existing);

PANGO_AVAILABLE_IN_ALL
PangoFontDescription *  pango_font_description_from_string       (const char                  *str);
PANGO_AVAILABLE_IN_ALL
char *                  pango_font_description_to_string         (const PangoFontDescription  *desc);


G_DEFINE_AUTOPTR_CLEANUP_FUNC(PangoFontDescription, pango_font_description_free)

G_END_DECLS