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
|
// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_PAGESETUP_H
#define _GTKMM_PAGESETUP_H
#include <glibmm.h>
/* Copyright (C) 2006 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <gtkmm/enums.h>
#include <gtkmm/papersize.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkPageSetup GtkPageSetup;
typedef struct _GtkPageSetupClass GtkPageSetupClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class PageSetup_Class; } // namespace Gtk
namespace Gtk
{
/** A PageSetup object stores the page size, orientation and margins. You can get one of these from the page setup dialog
* and then pass it to the PrintOperation when printing. The benefit of splitting this out of the PrintSettings is that
* these affect the actual layout of the page, and thus need to be set long before the user prints.
*
* 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
* minimal size for the layout margins.
*
* To obtain a PageSetup use PageSetup::create() to get the defaults, or use run_page_setup_dialog() to show the page
* setup dialog and receive the resulting page setup.
*
* @newin2p10
*
* @ingroup Printing
*/
class PageSetup : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef PageSetup CppObjectType;
typedef PageSetup_Class CppClassType;
typedef GtkPageSetup BaseObjectType;
typedef GtkPageSetupClass BaseClassType;
private: friend class PageSetup_Class;
static CppClassType pagesetup_class_;
private:
// noncopyable
PageSetup(const PageSetup&);
PageSetup& operator=(const PageSetup&);
protected:
explicit PageSetup(const Glib::ConstructParams& construct_params);
explicit PageSetup(GtkPageSetup* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~PageSetup();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_type() G_GNUC_CONST;
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkPageSetup* gobj() { return reinterpret_cast<GtkPageSetup*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkPageSetup* gobj() const { return reinterpret_cast<GtkPageSetup*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkPageSetup* gobj_copy();
private:
protected:
PageSetup();
#if 0 //TODO: Reimplement, or add _construct_from_* functions in GTK+. See bug #475565 .
GtkPageSetup *gtk_page_setup_new_from_file (const gchar *file_name,
GError **error);
GtkPageSetup *gtk_page_setup_new_from_key_file (GKeyFile *key_file,
const gchar *group_name,
GError **error);
#endif
public:
static Glib::RefPtr<PageSetup> create();
/** Gets the page orientation of the Gtk::PageSetup.
* @return The page orientation
*
* @newin2p10.
*/
PageOrientation get_orientation() const;
/** Sets the page orientation of the Gtk::PageSetup.
*
* @newin2p10
* @param orientation A Gtk::PageOrientation value.
*/
void set_orientation(PageOrientation orientation);
/** Gets the paper size of the Gtk::PageSetup.
* @return The paper size
*
* @newin2p10.
*/
PaperSize get_paper_size();
/** Gets the paper size of the Gtk::PageSetup.
* @return The paper size
*
* @newin2p10.
*/
const PaperSize get_paper_size() const;
/** Sets the paper size of the Gtk::PageSetup without
* changing the margins. See
* gtk_page_setup_set_paper_size_and_default_margins().
*
* @newin2p10
* @param size A Gtk::PaperSize.
*/
void set_paper_size(const PaperSize& paper_size);
/** Gets the top margin in units of @a unit .
* @param unit The unit for the return value.
* @return The top margin
*
* @newin2p10.
*/
double get_top_margin(Unit unit) const;
/** Sets the top margin of the Gtk::PageSetup.
*
* @newin2p10
* @param margin The new top margin in units of @a unit .
* @param unit The units for @a margin .
*/
void set_top_margin(double margin, Unit unit);
/** Gets the bottom margin in units of @a unit .
* @param unit The unit for the return value.
* @return The bottom margin
*
* @newin2p10.
*/
double get_bottom_margin(Unit unit) const;
/** Sets the bottom margin of the Gtk::PageSetup.
*
* @newin2p10
* @param margin The new bottom margin in units of @a unit .
* @param unit The units for @a margin .
*/
void set_bottom_margin(double margin, Unit unit);
/** Gets the left margin in units of @a unit .
* @param unit The unit for the return value.
* @return The left margin
*
* @newin2p10.
*/
double get_left_margin(Unit unit) const;
/** Sets the left margin of the Gtk::PageSetup.
*
* @newin2p10
* @param margin The new left margin in units of @a unit .
* @param unit The units for @a margin .
*/
void set_left_margin(double margin, Unit unit);
/** Gets the right margin in units of @a unit .
* @param unit The unit for the return value.
* @return The right margin
*
* @newin2p10.
*/
double get_right_margin(Unit unit) const;
/** Sets the right margin of the Gtk::PageSetup.
*
* @newin2p10
* @param margin The new right margin in units of @a unit .
* @param unit The units for @a margin .
*/
void set_right_margin(double margin, Unit unit);
/** Sets the paper size of the Gtk::PageSetup and modifies
* the margins according to the new paper size.
*
* @newin2p10
* @param size A Gtk::PaperSize.
*/
void set_paper_size_and_default_margins(const PaperSize& paper_size);
/** Return value: the paper width.
* @param unit The unit for the return value.
* @return The paper width.
*
* @newin2p10.
*/
double get_paper_width(Unit unit) const;
/** Return value: the paper height.
* @param unit The unit for the return value.
* @return The paper height.
*
* @newin2p10.
*/
double get_paper_height(Unit unit) const;
/** Return value: the page width.
* @param unit The unit for the return value.
* @return The page width.
*
* @newin2p10.
*/
double get_page_width(Unit unit) const;
/** Return value: the page height.
* @param unit The unit for the return value.
* @return The page height.
*
* @newin2p10.
*/
double get_page_height(Unit unit) const;
//The save_ prefix was added to these functions to make them clearer. GTK+ didn't want to change them.
/** This function saves the information from @a setup to @a file_name .
* @a throws Glib::FileError
* @param file_name The file to save to.
* @return <tt>true</tt> on success
*
* @newin2p12.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
bool save_to_file(const std::string& file_name) const;
#else
bool save_to_file(const std::string& file_name, std::auto_ptr<Glib::Error>& error) const;
#endif //GLIBMM_EXCEPTIONS_ENABLED
/** This function adds the page setup from @a setup to @a key_file .
*
* @newin2p12
* @param key_file The Glib::KeyFile to save the page setup to.
* @param group_name The group to add the settings to in @a key_file .
*/
void save_to_key_file(Glib::KeyFile& key_file, const Glib::ustring& group_name);
/** This function adds the page setup from @a setup to @a key_file,
* in the group "Page Setup"
*
* @newin2p12
* @param key_file The G::KeyFile to save the page setup to.
*/
void save_to_key_file(Glib::KeyFile& key_file);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
protected:
//GTK+ Virtual Functions (override these to change behaviour):
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED
//Default Signal Handlers::
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::PageSetup
*/
Glib::RefPtr<Gtk::PageSetup> wrap(GtkPageSetup* object, bool take_copy = false);
}
#endif /* _GTKMM_PAGESETUP_H */
|
