gtkmm: Gtk::PageSetup Class Reference

A PageSetup object stores the page size, orientation and margins. More...

#include <gtkmm/pagesetup.h>

Inheritance diagram for Gtk::PageSetup:

Public Member Functions
	PageSetup (PageSetup && src) noexcept

PageSetup &	operator= (PageSetup && src) noexcept

	~PageSetup () noexcept override

GtkPageSetup *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkPageSetup *	gobj () const
	Provides access to the underlying C GObject. More...

GtkPageSetup *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< PageSetup >	copy () const
	Copies a `Gtk::PageSetup`. More...

bool	load_from_file (const std::string & file_name)
	Reads the page setup from the file file_name. More...

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. More...

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. More...

PageOrientation	get_orientation () const
	Gets the page orientation of the `Gtk::PageSetup`. More...

void	set_orientation (PageOrientation orientation)
	Sets the page orientation of the `Gtk::PageSetup`. More...

PaperSize	get_paper_size ()
	Gets the paper size of the `Gtk::PageSetup`. More...

const PaperSize	get_paper_size () const
	Gets the paper size of the `Gtk::PageSetup`. More...

void	set_paper_size (const PaperSize &size)
	Sets the paper size of the `Gtk::PageSetup` without changing the margins. More...

double	get_top_margin (Unit unit) const
	Gets the top margin in units of unit. More...

void	set_top_margin (double margin, Unit unit)
	Sets the top margin of the `Gtk::PageSetup`. More...

double	get_bottom_margin (Unit unit) const
	Gets the bottom margin in units of unit. More...

void	set_bottom_margin (double margin, Unit unit)
	Sets the bottom margin of the `Gtk::PageSetup`. More...

double	get_left_margin (Unit unit) const
	Gets the left margin in units of unit. More...

void	set_left_margin (double margin, Unit unit)
	Sets the left margin of the `Gtk::PageSetup`. More...

double	get_right_margin (Unit unit) const
	Gets the right margin in units of unit. More...

void	set_right_margin (double margin, Unit unit)
	Sets the right margin of the `Gtk::PageSetup`. More...

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. More...

double	get_paper_width (Unit unit) const
	Returns the paper width in units of unit. More...

double	get_paper_height (Unit unit) const
	Returns the paper height in units of unit. More...

double	get_page_width (Unit unit) const
	Returns the page width in units of unit. More...

double	get_page_height (Unit unit) const
	Returns the page height in units of unit. More...

bool	save_to_file (const std::string & file_name) const
	This function saves the information from setup to file_name. More...

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. More...

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". More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

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. More...

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. More...

static Glib::RefPtr< PageSetup >	create_from_file (const std::string & file_name)
	Reads the page setup from the file file_name. More...

Protected Member Functions
	PageSetup ()

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::PageSetup >	wrap (GtkPageSetup * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

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.

Since gtkmm 2.10:

Constructor & Destructor Documentation

◆ PageSetup() [1/2]

Gtk::PageSetup::PageSetup ( PageSetup && src )

noexcept

◆ ~PageSetup()

Gtk::PageSetup::~PageSetup ( )

overridenoexcept

◆ PageSetup() [2/2]

Gtk::PageSetup::PageSetup ( )

protected

Member Function Documentation

◆ copy()

Glib::RefPtr< PageSetup > Gtk::PageSetup::copy ( ) const

Copies a Gtk::PageSetup.

Returns: A copy of other.

◆ create()

static Glib::RefPtr< PageSetup > Gtk::PageSetup::create ( )

static

◆ create_from_file()

static Glib::RefPtr< PageSetup > Gtk::PageSetup::create_from_file ( const std::string & file_name )

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().

Parameters

file_name The filename to read the page setup from.

Returns: The restored PageSetup

Since gtkmm 2.14:

◆ create_from_key_file() [1/2]

static Glib::RefPtr< PageSetup > Gtk::PageSetup::create_from_key_file ( const Glib::RefPtr< const Glib::KeyFile > & key_file )

static

Reads the page setup from the "Page Setup" group in the key file key_file.

Returns a new PageSetup object with the restored page setup, or an empty RefPtr if an error occurred.

Parameters

key_file The KeyFile to retrieve the page setup from.

Returns: The restored PageSetup

Exceptions

KeyFileError

Since gtkmm 2.14:

◆ create_from_key_file() [2/2]

static Glib::RefPtr< PageSetup > Gtk::PageSetup::create_from_key_file	(	const Glib::RefPtr< const Glib::KeyFile > &	key_file,
		const Glib::ustring &	group_name
	)

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.

Parameters

key_file	The KeyFile to retrieve the page setup from.
group_name	The name of the group in the key_file to read.

Returns: The restored PageSetup

Exceptions

KeyFileError

Since gtkmm 2.14:

◆ get_bottom_margin()

double Gtk::PageSetup::get_bottom_margin ( Unit unit ) const

Gets the bottom margin in units of unit.

Parameters

unit	The unit for the return value.

Returns: The bottom margin.

◆ get_left_margin()

double Gtk::PageSetup::get_left_margin ( Unit unit ) const

Gets the left margin in units of unit.

Parameters

unit	The unit for the return value.

Returns: The left margin.

◆ get_orientation()

PageOrientation Gtk::PageSetup::get_orientation ( ) const

Gets the page orientation of the Gtk::PageSetup.

Returns: The page orientation.

◆ get_page_height()

double Gtk::PageSetup::get_page_height ( Unit unit ) const

Returns the page height in units of unit.

Note that this function takes orientation and margins into consideration. See get_paper_height().

Parameters

unit	The unit for the return value.

Returns: The page height.

◆ get_page_width()

double Gtk::PageSetup::get_page_width ( Unit unit ) const

Returns the page width in units of unit.

Note that this function takes orientation and margins into consideration. See get_paper_width().

Parameters

unit	The unit for the return value.

Returns: The page width.

◆ get_paper_height()

double Gtk::PageSetup::get_paper_height ( Unit unit ) const

Returns the paper height in units of unit.

Note that this function takes orientation, but not margins into consideration. See get_page_height().

Parameters

unit	The unit for the return value.

Returns: The paper height.

◆ get_paper_size() [1/2]

PaperSize Gtk::PageSetup::get_paper_size ( )

Gets the paper size of the Gtk::PageSetup.

Returns: The paper size.

◆ get_paper_size() [2/2]

const PaperSize Gtk::PageSetup::get_paper_size ( ) const

Gets the paper size of the Gtk::PageSetup.

Returns: The paper size.

◆ get_paper_width()

double Gtk::PageSetup::get_paper_width ( Unit unit ) const

Returns the paper width in units of unit.

Note that this function takes orientation, but not margins into consideration. See get_page_width().

Parameters

unit	The unit for the return value.

Returns: The paper width.

◆ get_right_margin()

double Gtk::PageSetup::get_right_margin ( Unit unit ) const

Gets the right margin in units of unit.

Parameters

unit	The unit for the return value.

Returns: The right margin.

◆ get_top_margin()

double Gtk::PageSetup::get_top_margin ( Unit unit ) const

Gets the top margin in units of unit.

Parameters

unit	The unit for the return value.

Returns: The top margin.

◆ get_type()

static GType Gtk::PageSetup::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkPageSetup * Gtk::PageSetup::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkPageSetup * Gtk::PageSetup::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

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.

◆ load_from_file()

bool Gtk::PageSetup::load_from_file ( const std::string & file_name )

Reads the page setup from the file file_name.

See to_file().

Parameters

file_name The filename to read the page setup from.

Returns: true on success.

Exceptions

Glib::Error

◆ load_from_key_file() [1/2]

bool Gtk::PageSetup::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.

Parameters

key_file The KeyFile to retrieve the page setup from.

Returns: true on success

Exceptions

KeyFileError

Since gtkmm 2.14:

◆ load_from_key_file() [2/2]

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.

Parameters

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”.

Returns: true on success.

Exceptions

Glib::Error

◆ operator=()

PageSetup & Gtk::PageSetup::operator= ( PageSetup && src )

noexcept

◆ save_to_file()

bool Gtk::PageSetup::save_to_file ( const std::string & file_name ) const

This function saves the information from setup to file_name.

Exceptions

Glib::FileError

Since gtkmm 2.12:

Parameters

file_name The file to save to.

Returns: true on success.

◆ save_to_key_file() [1/2]

void Gtk::PageSetup::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".

Since gtkmm 2.12:

Parameters

key_file The G::KeyFile to save the page setup to.

◆ save_to_key_file() [2/2]

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.

Parameters

key_file	The Glib::KeyFile to save the page setup to.
group_name	The group to add the settings to in key_file.

◆ set_bottom_margin()

void Gtk::PageSetup::set_bottom_margin	(	double	margin,
		Unit	unit
	)

Sets the bottom margin of the Gtk::PageSetup.

Parameters

margin	The new bottom margin in units of unit.
unit	The units for margin.

◆ set_left_margin()

void Gtk::PageSetup::set_left_margin	(	double	margin,
		Unit	unit
	)

Sets the left margin of the Gtk::PageSetup.

Parameters

margin	The new left margin in units of unit.
unit	The units for margin.

◆ set_orientation()

void Gtk::PageSetup::set_orientation ( PageOrientation orientation )

Sets the page orientation of the Gtk::PageSetup.

Parameters

orientation A Gtk::PageOrientation value.

◆ set_paper_size()

void Gtk::PageSetup::set_paper_size ( const PaperSize & size )

Sets the paper size of the Gtk::PageSetup without changing the margins.

See set_paper_size_and_default_margins().

Parameters

size	A `Gtk::PaperSize`.

◆ set_paper_size_and_default_margins()

void Gtk::PageSetup::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.

Parameters

size	A `Gtk::PaperSize`.

◆ set_right_margin()

void Gtk::PageSetup::set_right_margin	(	double	margin,
		Unit	unit
	)

Sets the right margin of the Gtk::PageSetup.

Parameters

margin	The new right margin in units of unit.
unit	The units for margin.

◆ set_top_margin()

void Gtk::PageSetup::set_top_margin	(	double	margin,
		Unit	unit
	)

Sets the top margin of the Gtk::PageSetup.

Parameters

margin	The new top margin in units of unit.
unit	The units for margin.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::PageSetup > wrap	(	GtkPageSetup *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

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.

Returns: A C++ instance that wraps this C instance.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ PageSetup() [1/2]

◆ ~PageSetup()

◆ PageSetup() [2/2]

Member Function Documentation

◆ copy()

◆ create()

◆ create_from_file()

◆ create_from_key_file() [1/2]

◆ create_from_key_file() [2/2]

◆ get_bottom_margin()

◆ get_left_margin()

◆ get_orientation()

◆ get_page_height()

◆ get_page_width()

◆ get_paper_height()

◆ get_paper_size() [1/2]

◆ get_paper_size() [2/2]

◆ get_paper_width()

◆ get_right_margin()

◆ get_top_margin()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ load_from_file()

◆ load_from_key_file() [1/2]

◆ load_from_key_file() [2/2]

◆ operator=()

◆ save_to_file()

◆ save_to_key_file() [1/2]

◆ save_to_key_file() [2/2]

◆ set_bottom_margin()

◆ set_left_margin()

◆ set_orientation()

◆ set_paper_size()

◆ set_paper_size_and_default_margins()

◆ set_right_margin()

◆ set_top_margin()

Friends And Related Function Documentation

◆ wrap()