-
-
Notifications
You must be signed in to change notification settings - Fork 46
/
PangoCairo-1.0.gir
763 lines (719 loc) · 36.7 KB
/
PangoCairo-1.0.gir
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0" version="1.2">
<include name="GObject" version="2.0"/>
<include name="Pango" version="1.0"/>
<include name="cairo" version="1.0"/>
<package name="pangocairo"/>
<c:include name="pango/pangocairo.h"/>
<namespace name="PangoCairo" version="1.0" shared-library="libpangocairo-1.0.so.0" c:identifier-prefixes="PangoCairo" c:symbol-prefixes="pango_cairo">
<function-macro name="FONT" c:identifier="PANGO_CAIRO_FONT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="FONT_MAP" c:identifier="PANGO_CAIRO_FONT_MAP" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<interface name="Font" c:symbol-prefix="font" c:type="PangoCairoFont" version="1.18" glib:type-name="PangoCairoFont" glib:get-type="pango_cairo_font_get_type">
<doc xml:space="preserve">`PangoCairoFont` is an interface exported by fonts for
use with Cairo.
The actual type of the font will depend on the particular
font technology Cairo was compiled to use.</doc>
<prerequisite name="Pango.Font"/>
<method name="get_scaled_font" c:identifier="pango_cairo_font_get_scaled_font" version="1.18">
<doc xml:space="preserve">Gets the `cairo_scaled_font_t` used by @font.
The scaled font can be referenced and kept using
cairo_scaled_font_reference().</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the `cairo_scaled_font_t`
used by @font</doc>
<type name="cairo.ScaledFont" c:type="cairo_scaled_font_t*"/>
</return-value>
<parameters>
<instance-parameter name="font" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a `PangoFont` from a `PangoCairoFontMap`</doc>
<type name="Font" c:type="PangoCairoFont*"/>
</instance-parameter>
</parameters>
</method>
</interface>
<interface name="FontMap" c:symbol-prefix="font_map" c:type="PangoCairoFontMap" version="1.10" glib:type-name="PangoCairoFontMap" glib:get-type="pango_cairo_font_map_get_type">
<doc xml:space="preserve">`PangoCairoFontMap` is an interface exported by font maps for
use with Cairo.
The actual type of the font map will depend on the particular
font technology Cairo was compiled to use.</doc>
<prerequisite name="Pango.FontMap"/>
<function name="get_default" c:identifier="pango_cairo_font_map_get_default" version="1.10">
<doc xml:space="preserve">Gets a default `PangoCairoFontMap` to use with Cairo.
Note that the type of the returned object will depend on the
particular font backend Cairo was compiled to use; you generally
should only use the `PangoFontMap` and `PangoCairoFontMap`
interfaces on the returned object.
The default Cairo fontmap can be changed by using
[[email protected]_default]. This can be used to
change the Cairo font backend that the default fontmap uses
for example.
Note that since Pango 1.32.6, the default fontmap is per-thread.
Each thread gets its own default fontmap. In this way, PangoCairo
can be used safely from multiple threads.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the default PangoCairo fontmap
for the current thread. This object is owned by Pango and must
not be freed.</doc>
<type name="Pango.FontMap" c:type="PangoFontMap*"/>
</return-value>
</function>
<function name="new" c:identifier="pango_cairo_font_map_new" version="1.10">
<doc xml:space="preserve">Creates a new `PangoCairoFontMap` object.
A fontmap is used to cache information about available fonts,
and holds certain global parameters such as the resolution.
In most cases, you can use `[email protected]_map_get_default]
instead.
Note that the type of the returned object will depend
on the particular font backend Cairo was compiled to use;
You generally should only use the `PangoFontMap` and
`PangoCairoFontMap` interfaces on the returned object.
You can override the type of backend returned by using an
environment variable %PANGOCAIRO_BACKEND. Supported types,
based on your build, are fc (fontconfig), win32, and coretext.
If requested type is not available, NULL is returned. Ie.
this is only useful for testing, when at least two backends
are compiled in.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly allocated `PangoFontMap`,
which should be freed with g_object_unref().</doc>
<type name="Pango.FontMap" c:type="PangoFontMap*"/>
</return-value>
</function>
<function name="new_for_font_type" c:identifier="pango_cairo_font_map_new_for_font_type" version="1.18">
<doc xml:space="preserve">Creates a new `PangoCairoFontMap` object of the type suitable
to be used with cairo font backend of type @fonttype.
In most cases one should simply use [[email protected]], or
in fact in most of those cases, just use [[email protected]_default].</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the newly allocated
`PangoFontMap` of suitable type which should be freed with
g_object_unref(), or %NULL if the requested cairo font backend
is not supported / compiled in.</doc>
<type name="Pango.FontMap" c:type="PangoFontMap*"/>
</return-value>
<parameters>
<parameter name="fonttype" transfer-ownership="none">
<doc xml:space="preserve">desired #cairo_font_type_t</doc>
<type name="cairo.FontType" c:type="cairo_font_type_t"/>
</parameter>
</parameters>
</function>
<method name="create_context" c:identifier="pango_cairo_font_map_create_context" version="1.10" introspectable="0" deprecated="1" deprecated-version="1.22">
<doc xml:space="preserve">Create a `PangoContext` for the given fontmap.</doc>
<doc-deprecated xml:space="preserve">Use pango_font_map_create_context() instead.</doc-deprecated>
<return-value>
<doc xml:space="preserve">the newly created context; free with g_object_unref().</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</return-value>
<parameters>
<instance-parameter name="fontmap" transfer-ownership="none">
<doc xml:space="preserve">a `PangoCairoFontMap`</doc>
<type name="FontMap" c:type="PangoCairoFontMap*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_font_type" c:identifier="pango_cairo_font_map_get_font_type" version="1.18">
<doc xml:space="preserve">Gets the type of Cairo font backend that @fontmap uses.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the `cairo_font_type_t` cairo font backend type</doc>
<type name="cairo.FontType" c:type="cairo_font_type_t"/>
</return-value>
<parameters>
<instance-parameter name="fontmap" transfer-ownership="none">
<doc xml:space="preserve">a `PangoCairoFontMap`</doc>
<type name="FontMap" c:type="PangoCairoFontMap*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_resolution" c:identifier="pango_cairo_font_map_get_resolution" version="1.10">
<doc xml:space="preserve">Gets the resolution for the fontmap.
See [[email protected]_resolution].</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the resolution in "dots per inch"</doc>
<type name="gdouble" c:type="double"/>
</return-value>
<parameters>
<instance-parameter name="fontmap" transfer-ownership="none">
<doc xml:space="preserve">a `PangoCairoFontMap`</doc>
<type name="FontMap" c:type="PangoCairoFontMap*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_default" c:identifier="pango_cairo_font_map_set_default" version="1.22">
<doc xml:space="preserve">Sets a default `PangoCairoFontMap` to use with Cairo.
This can be used to change the Cairo font backend that the
default fontmap uses for example. The old default font map
is unreffed and the new font map referenced.
Note that since Pango 1.32.6, the default fontmap is per-thread.
This function only changes the default fontmap for
the current thread. Default fontmaps of existing threads
are not changed. Default fontmaps of any new threads will
still be created using [[email protected]].
A value of %NULL for @fontmap will cause the current default
font map to be released and a new default font map to be created
on demand, using [[email protected]].</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="fontmap" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">The new default font map</doc>
<type name="FontMap" c:type="PangoCairoFontMap*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_resolution" c:identifier="pango_cairo_font_map_set_resolution" version="1.10">
<doc xml:space="preserve">Sets the resolution for the fontmap.
This is a scale factor between
points specified in a `PangoFontDescription` and Cairo units. The
default value is 96, meaning that a 10 point font will be 13
units high. (10 * 96. / 72. = 13.3).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="fontmap" transfer-ownership="none">
<doc xml:space="preserve">a `PangoCairoFontMap`</doc>
<type name="FontMap" c:type="PangoCairoFontMap*"/>
</instance-parameter>
<parameter name="dpi" transfer-ownership="none">
<doc xml:space="preserve">the resolution in "dots per inch". (Physical inches aren't actually
involved; the terminology is conventional.)</doc>
<type name="gdouble" c:type="double"/>
</parameter>
</parameters>
</method>
</interface>
<function-macro name="IS_FONT" c:identifier="PANGO_CAIRO_IS_FONT" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<function-macro name="IS_FONT_MAP" c:identifier="PANGO_CAIRO_IS_FONT_MAP" introspectable="0">
<parameters>
<parameter name="obj">
</parameter>
</parameters>
</function-macro>
<callback name="ShapeRendererFunc" c:type="PangoCairoShapeRendererFunc">
<doc xml:space="preserve">Function type for rendering attributes of type %PANGO_ATTR_SHAPE
with Pango's Cairo renderer.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context with current point set to where the shape should
be rendered</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="attr" transfer-ownership="none">
<doc xml:space="preserve">the %PANGO_ATTR_SHAPE to render</doc>
<type name="Pango.AttrShape" c:type="PangoAttrShape*"/>
</parameter>
<parameter name="do_path" transfer-ownership="none">
<doc xml:space="preserve">whether only the shape path should be appended to current
path of @cr and no filling/stroking done. This will be set
to %TRUE when called from pango_cairo_layout_path() and
pango_cairo_layout_line_path() rendering functions.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="data" transfer-ownership="none" nullable="1" allow-none="1" closure="3">
<doc xml:space="preserve">user data passed to pango_cairo_context_set_shape_renderer()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<function name="context_get_font_options" c:identifier="pango_cairo_context_get_font_options" version="1.10">
<doc xml:space="preserve">Retrieves any font rendering options previously set with
[[email protected]_set_font_options].
This function does not report options that are derived from
the target surface by [func@update_context].</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the font options previously set on the
context, or %NULL if no options have been set. This value is
owned by the context and must not be modified or freed.</doc>
<type name="cairo.FontOptions" c:type="const cairo_font_options_t*"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
</parameters>
</function>
<function name="context_get_resolution" c:identifier="pango_cairo_context_get_resolution" version="1.10">
<doc xml:space="preserve">Gets the resolution for the context.
See [[email protected]_set_resolution]</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the resolution in "dots per inch". A negative value will
be returned if no resolution has previously been set.</doc>
<type name="gdouble" c:type="double"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
</parameters>
</function>
<function name="context_get_shape_renderer" c:identifier="pango_cairo_context_get_shape_renderer" version="1.18" introspectable="0">
<doc xml:space="preserve">Sets callback function for context to use for rendering attributes
of type %PANGO_ATTR_SHAPE.
See `PangoCairoShapeRendererFunc` for details.
Retrieves callback function and associated user data for rendering
attributes of type %PANGO_ATTR_SHAPE as set by
[[email protected]_set_shape_renderer], if any.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the shape rendering callback
previously set on the context, or %NULL if no shape rendering callback
have been set.</doc>
<type name="ShapeRendererFunc" c:type="PangoCairoShapeRendererFunc"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
<parameter name="data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">Pointer to `gpointer` to return user data</doc>
<type name="gpointer" c:type="gpointer*"/>
</parameter>
</parameters>
</function>
<function name="context_set_font_options" c:identifier="pango_cairo_context_set_font_options" version="1.10">
<doc xml:space="preserve">Sets the font options used when rendering text with this context.
These options override any options that [func@update_context]
derives from the target surface.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
<parameter name="options" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">a `cairo_font_options_t`, or %NULL to unset
any previously set options. A copy is made.</doc>
<type name="cairo.FontOptions" c:type="const cairo_font_options_t*"/>
</parameter>
</parameters>
</function>
<function name="context_set_resolution" c:identifier="pango_cairo_context_set_resolution" version="1.10">
<doc xml:space="preserve">Sets the resolution for the context.
This is a scale factor between points specified in a `PangoFontDescription`
and Cairo units. The default value is 96, meaning that a 10 point font will
be 13 units high. (10 * 96. / 72. = 13.3).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
<parameter name="dpi" transfer-ownership="none">
<doc xml:space="preserve">the resolution in "dots per inch". (Physical inches aren't actually
involved; the terminology is conventional.) A 0 or negative value
means to use the resolution from the font map.</doc>
<type name="gdouble" c:type="double"/>
</parameter>
</parameters>
</function>
<function name="context_set_shape_renderer" c:identifier="pango_cairo_context_set_shape_renderer" version="1.18">
<doc xml:space="preserve">Sets callback function for context to use for rendering attributes
of type %PANGO_ATTR_SHAPE.
See `PangoCairoShapeRendererFunc` for details.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
<parameter name="func" transfer-ownership="none" nullable="1" allow-none="1" scope="notified" closure="2" destroy="3">
<doc xml:space="preserve">Callback function for rendering attributes of
type %PANGO_ATTR_SHAPE, or %NULL to disable shape rendering.</doc>
<type name="ShapeRendererFunc" c:type="PangoCairoShapeRendererFunc"/>
</parameter>
<parameter name="data" transfer-ownership="none" nullable="1" allow-none="1">
<doc xml:space="preserve">User data that will be passed to @func.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="dnotify" transfer-ownership="none" nullable="1" allow-none="1" scope="async">
<doc xml:space="preserve">Callback that will be called when the
context is freed to release @data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</function>
<function name="create_context" c:identifier="pango_cairo_create_context" version="1.22">
<doc xml:space="preserve">Creates a context object set up to match the current transformation
and target surface of the Cairo context.
This context can then be
used to create a layout using [[email protected]].
This function is a convenience function that creates a context using
the default font map, then updates it to @cr. If you just need to
create a layout for use with @cr and do not need to access `PangoContext`
directly, you can use [func@create_layout] instead.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly created `PangoContext`</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
</parameters>
</function>
<function name="create_layout" c:identifier="pango_cairo_create_layout" version="1.10">
<doc xml:space="preserve">Creates a layout object set up to match the current transformation
and target surface of the Cairo context.
This layout can then be used for text measurement with functions
like [[email protected]_size] or drawing with functions like
[func@show_layout]. If you change the transformation or target
surface for @cr, you need to call [func@update_layout].
This function is the most convenient way to use Cairo with Pango,
however it is slightly inefficient since it creates a separate
`PangoContext` object for each layout. This might matter in an
application that was laying out large amounts of text.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly created `PangoLayout`</doc>
<type name="Pango.Layout" c:type="PangoLayout*"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
</parameters>
</function>
<function name="error_underline_path" c:identifier="pango_cairo_error_underline_path" version="1.14">
<doc xml:space="preserve">Add a squiggly line to the current path in the specified cairo context that
approximately covers the given rectangle in the style of an underline used
to indicate a spelling error.
The width of the underline is rounded to an integer number of up/down
segments and the resulting rectangle is centered in the original rectangle.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">The X coordinate of one corner of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">The Y coordinate of one corner of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Non-negative width of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Non-negative height of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
</parameters>
</function>
<function name="font_map_get_default" c:identifier="pango_cairo_font_map_get_default" moved-to="FontMap.get_default" version="1.10">
<doc xml:space="preserve">Gets a default `PangoCairoFontMap` to use with Cairo.
Note that the type of the returned object will depend on the
particular font backend Cairo was compiled to use; you generally
should only use the `PangoFontMap` and `PangoCairoFontMap`
interfaces on the returned object.
The default Cairo fontmap can be changed by using
[[email protected]_default]. This can be used to
change the Cairo font backend that the default fontmap uses
for example.
Note that since Pango 1.32.6, the default fontmap is per-thread.
Each thread gets its own default fontmap. In this way, PangoCairo
can be used safely from multiple threads.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the default PangoCairo fontmap
for the current thread. This object is owned by Pango and must
not be freed.</doc>
<type name="Pango.FontMap" c:type="PangoFontMap*"/>
</return-value>
</function>
<function name="font_map_new" c:identifier="pango_cairo_font_map_new" moved-to="FontMap.new" version="1.10">
<doc xml:space="preserve">Creates a new `PangoCairoFontMap` object.
A fontmap is used to cache information about available fonts,
and holds certain global parameters such as the resolution.
In most cases, you can use `[email protected]_map_get_default]
instead.
Note that the type of the returned object will depend
on the particular font backend Cairo was compiled to use;
You generally should only use the `PangoFontMap` and
`PangoCairoFontMap` interfaces on the returned object.
You can override the type of backend returned by using an
environment variable %PANGOCAIRO_BACKEND. Supported types,
based on your build, are fc (fontconfig), win32, and coretext.
If requested type is not available, NULL is returned. Ie.
this is only useful for testing, when at least two backends
are compiled in.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the newly allocated `PangoFontMap`,
which should be freed with g_object_unref().</doc>
<type name="Pango.FontMap" c:type="PangoFontMap*"/>
</return-value>
</function>
<function name="font_map_new_for_font_type" c:identifier="pango_cairo_font_map_new_for_font_type" moved-to="FontMap.new_for_font_type" version="1.18">
<doc xml:space="preserve">Creates a new `PangoCairoFontMap` object of the type suitable
to be used with cairo font backend of type @fonttype.
In most cases one should simply use [[email protected]], or
in fact in most of those cases, just use [[email protected]_default].</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the newly allocated
`PangoFontMap` of suitable type which should be freed with
g_object_unref(), or %NULL if the requested cairo font backend
is not supported / compiled in.</doc>
<type name="Pango.FontMap" c:type="PangoFontMap*"/>
</return-value>
<parameters>
<parameter name="fonttype" transfer-ownership="none">
<doc xml:space="preserve">desired #cairo_font_type_t</doc>
<type name="cairo.FontType" c:type="cairo_font_type_t"/>
</parameter>
</parameters>
</function>
<function name="glyph_string_path" c:identifier="pango_cairo_glyph_string_path" version="1.10">
<doc xml:space="preserve">Adds the glyphs in @glyphs to the current path in the specified
cairo context.
The origin of the glyphs (the left edge of the baseline)
will be at the current point of the cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="font" transfer-ownership="none">
<doc xml:space="preserve">a `PangoFont` from a `PangoCairoFontMap`</doc>
<type name="Pango.Font" c:type="PangoFont*"/>
</parameter>
<parameter name="glyphs" transfer-ownership="none">
<doc xml:space="preserve">a `PangoGlyphString`</doc>
<type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
</parameter>
</parameters>
</function>
<function name="layout_line_path" c:identifier="pango_cairo_layout_line_path" version="1.10">
<doc xml:space="preserve">Adds the text in `PangoLayoutLine` to the current path in the
specified cairo context.
The origin of the glyphs (the left edge of the line) will be
at the current point of the cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve">a `PangoLayoutLine`</doc>
<type name="Pango.LayoutLine" c:type="PangoLayoutLine*"/>
</parameter>
</parameters>
</function>
<function name="layout_path" c:identifier="pango_cairo_layout_path" version="1.10">
<doc xml:space="preserve">Adds the text in a `PangoLayout` to the current path in the
specified cairo context.
The top-left corner of the `PangoLayout` will be at the
current point of the cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="layout" transfer-ownership="none">
<doc xml:space="preserve">a Pango layout</doc>
<type name="Pango.Layout" c:type="PangoLayout*"/>
</parameter>
</parameters>
</function>
<function name="show_error_underline" c:identifier="pango_cairo_show_error_underline" version="1.14">
<doc xml:space="preserve">Draw a squiggly line in the specified cairo context that approximately
covers the given rectangle in the style of an underline used to indicate a
spelling error.
The width of the underline is rounded to an integer
number of up/down segments and the resulting rectangle is centered in the
original rectangle.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="x" transfer-ownership="none">
<doc xml:space="preserve">The X coordinate of one corner of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="y" transfer-ownership="none">
<doc xml:space="preserve">The Y coordinate of one corner of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve">Non-negative width of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve">Non-negative height of the rectangle</doc>
<type name="gdouble" c:type="double"/>
</parameter>
</parameters>
</function>
<function name="show_glyph_item" c:identifier="pango_cairo_show_glyph_item" version="1.22">
<doc xml:space="preserve">Draws the glyphs in @glyph_item in the specified cairo context,
embedding the text associated with the glyphs in the output if the
output format supports it (PDF for example), otherwise it acts
similar to [func@show_glyph_string].
The origin of the glyphs (the left edge of the baseline) will
be drawn at the current point of the cairo context.
Note that @text is the start of the text for layout, which is then
indexed by `glyph_item->item->offset`.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve">the UTF-8 text that @glyph_item refers to</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="glyph_item" transfer-ownership="none">
<doc xml:space="preserve">a `PangoGlyphItem`</doc>
<type name="Pango.GlyphItem" c:type="PangoGlyphItem*"/>
</parameter>
</parameters>
</function>
<function name="show_glyph_string" c:identifier="pango_cairo_show_glyph_string" version="1.10">
<doc xml:space="preserve">Draws the glyphs in @glyphs in the specified cairo context.
The origin of the glyphs (the left edge of the baseline) will
be drawn at the current point of the cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="font" transfer-ownership="none">
<doc xml:space="preserve">a `PangoFont` from a `PangoCairoFontMap`</doc>
<type name="Pango.Font" c:type="PangoFont*"/>
</parameter>
<parameter name="glyphs" transfer-ownership="none">
<doc xml:space="preserve">a `PangoGlyphString`</doc>
<type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
</parameter>
</parameters>
</function>
<function name="show_layout" c:identifier="pango_cairo_show_layout" version="1.10">
<doc xml:space="preserve">Draws a `PangoLayout` in the specified cairo context.
The top-left corner of the `PangoLayout` will be drawn
at the current point of the cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="layout" transfer-ownership="none">
<doc xml:space="preserve">a Pango layout</doc>
<type name="Pango.Layout" c:type="PangoLayout*"/>
</parameter>
</parameters>
</function>
<function name="show_layout_line" c:identifier="pango_cairo_show_layout_line" version="1.10">
<doc xml:space="preserve">Draws a `PangoLayoutLine` in the specified cairo context.
The origin of the glyphs (the left edge of the line) will
be drawn at the current point of the cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve">a `PangoLayoutLine`</doc>
<type name="Pango.LayoutLine" c:type="PangoLayoutLine*"/>
</parameter>
</parameters>
</function>
<function name="update_context" c:identifier="pango_cairo_update_context" version="1.10">
<doc xml:space="preserve">Updates a `PangoContext` previously created for use with Cairo to
match the current transformation and target surface of a Cairo
context.
If any layouts have been created for the context, it's necessary
to call [[email protected]_changed] on those layouts.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve">a `PangoContext`, from a pangocairo font map</doc>
<type name="Pango.Context" c:type="PangoContext*"/>
</parameter>
</parameters>
</function>
<function name="update_layout" c:identifier="pango_cairo_update_layout" version="1.10">
<doc xml:space="preserve">Updates the private `PangoContext` of a `PangoLayout` created with
[func@create_layout] to match the current transformation and target
surface of a Cairo context.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cr" transfer-ownership="none">
<doc xml:space="preserve">a Cairo context</doc>
<type name="cairo.Context" c:type="cairo_t*"/>
</parameter>
<parameter name="layout" transfer-ownership="none">
<doc xml:space="preserve">a `PangoLayout`, from [func@create_layout]</doc>
<type name="Pango.Layout" c:type="PangoLayout*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>