gtkmm: Gtk::PrintSettings Class Reference

A PrintSettings object represents the settings of a print dialog in a system-independent way. More...

#include <gtkmm/printsettings.h>

Inheritance diagram for Gtk::PrintSettings:

Classes
class	Keys
	Print settings keys. More...

Public Types
typedef sigc::slot< void(const Glib::ustring &, const Glib::ustring &)>	SlotForeach
	For example, void on_foreach_setting(const Glib::ustring& key, const Glib::ustring& value);.

Public Member Functions
	PrintSettings (PrintSettings &&src) noexcept

PrintSettings &	operator= (PrintSettings &&src) noexcept

	~PrintSettings () noexcept override

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

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

GtkPrintSettings *	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< PrintSettings >	copy () const
	Copies a `Gtk::PrintSettings` object.

bool	load_from_file (const std::string &file_name)
	Reads the print settings from file_name.

bool	load_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file, const Glib::ustring &group_name)
	Reads the print settings from the group group_name in key_file.

bool	load_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file)
	Reads the print settings from the key_file.

bool	save_to_file (const std::string &file_name) const
	This function saves the print settings from settings 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 print settings from settings to key_file.

void	save_to_key_file (const Glib::RefPtr< Glib::KeyFile > &key_file) const
	This function adds the print settings from settings to key_file, in the "Print Settings" group.

bool	has_key (const Glib::ustring &key) const
	Returns `true`, if a value is associated with key.

Glib::ustring	get (const Glib::ustring &key) const
	Looks up the string value associated with key.

void	set (const Glib::ustring &key, const Glib::ustring & value)
	Associates value with key.

void	unset (const Glib::ustring &key)
	Removes any value associated with key.

void	setting_foreach (const SlotForeach &slot)
	Calls a function for each print setting.

bool	get_bool (const Glib::ustring &key) const
	Returns the boolean represented by the value that is associated with key.

void	set_bool (const Glib::ustring &key, bool value=true)
	Sets key to a boolean value.

double	get_double (const Glib::ustring &key) const
	Returns the double value associated with key, or 0.

double	get_double_with_default (const Glib::ustring &key, double def) const
	Returns the floating point number represented by the value that is associated with key, or default_val if the value does not represent a floating point number.

void	set_double (const Glib::ustring &key, double value)
	Sets key to a double value.

double	get_length (const Glib::ustring &key, Unit unit) const
	Returns the value associated with key, interpreted as a length.

void	set_length (const Glib::ustring &key, double value, Unit unit)
	Associates a length in units of unit with key.

int	get_int (const Glib::ustring &key) const
	Returns the integer value of key, or 0.

int	get_int_with_default (const Glib::ustring &key, int def) const
	Returns the value of key, interpreted as an integer, or the default value.

void	set_int (const Glib::ustring &key, int value)
	Sets key to an integer value.

Glib::ustring	get_printer () const
	Convenience function to obtain the value of GTK_PRINT_SETTINGS_PRINTER.

void	set_printer (const Glib::ustring &printer)
	Convenience function to set GTK_PRINT_SETTINGS_PRINTER to printer.

PageOrientation	get_orientation () const
	Get the value of GTK_PRINT_SETTINGS_ORIENTATION, converted to a `Gtk::PageOrientation`.

void	set_orientation (PageOrientation orientation)
	Sets the value of GTK_PRINT_SETTINGS_ORIENTATION.

PaperSize	get_paper_size ()
	Gets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a `Gtk::PaperSize`.

const PaperSize	get_paper_size () const
	Gets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a `Gtk::PaperSize`.

void	set_paper_size (const PaperSize &paper_size)
	Sets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, GTK_PRINT_SETTINGS_PAPER_WIDTH and GTK_PRINT_SETTINGS_PAPER_HEIGHT.

double	get_paper_width (Unit unit) const
	Gets the value of GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to unit.

void	set_paper_width (double width, Unit unit)
	Sets the value of GTK_PRINT_SETTINGS_PAPER_WIDTH.

double	get_paper_height (Unit unit) const
	Gets the value of GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to unit.

void	set_paper_height (double height, Unit unit)
	Sets the value of GTK_PRINT_SETTINGS_PAPER_HEIGHT.

bool	get_use_color () const
	Gets the value of GTK_PRINT_SETTINGS_USE_COLOR.

void	set_use_color (bool use_color=true)
	Sets the value of GTK_PRINT_SETTINGS_USE_COLOR.

bool	get_collate () const
	Gets the value of GTK_PRINT_SETTINGS_COLLATE.

void	set_collate (bool collate=true)
	Sets the value of GTK_PRINT_SETTINGS_COLLATE.

bool	get_reverse () const
	Gets the value of GTK_PRINT_SETTINGS_REVERSE.

void	set_reverse (bool reverse=true)
	Sets the value of GTK_PRINT_SETTINGS_REVERSE.

PrintDuplex	get_duplex () const
	Gets the value of GTK_PRINT_SETTINGS_DUPLEX.

void	set_duplex (PrintDuplex duplex)
	Sets the value of GTK_PRINT_SETTINGS_DUPLEX.

PrintQuality	get_quality () const
	Gets the value of GTK_PRINT_SETTINGS_QUALITY.

void	set_quality (PrintQuality quality)
	Sets the value of GTK_PRINT_SETTINGS_QUALITY.

int	get_n_copies () const
	Gets the value of GTK_PRINT_SETTINGS_N_COPIES.

void	set_n_copies (int num_copies)
	Sets the value of GTK_PRINT_SETTINGS_N_COPIES.

int	get_number_up () const
	Gets the value of GTK_PRINT_SETTINGS_NUMBER_UP.

void	set_number_up (int number_up)
	Sets the value of GTK_PRINT_SETTINGS_NUMBER_UP.

NumberUpLayout	get_number_up_layout () const
	Gets the value of GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

void	set_number_up (NumberUpLayout number_up_layout)
	Sets the value of GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

int	get_resolution () const
	Gets the value of GTK_PRINT_SETTINGS_RESOLUTION.

void	set_resolution (int resolution)
	Sets the values of GTK_PRINT_SETTINGS_RESOLUTION, GTK_PRINT_SETTINGS_RESOLUTION_X and GTK_PRINT_SETTINGS_RESOLUTION_Y.

int	get_resolution_x () const
	Gets the value of GTK_PRINT_SETTINGS_RESOLUTION_X.

int	get_resolution_y () const
	Gets the value of GTK_PRINT_SETTINGS_RESOLUTION_Y.

void	set_resolution_xy (int resolution_x, int resolution_y)
	Sets the values of GTK_PRINT_SETTINGS_RESOLUTION, GTK_PRINT_SETTINGS_RESOLUTION_X and GTK_PRINT_SETTINGS_RESOLUTION_Y.

double	get_printer_lpi () const
	Gets the value of GTK_PRINT_SETTINGS_PRINTER_LPI.

void	set_printer_lpi (double lpi)
	Sets the value of GTK_PRINT_SETTINGS_PRINTER_LPI.

double	get_scale () const
	Gets the value of GTK_PRINT_SETTINGS_SCALE.

void	set_scale (double scale)
	Sets the value of GTK_PRINT_SETTINGS_SCALE.

PrintPages	get_print_pages () const
	Gets the value of GTK_PRINT_SETTINGS_PRINT_PAGES.

void	set_print_pages (PrintPages pages)
	Sets the value of GTK_PRINT_SETTINGS_PRINT_PAGES.

std::vector< PageRange >	get_page_ranges () const

void	set_page_ranges (const std::vector< PageRange > &page_ranges)

PageSet	get_page_set () const
	Gets the value of GTK_PRINT_SETTINGS_PAGE_SET.

void	set_page_set (PageSet page_set)
	Sets the value of GTK_PRINT_SETTINGS_PAGE_SET.

Glib::ustring	get_default_source () const
	Gets the value of GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

void	set_default_source (const Glib::ustring &default_source)
	Sets the value of GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

Glib::ustring	get_media_type () const
	Gets the value of GTK_PRINT_SETTINGS_MEDIA_TYPE.

void	set_media_type (const Glib::ustring &media_type)
	Sets the value of GTK_PRINT_SETTINGS_MEDIA_TYPE.

Glib::ustring	get_dither () const
	Gets the value of GTK_PRINT_SETTINGS_DITHER.

void	set_dither (const Glib::ustring &dither)
	Sets the value of GTK_PRINT_SETTINGS_DITHER.

Glib::ustring	get_finishings () const
	Gets the value of GTK_PRINT_SETTINGS_FINISHINGS.

void	set_finishings (const Glib::ustring &finishings)
	Sets the value of GTK_PRINT_SETTINGS_FINISHINGS.

