gtkmm 4.16.0
|
A PageSetup object stores the page size, orientation and margins. More...
#include <gtkmm/pagesetup.h>
Public Member Functions | |
PageSetup (PageSetup &&src) noexcept | |
PageSetup & | operator= (PageSetup &&src) noexcept |
~PageSetup () noexcept override | |
GtkPageSetup * | gobj () |
Provides access to the underlying C GObject. | |
const GtkPageSetup * | gobj () const |
Provides access to the underlying C GObject. | |
GtkPageSetup * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
Glib::RefPtr< PageSetup > | copy () const |
Copies a Gtk::PageSetup . | |
bool | load_from_file (const std::string &file_name) |
Reads the page setup from the file file_name. | |
bool | load_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file, const Glib::ustring &group_name) |
Reads the page setup from the group group_name in the key file key_file. | |
bool | load_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file) |
Reads the page setup from the "Page Setup" group in the key file key_file. | |
PageOrientation | get_orientation () const |
Gets the page orientation of the Gtk::PageSetup . | |
void | set_orientation (PageOrientation orientation) |
Sets the page orientation of the Gtk::PageSetup . | |
PaperSize | get_paper_size () |
Gets the paper size of the Gtk::PageSetup . | |
const PaperSize | get_paper_size () const |
Gets the paper size of the Gtk::PageSetup . | |
void | set_paper_size (const PaperSize &size) |
Sets the paper size of the Gtk::PageSetup without changing the margins. | |
double | get_top_margin (Unit unit) const |
Gets the top margin in units of unit. | |
void | set_top_margin (double margin, Unit unit) |
Sets the top margin of the Gtk::PageSetup . | |
double | get_bottom_margin (Unit unit) const |
Gets the bottom margin in units of unit. | |
void | set_bottom_margin (double margin, Unit unit) |
Sets the bottom margin of the Gtk::PageSetup . | |
double | get_left_margin (Unit unit) const |
Gets the left margin in units of unit. | |
void | set_left_margin (double margin, Unit unit) |
Sets the left margin of the Gtk::PageSetup . | |
double | get_right_margin (Unit unit) const |
Gets the right margin in units of unit. | |
void | set_right_margin (double margin, Unit unit) |
Sets the right margin of the Gtk::PageSetup . | |
void | set_paper_size_and_default_margins (const PaperSize &size) |
Sets the paper size of the Gtk::PageSetup and modifies the margins according to the new paper size. | |
double | get_paper_width (Unit unit) const |
Returns the paper width in units of unit. | |
double | get_paper_height (Unit unit) const |
Returns the paper height in units of unit. | |
double | get_page_width (Unit unit) const |
Returns the page width in units of unit. | |
double | get_page_height (Unit unit) const |
Returns the page height in units of unit. | |
bool | save_to_file (const std::string &file_name) const |
This function saves the information from setup to file_name. | |
void | save_to_key_file (const Glib::RefPtr< Glib::KeyFile > &key_file, const Glib::ustring &group_name) const |
This function adds the page setup from setup to key_file. | |
void | save_to_key_file (const Glib::RefPtr< Glib::KeyFile > &key_file) const |
This function adds the page setup from setup to key_file, in the group "Page Setup". | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
static Glib::RefPtr< PageSetup > | create () |
static Glib::RefPtr< PageSetup > | create_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file) |
Reads the page setup from the "Page Setup" group in the key file key_file. | |
static Glib::RefPtr< PageSetup > | create_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file, const Glib::ustring &group_name) |
Reads the page setup from the group group_name in the key file key_file. | |
static Glib::RefPtr< PageSetup > | create_from_file (const std::string &file_name) |
Reads the page setup from the file file_name. | |
Protected Member Functions | |
PageSetup () | |
Related Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Gtk::PageSetup > | wrap (GtkPageSetup *object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
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.
|
noexcept |
|
overridenoexcept |
|
protected |
Glib::RefPtr< PageSetup > Gtk::PageSetup::copy | ( | ) | const |
Copies a Gtk::PageSetup
.
|
static |
Reads the page setup from the file file_name.
Returns a new PageSetup object with the restored page setup, or an empty RefPtr if an error occurred. See save_to_file().
file_name | The filename to read the page setup from. |
|
static |
Reads the page setup from the group group_name in the key file key_file.
Returns a new PageSetup object with the restored page setup, or an empty RefPtr if an error occurred.
key_file | The KeyFile to retrieve the page setup from. |
group_name | The name of the group in the key_file to read. |
KeyFileError |
Gets the bottom margin in units of unit.
unit | The unit for the return value. |
Gets the left margin in units of unit.
unit | The unit for the return value. |
PageOrientation Gtk::PageSetup::get_orientation | ( | ) | const |
Gets the page orientation of the Gtk::PageSetup
.
Returns the page height in units of unit.
Note that this function takes orientation and margins into consideration. See get_paper_height().
unit | The unit for the return value. |
Returns the page width in units of unit.
Note that this function takes orientation and margins into consideration. See get_paper_width().
unit | The unit for the return value. |
Returns the paper height in units of unit.
Note that this function takes orientation, but not margins into consideration. See get_page_height().
unit | The unit for the return value. |
PaperSize Gtk::PageSetup::get_paper_size | ( | ) |
Gets the paper size of the Gtk::PageSetup
.
Gets the paper size of the Gtk::PageSetup
.
Returns the paper width in units of unit.
Note that this function takes orientation, but not margins into consideration. See get_page_width().
unit | The unit for the return value. |
Gets the right margin in units of unit.
unit | The unit for the return value. |
Gets the top margin in units of unit.
unit | The unit for the return value. |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkPageSetup * Gtk::PageSetup::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gtk::PageSetup::load_from_file | ( | const std::string & | file_name | ) |
Reads the page setup from the file file_name.
See to_file().
file_name | The filename to read the page setup from. |
true
on success.Glib::Error |
Reads the page setup from the "Page Setup" group in the key file key_file.
key_file | The KeyFile to retrieve the page setup from. |
KeyFileError |
bool Gtk::PageSetup::load_from_key_file | ( | const Glib::RefPtr< const Glib::KeyFile > & | key_file, |
const Glib::ustring & | group_name | ||
) |
Reads the page setup from the group group_name in the key file key_file.
key_file | The Glib::KeyFile to retrieve the page_setup from. |
group_name | The name of the group in the key_file to read to use the default name “Page Setup”. |
true
on success.Glib::Error |
bool Gtk::PageSetup::save_to_file | ( | const std::string & | file_name | ) | const |
This function saves the information from setup to file_name.
file_name | The file to save to. |
true
on success.Glib::FileError |
This function adds the page setup from setup to key_file, in the group "Page Setup".
key_file | The Glib::KeyFile to save the page setup to. |
void Gtk::PageSetup::save_to_key_file | ( | const Glib::RefPtr< Glib::KeyFile > & | key_file, |
const Glib::ustring & | group_name | ||
) | const |
This function adds the page setup from setup to key_file.
key_file | The Glib::KeyFile to save the page setup to. |
group_name | The group to add the settings to in key_file. |
Sets the bottom margin of the Gtk::PageSetup
.
margin | The new bottom margin in units of unit. |
unit | The units for margin. |
Sets the left margin of the Gtk::PageSetup
.
margin | The new left margin in units of unit. |
unit | The units for margin. |
void Gtk::PageSetup::set_orientation | ( | PageOrientation | orientation | ) |
Sets the page orientation of the Gtk::PageSetup
.
orientation | A Gtk::PageOrientation value. |
Sets the paper size of the Gtk::PageSetup
without changing the margins.
See set_paper_size_and_default_margins().
size | A Gtk::PaperSize . |
Sets the paper size of the Gtk::PageSetup
and modifies the margins according to the new paper size.
size | A Gtk::PaperSize . |
Sets the right margin of the Gtk::PageSetup
.
margin | The new right margin in units of unit. |
unit | The units for margin. |
Sets the top margin of the Gtk::PageSetup
.
margin | The new top margin in units of unit. |
unit | The units for margin. |
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |