]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkprintsettings.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtkprintsettings.sgml
1 <!-- ##### SECTION Title ##### -->
2 GtkPrintSettings
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Stores print settings
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 A GtkPrintSettings object represents the settings of a print dialog in 
10 a system-independent way. The main use for this object is that once 
11 you've printed you can get a settings object that represents the settings 
12 the user chose, and the next time you print you can pass that object in so 
13 that the user doesn't have to re-set all his settings. 
14 </para>
15 <para>
16 Its also possible to enumerate the settings so that you can easily save 
17 the settings for the next time your app runs, or even store them in a 
18 document. The predefined keys try to use shared values as much as possible 
19 so that moving such a document between systems still works.
20 </para>
21
22 <!-- TODO example of getting, storing and setting settings -->
23  
24 <para>
25 Printing support was added in GTK+ 2.10.
26 </para>
27
28 <!-- ##### SECTION See_Also ##### -->
29 <para>
30
31 </para>
32
33 <!-- ##### SECTION Stability_Level ##### -->
34
35
36 <!-- ##### SECTION Image ##### -->
37
38
39 <!-- ##### STRUCT GtkPrintSettings ##### -->
40 <para>
41
42 </para>
43
44
45 <!-- ##### USER_FUNCTION GtkPrintSettingsFunc ##### -->
46 <para>
47
48 </para>
49
50 @key: 
51 @value: 
52 @user_data: 
53
54
55 <!-- ##### FUNCTION gtk_print_settings_new ##### -->
56 <para>
57
58 </para>
59
60 @void: 
61 @Returns: 
62
63
64 <!-- ##### FUNCTION gtk_print_settings_copy ##### -->
65 <para>
66
67 </para>
68
69 @other: 
70 @Returns: 
71
72
73 <!-- ##### FUNCTION gtk_print_settings_has_key ##### -->
74 <para>
75
76 </para>
77
78 @settings: 
79 @key: 
80 @Returns: 
81
82
83 <!-- ##### FUNCTION gtk_print_settings_get ##### -->
84 <para>
85
86 </para>
87
88 @settings: 
89 @key: 
90 @Returns: 
91
92
93 <!-- ##### FUNCTION gtk_print_settings_set ##### -->
94 <para>
95
96 </para>
97
98 @settings: 
99 @key: 
100 @value: 
101
102
103 <!-- ##### FUNCTION gtk_print_settings_unset ##### -->
104 <para>
105
106 </para>
107
108 @settings: 
109 @key: 
110
111
112 <!-- ##### FUNCTION gtk_print_settings_foreach ##### -->
113 <para>
114
115 </para>
116
117 @settings: 
118 @func: 
119 @user_data: 
120
121
122 <!-- ##### FUNCTION gtk_print_settings_get_bool ##### -->
123 <para>
124
125 </para>
126
127 @settings: 
128 @key: 
129 @Returns: 
130
131
132 <!-- ##### FUNCTION gtk_print_settings_set_bool ##### -->
133 <para>
134
135 </para>
136
137 @settings: 
138 @key: 
139 @value: 
140
141
142 <!-- ##### FUNCTION gtk_print_settings_get_double ##### -->
143 <para>
144
145 </para>
146
147 @settings: 
148 @key: 
149 @Returns: 
150
151
152 <!-- ##### FUNCTION gtk_print_settings_get_double_with_default ##### -->
153 <para>
154
155 </para>
156
157 @settings: 
158 @key: 
159 @def: 
160 @Returns: 
161
162
163 <!-- ##### FUNCTION gtk_print_settings_set_double ##### -->
164 <para>
165
166 </para>
167
168 @settings: 
169 @key: 
170 @value: 
171
172
173 <!-- ##### FUNCTION gtk_print_settings_get_length ##### -->
174 <para>
175
176 </para>
177
178 @settings: 
179 @key: 
180 @unit: 
181 @Returns: 
182
183
184 <!-- ##### FUNCTION gtk_print_settings_set_length ##### -->
185 <para>
186
187 </para>
188
189 @settings: 
190 @key: 
191 @value: 
192 @unit: 
193
194
195 <!-- ##### FUNCTION gtk_print_settings_get_int ##### -->
196 <para>
197
198 </para>
199
200 @settings: 
201 @key: 
202 @Returns: 
203
204
205 <!-- ##### FUNCTION gtk_print_settings_get_int_with_default ##### -->
206 <para>
207
208 </para>
209
210 @settings: 
211 @key: 
212 @def: 
213 @Returns: 
214
215
216 <!-- ##### FUNCTION gtk_print_settings_set_int ##### -->
217 <para>
218
219 </para>
220
221 @settings: 
222 @key: 
223 @value: 
224
225
226 <!-- ##### MACRO GTK_PRINT_SETTINGS_PRINTER ##### -->
227 <para>
228
229 </para>
230
231
232
233 <!-- ##### FUNCTION gtk_print_settings_get_printer ##### -->
234 <para>
235
236 </para>
237
238 @settings: 
239 @Returns: 
240
241
242 <!-- ##### FUNCTION gtk_print_settings_set_printer ##### -->
243 <para>
244
245 </para>
246
247 @settings: 
248 @printer: 
249
250
251 <!-- ##### ENUM GtkPageOrientation ##### -->
252 <para>
253
254 </para>
255
256 @GTK_PAGE_ORIENTATION_PORTRAIT: 
257 @GTK_PAGE_ORIENTATION_LANDSCAPE: 
258 @GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT: 
259 @GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE: 
260
261 <!-- ##### MACRO GTK_PRINT_SETTINGS_ORIENTATION ##### -->
262 <para>
263
264 </para>
265
266
267
268 <!-- ##### FUNCTION gtk_print_settings_get_orientation ##### -->
269 <para>
270
271 </para>
272
273 @settings: 
274 @Returns: 
275
276
277 <!-- ##### FUNCTION gtk_print_settings_set_orientation ##### -->
278 <para>
279
280 </para>
281
282 @settings: 
283 @orientation: 
284
285
286 <!-- ##### MACRO GTK_PRINT_SETTINGS_PAPER_FORMAT ##### -->
287 <para>
288
289 </para>
290
291
292
293 <!-- ##### FUNCTION gtk_print_settings_get_paper_size ##### -->
294 <para>
295
296 </para>
297
298 @settings: 
299 @Returns: 
300
301
302 <!-- ##### FUNCTION gtk_print_settings_set_paper_size ##### -->
303 <para>
304
305 </para>
306
307 @settings: 
308 @paper_size: 
309
310
311 <!-- ##### MACRO GTK_PRINT_SETTINGS_PAPER_WIDTH ##### -->
312 <para>
313
314 </para>
315
316
317
318 <!-- ##### FUNCTION gtk_print_settings_get_paper_width ##### -->
319 <para>
320
321 </para>
322
323 @settings: 
324 @unit: 
325 @Returns: 
326
327
328 <!-- ##### FUNCTION gtk_print_settings_set_paper_width ##### -->
329 <para>
330
331 </para>
332
333 @settings: 
334 @width: 
335 @unit: 
336
337
338 <!-- ##### MACRO GTK_PRINT_SETTINGS_PAPER_HEIGHT ##### -->
339 <para>
340
341 </para>
342
343
344
345 <!-- ##### FUNCTION gtk_print_settings_get_paper_height ##### -->
346 <para>
347
348 </para>
349
350 @settings: 
351 @unit: 
352 @Returns: 
353
354
355 <!-- ##### FUNCTION gtk_print_settings_set_paper_height ##### -->
356 <para>
357
358 </para>
359
360 @settings: 
361 @height: 
362 @unit: 
363
364
365 <!-- ##### MACRO GTK_PRINT_SETTINGS_USE_COLOR ##### -->
366 <para>
367
368 </para>
369
370
371
372 <!-- ##### FUNCTION gtk_print_settings_get_use_color ##### -->
373 <para>
374
375 </para>
376
377 @settings: 
378 @Returns: 
379
380
381 <!-- ##### FUNCTION gtk_print_settings_set_use_color ##### -->
382 <para>
383
384 </para>
385
386 @settings: 
387 @use_color: 
388
389
390 <!-- ##### MACRO GTK_PRINT_SETTINGS_COLLATE ##### -->
391 <para>
392
393 </para>
394
395
396
397 <!-- ##### FUNCTION gtk_print_settings_get_collate ##### -->
398 <para>
399
400 </para>
401
402 @settings: 
403 @Returns: 
404
405
406 <!-- ##### FUNCTION gtk_print_settings_set_collate ##### -->
407 <para>
408
409 </para>
410
411 @settings: 
412 @collate: 
413
414
415 <!-- ##### MACRO GTK_PRINT_SETTINGS_REVERSE ##### -->
416 <para>
417
418 </para>
419
420
421
422 <!-- ##### FUNCTION gtk_print_settings_get_reverse ##### -->
423 <para>
424
425 </para>
426
427 @settings: 
428 @Returns: 
429
430
431 <!-- ##### FUNCTION gtk_print_settings_set_reverse ##### -->
432 <para>
433
434 </para>
435
436 @settings: 
437 @reverse: 
438
439
440 <!-- ##### ENUM GtkPrintDuplex ##### -->
441 <para>
442
443 </para>
444
445 @GTK_PRINT_DUPLEX_SIMPLEX: 
446 @GTK_PRINT_DUPLEX_HORIZONTAL: 
447 @GTK_PRINT_DUPLEX_VERTICAL: 
448
449 <!-- ##### MACRO GTK_PRINT_SETTINGS_DUPLEX ##### -->
450 <para>
451
452 </para>
453
454
455
456 <!-- ##### FUNCTION gtk_print_settings_get_duplex ##### -->
457 <para>
458
459 </para>
460
461 @settings: 
462 @Returns: 
463
464
465 <!-- ##### FUNCTION gtk_print_settings_set_duplex ##### -->
466 <para>
467
468 </para>
469
470 @settings: 
471 @duplex: 
472
473
474 <!-- ##### ENUM GtkPrintQuality ##### -->
475 <para>
476
477 </para>
478
479 @GTK_PRINT_QUALITY_LOW: 
480 @GTK_PRINT_QUALITY_NORMAL: 
481 @GTK_PRINT_QUALITY_HIGH: 
482 @GTK_PRINT_QUALITY_DRAFT: 
483
484 <!-- ##### MACRO GTK_PRINT_SETTINGS_QUALITY ##### -->
485 <para>
486
487 </para>
488
489
490
491 <!-- ##### FUNCTION gtk_print_settings_get_quality ##### -->
492 <para>
493
494 </para>
495
496 @settings: 
497 @Returns: 
498
499
500 <!-- ##### FUNCTION gtk_print_settings_set_quality ##### -->
501 <para>
502
503 </para>
504
505 @settings: 
506 @quality: 
507
508
509 <!-- ##### MACRO GTK_PRINT_SETTINGS_N_COPIES ##### -->
510 <para>
511
512 </para>
513
514
515
516 <!-- ##### FUNCTION gtk_print_settings_get_n_copies ##### -->
517 <para>
518
519 </para>
520
521 @settings: 
522 @Returns: 
523
524
525 <!-- ##### FUNCTION gtk_print_settings_set_n_copies ##### -->
526 <para>
527
528 </para>
529
530 @settings: 
531 @num_copies: 
532
533
534 <!-- ##### MACRO GTK_PRINT_SETTINGS_NUMBER_UP ##### -->
535 <para>
536
537 </para>
538
539
540
541 <!-- ##### FUNCTION gtk_print_settings_get_number_up ##### -->
542 <para>
543
544 </para>
545
546 @settings: 
547 @Returns: 
548
549
550 <!-- ##### FUNCTION gtk_print_settings_set_number_up ##### -->
551 <para>
552
553 </para>
554
555 @settings: 
556 @number_up: 
557
558
559 <!-- ##### ENUM GtkNumberUpLayout ##### -->
560 <para>
561 Used to determine the layout of pages on a sheet when printing
562 multiple pages per sheet.
563 </para>
564
565 @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-lrtb.png" format="PNG"></inlinegraphic>
566 @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-lrbt.png" format="PNG"></inlinegraphic>
567 @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-rltb.png" format="PNG"></inlinegraphic>
568 @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-rlbt.png" format="PNG"></inlinegraphic>
569 @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-tblr.png" format="PNG"></inlinegraphic>
570 @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-tbrl.png" format="PNG"></inlinegraphic>
571 @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-btlr.png" format="PNG"></inlinegraphic>
572 @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-btrl.png" format="PNG"></inlinegraphic>
573
574 <!-- ##### MACRO GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT ##### -->
575 <para>
576
577 </para>
578
579
580
581 <!-- ##### FUNCTION gtk_print_settings_get_number_up_layout ##### -->
582 <para>
583
584 </para>
585
586 @settings: 
587 @Returns: 
588
589
590 <!-- ##### FUNCTION gtk_print_settings_set_number_up_layout ##### -->
591 <para>
592
593 </para>
594
595 @settings: 
596 @number_up_layout: 
597
598
599 <!-- ##### MACRO GTK_PRINT_SETTINGS_RESOLUTION ##### -->
600 <para>
601
602 </para>
603
604
605
606 <!-- ##### FUNCTION gtk_print_settings_get_resolution ##### -->
607 <para>
608
609 </para>
610
611 @settings: 
612 @Returns: 
613
614
615 <!-- ##### FUNCTION gtk_print_settings_set_resolution ##### -->
616 <para>
617
618 </para>
619
620 @settings: 
621 @resolution: 
622
623
624 <!-- ##### FUNCTION gtk_print_settings_set_resolution_xy ##### -->
625 <para>
626
627 </para>
628
629 @settings: 
630 @resolution_x: 
631 @resolution_y: 
632
633
634 <!-- ##### MACRO GTK_PRINT_SETTINGS_RESOLUTION_X ##### -->
635 <para>
636
637 </para>
638
639
640
641 <!-- ##### FUNCTION gtk_print_settings_get_resolution_x ##### -->
642 <para>
643
644 </para>
645
646 @settings: 
647 @Returns: 
648
649
650 <!-- ##### MACRO GTK_PRINT_SETTINGS_RESOLUTION_Y ##### -->
651 <para>
652
653 </para>
654
655
656
657 <!-- ##### FUNCTION gtk_print_settings_get_resolution_y ##### -->
658 <para>
659
660 </para>
661
662 @settings: 
663 @Returns: 
664
665
666 <!-- ##### MACRO GTK_PRINT_SETTINGS_PRINTER_LPI ##### -->
667 <para>
668
669 </para>
670
671
672
673 <!-- ##### FUNCTION gtk_print_settings_get_printer_lpi ##### -->
674 <para>
675
676 </para>
677
678 @settings: 
679 @Returns: 
680
681
682 <!-- ##### FUNCTION gtk_print_settings_set_printer_lpi ##### -->
683 <para>
684
685 </para>
686
687 @settings: 
688 @lpi: 
689
690
691 <!-- ##### MACRO GTK_PRINT_SETTINGS_SCALE ##### -->
692 <para>
693
694 </para>
695
696
697
698 <!-- ##### FUNCTION gtk_print_settings_get_scale ##### -->
699 <para>
700
701 </para>
702
703 @settings: 
704 @Returns: 
705
706
707 <!-- ##### FUNCTION gtk_print_settings_set_scale ##### -->
708 <para>
709
710 </para>
711
712 @settings: 
713 @scale: 
714
715
716 <!-- ##### ENUM GtkPrintPages ##### -->
717 <para>
718
719 </para>
720
721 @GTK_PRINT_PAGES_ALL: 
722 @GTK_PRINT_PAGES_CURRENT: 
723 @GTK_PRINT_PAGES_RANGES: 
724 @GTK_PRINT_PAGES_SELECTION: 
725
726 <!-- ##### MACRO GTK_PRINT_SETTINGS_PRINT_PAGES ##### -->
727 <para>
728
729 </para>
730
731
732
733 <!-- ##### FUNCTION gtk_print_settings_get_print_pages ##### -->
734 <para>
735
736 </para>
737
738 @settings: 
739 @Returns: 
740
741
742 <!-- ##### FUNCTION gtk_print_settings_set_print_pages ##### -->
743 <para>
744
745 </para>
746
747 @settings: 
748 @pages: 
749
750
751 <!-- ##### STRUCT GtkPageRange ##### -->
752 <para>
753
754 </para>
755
756 @start: 
757 @end: 
758
759 <!-- ##### MACRO GTK_PRINT_SETTINGS_PAGE_RANGES ##### -->
760 <para>
761
762 </para>
763
764
765
766 <!-- ##### FUNCTION gtk_print_settings_get_page_ranges ##### -->
767 <para>
768
769 </para>
770
771 @settings: 
772 @num_ranges: 
773 @Returns: 
774
775
776 <!-- ##### FUNCTION gtk_print_settings_set_page_ranges ##### -->
777 <para>
778
779 </para>
780
781 @settings: 
782 @page_ranges: 
783 @num_ranges: 
784
785
786 <!-- ##### ENUM GtkPageSet ##### -->
787 <para>
788
789 </para>
790
791 @GTK_PAGE_SET_ALL: 
792 @GTK_PAGE_SET_EVEN: 
793 @GTK_PAGE_SET_ODD: 
794
795 <!-- ##### MACRO GTK_PRINT_SETTINGS_PAGE_SET ##### -->
796 <para>
797
798 </para>
799
800
801
802 <!-- ##### FUNCTION gtk_print_settings_get_page_set ##### -->
803 <para>
804
805 </para>
806
807 @settings: 
808 @Returns: 
809
810
811 <!-- ##### FUNCTION gtk_print_settings_set_page_set ##### -->
812 <para>
813
814 </para>
815
816 @settings: 
817 @page_set: 
818
819
820 <!-- ##### MACRO GTK_PRINT_SETTINGS_DEFAULT_SOURCE ##### -->
821 <para>
822
823 </para>
824
825
826
827 <!-- ##### FUNCTION gtk_print_settings_get_default_source ##### -->
828 <para>
829
830 </para>
831
832 @settings: 
833 @Returns: 
834
835
836 <!-- ##### FUNCTION gtk_print_settings_set_default_source ##### -->
837 <para>
838
839 </para>
840
841 @settings: 
842 @default_source: 
843
844
845 <!-- ##### MACRO GTK_PRINT_SETTINGS_MEDIA_TYPE ##### -->
846 <para>
847
848 </para>
849
850
851
852 <!-- ##### FUNCTION gtk_print_settings_get_media_type ##### -->
853 <para>
854
855 </para>
856
857 @settings: 
858 @Returns: 
859
860
861 <!-- ##### FUNCTION gtk_print_settings_set_media_type ##### -->
862 <para>
863
864 </para>
865
866 @settings: 
867 @media_type: 
868
869
870 <!-- ##### MACRO GTK_PRINT_SETTINGS_DITHER ##### -->
871 <para>
872
873 </para>
874
875
876
877 <!-- ##### FUNCTION gtk_print_settings_get_dither ##### -->
878 <para>
879
880 </para>
881
882 @settings: 
883 @Returns: 
884
885
886 <!-- ##### FUNCTION gtk_print_settings_set_dither ##### -->
887 <para>
888
889 </para>
890
891 @settings: 
892 @dither: 
893
894
895 <!-- ##### MACRO GTK_PRINT_SETTINGS_FINISHINGS ##### -->
896 <para>
897
898 </para>
899
900
901
902 <!-- ##### FUNCTION gtk_print_settings_get_finishings ##### -->
903 <para>
904
905 </para>
906
907 @settings: 
908 @Returns: 
909
910
911 <!-- ##### FUNCTION gtk_print_settings_set_finishings ##### -->
912 <para>
913
914 </para>
915
916 @settings: 
917 @finishings: 
918
919
920 <!-- ##### MACRO GTK_PRINT_SETTINGS_OUTPUT_BIN ##### -->
921 <para>
922
923 </para>
924
925
926
927 <!-- ##### FUNCTION gtk_print_settings_get_output_bin ##### -->
928 <para>
929
930 </para>
931
932 @settings: 
933 @Returns: 
934
935
936 <!-- ##### FUNCTION gtk_print_settings_set_output_bin ##### -->
937 <para>
938
939 </para>
940
941 @settings: 
942 @output_bin: 
943
944
945 <!-- ##### MACRO GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT ##### -->
946 <para>
947 The key used by the "Print to file" printer to store the format
948 of the output. The supported values are "PS" and "PDF".
949 </para>
950
951
952
953 <!-- ##### MACRO GTK_PRINT_SETTINGS_OUTPUT_URI ##### -->
954 <para>
955 The key used by the "Print to file" printer to store the URI
956 to which the output should be written. GTK+ itself supports
957 only "file://" URIs.
958 </para>
959
960
961
962 <!-- ##### MACRO GTK_PRINT_SETTINGS_WIN32_DRIVER_EXTRA ##### -->
963 <para>
964
965 </para>
966
967
968
969 <!-- ##### MACRO GTK_PRINT_SETTINGS_WIN32_DRIVER_VERSION ##### -->
970 <para>
971
972 </para>
973
974
975
976 <!-- ##### FUNCTION gtk_print_settings_new_from_file ##### -->
977 <para>
978
979 </para>
980
981 @file_name: 
982 @error: 
983 @Returns: 
984
985
986 <!-- ##### FUNCTION gtk_print_settings_new_from_key_file ##### -->
987 <para>
988
989 </para>
990
991 @key_file: 
992 @group_name: 
993 @error: 
994 @Returns: 
995
996
997 <!-- ##### FUNCTION gtk_print_settings_load_file ##### -->
998 <para>
999
1000 </para>
1001
1002 @settings: 
1003 @file_name: 
1004 @error: 
1005 @Returns: 
1006
1007
1008 <!-- ##### FUNCTION gtk_print_settings_load_key_file ##### -->
1009 <para>
1010
1011 </para>
1012
1013 @settings: 
1014 @key_file: 
1015 @group_name: 
1016 @error: 
1017 @Returns: 
1018
1019
1020 <!-- ##### FUNCTION gtk_print_settings_to_file ##### -->
1021 <para>
1022
1023 </para>
1024
1025 @settings: 
1026 @file_name: 
1027 @error: 
1028 @Returns: 
1029
1030
1031 <!-- ##### FUNCTION gtk_print_settings_to_key_file ##### -->
1032 <para>
1033
1034 </para>
1035
1036 @settings: 
1037 @key_file: 
1038 @group_name: 
1039
1040