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