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
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Main Page - Header</title>
<link href="inti.css" rel="stylesheet" type="text/css">
<meta name="description" content="Reference Manual">
<meta name="author" content="The Inti Development Team">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(231, 232, 231);"
link="#000099" vlink="#990099" alink="#000099">
<table cellpadding="0" cellspacing="0" border="0" style="width: 100%;">
<tbody>
<tr
style="color: rgb(255, 255, 204); font-family: helvetica,arial,sans-serif; font-weight: bold;">
<td
style="vertical-align: top; background-color: rgb(0, 55, 85); text-align: center;">
<font size="+1">Reference Manual</font> </td>
</tr>
<tr>
<td valign="top" height="116" background="../images/top-fade.png"
align="center"><img src="../images/inti-logo.png" alt="Inti Logo"> <br>
</td>
</tr>
</tbody>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.3.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>Inti::Gtk::SourcePrintJob Class Reference</h1>A GtkSourcePrintJob C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sourceprintjob_8h-source.html">inti/gtk-sourceview/sourceprintjob.h</a>></code>
<p>
<a href="classInti_1_1Gtk_1_1SourcePrintJob-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z27_0">SourcePrintJob</a> (<a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> *buffer=0)
<dl class="el"><dd class="mdescRight">Constructs a new source print job. </em> <a href="#z27_0"></a><em><br><br></dl><li><a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z27_1">SourcePrintJob</a> (GnomePrintConfig &config, <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> *buffer=0)
<dl class="el"><dd class="mdescRight">Constructs a new source print job with the specified configuration. </em> <a href="#z27_1"></a><em><br><br></dl><li><a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z27_2">SourcePrintJob</a> (<a class="el" href="classInti_1_1Gtk_1_1SourceView.html">SourceView</a> &view)
<dl class="el"><dd class="mdescRight">Convenience constructor that sets several configuration options at once, so that the printed output matches the view. </em> <a href="#z27_2"></a><em><br><br></dl><li><a name="z27_3" doxytag="Inti::Gtk::SourcePrintJob::~SourcePrintJob"></a>
virtual <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z27_3">~SourcePrintJob</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a name="z28_0" doxytag="Inti::Gtk::SourcePrintJob::gtk_source_print_job"></a>
GtkSourcePrintJob * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_0">gtk_source_print_job</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkSourcePrintJob structure. <br><br></dl><li><a name="z28_1" doxytag="Inti::Gtk::SourcePrintJob::gtk_source_print_job_class"></a>
GtkSourcePrintJobClass * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_1">gtk_source_print_job_class</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkSourcePrintJobClass structure. <br><br></dl><li><a name="z28_2" doxytag="Inti::Gtk::SourcePrintJob::operator GtkSourcePrintJob *"></a>
<a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_2">operator GtkSourcePrintJob *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> to a GtkSourcePrintJob pointer. <br><br></dl><li><a name="z28_3" doxytag="Inti::Gtk::SourcePrintJob::is_gtk_source_print_job"></a>
bool <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_3">is_gtk_source_print_job</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the object instance is of type GTK_TYPE_SOURCE_PRINT_JOB. <br><br></dl><li>GnomePrintConfig * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_4">get_config</a> () const
<dl class="el"><dd class="mdescRight">Gets the current GnomePrintConfig the print job will use. </em> <a href="#z28_4"></a><em><br><br></dl><li><a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_5">get_buffer</a> () const
<dl class="el"><dd class="mdescRight">Gets the <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> the print job would print. </em> <a href="#z28_5"></a><em><br><br></dl><li>unsigned int <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_6">get_tabs_width</a> () const
<dl class="el"><dd class="mdescRight">Gets the configured tabs width in equivalent spaces (the default value is 8). </em> <a href="#z28_6"></a><em><br><br></dl><li>WrapMode <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_7">get_wrap_mode</a> () const
<dl class="el"><dd class="mdescRight">Gets the wrapping style for text lines wider than the printable width. </em> <a href="#z28_7"></a><em><br><br></dl><li>bool <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_8">get_highlight</a> () const
<dl class="el"><dd class="mdescRight">Gets whether the job is configured to print the text highlighted with colors and font styles. </em> <a href="#z28_8"></a><em><br><br></dl><li>String <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_9">get_font</a> () const
<dl class="el"><dd class="mdescRight">Gets the default font to be used for the printed text. </em> <a href="#z28_9"></a><em><br><br></dl><li>String <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_10">get_numbers_font</a> () const
<dl class="el"><dd class="mdescRight">Gets the font to be used for the line numbers. </em> <a href="#z28_10"></a><em><br><br></dl><li>unsigned int <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_11">get_print_numbers</a> () const
<dl class="el"><dd class="mdescRight">Obtains the interval used for line number printing. </em> <a href="#z28_11"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_12">get_text_margins</a> (double *top, double *bottom, double *left, double *right) const
<dl class="el"><dd class="mdescRight">Gets the user set margins for the print job. </em> <a href="#z28_12"></a><em><br><br></dl><li>GnomePrintJob * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_13">get_print_job</a> () const
<dl class="el"><dd class="mdescRight">Gets a reference to the GnomePrintJob which the job is printing or has recently finished printing. </em> <a href="#z28_13"></a><em><br><br></dl><li>unsigned int <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_14">get_page</a> () const
<dl class="el"><dd class="mdescRight">Gets the currently printing page number. </em> <a href="#z28_14"></a><em><br><br></dl><li>unsigned int <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_15">get_page_count</a> () const
<dl class="el"><dd class="mdescRight">Obtains the total number of pages the job will print. </em> <a href="#z28_15"></a><em><br><br></dl><li>GnomePrintContext * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_16">get_print_context</a> () const
<dl class="el"><dd class="mdescRight">Gets the GnomePrintContext of the current job. </em> <a href="#z28_16"></a><em><br><br></dl><li>bool <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_17">get_print_header</a> () const
<dl class="el"><dd class="mdescRight">Determines if a header is set to be printed for each page. </em> <a href="#z28_17"></a><em><br><br></dl><li>bool <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_18">get_print_footer</a> () const
<dl class="el"><dd class="mdescRight">Determines if a footer is set to be printed for each page. </em> <a href="#z28_18"></a><em><br><br></dl><li>String <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_19">get_header_footer_font</a> () const
<dl class="el"><dd class="mdescRight">Gets the font to be used for the header and footer. </em> <a href="#z28_19"></a><em><br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_0">set_config</a> (GnomePrintConfig &config)
<dl class="el"><dd class="mdescRight">Sets the print configuration for the job. </em> <a href="#z29_0"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_1">set_buffer</a> (<a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> &buffer)
<dl class="el"><dd class="mdescRight">Sets the <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> the print job will print. </em> <a href="#z29_1"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_2">set_tabs_width</a> (unsigned int tabs_width)
<dl class="el"><dd class="mdescRight">Sets the tabs width (in equivalent spaces) for the printed text. </em> <a href="#z29_2"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_3">set_wrap_mode</a> (WrapMode wrap)
<dl class="el"><dd class="mdescRight">Sets the wrap mode for lines of text larger than the printable width. </em> <a href="#z29_3"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_4">set_highlight</a> (bool highlight)
<dl class="el"><dd class="mdescRight">Sets whether the printed text will be highlighted according to the buffer rules. </em> <a href="#z29_4"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_5">set_font</a> (const String &font_name)
<dl class="el"><dd class="mdescRight">Sets the default font for the printed text. </em> <a href="#z29_5"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_6">set_numbers_font</a> (const String &font_name)
<dl class="el"><dd class="mdescRight">Sets the font for printing line numbers on the left margin. </em> <a href="#z29_6"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_7">set_print_numbers</a> (unsigned int interval)
<dl class="el"><dd class="mdescRight">Sets the interval for printed line numbers. </em> <a href="#z29_7"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_8">set_text_margins</a> (double top, double bottom, double left, double right)
<dl class="el"><dd class="mdescRight">Sets the four user margins for the print job. </em> <a href="#z29_8"></a><em><br><br></dl><li>GnomePrintJob * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_9">print</a> ()
<dl class="el"><dd class="mdescRight">Produces a GnomePrintJob with the printed document. </em> <a href="#z29_9"></a><em><br><br></dl><li>GnomePrintJob * <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_10">print</a> (const TextIter &start, const TextIter &end)
<dl class="el"><dd class="mdescRight">Produces a GnomePrintJob with the source buffer range from <em>start</em> to <em>end</em>. </em> <a href="#z29_10"></a><em><br><br></dl><li>bool <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_11">print_async</a> (const TextIter &start, const TextIter &end)
<dl class="el"><dd class="mdescRight">Starts to print the job asynchronously. </em> <a href="#z29_11"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_12">cancel</a> ()
<dl class="el"><dd class="mdescRight">Cancels an asynchronous printing operation. </em> <a href="#z29_12"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_13">set_print_header</a> (bool setting)
<dl class="el"><dd class="mdescRight">Sets whether you want to print a header in each page. </em> <a href="#z29_13"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_14">set_print_footer</a> (bool setting)
<dl class="el"><dd class="mdescRight">Sets whether you want to print a footer in each page. </em> <a href="#z29_14"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_15">set_header_footer_font</a> (const String &font_name)
<dl class="el"><dd class="mdescRight">Sets the font for printing headers and footers. </em> <a href="#z29_15"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_17">set_header_format</a> (const String &left, const String &center, const String &right, bool separator)
<dl class="el"><dd class="mdescRight">Sets strftime-like header format strings, to be printed on the left, center and right of the top of each page. </em> <a href="#z29_17"></a><em><br><br></dl><li>void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_19">set_footer_format</a> (const String &left, const String &center, const String &right, bool separator)
<dl class="el"><dd class="mdescRight">Sets strftime-like footer format strings, to be printed on the left, center and right of the bottom of each page (see <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_17">set_header_format()</a>). </em> <a href="#z29_19"></a><em><br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Property Proxies</div></td></tr>
<ul>
<li><a name="z30_0" doxytag="Inti::Gtk::SourcePrintJob::prop_config"></a>
const ConfigPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_0">prop_config</a> ()
<dl class="el"><dd class="mdescRight">The Configuration options for the print job (GnomePrintConfig* : Read / Write). <br><br></dl><li><a name="z30_1" doxytag="Inti::Gtk::SourcePrintJob::prop_buffer"></a>
const BufferPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_1">prop_buffer</a> ()
<dl class="el"><dd class="mdescRight">The <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">Gtk::SourceBuffer</a> object to print (<a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">Gtk::SourceBuffer</a>* : Read / Write). <br><br></dl><li><a name="z30_2" doxytag="Inti::Gtk::SourcePrintJob::prop_tabs_width"></a>
const TabsWidthPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_2">prop_tabs_width</a> ()
<dl class="el"><dd class="mdescRight">The width in equivalent space characters of tabs (unsigned int : Read / Write). <br><br></dl><li><a name="z30_3" doxytag="Inti::Gtk::SourcePrintJob::prop_wrap_mode"></a>
const WrapModePropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_3">prop_wrap_mode</a> ()
<dl class="el"><dd class="mdescRight">The word wrapping mode (WrapMode : Read / Write). <br><br></dl><li><a name="z30_4" doxytag="Inti::Gtk::SourcePrintJob::prop_highlight"></a>
const HighlightPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_4">prop_highlight</a> ()
<dl class="el"><dd class="mdescRight">Whether to print the document with highlighted syntax (bool : Read / Write). <br><br></dl><li><a name="z30_5" doxytag="Inti::Gtk::SourcePrintJob::prop_font"></a>
const FontPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_5">prop_font</a> ()
<dl class="el"><dd class="mdescRight">The Font name to use for the document text (String : Read / Write). <br><br></dl><li><a name="z30_6" doxytag="Inti::Gtk::SourcePrintJob::prop_numbers_font"></a>
const NumbersFontPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_6">prop_numbers_font</a> ()
<dl class="el"><dd class="mdescRight">The Font name to use for the line numbers (String : Read / Write). <br><br></dl><li><a name="z30_7" doxytag="Inti::Gtk::SourcePrintJob::prop_print_numbers"></a>
const PrintNumbersPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_7">prop_print_numbers</a> ()
<dl class="el"><dd class="mdescRight">The Interval of printed line numbers (0 means no numbers) (unsigned int : Read / Write). <br><br></dl><li><a name="z30_8" doxytag="Inti::Gtk::SourcePrintJob::prop_print_header"></a>
const PrintHeaderPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_8">prop_print_header</a> ()
<dl class="el"><dd class="mdescRight">Whether to print a header in each page (bool : Read / Write). <br><br></dl><li><a name="z30_9" doxytag="Inti::Gtk::SourcePrintJob::prop_print_footer"></a>
const PrintFooterPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_9">prop_print_footer</a> ()
<dl class="el"><dd class="mdescRight">Whether to print a footer in each page (bool : Read / Write). <br><br></dl><li><a name="z30_10" doxytag="Inti::Gtk::SourcePrintJob::prop_header_footer_font"></a>
const HeaderFooterFontPropertyProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z30_10">prop_header_footer_font</a> ()
<dl class="el"><dd class="mdescRight">The font name to use for the header and footer (String : Read / Write). <br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a name="z31_0" doxytag="Inti::Gtk::SourcePrintJob::sig_begin_page"></a>
const BeginPageSignalProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z31_0">sig_begin_page</a> ()
<dl class="el"><dd class="mdescRight">Connect to the begin_page_signal; emitted whenever the print job is about to print a new text page. <br><br></dl><li><a name="z31_1" doxytag="Inti::Gtk::SourcePrintJob::sig_finished"></a>
const FinishedSignalProxy <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z31_1">sig_finished</a> ()
<dl class="el"><dd class="mdescRight">Connect to the finished_signal; emitted whenever an asynchronous print job has finished. <br><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z25_0">SourcePrintJob</a> (GtkSourcePrintJob *job, bool reference=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> from an existing GtkSourcePrintJob. </em> <a href="#z25_0"></a><em><br><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Handlers</div></td></tr>
<ul>
<li>virtual void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z26_0">on_begin_page</a> ()
<dl class="el"><dd class="mdescRight">Called whenever the print job is about to print a new text page. </em> <a href="#z26_0"></a><em><br><br></dl><li>virtual void <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z26_1">on_finished</a> ()
<dl class="el"><dd class="mdescRight">Called whenever an asynchronous print job has finished. </em> <a href="#z26_1"></a><em><br><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkSourcePrintJob C++ wrapper class.
<p>
The <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> object is used to print the contents of a <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a>. You can set various configuration options to customize the printed output, and the result is obtained as a GnomePrintJob object, which you can then preview with gnome_print_job_preview_new() or print directly with gnome_print_job_print().<p>
The easiest way to construct a new print job is from a <a class="el" href="classInti_1_1Gtk_1_1SourceView.html">SourceView</a>. In this case the print job's buffer, tabs width, highlight, wrap mode, and font will be set to the values currently set in the source view. Other constructors take a <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a>, a GnomePrintConfig object or both. If a GnomePrintConfig is not specified the print job will use the default gnome print configuration. If no font is set the print job will use the default font: 'Monospace Regular 10'.<p>
Printing 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 "begin_page" and "finished" signals).<p>
The task of a <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> is to produce a GnomePrintJob. What this means is that once you get the resulting GnomePrintJob, you might reuse the <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> 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.<p>
Before printing you should at least set the <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> you want to print (using <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_1">set_buffer()</a>). Besides that, you might configure word wrapping, font, whether to print hightlighted text as seen in the <a class="el" href="classInti_1_1Gtk_1_1SourceView.html">SourceView</a>, line numbers, basic headers and footers.<p>
<a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> can print basic headers and footers in each page. You can specify strftime() like strings for text on the left, right and center of the top and bottom of the page. You can also make <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> 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).<p>
Customization beyond that is possible, but you have to do the printing manually. To do that, you need to connect to the "begin_page" signal of the job and allocate some space in the page using <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_8">set_text_margins()</a>. Whenever <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> is about to print a new text page, the signal will be emitted. You can then get the GnomePrintContext being used with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_16">get_print_context()</a> and use Gnome Print functions directly. The space you allocate is inside the document margins defined in the specified GnomePrintConfig, but outside all print area used by <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> itself.<p>
<b>Example:</b> A quick bootstrap code sequence to get you started using <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a>: <div class="fragment"><pre> GnomePrintJob *
print_source_buffer_from_view(Gtk::SourceView& view, <span class="keyword">const</span> String& title)
{
<span class="comment">// Create a job using the default print configuration and setup the buffer,</span>
<span class="comment">// font and wrapping with those values set in the source view.</span>
Pointer<Gtk::SourcePrintJob> job = <span class="keyword">new</span> Gtk::SourcePrintJob(*view);
<span class="comment">// Print line numbers every 5 lines, using the default font.</span>
job->set_print_numbers(5);
<span class="comment">// Print a header with the title centered.</span>
job->set_header_footer_font(<span class="stringliteral">"Sans Regular 12.0"</span>);
job->set_header_format(0, title, 0, <span class="keyword">true</span>);
job->set_print_header(<span class="keyword">true</span>);
<span class="comment">// Print the page number in the page bottom.</span>
job->set_footer_format(0, 0, <span class="stringliteral">"Page N of Q"</span>, <span class="keyword">true</span>);
job->set_print_footer(<span class="keyword">true</span>);
<span class="comment">// Print the whole buffer and return the result (that is, a GnomePrintJob pointer).</span>
<span class="keywordflow">return</span> job->print();
}
</pre></div>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="z25_0" doxytag="Inti::Gtk::SourcePrintJob::SourcePrintJob"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Inti::Gtk::SourcePrintJob::SourcePrintJob </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkSourcePrintJob * </td>
<td class="mdname" nowrap> <em>job</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>reference</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html">SourcePrintJob</a> from an existing GtkSourcePrintJob.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>job</em> </td><td>A pointer to a GtkSourcePrintJob. </td></tr>
<tr><td valign=top><em>reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>job</em> can be a newly created GtkSourcePrintJob or an existing GtkSourcePrintJob (see G::Object::Object). </td>
</tr>
</table>
<a name="z27_0" doxytag="Inti::Gtk::SourcePrintJob::SourcePrintJob"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Inti::Gtk::SourcePrintJob::SourcePrintJob </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>buffer</em> = 0 </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new source print job.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>buffer</em> </td><td>The <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> to print, or null.</td></tr>
</table>
</dl>
<br>
If no GnomePrintConfig is set by calling <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_0">set_config()</a> the print job will use the default gnome print configuration. </td>
</tr>
</table>
<a name="z27_1" doxytag="Inti::Gtk::SourcePrintJob::SourcePrintJob"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Inti::Gtk::SourcePrintJob::SourcePrintJob </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GnomePrintConfig & </td>
<td class="mdname" nowrap> <em>config</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> * </td>
<td class="mdname" nowrap> <em>buffer</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new source print job with the specified configuration.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>config</em> </td><td>The print job options. </td></tr>
<tr><td valign=top><em>buffer</em> </td><td>The <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> to print, or null. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="z27_2" doxytag="Inti::Gtk::SourcePrintJob::SourcePrintJob"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Inti::Gtk::SourcePrintJob::SourcePrintJob </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classInti_1_1Gtk_1_1SourceView.html">SourceView</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>view</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Convenience constructor that sets several configuration options at once, so that the printed output matches the view.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>view</em> </td><td>The <a class="el" href="classInti_1_1Gtk_1_1SourceView.html">SourceView</a> to get the configuration from.</td></tr>
</table>
</dl>
<br>
The configuration options set are the buffer, tabs width, highlighting, wrap mode and default font. This is the easiest way to set up a print job. If no configuration is set later the default GnomePrintConfig is used. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="z29_12" doxytag="Inti::Gtk::SourcePrintJob::cancel"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::cancel </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Cancels an asynchronous printing operation.
<p>
<br>
This will remove any pending print idle handler and unref the current GnomePrintJob. Note that if you got a reference to the job's GnomePrintJob (using <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_13">get_print_job()</a>) it will not be destroyed (since you hold a reference to it), and it will not be closed either. If you wish to show or print the partially printed document you need to close it yourself. This method has no effect when called from a non-asynchronous print operation. </td>
</tr>
</table>
<a name="z28_5" doxytag="Inti::Gtk::SourcePrintJob::get_buffer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a>* Inti::Gtk::SourcePrintJob::get_buffer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> the print job would print.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> to print. </dd></dl>
</td>
</tr>
</table>
<a name="z28_4" doxytag="Inti::Gtk::SourcePrintJob::get_config"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GnomePrintConfig* Inti::Gtk::SourcePrintJob::get_config </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the current GnomePrintConfig the print job will use.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the GnomePrintConfig for the print job.</dd></dl>
<br>
If not previously set, this will create a default configuration and return it. </td>
</tr>
</table>
<a name="z28_9" doxytag="Inti::Gtk::SourcePrintJob::get_font"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String Inti::Gtk::SourcePrintJob::get_font </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the default font to be used for the printed text.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A String with the name of the current text font.</dd></dl>
<br>
The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". </td>
</tr>
</table>
<a name="z28_19" doxytag="Inti::Gtk::SourcePrintJob::get_header_footer_font"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String Inti::Gtk::SourcePrintJob::get_header_footer_font </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the font to be used for the header and footer.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A String with the name of the current header and footer font, or null.</dd></dl>
<br>
The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". This method might return null if a specific font has not been set. </td>
</tr>
</table>
<a name="z28_8" doxytag="Inti::Gtk::SourcePrintJob::get_highlight"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Inti::Gtk::SourcePrintJob::get_highlight </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets whether the job is configured to print the text highlighted with colors and font styles.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the printed output will be highlighted.</dd></dl>
<br>
Note that highlighting will happen only if the buffer to print has highlighting activated. </td>
</tr>
</table>
<a name="z28_10" doxytag="Inti::Gtk::SourcePrintJob::get_numbers_font"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> String Inti::Gtk::SourcePrintJob::get_numbers_font </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the font to be used for the line numbers.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A String with the name of the current line numbers font, or null.</dd></dl>
<br>
The returned string is of the form "Fontfamily Style Size", for example "Monospace Regular 10.0". This function might return a null String if a specific font for line numbers has not been set. </td>
</tr>
</table>
<a name="z28_14" doxytag="Inti::Gtk::SourcePrintJob::get_page"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int Inti::Gtk::SourcePrintJob::get_page </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the currently printing page number.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current page number.</dd></dl>
<br>
This method is only valid while printing (either synchronously or asynchronously). </td>
</tr>
</table>
<a name="z28_15" doxytag="Inti::Gtk::SourcePrintJob::get_page_count"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int Inti::Gtk::SourcePrintJob::get_page_count </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the total number of pages the job will print.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The number of pages of the printed job.</dd></dl>
<br>
The returned value is only meaninful after pagination has finished. In practice, for synchronous printing this means when "begin_page" is emitted, or after <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_11">print_async()</a> has returned. </td>
</tr>
</table>
<a name="z28_16" doxytag="Inti::Gtk::SourcePrintJob::get_print_context"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GnomePrintContext* Inti::Gtk::SourcePrintJob::get_print_context </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the GnomePrintContext of the current job.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current GnomePrintContext</dd></dl>
<br>
This method is only valid while printing. Normally you would use this method to print in the margins set by set_margins() in a handler for the "begin_page" signal. The returned object is owned by job. </td>
</tr>
</table>
<a name="z28_18" doxytag="Inti::Gtk::SourcePrintJob::get_print_footer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Inti::Gtk::SourcePrintJob::get_print_footer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determines if a footer is set to be printed for each page.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the footer is set to be printed.</dd></dl>
<br>
A footer will be printed if this method returns true and some format strings have been specified with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_19">set_footer_format()</a>. </td>
</tr>
</table>
<a name="z28_17" doxytag="Inti::Gtk::SourcePrintJob::get_print_header"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Inti::Gtk::SourcePrintJob::get_print_header </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determines if a header is set to be printed for each page.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the header is set to be printed.</dd></dl>
<br>
A header will be printed if this method returns true and some format strings have been specified with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_17">set_header_format()</a>. </td>
</tr>
</table>
<a name="z28_13" doxytag="Inti::Gtk::SourcePrintJob::get_print_job"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GnomePrintJob* Inti::Gtk::SourcePrintJob::get_print_job </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets a reference to the GnomePrintJob which the job is printing or has recently finished printing.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A new reference to the job's GnomePrintJob, or null.</dd></dl>
<br>
Note you need to unref the returned object. You may call this method in the middle of an asynchronous printing operation, but the returned GnomePrintJob will not be closed until the last page is printed and the "finished" signal is emitted. </td>
</tr>
</table>
<a name="z28_11" doxytag="Inti::Gtk::SourcePrintJob::get_print_numbers"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int Inti::Gtk::SourcePrintJob::get_print_numbers </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the interval used for line number printing.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The interval of printed line numbers.</dd></dl>
<br>
If the return value is 0, no line numbers will be printed. The default value is 1 (that is, line numbers are printed on all lines). </td>
</tr>
</table>
<a name="z28_6" doxytag="Inti::Gtk::SourcePrintJob::get_tabs_width"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned int Inti::Gtk::SourcePrintJob::get_tabs_width </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the configured tabs width in equivalent spaces (the default value is 8).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The tabs width in equivalent spaces. </dd></dl>
</td>
</tr>
</table>
<a name="z28_12" doxytag="Inti::Gtk::SourcePrintJob::get_text_margins"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::get_text_margins </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double * </td>
<td class="mdname" nowrap> <em>top</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>bottom</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>left</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double * </td>
<td class="mdname" nowrap> <em>right</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the user set margins for the print job.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>top</em> </td><td>The location to store the top margin. </td></tr>
<tr><td valign=top><em>bottom</em> </td><td>The location to store the bottom margin. </td></tr>
<tr><td valign=top><em>left</em> </td><td>The location to store the left margin. </td></tr>
<tr><td valign=top><em>right</em> </td><td>The location to store the right margin.</td></tr>
</table>
</dl>
<br>
This function retrieves the values previously set by <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_8">set_text_margins()</a>. The default for all four margins is 0. Any of the pointers can be null if you want to ignore that value. </td>
</tr>
</table>
<a name="z28_7" doxytag="Inti::Gtk::SourcePrintJob::get_wrap_mode"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> WrapMode Inti::Gtk::SourcePrintJob::get_wrap_mode </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the wrapping style for text lines wider than the printable width.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current wrapping mode for the print job.</dd></dl>
<br>
The default is no wrapping. </td>
</tr>
</table>
<a name="z26_0" doxytag="Inti::Gtk::SourcePrintJob::on_begin_page"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Inti::Gtk::SourcePrintJob::on_begin_page </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Called whenever the print job is about to print a new text page.
<p>
You can connect to this signal to provide the user with feedback about the progress of printing, or to customize the printed page by for example, printing your own headers and footers. </td>
</tr>
</table>
<a name="z26_1" doxytag="Inti::Gtk::SourcePrintJob::on_finished"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Inti::Gtk::SourcePrintJob::on_finished </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Called whenever an asynchronous print job has finished.
<p>
You can connect to this signal to get notification when a job has finished printing. When it's emitted, the GnomePrintJob the print job was producing has been closed and it can be either previewed or printed to the physical device. </td>
</tr>
</table>
<a name="z29_10" doxytag="Inti::Gtk::SourcePrintJob::print"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GnomePrintJob* Inti::Gtk::SourcePrintJob::print </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const TextIter & </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TextIter & </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Produces a GnomePrintJob with the source buffer range from <em>start</em> to <em>end</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>start</em> </td><td>The start of the region of text to print. </td></tr>
<tr><td valign=top><em>end</em> </td><td>The end of the region of text to print. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A closed GnomePrintJob with the text from start to end printed, or null if job could not print.</dd></dl>
<br>
The returned GnomePrintJob pointer is referenced and so must be unreferenced when no longer required. </td>
</tr>
</table>
<a name="z29_9" doxytag="Inti::Gtk::SourcePrintJob::print"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GnomePrintJob* Inti::Gtk::SourcePrintJob::print </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Produces a GnomePrintJob with the printed document.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A closed GnomePrintJob with the printed document, or null if printing could not be completed.</dd></dl>
<br>
The whole contents of the configured <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> are printed. The returned job is already closed and ready to be previewed (using gnome_print_job_preview_new()) or printed directly. The caller of this method owns a reference to the returned object, so job can be destroyed and the output will still be valid, or the document can be printed again with different settings. </td>
</tr>
</table>
<a name="z29_11" doxytag="Inti::Gtk::SourcePrintJob::print_async"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Inti::Gtk::SourcePrintJob::print_async </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const TextIter & </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const TextIter & </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Starts to print the job asynchronously.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>start</em> </td><td>The start of the region of text to print. </td></tr>
<tr><td valign=top><em>end</em> </td><td>The end of the region of text to print. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the print started.</dd></dl>
<br>
This method will ready the job for printing and install an idle handler that will render one page at a time. This method will not return immediatly, as only page rendering is done asynchronously. Text retrieval and paginating happens within this method. Also, if highlighting is enabled, the whole buffer needs to be highlighted first. To get notification when the job has finished, you must connect to the "finished" signal. After this signal is emitted you can retrieve the resulting GnomePrintJob with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z28_13">get_print_job()</a>. You may cancel the job with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_12">cancel()</a>. </td>
</tr>
</table>
<a name="z29_1" doxytag="Inti::Gtk::SourcePrintJob::set_buffer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_buffer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>buffer</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> the print job will print.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>buffer</em> </td><td>The <a class="el" href="classInti_1_1Gtk_1_1SourceBuffer.html">SourceBuffer</a> to print.</td></tr>
</table>
</dl>
<br>
You need to specify a buffer to print, either by using this method or by specifying a buffer when you construct the print job. </td>
</tr>
</table>
<a name="z29_0" doxytag="Inti::Gtk::SourcePrintJob::set_config"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_config </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GnomePrintConfig & </td>
<td class="mdname1" valign="top" nowrap> <em>config</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the print configuration for the job.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>config</em> </td><td>A GnomePrintConfig object to get printing configuration from.</td></tr>
</table>
</dl>
<br>
If you don't set a configuration object for the print job, when needed one will be created with gnome_print_config_default(). </td>
</tr>
</table>
<a name="z29_5" doxytag="Inti::Gtk::SourcePrintJob::set_font"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_font </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>font_name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the default font for the printed text.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>font_name</em> </td><td>The name of the font used for the document text.</td></tr>
</table>
</dl>
<br>
The <em>font_name</em> should be a full font name GnomePrint can understand. The default font name is "Monospace Regular 10"; </td>
</tr>
</table>
<a name="z29_19" doxytag="Inti::Gtk::SourcePrintJob::set_footer_format"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_footer_format </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>left</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const String & </td>
<td class="mdname" nowrap> <em>center</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const String & </td>
<td class="mdname" nowrap> <em>right</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>separator</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets strftime-like footer format strings, to be printed on the left, center and right of the bottom of each page (see <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_17">set_header_format()</a>).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>left</em> </td><td>A format string to print on the left of the footer. </td></tr>
<tr><td valign=top><em>center</em> </td><td>A format string to print on the center of the footer. </td></tr>
<tr><td valign=top><em>right</em> </td><td>A format string to print on the right of the footer. </td></tr>
<tr><td valign=top><em>separator</em> </td><td>Set <em>true</em> if you want a separator line to be printed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="z29_15" doxytag="Inti::Gtk::SourcePrintJob::set_header_footer_font"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_header_footer_font </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>font_name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the font for printing headers and footers.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>font_name</em> </td><td>The full name of the font to be used in headers and footers, or null.</td></tr>
</table>
</dl>
<br>
If a null String is supplied, the default font (that is, the one being used for the text) will be used instead. The default font name is 'Monospace Regular 10'; </td>
</tr>
</table>
<a name="z29_17" doxytag="Inti::Gtk::SourcePrintJob::set_header_format"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_header_format </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname" nowrap> <em>left</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const String & </td>
<td class="mdname" nowrap> <em>center</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const String & </td>
<td class="mdname" nowrap> <em>right</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>separator</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets strftime-like header format strings, to be printed on the left, center and right of the top of each page.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>left</em> </td><td>A format string to print on the left of the header. </td></tr>
<tr><td valign=top><em>center</em> </td><td>A format string to print on the center of the header. </td></tr>
<tr><td valign=top><em>right</em> </td><td>A format string to print on the right of the header. </td></tr>
<tr><td valign=top><em>separator</em> </td><td>Set <em>true</em> if you want a separator line to be printed.</td></tr>
</table>
</dl>
<br>
The strings may include strftime(3) codes which will be expanded at print time. All strftime() codes are accepted (A for the day, F for the date, T for the time), with the addition of N for the page number and Q for the total page count. <em>separator</em> specifies if a solid line should be drawn to separate the header from the document text. If a null String is given for any of the three arguments, that particular string will not be printed. For the header to be printed, in addition to specifying format strings, you need to enable header printing with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_13">set_print_header()</a>. </td>
</tr>
</table>
<a name="z29_4" doxytag="Inti::Gtk::SourcePrintJob::set_highlight"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_highlight </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>highlight</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets whether the printed text will be highlighted according to the buffer rules.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>highlight</em> </td><td>Set <em>true</em> if the printed text should be highlighted.</td></tr>
</table>
</dl>
<br>
If <em>highlight</em> is true both color and font style are applied. </td>
</tr>
</table>
<a name="z29_6" doxytag="Inti::Gtk::SourcePrintJob::set_numbers_font"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_numbers_font </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const String & </td>
<td class="mdname1" valign="top" nowrap> <em>font_name</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the font for printing line numbers on the left margin.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>font_name</em> </td><td>The full name of the font for line numbers, or null.</td></tr>
</table>
</dl>
<br>
If a null String is supplied, the default font (that is, the one being used for the text) will be used instead. </td>
</tr>
</table>
<a name="z29_14" doxytag="Inti::Gtk::SourcePrintJob::set_print_footer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_print_footer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets whether you want to print a footer in each page.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>setting</em> </td><td>Set <em>true</em> if you want the footer to be printed.</td></tr>
</table>
</dl>
<br>
The default footer consists of three pieces of text and an optional line separator, configurable with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_19">set_footer_format()</a>. Note that by default the footer format is unspecified, and if it's empty it will not be printed, regardless of this setting. </td>
</tr>
</table>
<a name="z29_13" doxytag="Inti::Gtk::SourcePrintJob::set_print_header"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_print_header </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets whether you want to print a header in each page.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>setting</em> </td><td>Set <em>true</em> if you want the header to be printed.</td></tr>
</table>
</dl>
<br>
The default header consists of three pieces of text and an optional line separator, configurable with <a class="el" href="classInti_1_1Gtk_1_1SourcePrintJob.html#z29_17">set_header_format()</a>. Note that by default the header format is unspecified, and if it's empty it will not be printed, regardless of this setting. </td>
</tr>
</table>
<a name="z29_7" doxytag="Inti::Gtk::SourcePrintJob::set_print_numbers"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_print_numbers </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>interval</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the interval for printed line numbers.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>interval</em> </td><td>The interval for printed line numbers.</td></tr>
</table>
</dl>
<br>
If <em>interval</em> is 0 no numbers will be printed. If greater than 0, a number will be printed every <em>interval</em> lines (that is, 1 will print a number on every line, 2 will print a number on every second line, 3 will print a number on every third line, and so on). </td>
</tr>
</table>
<a name="z29_2" doxytag="Inti::Gtk::SourcePrintJob::set_tabs_width"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_tabs_width </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>tabs_width</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the tabs width (in equivalent spaces) for the printed text.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>tabs_width</em> </td><td>The number of equivalent spaces for the tabs width.</td></tr>
</table>
</dl>
<br>
The width in printing units will be calculated as the width of a string containing tabs_width spaces of the default font. Tab stops are set for the full width of printed text. </td>
</tr>
</table>
<a name="z29_8" doxytag="Inti::Gtk::SourcePrintJob::set_text_margins"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_text_margins </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname" nowrap> <em>top</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>bottom</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>left</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>right</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the four user margins for the print job.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>top</em> </td><td>The top user margin. </td></tr>
<tr><td valign=top><em>bottom</em> </td><td>The bottom user margin. </td></tr>
<tr><td valign=top><em>left</em> </td><td>The left user margin. </td></tr>
<tr><td valign=top><em>right</em> </td><td>The right user margin.</td></tr>
</table>
</dl>
<br>
These margins are in addition to the document margins provided in the GnomePrintConfig and will not be used for headers, footers or line numbers (those are calculated separatedly). You can print in the space allocated by these margins by connecting to the "begin_page" signal. The space is around the printed text, and inside the margins specified in the GnomePrintConfig.<p>
The margin numbers are given in device units. If any of the given values is less than 0, that particular margin is not altered by this function. </td>
</tr>
</table>
<a name="z29_3" doxytag="Inti::Gtk::SourcePrintJob::set_wrap_mode"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Inti::Gtk::SourcePrintJob::set_wrap_mode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">WrapMode </td>
<td class="mdname1" valign="top" nowrap> <em>wrap</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the wrap mode for lines of text larger than the printable width.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>wrap</em> </td><td>A WrapMode. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sourceprintjob_8h-source.html">sourceprintjob.h</a></ul>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Main Page - Footer</title>
<meta name="description" content="Reference Manual">
<meta name="author" content="The Inti Development Team">
</head>
<body>
<br>
<br>
<table cellpadding="0" cellspacing="0" border="0" style="width: 100%;">
<tbody>
<tr>
<td valign="top">
<hr></td>
</tr>
<tr>
<td valign="top" height="116"
background="../images/bottom-fade.png">
<address><small>Generated on Wed Aug 27 21:17:28 2003 for Inti-SourceView by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" align="middle" border="0" width="110" height="53"> </a>
1.3.2 written by <a href="mailto:dimitri@stack.nl">Dimitri
van Heesch</a>, © 1997-2002</small></address>
</td>
</tr>
<tr>
<td style="vertical-align: top; background-color: rgb(0, 55, 85);"><br>
</td>
</tr>
</tbody>
</table>
<br>
</body>
</html>
|