Glib::ustring	get_output_bin () const
	Gets the value of GTK_PRINT_SETTINGS_OUTPUT_BIN.

void	set_output_bin (const Glib::ustring &output_bin)
	Sets the value of GTK_PRINT_SETTINGS_OUTPUT_BIN.

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< PrintSettings >	create ()

static Glib::RefPtr< PrintSettings >	create_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file)
	Reads the print settings from the key_file.

static Glib::RefPtr< PrintSettings >	create_from_key_file (const Glib::RefPtr< const Glib::KeyFile > &key_file, const Glib::ustring &group_name)
	Reads the print settings from the group group_name in key_file.

static Glib::RefPtr< PrintSettings >	create_from_file (const std::string &file_name)
	Reads the print settings from file_name.

Protected Member Functions
	PrintSettings ()

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gtk::PrintSettings >	wrap (GtkPrintSettings *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

A PrintSettings object represents the settings of a print dialog in a system-independent way.

The main use for this object is that once you've printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so that the user doesn't have to re-set all his settings.

It's also possible to enumerate the settings so that you can easily save the settings for the next time your app runs, or even store them in a document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works.

Member Typedef Documentation

◆ SlotForeach

typedef sigc::slot<void(const Glib::ustring&, const Glib::ustring&)> Gtk::PrintSettings::SlotForeach

For example, void on_foreach_setting(const Glib::ustring& key, const Glib::ustring& value);.

Constructor & Destructor Documentation

◆ PrintSettings() [1/2]

Gtk::PrintSettings::PrintSettings ( PrintSettings && src )

noexcept

◆ ~PrintSettings()

Gtk::PrintSettings::~PrintSettings ( )

overridenoexcept

◆ PrintSettings() [2/2]

Gtk::PrintSettings::PrintSettings ( )

protected

Member Function Documentation

◆ copy()

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

Copies a Gtk::PrintSettings object.

Returns: A newly allocated copy of other.

◆ create()

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

static

◆ create_from_file()

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

static

Reads the print settings from file_name.

Returns a new PrintSettings object with the restored settings, or an empty RefPtr if an error occurred. See save_to_file().

Parameters

file_name The filename to read the settings from.

Returns: the restored PrintSettings

Exceptions

Glib::KeyFileError,Glib::FileError

◆ create_from_key_file() [1/2]

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

static

Reads the print settings from the key_file.

Returns a new PrintSettings object with the restored settings, or an empty RefPtr if an error occurred. See save_to_key_file().

Parameters

key_file The KeyFile to retrieve the settings from.

Returns: The restored PrintSettings

Exceptions

Glib::KeyFileError,Glib::FileError

◆ create_from_key_file() [2/2]

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

static

Reads the print settings from the group group_name in key_file.

Returns a new PrintSettings object with the restored settings, or an empty RefPtr if an error occurred. See save_to_key_file().

Parameters

key_file	The KeyFile to retrieve the settings from.
group_name	The name of the group to use.

Returns: The restored PrintSettings

Exceptions

Glib::KeyFileError,Glib::FileError

◆ get()

Glib::ustring Gtk::PrintSettings::get ( const Glib::ustring & key ) const

Looks up the string value associated with key.

Parameters

key A key.

Returns: The string value for key.

◆ get_bool()

bool Gtk::PrintSettings::get_bool ( const Glib::ustring & key ) const

Returns the boolean represented by the value that is associated with key.

The string “true” represents true, any other string false.

Parameters

key A key.

Returns: true, if key maps to a true value.

◆ get_collate()

bool Gtk::PrintSettings::get_collate ( ) const

Gets the value of GTK_PRINT_SETTINGS_COLLATE.

Returns: Whether to collate the printed pages.

◆ get_default_source()

Glib::ustring Gtk::PrintSettings::get_default_source ( ) const

Gets the value of GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

Returns: The default source.

◆ get_dither()

Glib::ustring Gtk::PrintSettings::get_dither ( ) const

Gets the value of GTK_PRINT_SETTINGS_DITHER.

Returns: The dithering that is used.

◆ get_double()

double Gtk::PrintSettings::get_double ( const Glib::ustring & key ) const

Returns the double value associated with key, or 0.

Parameters

key A key.

Returns: The double value of key.

◆ get_double_with_default()

double Gtk::PrintSettings::get_double_with_default	(	const Glib::ustring &	key,
		double	def
	)		const

Returns the floating point number represented by the value that is associated with key, or default_val if the value does not represent a floating point number.

Floating point numbers are parsed with Glib::ascii_strtod().

Parameters

key	A key.
def	The default value.

Returns: The floating point number associated with key.

◆ get_duplex()

PrintDuplex Gtk::PrintSettings::get_duplex ( ) const

Gets the value of GTK_PRINT_SETTINGS_DUPLEX.

Returns: Whether to print the output in duplex.

◆ get_finishings()

Glib::ustring Gtk::PrintSettings::get_finishings ( ) const

Gets the value of GTK_PRINT_SETTINGS_FINISHINGS.

Returns: The finishings.

◆ get_int()

int Gtk::PrintSettings::get_int ( const Glib::ustring & key ) const

Returns the integer value of key, or 0.

Parameters

key A key.

Returns: The integer value of key.

◆ get_int_with_default()

int Gtk::PrintSettings::get_int_with_default	(	const Glib::ustring &	key,
		int	def
	)		const

Returns the value of key, interpreted as an integer, or the default value.

Parameters

key	A key.
def	The default value.

Returns: The integer value of key.

◆ get_length()

double Gtk::PrintSettings::get_length	(	const Glib::ustring &	key,
		Unit	unit
	)		const

Returns the value associated with key, interpreted as a length.

The returned value is converted to units.

Parameters

key	A key.
unit	The unit of the return value.

Returns: The length value of key, converted to unit.

◆ get_media_type()

Glib::ustring Gtk::PrintSettings::get_media_type ( ) const

Gets the value of GTK_PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

Returns: The media type.

◆ get_n_copies()

int Gtk::PrintSettings::get_n_copies ( ) const

Gets the value of GTK_PRINT_SETTINGS_N_COPIES.

Returns: The number of copies to print.

◆ get_number_up()

int Gtk::PrintSettings::get_number_up ( ) const

Gets the value of GTK_PRINT_SETTINGS_NUMBER_UP.

Returns: The number of pages per sheet.

◆ get_number_up_layout()

NumberUpLayout Gtk::PrintSettings::get_number_up_layout ( ) const

Gets the value of GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

Returns: Layout of page in number-up mode.

◆ get_orientation()

PageOrientation Gtk::PrintSettings::get_orientation ( ) const

Get the value of GTK_PRINT_SETTINGS_ORIENTATION, converted to a Gtk::PageOrientation.

Returns: The orientation.

◆ get_output_bin()

Glib::ustring Gtk::PrintSettings::get_output_bin ( ) const

Gets the value of GTK_PRINT_SETTINGS_OUTPUT_BIN.

Returns: The output bin.

◆ get_page_ranges()

std::vector< PageRange > Gtk::PrintSettings::get_page_ranges ( ) const

◆ get_page_set()

PageSet Gtk::PrintSettings::get_page_set ( ) const

Gets the value of GTK_PRINT_SETTINGS_PAGE_SET.

Returns: The set of pages to print.

◆ get_paper_height()

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

Gets the value of GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to unit.

Parameters

unit	The unit for the return value.

Returns: The paper height, in units of unit.

◆ get_paper_size() [1/2]

PaperSize Gtk::PrintSettings::get_paper_size ( )

Gets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a Gtk::PaperSize.

Returns: The paper size.

◆ get_paper_size() [2/2]

const PaperSize Gtk::PrintSettings::get_paper_size ( ) const

Gets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a Gtk::PaperSize.

Returns: The paper size.

◆ get_paper_width()

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

Gets the value of GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to unit.

Parameters

unit	The unit for the return value.

Returns: The paper width, in units of unit.

◆ get_print_pages()

PrintPages Gtk::PrintSettings::get_print_pages ( ) const

Gets the value of GTK_PRINT_SETTINGS_PRINT_PAGES.

Returns: Which pages to print.

◆ get_printer()

Glib::ustring Gtk::PrintSettings::get_printer ( ) const

Convenience function to obtain the value of GTK_PRINT_SETTINGS_PRINTER.

Returns: The printer name.

◆ get_printer_lpi()

double Gtk::PrintSettings::get_printer_lpi ( ) const

Gets the value of GTK_PRINT_SETTINGS_PRINTER_LPI.

Returns: The resolution in lpi (lines per inch).

◆ get_quality()

PrintQuality Gtk::PrintSettings::get_quality ( ) const

Gets the value of GTK_PRINT_SETTINGS_QUALITY.

Returns: The print quality.

◆ get_resolution()

int Gtk::PrintSettings::get_resolution ( ) const

Gets the value of GTK_PRINT_SETTINGS_RESOLUTION.

Returns: The resolution in dpi.

◆ get_resolution_x()

int Gtk::PrintSettings::get_resolution_x ( ) const

Gets the value of GTK_PRINT_SETTINGS_RESOLUTION_X.

Returns: The horizontal resolution in dpi.

◆ get_resolution_y()

int Gtk::PrintSettings::get_resolution_y ( ) const

Gets the value of GTK_PRINT_SETTINGS_RESOLUTION_Y.

Returns: The vertical resolution in dpi.

◆ get_reverse()

bool Gtk::PrintSettings::get_reverse ( ) const

Gets the value of GTK_PRINT_SETTINGS_REVERSE.

Returns: Whether to reverse the order of the printed pages.

◆ get_scale()

double Gtk::PrintSettings::get_scale ( ) const

Gets the value of GTK_PRINT_SETTINGS_SCALE.

Returns: The scale in percent.

◆ get_type()

static GType Gtk::PrintSettings::get_type ( )

static

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

◆ get_use_color()

bool Gtk::PrintSettings::get_use_color ( ) const

Gets the value of GTK_PRINT_SETTINGS_USE_COLOR.

Returns: Whether to use color.

◆ gobj() [1/2]

GtkPrintSettings * Gtk::PrintSettings::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkPrintSettings * Gtk::PrintSettings::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkPrintSettings * Gtk::PrintSettings::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ has_key()

bool Gtk::PrintSettings::has_key ( const Glib::ustring & key ) const

Returns true, if a value is associated with key.

Parameters

key A key.

Returns: true, if key has a value.

◆ load_from_file()

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

Reads the print settings from file_name.

If the file could not be loaded then error is set to either a Glib::FileError or Glib::KeyFileError.

See to_file().

Parameters

file_name The filename to read the settings from.

Returns: true on success.

Exceptions

Glib::KeyFileError
Glib::FileError

◆ load_from_key_file() [1/2]

bool Gtk::PrintSettings::load_from_key_file ( const Glib::RefPtr< const Glib::KeyFile > & key_file )

Reads the print settings from the key_file.

See save_to_key_file().

Parameters

key_file The KeyFile to retrieve the settings from.

Returns: true on success.

Exceptions

Glib::KeyFileError,Glib::FileError

◆ load_from_key_file() [2/2]

bool Gtk::PrintSettings::load_from_key_file	(	const Glib::RefPtr< const Glib::KeyFile > &	key_file,
		const Glib::ustring &	group_name
	)

Reads the print settings from the group group_name in key_file.

If the file could not be loaded then error is set to either a Glib::FileError or Glib::KeyFileError.

Parameters

key_file	The `Glib::KeyFile` to retrieve the settings from.
group_name	The name of the group to use, or `nullptr` to use the default “Print Settings”.

Returns: true on success.

Exceptions

Glib::KeyFileError
Glib::FileError

◆ operator=()

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

noexcept

◆ save_to_file()

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

This function saves the print settings from settings to file_name.

If the file could not be written then error is set to either a Glib::FileError or Glib::KeyFileError.

Parameters

file_name The file to save to.

Returns: true on success.

Exceptions

Glib::KeyFileError
Glib::FileError

◆ save_to_key_file() [1/2]

void Gtk::PrintSettings::save_to_key_file ( const Glib::RefPtr< Glib::KeyFile > & key_file ) const

This function adds the print settings from settings to key_file, in the "Print Settings" group.

Parameters

key_file The Glib::KeyFile to save the print settings to.

◆ save_to_key_file() [2/2]

void Gtk::PrintSettings::save_to_key_file	(	const Glib::RefPtr< Glib::KeyFile > &	key_file,
		const Glib::ustring &	group_name
	)		const

This function adds the print settings from settings to key_file.

Parameters

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

◆ set()

void Gtk::PrintSettings::set	(	const Glib::ustring &	key,
		const Glib::ustring &	value
	)

Associates value with key.

Parameters

key	A key.
value	A string value.

◆ set_bool()

void Gtk::PrintSettings::set_bool	(	const Glib::ustring &	key,
		bool	value = `true`
	)

Sets key to a boolean value.

Parameters

key	A key.
value	A boolean.

◆ set_collate()

void Gtk::PrintSettings::set_collate ( bool collate = true )

Sets the value of GTK_PRINT_SETTINGS_COLLATE.

Parameters

collate Whether to collate the output.

◆ set_default_source()

void Gtk::PrintSettings::set_default_source ( const Glib::ustring & default_source )

Sets the value of GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

Parameters

default_source The default source.

◆ set_dither()

void Gtk::PrintSettings::set_dither ( const Glib::ustring & dither )

Sets the value of GTK_PRINT_SETTINGS_DITHER.

Parameters

dither The dithering that is used.

◆ set_double()

void Gtk::PrintSettings::set_double	(	const Glib::ustring &	key,
		double	value
	)

Sets key to a double value.

Parameters

key	A key.
value	A double value.

◆ set_duplex()

void Gtk::PrintSettings::set_duplex ( PrintDuplex duplex )

Sets the value of GTK_PRINT_SETTINGS_DUPLEX.

Parameters

duplex A Gtk::PrintDuplex value.

◆ set_finishings()

void Gtk::PrintSettings::set_finishings ( const Glib::ustring & finishings )

Sets the value of GTK_PRINT_SETTINGS_FINISHINGS.

Parameters

finishings The finishings.

◆ set_int()

void Gtk::PrintSettings::set_int	(	const Glib::ustring &	key,
		int	value
	)

Sets key to an integer value.

Parameters

key	A key.
value	An integer.

◆ set_length()

void Gtk::PrintSettings::set_length	(	const Glib::ustring &	key,
		double	value,
		Unit	unit
	)

Associates a length in units of unit with key.

Parameters

key	A key.
value	A length.
unit	The unit of length.

◆ set_media_type()

void Gtk::PrintSettings::set_media_type ( const Glib::ustring & media_type )

Sets the value of GTK_PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

Parameters

media_type The media type.

◆ set_n_copies()

void Gtk::PrintSettings::set_n_copies ( int num_copies )

Sets the value of GTK_PRINT_SETTINGS_N_COPIES.

Parameters

num_copies The number of copies.

◆ set_number_up() [1/2]

void Gtk::PrintSettings::set_number_up ( int number_up )

Sets the value of GTK_PRINT_SETTINGS_NUMBER_UP.

Parameters

number_up The number of pages per sheet.

◆ set_number_up() [2/2]

void Gtk::PrintSettings::set_number_up ( NumberUpLayout number_up_layout )

Sets the value of GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

Parameters

number_up_layout A Gtk::NumberUpLayout value.

◆ set_orientation()

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

Sets the value of GTK_PRINT_SETTINGS_ORIENTATION.

Parameters

orientation A page orientation.

◆ set_output_bin()

void Gtk::PrintSettings::set_output_bin ( const Glib::ustring & output_bin )

Sets the value of GTK_PRINT_SETTINGS_OUTPUT_BIN.

Parameters

output_bin The output bin.

◆ set_page_ranges()

void Gtk::PrintSettings::set_page_ranges ( const std::vector< PageRange > & page_ranges )

◆ set_page_set()

void Gtk::PrintSettings::set_page_set ( PageSet page_set )

Sets the value of GTK_PRINT_SETTINGS_PAGE_SET.

Parameters

page_set A Gtk::PageSet value.

◆ set_paper_height()

void Gtk::PrintSettings::set_paper_height	(	double	height,
		Unit	unit
	)

Sets the value of GTK_PRINT_SETTINGS_PAPER_HEIGHT.

Parameters

height	The paper height.
unit	The units of height.

◆ set_paper_size()

void Gtk::PrintSettings::set_paper_size ( const PaperSize & paper_size )

Sets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, GTK_PRINT_SETTINGS_PAPER_WIDTH and GTK_PRINT_SETTINGS_PAPER_HEIGHT.

Parameters

paper_size A paper size.

◆ set_paper_width()

void Gtk::PrintSettings::set_paper_width	(	double	width,
		Unit	unit
	)

Sets the value of GTK_PRINT_SETTINGS_PAPER_WIDTH.

Parameters

width	The paper width.
unit	The units of width.

◆ set_print_pages()

void Gtk::PrintSettings::set_print_pages ( PrintPages pages )

Sets the value of GTK_PRINT_SETTINGS_PRINT_PAGES.

Parameters

pages A Gtk::PrintPages value.

◆ set_printer()

void Gtk::PrintSettings::set_printer ( const Glib::ustring & printer )

Convenience function to set GTK_PRINT_SETTINGS_PRINTER to printer.

Parameters

printer The printer name.

◆ set_printer_lpi()

void Gtk::PrintSettings::set_printer_lpi ( double lpi )

Sets the value of GTK_PRINT_SETTINGS_PRINTER_LPI.

Parameters

lpi	The resolution in lpi (lines per inch).

◆ set_quality()

void Gtk::PrintSettings::set_quality ( PrintQuality quality )

Sets the value of GTK_PRINT_SETTINGS_QUALITY.

Parameters

quality A Gtk::PrintQuality value.

◆ set_resolution()

void Gtk::PrintSettings::set_resolution ( int resolution )

Sets the values of GTK_PRINT_SETTINGS_RESOLUTION, GTK_PRINT_SETTINGS_RESOLUTION_X and GTK_PRINT_SETTINGS_RESOLUTION_Y.

Parameters

resolution The resolution in dpi.

◆ set_resolution_xy()

void Gtk::PrintSettings::set_resolution_xy	(	int	resolution_x,
		int	resolution_y
	)

Sets the values of GTK_PRINT_SETTINGS_RESOLUTION, GTK_PRINT_SETTINGS_RESOLUTION_X and GTK_PRINT_SETTINGS_RESOLUTION_Y.

Parameters

resolution_x	The horizontal resolution in dpi.
resolution_y	The vertical resolution in dpi.

◆ set_reverse()

void Gtk::PrintSettings::set_reverse ( bool reverse = true )

Sets the value of GTK_PRINT_SETTINGS_REVERSE.

Parameters

reverse Whether to reverse the output.

◆ set_scale()

void Gtk::PrintSettings::set_scale ( double scale )

Sets the value of GTK_PRINT_SETTINGS_SCALE.

Parameters

scale The scale in percent.

◆ set_use_color()

void Gtk::PrintSettings::set_use_color ( bool use_color = true )

Sets the value of GTK_PRINT_SETTINGS_USE_COLOR.

Parameters

use_color Whether to use color.

◆ setting_foreach()

void Gtk::PrintSettings::setting_foreach ( const SlotForeach & slot )

Calls a function for each print setting.

Parameters

slot	The callback to call for each print setting.

◆ unset()

void Gtk::PrintSettings::unset ( const Glib::ustring & key )

Removes any value associated with key.

This has the same effect as setting the value to nullptr.

Parameters

key A key.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gtk::PrintSettings > wrap	(	GtkPrintSettings *	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.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols

Detailed Description

Member Typedef Documentation

◆ SlotForeach

Constructor & Destructor Documentation

◆ PrintSettings() [1/2]

◆ ~PrintSettings()

◆ PrintSettings() [2/2]

Member Function Documentation

◆ copy()

◆ create()

◆ create_from_file()

◆ create_from_key_file() [1/2]

◆ create_from_key_file() [2/2]

◆ get()

◆ get_bool()

◆ get_collate()

◆ get_default_source()

◆ get_dither()

◆ get_double()

◆ get_double_with_default()

◆ get_duplex()

◆ get_finishings()

◆ get_int()

◆ get_int_with_default()

◆ get_length()

◆ get_media_type()

◆ get_n_copies()

◆ get_number_up()

◆ get_number_up_layout()

◆ get_orientation()

◆ get_output_bin()

◆ get_page_ranges()

◆ get_page_set()

◆ get_paper_height()

◆ get_paper_size() [1/2]

◆ get_paper_size() [2/2]

◆ get_paper_width()

◆ get_print_pages()

◆ get_printer()

◆ get_printer_lpi()

◆ get_quality()

◆ get_resolution()

◆ get_resolution_x()

◆ get_resolution_y()

◆ get_reverse()

◆ get_scale()

◆ get_type()

◆ get_use_color()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ has_key()

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

◆ set_bool()

◆ set_collate()

◆ set_default_source()

◆ set_dither()

◆ set_double()

◆ set_duplex()

◆ set_finishings()

◆ set_int()

◆ set_length()

◆ set_media_type()

◆ set_n_copies()

◆ set_number_up() [1/2]

◆ set_number_up() [2/2]

◆ set_orientation()