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
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
<!ENTITY tutorial SYSTEM "lang-tutorial.sgml">
<!ENTITY reference SYSTEM "lang-reference.sgml">
]>
<refentry id="GtkSourcePrintCompositor">
<refmeta>
<refentrytitle role="top_of_page" id="GtkSourcePrintCompositor.top_of_page">GtkSourcePrintCompositor</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTKSOURCEVIEW-2.0 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkSourcePrintCompositor</refname>
<refpurpose>Compose a <link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link> for printing.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GtkSourcePrintCompositor.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <gtksourceview/gtksourceprintcompositor.h>
<link linkend="GtkSourcePrintCompositor-struct">GtkSourcePrintCompositor</link>;
<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link>* <link linkend="gtk-source-print-compositor-new">gtk_source_print_compositor_new</link>
(<link linkend="GtkSourceBuffer">GtkSourceBuffer</link> *buffer);
<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link>* <link linkend="gtk-source-print-compositor-new-from-view">gtk_source_print_compositor_new_from_view</link>
(<link linkend="GtkSourceView">GtkSourceView</link> *view);
<link linkend="GtkSourceBuffer">GtkSourceBuffer</link>* <link linkend="gtk-source-print-compositor-get-buffer">gtk_source_print_compositor_get_buffer</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-tab-width">gtk_source_print_compositor_set_tab_width</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="guint">guint</link> width);
<link linkend="guint">guint</link> <link linkend="gtk-source-print-compositor-get-tab-width">gtk_source_print_compositor_get_tab_width</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-wrap-mode">gtk_source_print_compositor_set_wrap_mode</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkWrapMode">GtkWrapMode</link> wrap_mode);
<link linkend="GtkWrapMode">GtkWrapMode</link> <link linkend="gtk-source-print-compositor-get-wrap-mode">gtk_source_print_compositor_get_wrap_mode</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-highlight-syntax">gtk_source_print_compositor_set_highlight_syntax</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> highlight);
<link linkend="gboolean">gboolean</link> <link linkend="gtk-source-print-compositor-get-highlight-syntax">gtk_source_print_compositor_get_highlight_syntax</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-print-line-numbers">gtk_source_print_compositor_set_print_line_numbers</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="guint">guint</link> interval);
<link linkend="guint">guint</link> <link linkend="gtk-source-print-compositor-get-print-line-numbers">gtk_source_print_compositor_get_print_line_numbers</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-body-font-name">gtk_source_print_compositor_set_body_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);
<link linkend="gchar">gchar</link>* <link linkend="gtk-source-print-compositor-get-body-font-name">gtk_source_print_compositor_get_body_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-line-numbers-font-name">gtk_source_print_compositor_set_line_numbers_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);
<link linkend="gchar">gchar</link>* <link linkend="gtk-source-print-compositor-get-line-numbers-font-name">gtk_source_print_compositor_get_line_numbers_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-header-font-name">gtk_source_print_compositor_set_header_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);
<link linkend="gchar">gchar</link>* <link linkend="gtk-source-print-compositor-get-header-font-name">gtk_source_print_compositor_get_header_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-footer-font-name">gtk_source_print_compositor_set_footer_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);
<link linkend="gchar">gchar</link>* <link linkend="gtk-source-print-compositor-get-footer-font-name">gtk_source_print_compositor_get_footer_font_name</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="gdouble">gdouble</link> <link linkend="gtk-source-print-compositor-get-top-margin">gtk_source_print_compositor_get_top_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-top-margin">gtk_source_print_compositor_set_top_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="gdouble">gdouble</link> <link linkend="gtk-source-print-compositor-get-bottom-margin">gtk_source_print_compositor_get_bottom_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-bottom-margin">gtk_source_print_compositor_set_bottom_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="gdouble">gdouble</link> <link linkend="gtk-source-print-compositor-get-left-margin">gtk_source_print_compositor_get_left_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-left-margin">gtk_source_print_compositor_set_left_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="gdouble">gdouble</link> <link linkend="gtk-source-print-compositor-get-right-margin">gtk_source_print_compositor_get_right_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-right-margin">gtk_source_print_compositor_set_right_margin</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-print-header">gtk_source_print_compositor_set_print_header</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> print);
<link linkend="gboolean">gboolean</link> <link linkend="gtk-source-print-compositor-get-print-header">gtk_source_print_compositor_get_print_header</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-print-footer">gtk_source_print_compositor_set_print_footer</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> print);
<link linkend="gboolean">gboolean</link> <link linkend="gtk-source-print-compositor-get-print-footer">gtk_source_print_compositor_get_print_footer</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-header-format">gtk_source_print_compositor_set_header_format</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> separator,
const <link linkend="gchar">gchar</link> *left,
const <link linkend="gchar">gchar</link> *center,
const <link linkend="gchar">gchar</link> *right);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-set-footer-format">gtk_source_print_compositor_set_footer_format</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> separator,
const <link linkend="gchar">gchar</link> *left,
const <link linkend="gchar">gchar</link> *center,
const <link linkend="gchar">gchar</link> *right);
<link linkend="gint">gint</link> <link linkend="gtk-source-print-compositor-get-n-pages">gtk_source_print_compositor_get_n_pages</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="gboolean">gboolean</link> <link linkend="gtk-source-print-compositor-paginate">gtk_source_print_compositor_paginate</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkPrintContext">GtkPrintContext</link> *context);
<link linkend="gdouble">gdouble</link> <link linkend="gtk-source-print-compositor-get-pagination-progress">gtk_source_print_compositor_get_pagination_progress</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);
<link linkend="void">void</link> <link linkend="gtk-source-print-compositor-draw-page">gtk_source_print_compositor_draw_page</link>
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkPrintContext">GtkPrintContext</link> *context,
<link linkend="gint">gint</link> page_nr);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GtkSourcePrintCompositor.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GtkSourcePrintCompositor
</synopsis>
</refsect1>
<refsect1 id="GtkSourcePrintCompositor.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GtkSourcePrintCompositor--body-font-name">body-font-name</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="GtkSourcePrintCompositor--buffer">buffer</link>" <link linkend="GtkSourceBuffer">GtkSourceBuffer</link>* : Read / Write / Construct Only
"<link linkend="GtkSourcePrintCompositor--footer-font-name">footer-font-name</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="GtkSourcePrintCompositor--header-font-name">header-font-name</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="GtkSourcePrintCompositor--highlight-syntax">highlight-syntax</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="GtkSourcePrintCompositor--line-numbers-font-name">line-numbers-font-name</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="GtkSourcePrintCompositor--n-pages">n-pages</link>" <link linkend="gint">gint</link> : Read
"<link linkend="GtkSourcePrintCompositor--print-footer">print-footer</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="GtkSourcePrintCompositor--print-header">print-header</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="GtkSourcePrintCompositor--print-line-numbers">print-line-numbers</link>" <link linkend="guint">guint</link> : Read / Write
"<link linkend="GtkSourcePrintCompositor--tab-width">tab-width</link>" <link linkend="guint">guint</link> : Read / Write
"<link linkend="GtkSourcePrintCompositor--wrap-mode">wrap-mode</link>" <link linkend="GtkWrapMode">GtkWrapMode</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="GtkSourcePrintCompositor.description" role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link> object is used to compose a
<link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link> for printing. You can set various configuration options to
customize the printed output. <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link> is designed to be used with
the high-level printing API of gtk+, i.e. <link linkend="GtkPrintOperation"><type>GtkPrintOperation</type></link>.
</para>
<para>
The margins specified in this object are the layout margins: they define the blank space
bordering the printed area of the pages.
They must not be confused with the "print margins", i.e. the parts of the page
that the printer cannot print on, defined in the <link linkend="GtkPageSetup"><type>GtkPageSetup</type></link> objects.
If the specified layout margins are smaller than the "print margins", the latter ones are used
as a fallback by the <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link> object, so that the printed area is not clipped.
</para>
<!--
<para>
Print composition can be done synchronously and asynchronously. Asynchronous
methods are provided so you can give the user feedback about what's
going on when printing long documents (see the <link
linkend="GtkSourcePrintJob-begin-page">"begin_page"</link>
and <link
linkend="GtkSourcePrintJob-finished">"finished"</link>
signals).
</para>
<para>
The task of a <link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link> is to produce a <link linkend="GnomePrintJob"><type>GnomePrintJob</type></link>. What
this means is that once you get the resulting <link linkend="GnomePrintJob"><type>GnomePrintJob</type></link>, you
might reuse the <link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link> to produce another output (with
different configuration options for example) or just unreference it
and forget about it. The lifetime of the produced object is
independent of that of the producer.
</para>
<para>
Before printing you should <emphasis>at least</emphasis> set the
<link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link> you want to print (using
<link linkend="gtk-source-print-job-set-buffer"><function>gtk_source_print_job_set_buffer()</function></link>). Besides that, you might
configure word wrapping, font, whether to print hightlighted text as
seen in the <link linkend="GtkSourceView"><type>GtkSourceView</type></link>, line numbers, basic headers and footers.
</para>
<para>
<link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link> can print basic headers and footers in each page.
You can specify <link linkend="strftime"><function>strftime()</function></link> like strings for text on the left, right
and center of the top and bottom of the page. You can also make
<link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link> draw a separator line between the text document and
the header and footer. And you can specify a different font (from
that used for the text document).
</para>
<para>
Customization beyond that is possible, but you have to do the printing
manually. To do that, you need to connect to the <link
linkend="GtkSourcePrintJob-begin-page">"begin_page"</link>
signal of the job and allocate some space in the page using
<link linkend="gtk-source-print-job-set-text-margins"><function>gtk_source_print_job_set_text_margins()</function></link>. Whenever <link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link>
is about to print a new text page, the signal will be emitted. You
can then get the <link linkend="GnomePrintContext"><type>GnomePrintContext</type></link> being used with
<link linkend="gtk-source-print-job-get-print-context"><function>gtk_source_print_job_get_print_context()</function></link> and use Gnome Print functions
directly. The space you allocate is inside the document margins
defined in the specified <link linkend="GnomePrintConfig"><type>GnomePrintConfig</type></link>, but outside all print area
used by <link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link> itself.
</para>
<para>
A quick bootstrap code sequence to get you started using
<link linkend="GtkSourcePrintJob"><type>GtkSourcePrintJob</type></link> is given below:
</para>
<informalexample><programlisting>
static GnomePrintJob *
print_source_buffer_from_view (GtkSourceView *view, const gchar *title)
{
GtkSourcePrintJob *job;
GnomePrintJob *print_job;
/* create the job using default print configuration */
job = gtk_source_print_job_new (NULL);
/* quickly setup the buffer, font and wrapping */
gtk_source_print_job_setup_from_view (job, view);
/* print line numbers every 5 lines, using default font */
gtk_source_print_job_set_print_numbers (job, 5);
/* print a header with the title centered */
gtk_source_print_job_set_header_footer_font (job, "Sans Regular 12.0");
gtk_source_print_job_set_header_format (job,
NULL,
title,
NULL,
TRUE);
gtk_source_print_job_set_print_header (job, TRUE);
/* print the page number in the page bottom */
gtk_source_print_job_set_footer_format (job,
NULL,
NULL,
"Page %N of %Q",
TRUE);
gtk_source_print_job_set_print_footer (job, TRUE);
/* print the whole buffer and return the result */
print_job = gtk_source_print_job_print (job);
/* job is no longer needed */
g_object_unref (job);
return print_job;
}
</programlisting></informalexample>
-->
</refsect1>
<refsect1 id="GtkSourcePrintCompositor.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkSourcePrintCompositor-struct" role="struct">
<title>GtkSourcePrintCompositor</title>
<indexterm zone="GtkSourcePrintCompositor-struct"><primary>GtkSourcePrintCompositor</primary></indexterm><programlisting>typedef struct _GtkSourcePrintCompositor GtkSourcePrintCompositor;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-new" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_new ()</title>
<indexterm zone="gtk-source-print-compositor-new" role="2.2"><primary>gtk_source_print_compositor_new</primary></indexterm><programlisting><link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link>* gtk_source_print_compositor_new
(<link linkend="GtkSourceBuffer">GtkSourceBuffer</link> *buffer);</programlisting>
<para>
Creates a new print compositor that can be used to print <parameter>buffer</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> the <link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link> to print
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new print compositor object.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-new-from-view" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_new_from_view ()</title>
<indexterm zone="gtk-source-print-compositor-new-from-view" role="2.2"><primary>gtk_source_print_compositor_new_from_view</primary></indexterm><programlisting><link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link>* gtk_source_print_compositor_new_from_view
(<link linkend="GtkSourceView">GtkSourceView</link> *view);</programlisting>
<para>
Creates a new print compositor that can be used to print the buffer
associated with <parameter>view</parameter>.
This constructor sets some configuration properties to make the
printed output match <parameter>view</parameter> as much as possible. The properties set are
<link linkend="GtkSourcePrintCompositor--tab-width"><type>"tab-width"</type></link>, <link linkend="GtkSourcePrintCompositor--highlight-syntax"><type>"highlight-syntax"</type></link>,
<link linkend="GtkSourcePrintCompositor--wrap-mode"><type>"wrap-mode"</type></link>, <link linkend="GtkSourcePrintCompositor--body-font-name"><type>"body-font-name"</type></link> and
<link linkend="GtkSourcePrintCompositor--print-line-numbers"><type>"print-line-numbers"</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>view</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourceView"><type>GtkSourceView</type></link> to get configuration from.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-buffer" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_buffer ()</title>
<indexterm zone="gtk-source-print-compositor-get-buffer" role="2.2"><primary>gtk_source_print_compositor_get_buffer</primary></indexterm><programlisting><link linkend="GtkSourceBuffer">GtkSourceBuffer</link>* gtk_source_print_compositor_get_buffer
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Gets the <link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link> associated with the compositor. The returned
object reference is owned by the compositor object and
should not be unreferenced.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link> associated with the compositor.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-tab-width" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_tab_width ()</title>
<indexterm zone="gtk-source-print-compositor-set-tab-width" role="2.2"><primary>gtk_source_print_compositor_set_tab_width</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_tab_width
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="guint">guint</link> width);</programlisting>
<para>
Sets the width of tabulation in characters for printed text.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> width of tab in characters.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-tab-width" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_tab_width ()</title>
<indexterm zone="gtk-source-print-compositor-get-tab-width" role="2.2"><primary>gtk_source_print_compositor_get_tab_width</primary></indexterm><programlisting><link linkend="guint">guint</link> gtk_source_print_compositor_get_tab_width
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the width of tabulation in characters for printed text.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> width of tab.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-wrap-mode" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_wrap_mode ()</title>
<indexterm zone="gtk-source-print-compositor-set-wrap-mode" role="2.2"><primary>gtk_source_print_compositor_set_wrap_mode</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_wrap_mode
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkWrapMode">GtkWrapMode</link> wrap_mode);</programlisting>
<para>
Sets the line wrapping mode for the printed text.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>wrap_mode</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWrapMode"><type>GtkWrapMode</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-wrap-mode" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_wrap_mode ()</title>
<indexterm zone="gtk-source-print-compositor-get-wrap-mode" role="2.2"><primary>gtk_source_print_compositor_get_wrap_mode</primary></indexterm><programlisting><link linkend="GtkWrapMode">GtkWrapMode</link> gtk_source_print_compositor_get_wrap_mode
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Gets the line wrapping mode for the printed text.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the line wrap mode.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-highlight-syntax" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_highlight_syntax ()</title>
<indexterm zone="gtk-source-print-compositor-set-highlight-syntax" role="2.2"><primary>gtk_source_print_compositor_set_highlight_syntax</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_highlight_syntax
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> highlight);</programlisting>
<para>
Sets whether the printed text will be highlighted according to the
buffer rules. Both color and font style are applied.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>highlight</parameter> :</term>
<listitem><simpara> whether syntax should be highlighted.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-highlight-syntax" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_highlight_syntax ()</title>
<indexterm zone="gtk-source-print-compositor-get-highlight-syntax" role="2.2"><primary>gtk_source_print_compositor_get_highlight_syntax</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_source_print_compositor_get_highlight_syntax
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Determines whether the printed text will be highlighted according to the
buffer rules. Note that highlighting will happen
only if the buffer to print has highlighting activated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the printed output will be highlighted.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-print-line-numbers" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_print_line_numbers ()</title>
<indexterm zone="gtk-source-print-compositor-set-print-line-numbers" role="2.2"><primary>gtk_source_print_compositor_set_print_line_numbers</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_print_line_numbers
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="guint">guint</link> interval);</programlisting>
<para>
Sets the interval for printed line numbers. If <parameter>interval</parameter> is 0 no
numbers will be printed. If greater than 0, a number will be
printed every <parameter>interval</parameter> lines (i.e. 1 will print all line numbers).
</para>
<para>
Maximum accepted value for <parameter>interval</parameter> is 100.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>interval</parameter> :</term>
<listitem><simpara> interval for printed line numbers.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-print-line-numbers" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_print_line_numbers ()</title>
<indexterm zone="gtk-source-print-compositor-get-print-line-numbers" role="2.2"><primary>gtk_source_print_compositor_get_print_line_numbers</primary></indexterm><programlisting><link linkend="guint">guint</link> gtk_source_print_compositor_get_print_line_numbers
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the interval used for line number printing. If the
value is 0, no line numbers will be printed. The default value is
1 (i.e. numbers printed in all lines).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the interval of printed line numbers.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-body-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_body_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-set-body-font-name" role="2.2"><primary>gtk_source_print_compositor_set_body_font_name</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_body_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);</programlisting>
<para>
Sets the default font for the printed text.
</para>
<para>
<parameter>font_name</parameter> should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter> :</term>
<listitem><simpara> the name of the default font for the body text.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-body-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_body_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-get-body-font-name" role="2.2"><primary>gtk_source_print_compositor_get_body_font_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gtk_source_print_compositor_get_body_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the name of the font used to print the text body. The returned string
must be freed with <link linkend="g-free"><function>g_free()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string containing the name of the font used to print the
text body.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-line-numbers-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_line_numbers_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-set-line-numbers-font-name" role="2.2"><primary>gtk_source_print_compositor_set_line_numbers_font_name</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_line_numbers_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);</programlisting>
<para>
Sets the font for printing line numbers on the left margin. If
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is supplied, the default font (i.e. the one being used for the
text) will be used instead.
</para>
<para>
<parameter>font_name</parameter> should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter> :</term>
<listitem><simpara> the name of the font for line numbers, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-line-numbers-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_line_numbers_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-get-line-numbers-font-name" role="2.2"><primary>gtk_source_print_compositor_get_line_numbers_font_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gtk_source_print_compositor_get_line_numbers_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the name of the font used to print line numbers on the left margin.
The returned string must be freed with <link linkend="g-free"><function>g_free()</function></link>)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string containing the name of the font used to print
line numbers on the left margin.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-header-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_header_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-set-header-font-name" role="2.2"><primary>gtk_source_print_compositor_set_header_font_name</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_header_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);</programlisting>
<para>
Sets the font for printing the page header. If
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is supplied, the default font (i.e. the one being used for the
text) will be used instead.
</para>
<para>
<parameter>font_name</parameter> should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter> :</term>
<listitem><simpara> the name of the font for header text, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-header-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_header_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-get-header-font-name" role="2.2"><primary>gtk_source_print_compositor_get_header_font_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gtk_source_print_compositor_get_header_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the name of the font used to print the page header.
The returned string must be freed with <link linkend="g-free"><function>g_free()</function></link>)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string containing the name of the font used to print
the page header.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-footer-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_footer_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-set-footer-font-name" role="2.2"><primary>gtk_source_print_compositor_set_footer_font_name</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_footer_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
const <link linkend="gchar">gchar</link> *font_name);</programlisting>
<para>
Sets the font for printing the page footer. If
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is supplied, the default font (i.e. the one being used for the
text) will be used instead.
</para>
<para>
<parameter>font_name</parameter> should be a
string representation of a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter> :</term>
<listitem><simpara> the name of the font for the footer text, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-footer-font-name" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_footer_font_name ()</title>
<indexterm zone="gtk-source-print-compositor-get-footer-font-name" role="2.2"><primary>gtk_source_print_compositor_get_footer_font_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gtk_source_print_compositor_get_footer_font_name
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the name of the font used to print the page footer.
The returned string must be freed with <link linkend="g-free"><function>g_free()</function></link>)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string containing the name of the font used to print
the page footer.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-top-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_top_margin ()</title>
<indexterm zone="gtk-source-print-compositor-get-top-margin" role="2.2"><primary>gtk_source_print_compositor_get_top_margin</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gtk_source_print_compositor_get_top_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Gets the top margin in units of <parameter>unit</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the unit for the return value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the top margin.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-top-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_top_margin ()</title>
<indexterm zone="gtk-source-print-compositor-set-top-margin" role="2.2"><primary>gtk_source_print_compositor_set_top_margin</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_top_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Sets the top margin used by <parameter>compositor</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>margin</parameter> :</term>
<listitem><simpara> the new top margin in units of <parameter>unit</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the units for <parameter>margin</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-bottom-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_bottom_margin ()</title>
<indexterm zone="gtk-source-print-compositor-get-bottom-margin" role="2.2"><primary>gtk_source_print_compositor_get_bottom_margin</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gtk_source_print_compositor_get_bottom_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Gets the bottom margin in units of <parameter>unit</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the unit for the return value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the bottom margin.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-bottom-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_bottom_margin ()</title>
<indexterm zone="gtk-source-print-compositor-set-bottom-margin" role="2.2"><primary>gtk_source_print_compositor_set_bottom_margin</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_bottom_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Sets the bottom margin used by <parameter>compositor</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>margin</parameter> :</term>
<listitem><simpara> the new bottom margin in units of <parameter>unit</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the units for <parameter>margin</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-left-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_left_margin ()</title>
<indexterm zone="gtk-source-print-compositor-get-left-margin" role="2.2"><primary>gtk_source_print_compositor_get_left_margin</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gtk_source_print_compositor_get_left_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Gets the left margin in units of <parameter>unit</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the unit for the return value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the left margin
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-left-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_left_margin ()</title>
<indexterm zone="gtk-source-print-compositor-set-left-margin" role="2.2"><primary>gtk_source_print_compositor_set_left_margin</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_left_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Sets the left margin used by <parameter>compositor</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>margin</parameter> :</term>
<listitem><simpara> the new left margin in units of <parameter>unit</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the units for <parameter>margin</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-right-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_right_margin ()</title>
<indexterm zone="gtk-source-print-compositor-get-right-margin" role="2.2"><primary>gtk_source_print_compositor_get_right_margin</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gtk_source_print_compositor_get_right_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Gets the right margin in units of <parameter>unit</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the unit for the return value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the right margin
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-right-margin" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_right_margin ()</title>
<indexterm zone="gtk-source-print-compositor-set-right-margin" role="2.2"><primary>gtk_source_print_compositor_set_right_margin</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_right_margin
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gdouble">gdouble</link> margin,
<link linkend="GtkUnit">GtkUnit</link> unit);</programlisting>
<para>
Sets the right margin used by <parameter>compositor</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>margin</parameter> :</term>
<listitem><simpara> the new right margin in units of <parameter>unit</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unit</parameter> :</term>
<listitem><simpara> the units for <parameter>margin</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-print-header" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_print_header ()</title>
<indexterm zone="gtk-source-print-compositor-set-print-header" role="2.2"><primary>gtk_source_print_compositor_set_print_header</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_print_header
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> print);</programlisting>
<para>
Sets whether you want to print a header in each page. The
header consists of three pieces of text and an optional line
separator, configurable with
<link linkend="gtk-source-print-compositor-set-header-format"><function>gtk_source_print_compositor_set_header_format()</function></link>.
</para>
<para>
Note that by default the header format is unspecified, and if it's
empty it will not be printed, regardless of this setting.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>print</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want the header to be printed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-print-header" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_print_header ()</title>
<indexterm zone="gtk-source-print-compositor-get-print-header" role="2.2"><primary>gtk_source_print_compositor_get_print_header</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_source_print_compositor_get_print_header
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Determines if a header is set to be printed for each page. A
header will be printed if this function returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
<emphasis>and</emphasis> some format strings have been specified
with <link linkend="gtk-source-print-compositor-set-header-format"><function>gtk_source_print_compositor_set_header_format()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the header is set to be printed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-print-footer" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_print_footer ()</title>
<indexterm zone="gtk-source-print-compositor-set-print-footer" role="2.2"><primary>gtk_source_print_compositor_set_print_footer</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_print_footer
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> print);</programlisting>
<para>
Sets whether you want to print a footer in each page. The
footer consists of three pieces of text and an optional line
separator, configurable with
<link linkend="gtk-source-print-compositor-set-footer-format"><function>gtk_source_print_compositor_set_footer_format()</function></link>.
</para>
<para>
Note that by default the footer format is unspecified, and if it's
empty it will not be printed, regardless of this setting.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>print</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want the footer to be printed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-print-footer" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_print_footer ()</title>
<indexterm zone="gtk-source-print-compositor-get-print-footer" role="2.2"><primary>gtk_source_print_compositor_get_print_footer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_source_print_compositor_get_print_footer
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Determines if a footer is set to be printed for each page. A
footer will be printed if this function returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
<emphasis>and</emphasis> some format strings have been specified
with <link linkend="gtk-source-print-compositor-set-footer-format"><function>gtk_source_print_compositor_set_footer_format()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the footer is set to be printed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-header-format" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_header_format ()</title>
<indexterm zone="gtk-source-print-compositor-set-header-format" role="2.2"><primary>gtk_source_print_compositor_set_header_format</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_header_format
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> separator,
const <link linkend="gchar">gchar</link> *left,
const <link linkend="gchar">gchar</link> *center,
const <link linkend="gchar">gchar</link> *right);</programlisting>
<para>
Sets strftime like header format strings, to be printed on the
left, center and right of the top of each page. The strings may
include strftime(3) codes which will be expanded at print time.
All <link linkend="strftime"><function>strftime()</function></link> codes are accepted, with the addition of <link linkend="N:CAPS"><literal>N</literal></link> for the
page number and <link linkend="Q:CAPS"><literal>Q</literal></link> for the page count.
</para>
<para>
<parameter>separator</parameter> specifies if a solid line should be drawn to separate
the header from the document text.
</para>
<para>
If <link linkend="NULL:CAPS"><literal>NULL</literal></link> is given for any of the three arguments, that particular
string will not be printed.
</para>
<para>
For the header to be printed, in
addition to specifying format strings, you need to enable header
printing with <link linkend="gtk-source-print-compositor-set-print-header"><function>gtk_source_print_compositor_set_print_header()</function></link>.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>separator</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want a separator line to be printed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter> :</term>
<listitem><simpara> a format string to print on the left of the header.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>center</parameter> :</term>
<listitem><simpara> a format string to print on the center of the header.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter> :</term>
<listitem><simpara> a format string to print on the right of the header.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-set-footer-format" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_set_footer_format ()</title>
<indexterm zone="gtk-source-print-compositor-set-footer-format" role="2.2"><primary>gtk_source_print_compositor_set_footer_format</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_set_footer_format
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="gboolean">gboolean</link> separator,
const <link linkend="gchar">gchar</link> *left,
const <link linkend="gchar">gchar</link> *center,
const <link linkend="gchar">gchar</link> *right);</programlisting>
<para>
Sets strftime like header format strings, to be printed on the
left, center and right of the bottom of each page. The strings may
include strftime(3) codes which will be expanded at print time.
All <link linkend="strftime"><function>strftime()</function></link> codes are accepted, with the addition of <link linkend="N:CAPS"><literal>N</literal></link> for the
page number and <link linkend="Q:CAPS"><literal>Q</literal></link> for the page count.
</para>
<para>
<parameter>separator</parameter> specifies if a solid line should be drawn to separate
the footer from the document text.
</para>
<para>
If <link linkend="NULL:CAPS"><literal>NULL</literal></link> is given for any of the three arguments, that particular
string will not be printed.
</para>
<para>
For the footer to be printed, in
addition to specifying format strings, you need to enable footer
printing with <link linkend="gtk-source-print-compositor-set-print-footer"><function>gtk_source_print_compositor_set_print_footer()</function></link>.
</para>
<para>
This function cannot be called anymore after the first call to the
<link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>separator</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if you want a separator line to be printed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter> :</term>
<listitem><simpara> a format string to print on the left of the footer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>center</parameter> :</term>
<listitem><simpara> a format string to print on the center of the footer.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter> :</term>
<listitem><simpara> a format string to print on the right of the footer.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-n-pages" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_n_pages ()</title>
<indexterm zone="gtk-source-print-compositor-get-n-pages" role="2.2"><primary>gtk_source_print_compositor_get_n_pages</primary></indexterm><programlisting><link linkend="gint">gint</link> gtk_source_print_compositor_get_n_pages
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the number of pages in the document or <code>-1</code> if the
document has not been completely paginated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the number of pages in the document or <code>-1</code> if the
document has not been completely paginated.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-paginate" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_paginate ()</title>
<indexterm zone="gtk-source-print-compositor-paginate" role="2.2"><primary>gtk_source_print_compositor_paginate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_source_print_compositor_paginate
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkPrintContext">GtkPrintContext</link> *context);</programlisting>
<para>
Paginate the document associated with the <parameter>compositor</parameter>.
</para>
<para>
In order to support non-blocking pagination, document is paginated in small chunks.
Each time <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> is invoked, a chunk of the document
is paginated. To paginate the entire document, <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link>
must be invoked multiple times.
It returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the document has been completely paginated, otherwise it returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.
</para>
<para>
This method has been designed to be invoked in the handler of the <link linkend="GtkPrintOperation-paginate"><type>"paginate"</type></link> signal,
as shown in the following example:
</para>
<para>
<informalexample><programlisting>
// Signal handler for the GtkPrintOperation::paginate signal
static gboolean
paginate (GtkPrintOperation *operation,
GtkPrintContext *context,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
if (gtk_source_print_compositor_paginate (compositor, context))
{
gint n_pages;
n_pages = gtk_source_print_compositor_get_n_pages (compositor);
gtk_print_operation_set_n_pages (operation, n_pages);
return TRUE;
}
return FALSE;
}
</programlisting></informalexample>
</para>
<para>
If you don't need to do pagination in chunks, you can simply do it all in the
<link linkend="GtkPrintOperation-begin-print"><type>"begin-print"</type></link> handler, and set the number of pages from there, like
in the following example:
</para>
<para>
<informalexample><programlisting>
// Signal handler for the GtkPrintOperation::begin-print signal
static void
begin_print (GtkPrintOperation *operation,
GtkPrintContext *context,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
gint n_pages;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
while (!gtk_source_print_compositor_paginate (compositor, context));
n_pages = gtk_source_print_compositor_get_n_pages (compositor);
gtk_print_operation_set_n_pages (operation, n_pages);
}
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> the <link linkend="GtkPrintContext"><type>GtkPrintContext</type></link> whose parameters (e.g. paper size, print margins, etc.)
are used by the the <parameter>compositor</parameter> to paginate the document.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the document has been completely paginated, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-get-pagination-progress" role="function" condition="since:2.2">
<title>gtk_source_print_compositor_get_pagination_progress ()</title>
<indexterm zone="gtk-source-print-compositor-get-pagination-progress" role="2.2"><primary>gtk_source_print_compositor_get_pagination_progress</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gtk_source_print_compositor_get_pagination_progress
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor);</programlisting>
<para>
Returns the current fraction of the document pagination that has been completed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a fraction from 0.0 to 1.0 inclusive
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.2
</para></refsect2>
<refsect2 id="gtk-source-print-compositor-draw-page" role="function">
<title>gtk_source_print_compositor_draw_page ()</title>
<indexterm zone="gtk-source-print-compositor-draw-page"><primary>gtk_source_print_compositor_draw_page</primary></indexterm><programlisting><link linkend="void">void</link> gtk_source_print_compositor_draw_page
(<link linkend="GtkSourcePrintCompositor">GtkSourcePrintCompositor</link> *compositor,
<link linkend="GtkPrintContext">GtkPrintContext</link> *context,
<link linkend="gint">gint</link> page_nr);</programlisting>
<para>
Draw page <parameter>page_nr</parameter> for printing on the the Cairo context encapsuled in <parameter>context</parameter>.
</para>
<para>
This method has been designed to be called in the handler of the <link linkend="GtkPrintOperation-draw-page"><type>"draw_page"</type></link> signal
as shown in the following example:
</para>
<para>
<informalexample><programlisting>
// Signal handler for the GtkPrintOperation::draw_page signal
static void
draw_page (GtkPrintOperation *operation,
GtkPrintContext *context,
gint page_nr,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
gtk_source_print_compositor_draw_page (compositor,
context,
page_nr);
}
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>compositor</parameter> :</term>
<listitem><simpara> a <link linkend="GtkSourcePrintCompositor"><type>GtkSourcePrintCompositor</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> the <link linkend="GtkPrintContext"><type>GtkPrintContext</type></link> encapsulating the context information that is required when
drawing the page for printing.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>page_nr</parameter> :</term>
<listitem><simpara> the number of the page to print.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GtkSourcePrintCompositor.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkSourcePrintCompositor--body-font-name"><title>The <literal>"body-font-name"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--body-font-name" role="2.2"><primary>GtkSourcePrintCompositor:body-font-name</primary></indexterm><programlisting> "body-font-name" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>
Name of the font used for the text body.
</para>
<para>
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--buffer"><title>The <literal>"buffer"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--buffer" role="2.2"><primary>GtkSourcePrintCompositor:buffer</primary></indexterm><programlisting> "buffer" <link linkend="GtkSourceBuffer">GtkSourceBuffer</link>* : Read / Write / Construct Only</programlisting>
<para>
The GtkSourceBuffer object to print.</para>
<para>
</para><para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--footer-font-name"><title>The <literal>"footer-font-name"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--footer-font-name" role="2.2"><primary>GtkSourcePrintCompositor:footer-font-name</primary></indexterm><programlisting> "footer-font-name" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>
Name of the font used to print page footer.
If this property is unspecified, the text body font is used.
</para>
<para>
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--header-font-name"><title>The <literal>"header-font-name"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--header-font-name" role="2.2"><primary>GtkSourcePrintCompositor:header-font-name</primary></indexterm><programlisting> "header-font-name" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>
Name of the font used to print page header.
If this property is unspecified, the text body font is used.
</para>
<para>
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--highlight-syntax"><title>The <literal>"highlight-syntax"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--highlight-syntax" role="2.2"><primary>GtkSourcePrintCompositor:highlight-syntax</primary></indexterm><programlisting> "highlight-syntax" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether to print the document with highlighted syntax.
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: TRUE</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--line-numbers-font-name"><title>The <literal>"line-numbers-font-name"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--line-numbers-font-name" role="2.2"><primary>GtkSourcePrintCompositor:line-numbers-font-name</primary></indexterm><programlisting> "line-numbers-font-name" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>
Name of the font used to print line numbers on the left margin.
If this property is unspecified, the text body font is used.
</para>
<para>
Accepted values are strings representing a font description Pango can understand.
(e.g. "Monospace 10"). See <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>
for a description of the format of the string representation.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--n-pages"><title>The <literal>"n-pages"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--n-pages" role="2.2"><primary>GtkSourcePrintCompositor:n-pages</primary></indexterm><programlisting> "n-pages" <link linkend="gint">gint</link> : Read</programlisting>
<para>
The number of pages in the document or <code>-1</code> if the
document has not been completely paginated.</para>
<para>
</para><para>Allowed values: >= -1</para>
<para>Default value: -1</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--print-footer"><title>The <literal>"print-footer"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--print-footer" role="2.2"><primary>GtkSourcePrintCompositor:print-footer</primary></indexterm><programlisting> "print-footer" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether to print a footer in each page.
</para>
<para>
Note that by default the footer format is unspecified, and if it is
unspecified the footer will not be printed, regardless of the value of
this property.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--print-header"><title>The <literal>"print-header"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--print-header" role="2.2"><primary>GtkSourcePrintCompositor:print-header</primary></indexterm><programlisting> "print-header" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether to print a header in each page.
</para>
<para>
Note that by default the header format is unspecified, and if it is
unspecified the header will not be printed, regardless of the value of
this property.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--print-line-numbers"><title>The <literal>"print-line-numbers"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--print-line-numbers" role="2.2"><primary>GtkSourcePrintCompositor:print-line-numbers</primary></indexterm><programlisting> "print-line-numbers" <link linkend="guint">guint</link> : Read / Write</programlisting>
<para>
Interval of printed line numbers. If this property is set to 0 no
numbers will be printed. If greater than 0, a number will be
printed every "print-line-numbers" lines (i.e. 1 will print all line numbers).
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Allowed values: <= 100</para>
<para>Default value: 1</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--tab-width"><title>The <literal>"tab-width"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--tab-width" role="2.2"><primary>GtkSourcePrintCompositor:tab-width</primary></indexterm><programlisting> "tab-width" <link linkend="guint">guint</link> : Read / Write</programlisting>
<para>
Width of a tab character expressed in spaces.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Allowed values: [1,32]</para>
<para>Default value: 8</para>
<para>Since 2.2
</para>
</refsect2>
<refsect2 id="GtkSourcePrintCompositor--wrap-mode"><title>The <literal>"wrap-mode"</literal> property</title>
<indexterm zone="GtkSourcePrintCompositor--wrap-mode" role="2.2"><primary>GtkSourcePrintCompositor:wrap-mode</primary></indexterm><programlisting> "wrap-mode" <link linkend="GtkWrapMode">GtkWrapMode</link> : Read / Write</programlisting>
<para>
Whether to wrap lines never, at word boundaries, or at character boundaries.
</para>
<para>
The value of this property cannot be changed anymore after the first
call to the <link linkend="gtk-source-print-compositor-paginate"><function>gtk_source_print_compositor_paginate()</function></link> function.</para>
<para>
</para><para>Default value: GTK_WRAP_NONE</para>
<para>Since 2.2
</para>
</refsect2>
</refsect1>
<refsect1 id="GtkSourcePrintCompositor.see-also">
<title>See Also</title>
<para>
The reference documentation for <link linkend="GtkSourceBuffer"><type>GtkSourceBuffer</type></link>. You might also want
to check the Printing section of the gtk+ reference
documentation.
</para>
</refsect1>
</refentry>
|
