summaryrefslogtreecommitdiff
path: root/docs/tmpl/fonts.sgml
blob: 0d777992c5234809ac9b519b46af76bf5de50c59 (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
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
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
<!-- ##### SECTION Title ##### -->
Fonts

<!-- ##### SECTION Short_Description ##### -->
Structures representing abstract fonts

<!-- ##### SECTION Long_Description ##### -->
<para>
Pango supports a flexible architecture where a
particular rendering architecture can supply an
implementation of fonts. The #PangoFont structure
represents an abstract rendering-system-indepent font.
Pango provides routines to list available fonts, and
to load a font of a given description.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### STRUCT PangoFontDescription ##### -->
<para>
The #PangoFontDescription structure represents the description
of an ideal font. These structures are used both to list
what fonts are available on the system and also for specifying
the characteristics of a font to load.
</para>


<!-- ##### MACRO PANGO_TYPE_FONT_DESCRIPTION ##### -->
<para>
The #GObject type for #PangoFontDescription.
</para>



<!-- ##### ENUM PangoStyle ##### -->
<para>
</para>

@PANGO_STYLE_NORMAL: 
@PANGO_STYLE_OBLIQUE: 
@PANGO_STYLE_ITALIC: 

<!-- ##### MACRO PANGO_TYPE_STYLE ##### -->
<para>
The #GObject type for #PangoStyle.
</para>



<!-- ##### ENUM PangoWeight ##### -->
<para>
An enumeration specifying the weight (boldness) of a font. This is a numerical
value ranging from 100 to 900, but there are some predefined values:
</para>

@PANGO_WEIGHT_ULTRALIGHT: the ultralight weight (= 200)
@PANGO_WEIGHT_LIGHT:  the light weight (=300)
@PANGO_WEIGHT_NORMAL: the default weight (= 400)
@PANGO_WEIGHT_SEMIBOLD: a weight intermediate between normal and bold (=600)
@PANGO_WEIGHT_BOLD: the bold weight (= 700)
@PANGO_WEIGHT_ULTRABOLD: the ultrabold weight (= 800)
@PANGO_WEIGHT_HEAVY: the heavy weight (= 900)

<!-- ##### MACRO PANGO_TYPE_WEIGHT ##### -->
<para>
The #GObject type for #PangoWeight.
</para>



<!-- ##### ENUM PangoVariant ##### -->
<para>
An enumeration specifying capitalization variant of the font.
</para>

@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.

<!-- ##### MACRO PANGO_TYPE_VARIANT ##### -->
<para>
The #GObject type for #PangoVariant.
</para>



<!-- ##### ENUM PangoStretch ##### -->
<para>
An enumeration specifying the width of the font relative to other designs
within a family.
</para>

@PANGO_STRETCH_ULTRA_CONDENSED: 
@PANGO_STRETCH_EXTRA_CONDENSED: 
@PANGO_STRETCH_CONDENSED: 
@PANGO_STRETCH_SEMI_CONDENSED: 
@PANGO_STRETCH_NORMAL: the normal width
@PANGO_STRETCH_SEMI_EXPANDED: 
@PANGO_STRETCH_EXPANDED: 
@PANGO_STRETCH_EXTRA_EXPANDED: 
@PANGO_STRETCH_ULTRA_EXPANDED: 

<!-- ##### MACRO PANGO_TYPE_STRETCH ##### -->
<para>
The #GObject type for #PangoStretch.
</para>



<!-- ##### ENUM PangoFontMask ##### -->
<para>
The bits in a #PangoFontMask correspond to fields in a  
#PangoFontDescription that have been set.
</para>

@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.

<!-- ##### MACRO PANGO_TYPE_FONT_MASK ##### -->
<para>
The #GObject type for #PangoFontMask.
</para>



<!-- ##### FUNCTION pango_font_description_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION pango_font_description_copy ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_copy_static ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_hash ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_equal ##### -->
<para>

</para>

@desc1: 
@desc2: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_free ##### -->
<para>

</para>

@desc: 


<!-- ##### FUNCTION pango_font_descriptions_free ##### -->
<para>

</para>

@descs: 
@n_descs: 


<!-- ##### FUNCTION pango_font_description_set_family ##### -->
<para>

</para>

@desc: 
@family: 


<!-- ##### FUNCTION pango_font_description_set_family_static ##### -->
<para>

</para>

@desc: 
@family: 


<!-- ##### FUNCTION pango_font_description_get_family ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_set_style ##### -->
<para>

</para>

@desc: 
@style: 


<!-- ##### FUNCTION pango_font_description_get_style ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_set_variant ##### -->
<para>

</para>

@desc: 
@variant: 


<!-- ##### FUNCTION pango_font_description_get_variant ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_set_weight ##### -->
<para>

</para>

@desc: 
@weight: 


<!-- ##### FUNCTION pango_font_description_get_weight ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_set_stretch ##### -->
<para>

</para>

@desc: 
@stretch: 


<!-- ##### FUNCTION pango_font_description_get_stretch ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_set_size ##### -->
<para>

</para>

@desc: 
@size: 


<!-- ##### FUNCTION pango_font_description_get_size ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_set_absolute_size ##### -->
<para>

</para>

@desc: 
@size: 


<!-- ##### FUNCTION pango_font_description_get_size_is_absolute ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_get_set_fields ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_unset_fields ##### -->
<para>

</para>

@desc: 
@to_unset: 


<!-- ##### FUNCTION pango_font_description_merge ##### -->
<para>

</para>

@desc: 
@desc_to_merge: 
@replace_existing: 


<!-- ##### FUNCTION pango_font_description_merge_static ##### -->
<para>

</para>

@desc: 
@desc_to_merge: 
@replace_existing: 


<!-- ##### FUNCTION pango_font_description_better_match ##### -->
<para>

</para>

@desc: 
@old_match: 
@new_match: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_from_string ##### -->
<para>

</para>

@str: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_to_string ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_description_to_filename ##### -->
<para>

</para>

@desc: 
@Returns: 


<!-- ##### STRUCT PangoFontMetrics ##### -->
<para>
A #PangoFontMetrics structure holds the overall metric information
for a font (possibly restricted to a script). The fields of this
structure are private to implementations of a font backend. See
the documentation of the corresponding getters for documentation
of their meaning.
</para>

@ref_count: 
@ascent: 
@descent: 
@approximate_char_width: 
@approximate_digit_width: 
@underline_position: 
@underline_thickness: 
@strikethrough_position: 
@strikethrough_thickness: 

<!-- ##### MACRO PANGO_TYPE_FONT_METRICS ##### -->
<para>
The #GObject type for #PangoFontMetrics.
</para>



<!-- ##### FUNCTION pango_font_metrics_ref ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_unref ##### -->
<para>

</para>

@metrics: 


<!-- ##### FUNCTION pango_font_metrics_get_ascent ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_descent ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_approximate_char_width ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_approximate_digit_width ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_underline_thickness ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_underline_position ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_strikethrough_thickness ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### FUNCTION pango_font_metrics_get_strikethrough_position ##### -->
<para>

</para>

@metrics: 
@Returns: 


<!-- ##### STRUCT PangoFont ##### -->
<para>
The #PangoFont structure is used to represent
a font in a rendering-system-independent matter.
To create an implementation of a #PangoFont,
the rendering-system specific code should malloc
a larger structure that contains a nested
#PangoFont, fill in the klass member of
the nested #PangoFont with a pointer to
a appropriate #PangoFontClass, then call
pango_font_init() on the structure.
</para>
<para>
The #PangoFont structure contains one member
which the implementation fills in.
</para>


<!-- ##### MACRO PANGO_TYPE_FONT ##### -->
<para>
The #GObject type for #PangoFont.
</para>



<!-- ##### MACRO PANGO_FONT ##### -->
<para>
Casts a #GObject to a #PangoFont.
</para>

@object: a #GObject.


<!-- ##### MACRO PANGO_IS_FONT ##### -->
<para>
Returns %TRUE if @object is a #PangoFont.
</para>

@object: a #GObject.


<!-- ##### FUNCTION pango_font_find_shaper ##### -->
<para>

</para>

@font: 
@language: 
@ch: 
@Returns: 


<!-- ##### FUNCTION pango_font_describe ##### -->
<para>

</para>

@font: 
@Returns: 


<!-- ##### FUNCTION pango_font_get_coverage ##### -->
<para>

</para>

@font: 
@language: 
@Returns: 


<!-- ##### FUNCTION pango_font_get_glyph_extents ##### -->
<para>

</para>

@font: 
@glyph: 
@ink_rect: 
@logical_rect: 


<!-- ##### FUNCTION pango_font_get_metrics ##### -->
<para>

</para>

@font: 
@language: 
@Returns: 


<!-- ##### FUNCTION pango_font_get_font_map ##### -->
<para>

</para>

@font: 
@Returns: 


<!-- ##### STRUCT PangoFontFamily ##### -->
<para>
The #PangoFontFamily structure is used to represent a family of related 
font faces. The faces in a family share a common design, but differ in 
slant, weight, width and other aspects.
</para>


<!-- ##### MACRO PANGO_TYPE_FONT_FAMILY ##### -->
<para>
The #GObject type for #PangoFontFamily.
</para>



<!-- ##### MACRO PANGO_FONT_FAMILY ##### -->
<para>
Casts a #GObject to a #PangoFontFamily.
</para>

@object: a #GObject.


<!-- ##### MACRO PANGO_IS_FONT_FAMILY ##### -->
<para>
Returns %TRUE if @object is a #PangoFontFamily.
</para>

@object: a #GObject.


<!-- ##### FUNCTION pango_font_family_get_name ##### -->
<para>

</para>

@family: 
@Returns: 


<!-- ##### FUNCTION pango_font_family_is_monospace ##### -->
<para>

</para>

@family: 
@Returns: 


<!-- ##### FUNCTION pango_font_family_list_faces ##### -->
<para>

</para>

@family: 
@faces: 
@n_faces: 


<!-- ##### STRUCT PangoFontFace ##### -->
<para>
The #PangoFontFace structure is used to represent a group of fonts with 
the same family, slant, weight, width, but varying sizes.
</para>


<!-- ##### MACRO PANGO_TYPE_FONT_FACE ##### -->
<para>
The #GObject type for #PangoFontFace.
</para>



<!-- ##### MACRO PANGO_FONT_FACE ##### -->
<para>
Casts a #GObject to a #PangoFontFace.
</para>

@object: a #GObject.


<!-- ##### MACRO PANGO_IS_FONT_FACE ##### -->
<para>
Returns %TRUE if @object is a #PangoFontFace.
</para>

@object: a #GObject.


<!-- ##### FUNCTION pango_font_face_get_face_name ##### -->
<para>

</para>

@face: 
@Returns: 


<!-- ##### FUNCTION pango_font_face_list_sizes ##### -->
<para>

</para>

@face: 
@sizes: 
@n_sizes: 


<!-- ##### FUNCTION pango_font_face_describe ##### -->
<para>

</para>

@face: 
@Returns: 


<!-- ##### STRUCT PangoFontMap ##### -->
<para>
The #PangoFontMap represents the set of fonts available for a
particular rendering system. This is a virtual object with
implementations being specific to particular rendering systems.  To
create an implementation of a #PangoFontMap, the rendering-system
specific code should malloc a larger structure that contains a nested
#PangoFontMap, fill in the klass member of the nested #PangoFontMap with a
pointer to a appropriate #PangoFontMapClass, then call
pango_font_map_init() on the structure.
</para>
<para>
The #PangoFontMap structure contains one member which the implementation
fills in.
</para>


<!-- ##### MACRO PANGO_TYPE_FONT_MAP ##### -->
<para>
The #GObject type for #PangoFontMap.
</para>



<!-- ##### MACRO PANGO_FONT_MAP ##### -->
<para>
Casts a #GObject to a #PangoFontMap. 
</para>

@object: a #GObject.


<!-- ##### MACRO PANGO_IS_FONT_MAP ##### -->
<para>
Returns %TRUE if @object is a #PangoFontMap.
</para>

@object: a #GObject.


<!-- ##### STRUCT PangoFontMapClass ##### -->
<para>
The #PangoFontMapClass structure holds the virtual functions for
a particular #PangoFontMap implementation.
</para>

@parent_class: 
@load_font: a function to load a font with a given description. See
            pango_font_map_load_font()
@list_families: A function to list available font families. See
                pango_font_map_list_families().
@load_fontset: 
@shape_engine_type: 

<!-- ##### MACRO PANGO_FONT_MAP_CLASS ##### -->
<para>
Casts a #GObject to a #PangoFontMapClass.
</para>

@klass: a #GObject.


<!-- ##### MACRO PANGO_IS_FONT_MAP_CLASS ##### -->
<para>
Returns %TRUE if @klass is a subtype of #PangoFontMapClass.
</para>

@klass: a #GObject.


<!-- ##### MACRO PANGO_FONT_MAP_GET_CLASS ##### -->
<para>
Returns the type of a #PangoFontMap.
</para>

@obj: a #PangoFontMap.


<!-- ##### FUNCTION pango_font_map_load_font ##### -->
<para>

</para>

@fontmap: 
@context: 
@desc: 
@Returns: 


<!-- ##### FUNCTION pango_font_map_load_fontset ##### -->
<para>

</para>

@fontmap: 
@context: 
@desc: 
@language: 
@Returns: 


<!-- ##### FUNCTION pango_font_map_list_families ##### -->
<para>

</para>

@fontmap: 
@families: 
@n_families: 


<!-- ##### FUNCTION pango_font_map_get_shape_engine_type ##### -->
<para>

</para>

@fontmap: 
@Returns: 


<!-- ##### STRUCT PangoFontset ##### -->
<para>
A #PangoFontset represents a set of #PangoFont to use
when rendering text. It is the result of resolving a
#PangoFontDescription against a particular #PangoContext.
It has operations for finding the component font for
a particular Unicode character, and for finding a composite
set of metrics for the entire fontset.
</para>


<!-- ##### MACRO PANGO_TYPE_FONTSET ##### -->
<para>
The #GObject type for #PangoFontset.
</para>



<!-- ##### STRUCT PangoFontsetClass ##### -->
<para>
The #PangoFontsetClass structure holds the virtual functions for
a particular #PangoFontset implementation.
</para>

@parent_class: 
@get_font: a function to get the font in the fontset that contains the 
   best glyph for the given Unicode character; see pango_fontset_get_font().
@get_metrics: a function to get overall metric information for the fonts 
   in the fontset; see pango_fontset_get_metrics().
@get_language: a function to get the language of the fontset.
@foreach: 

<!-- ##### FUNCTION pango_fontset_get_font ##### -->
<para>

</para>

@fontset: 
@wc: 
@Returns: 


<!-- ##### FUNCTION pango_fontset_get_metrics ##### -->
<para>

</para>

@fontset: 
@Returns: 


<!-- ##### USER_FUNCTION PangoFontsetForeachFunc ##### -->
<para>

</para>

@fontset: 
@font: 
@data: 
@Returns: 


<!-- ##### FUNCTION pango_fontset_foreach ##### -->
<para>

</para>

@fontset: 
@func: 
@data: 


<!-- ##### STRUCT PangoFontsetSimple ##### -->
<para>
#PangoFontsetSimple is a implementation of the abstract
#PangoFontset base class in terms of an array of fonts,
which the creator provides when constructing the
#PangoFontsetSimple.
</para>


<!-- ##### MACRO PANGO_TYPE_FONTSET_SIMPLE ##### -->
<para>
The #GObject type for #PangoFontsetSimple.
</para>



<!-- ##### FUNCTION pango_fontset_simple_new ##### -->
<para>

</para>

@language: 
@Returns: 


<!-- ##### FUNCTION pango_fontset_simple_append ##### -->
<para>

</para>

@fontset: 
@font: 


<!-- ##### FUNCTION pango_fontset_simple_size ##### -->
<para>

</para>

@fontset: 
@Returns: