gtkmm  4.18.0
Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::PrintSetup Class Referencefinal

An auxiliary object for printing that allows decoupling the setup from the printing. More...

#include <gtkmm/printsetup.h>

Public Member Functions

void reference () const
 Increment the reference count for this object. More...
 
void unreference () const
 Decrement the reference count for this object. More...
 
GtkPrintSetup* gobj ()
 Provides access to the underlying C instance. More...
 
const GtkPrintSetup* gobj () const
 Provides access to the underlying C instance. More...
 
GtkPrintSetup* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
 PrintSetup ()=delete
 
 PrintSetup (const PrintSetup&)=delete
 
PrintSetupoperator= (const PrintSetup&)=delete
 
Glib::RefPtr< PrintSettingsget_print_settings ()
 Returns the print settings of setup. More...
 
Glib::RefPtr< const PrintSettingsget_print_settings () const
 Returns the print settings of setup. More...
 
Glib::RefPtr< PageSetupget_page_setup ()
 Returns the page setup of setup. More...
 
Glib::RefPtr< const PageSetupget_page_setup () const
 Returns the page setup of setup. More...
 

Protected Member Functions

void operator delete (void*, std::size_t)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::PrintSetupwrap (GtkPrintSetup* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

An auxiliary object for printing that allows decoupling the setup from the printing.

A print setup is obtained by calling Gtk::PrintDialog::setup_finish(), and can later be passed to print functions such as Gtk::PrintDialog::print().

Print setups can be reused for multiple print calls.

Applications may wish to store the page_setup and print_settings from the print setup and copy them to the PrintDialog if they want to keep using them.

Since gtkmm 4.14:

Constructor & Destructor Documentation

Gtk::PrintSetup::PrintSetup ( )
delete
Gtk::PrintSetup::PrintSetup ( const PrintSetup )
delete

Member Function Documentation

Glib::RefPtr<PageSetup> Gtk::PrintSetup::get_page_setup ( )

Returns the page setup of setup.

It may be different from the Gtk::PrintDialog's page setup if the user changed it during the setup process.

Since gtkmm 4.14:
Returns
The page setup, or nullptr.
Glib::RefPtr<const PageSetup> Gtk::PrintSetup::get_page_setup ( ) const

Returns the page setup of setup.

It may be different from the Gtk::PrintDialog's page setup if the user changed it during the setup process.

Since gtkmm 4.14:
Returns
The page setup, or nullptr.
Glib::RefPtr<PrintSettings> Gtk::PrintSetup::get_print_settings ( )

Returns the print settings of setup.

They may be different from the Gtk::PrintDialog's settings if the user changed them during the setup process.

Since gtkmm 4.14:
Returns
The print settings, or nullptr.
Glib::RefPtr<const PrintSettings> Gtk::PrintSetup::get_print_settings ( ) const

Returns the print settings of setup.

They may be different from the Gtk::PrintDialog's settings if the user changed them during the setup process.

Since gtkmm 4.14:
Returns
The print settings, or nullptr.
GtkPrintSetup* Gtk::PrintSetup::gobj ( )

Provides access to the underlying C instance.

const GtkPrintSetup* Gtk::PrintSetup::gobj ( ) const

Provides access to the underlying C instance.

GtkPrintSetup* Gtk::PrintSetup::gobj_copy ( ) const

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

void Gtk::PrintSetup::operator delete ( void *  ,
std::size_t   
)
protected
PrintSetup& Gtk::PrintSetup::operator= ( const PrintSetup )
delete
void Gtk::PrintSetup::reference ( ) const

Increment the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

void Gtk::PrintSetup::unreference ( ) const

Decrement the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

Friends And Related Function Documentation

Glib::RefPtr< Gtk::PrintSetup > wrap ( GtkPrintSetup *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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.