summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkpagesetup.sgml
blob: 630770f6f6630e48b80b95b730f109d956bc5e64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!-- ##### SECTION Title ##### -->
GtkPageSetup

<!-- ##### SECTION Short_Description ##### -->
Stores page setup information

<!-- ##### SECTION Long_Description ##### -->
<para>
A GtkPageSetup object stores the page size, orientation and margins. 
The idea is that you can get one of these from the page setup dialog 
and then pass it to the #GtkPrintOperation when printing. 
The benefit of splitting this out of the #GtkPrintSettings is that 
these affect the actual layout of the page, and thus need to be set 
long before user prints. 
</para>
<para id="print-margins">
The margins specified in this object are the "print margins", i.e. the 
parts of the page that the printer cannot print on. These are different
from the layout margins that a word processor uses; they are typically
used to determine the <emphasis>minimal</emphasis> size for the layout 
margins.
</para>
<para>
To obtain a #GtkPageSetup use gtk_page_setup_new()
to get the defaults, or use gtk_print_run_page_setup_dialog() to show 
the page setup dialog and receive the resulting page setup.
</para>
<example>
<title>A page setup dialog</title>
<programlisting>
static GtkPrintSettings *settings = NULL;
static GtkPageSetup *page_setup = NULL;

static void
do_page_setup (void)
{
  GtkPageSetup *new_page_setup;

  if (settings == NULL)
    settings = gtk_print_settings_new (<!-- -->);

  new_page_setup = gtk_print_run_page_setup_dialog (GTK_WINDOW (main_window),
                                                    page_setup, settings);

  if (page_setup)
    g_object_unref (page_setup);

  page_setup = new_page_setup;
}
</programlisting>
</example>
<para>
Printing support was added in GTK+ 2.10.
</para>

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

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkPageSetup ##### -->
<para>

</para>


<!-- ##### FUNCTION gtk_page_setup_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_page_setup_copy ##### -->
<para>

</para>

@other: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_get_orientation ##### -->
<para>

</para>

@setup: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_set_orientation ##### -->
<para>

</para>

@setup: 
@orientation: 


<!-- ##### FUNCTION gtk_page_setup_get_paper_size ##### -->
<para>

</para>

@setup: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_set_paper_size ##### -->
<para>

</para>

@setup: 
@size: 


<!-- ##### FUNCTION gtk_page_setup_get_top_margin ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_set_top_margin ##### -->
<para>

</para>

@setup: 
@margin: 
@unit: 


<!-- ##### FUNCTION gtk_page_setup_get_bottom_margin ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_set_bottom_margin ##### -->
<para>

</para>

@setup: 
@margin: 
@unit: 


<!-- ##### FUNCTION gtk_page_setup_get_left_margin ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_set_left_margin ##### -->
<para>

</para>

@setup: 
@margin: 
@unit: 


<!-- ##### FUNCTION gtk_page_setup_get_right_margin ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_set_right_margin ##### -->
<para>

</para>

@setup: 
@margin: 
@unit: 


<!-- ##### FUNCTION gtk_page_setup_set_paper_size_and_default_margins ##### -->
<para>

</para>

@setup: 
@size: 


<!-- ##### FUNCTION gtk_page_setup_get_paper_width ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_get_paper_height ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_get_page_width ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_get_page_height ##### -->
<para>

</para>

@setup: 
@unit: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_new_from_file ##### -->
<para>

</para>

@file_name: 
@error: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_new_from_key_file ##### -->
<para>

</para>

@key_file: 
@group_name: 
@error: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_to_file ##### -->
<para>

</para>

@setup: 
@file_name: 
@error: 
@Returns: 


<!-- ##### FUNCTION gtk_page_setup_to_key_file ##### -->
<para>

</para>

@setup: 
@key_file: 
@group_name: