gtkmm  3.4.0
Public Member Functions | Related Functions
Gtk::PrintUnixDialog Class Reference

PrintUnixDialog implements a print dialog for platforms which don't provide a native print dialog, like Unix. More...

Inheritance diagram for Gtk::PrintUnixDialog:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~PrintUnixDialog ()
GtkPrintUnixDialog* gobj ()
 Provides access to the underlying C GtkObject.
const GtkPrintUnixDialog* gobj () const
 Provides access to the underlying C GtkObject.
 PrintUnixDialog (Gtk::Window& parent, const Glib::ustring& title)
 PrintUnixDialog (const Glib::ustring& title)
void set_page_setup (const Glib::RefPtr< PageSetup >& page_setup)
 Sets the page setup of the Gtk::PrintUnixDialog.
Glib::RefPtr< PageSetupget_page_setup ()
 Gets the page setup that is used by the Gtk::PrintUnixDialog.
Glib::RefPtr< const PageSetupget_page_setup () const
 Gets the page setup that is used by the Gtk::PrintUnixDialog.
void set_current_page (int current_page)
 Sets the current page number.
int get_current_page () const
 Gets the current page of the Gtk::PrintDialog.
void set_settings (const Glib::RefPtr< PrintSettings >& print_settings)
 Sets the Gtk::PrintSettings for the Gtk::PrintUnixDialog.
Glib::RefPtr< PrintSettingsget_settings ()
 Gets a new Gtk::PrintSettings object that represents the current values in the print dialog.
Glib::RefPtr< const PrintSettingsget_settings () const
 Gets a new Gtk::PrintSettings object that represents the current values in the print dialog.
Glib::RefPtr< Printerget_selected_printer ()
 Gets the currently selected printer.
Glib::RefPtr< const Printerget_selected_printer () const
 Gets the currently selected printer.
void add_custom_tab (const Widget& child, const Glib::ustring& tab_label)
void add_custom_tab (const Widget& child, const Widget& tab_label)
 Adds a custom tab to the print dialog.
void set_manual_capabilities (PrintCapabilities capabilities)
 This lets you specify the printing capabilities your application supports.
PrintCapabilities get_manual_capabilities () const
 Gets the value of Gtk::PrintUnixDialog::property_manual_capabilities() property.
void get_support_selection (bool support_selection=true)
 Sets whether the print dialog allows user to print a selection.
bool get_support_selection () const
 Gets the value of Gtk::PrintUnixDialog::property_support_selection() property.
void set_has_selection (bool has_selection=true)
 Sets whether a selection exists.
bool get_has_selection () const
 Gets the value of Gtk::PrintUnixDialog::property_has_selection() property.
void set_embed_page_setup (bool embed=true)
 Embed page size combo box and orientation combo box into page setup page.
bool get_embed_page_setup () const
 Gets the value of Gtk::PrintUnixDialog::property_embed_page_setup() property.
bool get_page_setup_set () const
 Gets the page setup that is used by the Gtk::PrintUnixDialog.
Glib::PropertyProxy
< Glib::RefPtr< PageSetup > > 
property_page_setup ()
 The GtkPageSetup to use.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< PageSetup > > 
property_page_setup () const
 The GtkPageSetup to use.
Glib::PropertyProxy< int > property_current_page ()
 The current page in the document.
Glib::PropertyProxy_ReadOnly< int > property_current_page () const
 The current page in the document.
Glib::PropertyProxy
< Glib::RefPtr< PrintSettings > > 
property_print_settings ()
 The GtkPrintSettings used for initializing the dialog.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< PrintSettings > > 
property_print_settings () const
 The GtkPrintSettings used for initializing the dialog.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Printer > > 
property_selected_printer () const
 The GtkPrinter which is selected.
Glib::PropertyProxy< bool > property_manual_capabilities ()
 Capabilities the application can handle.
Glib::PropertyProxy_ReadOnly
< bool > 
property_manual_capabilities () const
 Capabilities the application can handle.
Glib::PropertyProxy< bool > property_support_selection ()
 Whether the dialog supports selection.
Glib::PropertyProxy_ReadOnly
< bool > 
property_support_selection () const
 Whether the dialog supports selection.
Glib::PropertyProxy< bool > property_has_selection ()
 Whether the application has a selection.
Glib::PropertyProxy_ReadOnly
< bool > 
property_has_selection () const
 Whether the application has a selection.
Glib::PropertyProxy< bool > property_embed_page_setup ()
 TRUE if page setup combos are embedded in GtkPrintUnixDialog.
Glib::PropertyProxy_ReadOnly
< bool > 
property_embed_page_setup () const
 TRUE if page setup combos are embedded in GtkPrintUnixDialog.

Related Functions

(Note that these are not member functions.)

Gtk::PrintUnixDialogwrap (GtkPrintUnixDialog* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

PrintUnixDialog implements a print dialog for platforms which don't provide a native print dialog, like Unix.

It can be used very much like any other GTK+ dialog, at the cost of the portability offered by the high-level printing API exposed through PrintOperation.

In order to print something with PrintUnixDialog, you need to use get_selected_printer() to obtain a Printer object and use it to construct a PrintJob using PrintJob::create().

PrintUnixDialog uses the following response values:

Since gtkmm 2.10:

Constructor & Destructor Documentation

Gtk::PrintUnixDialog::PrintUnixDialog ( Gtk::Window parent,
const Glib::ustring title 
) [explicit]

Member Function Documentation

void Gtk::PrintUnixDialog::add_custom_tab ( const Widget child,
const Glib::ustring tab_label 
)
void Gtk::PrintUnixDialog::add_custom_tab ( const Widget child,
const Widget tab_label 
)

Adds a custom tab to the print dialog.

Since gtkmm 2.10:
Parameters:
childThe widget to put in the custom tab.
tab_labelThe widget to use as tab label.

Gets the current page of the Gtk::PrintDialog.

Since gtkmm 2.10:
Returns:
The current page of dialog.

Gets the value of Gtk::PrintUnixDialog::property_embed_page_setup() property.

Since gtkmm 2.18:
Returns:
Whether there is a selection.

Gets the value of Gtk::PrintUnixDialog::property_has_selection() property.

Since gtkmm 2.18:
Returns:
Whether there is a selection.

Gets the value of Gtk::PrintUnixDialog::property_manual_capabilities() property.

Since gtkmm 2.18:
Returns:
The printing capabilities.

Gets the page setup that is used by the Gtk::PrintUnixDialog.

Since gtkmm 2.10:
Returns:
The page setup of dialog.

Gets the page setup that is used by the Gtk::PrintUnixDialog.

Since gtkmm 2.10:
Returns:
The page setup of dialog.

Gets the page setup that is used by the Gtk::PrintUnixDialog.

Since gtkmm 2.18:
Returns:
Whether a page setup was set by user.

Gets the currently selected printer.

Since gtkmm 2.10:
Returns:
The currently selected printer.

Gets the currently selected printer.

Since gtkmm 2.10:
Returns:
The currently selected printer.

Gets a new Gtk::PrintSettings object that represents the current values in the print dialog.

Note that this creates a new object, and you need to unref it if don't want to keep it.

Since gtkmm 2.10:
Returns:
A new Gtk::PrintSettings object with the values from dialog.

Reimplemented from Gtk::Widget.

Gets a new Gtk::PrintSettings object that represents the current values in the print dialog.

Note that this creates a new object, and you need to unref it if don't want to keep it.

Since gtkmm 2.10:
Returns:
A new Gtk::PrintSettings object with the values from dialog.
void Gtk::PrintUnixDialog::get_support_selection ( bool  support_selection = true)

Sets whether the print dialog allows user to print a selection.

Since gtkmm 2.18:
Parameters:
support_selectiontrue to allow print selection.

Gets the value of Gtk::PrintUnixDialog::property_support_selection() property.

Since gtkmm 2.18:
Returns:
Whether the application supports print of selection.
GtkPrintUnixDialog* Gtk::PrintUnixDialog::gobj ( ) [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

const GtkPrintUnixDialog* Gtk::PrintUnixDialog::gobj ( ) const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

The current page in the document.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The current page in the document.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

TRUE if page setup combos are embedded in GtkPrintUnixDialog.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

TRUE if page setup combos are embedded in GtkPrintUnixDialog.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Whether the application has a selection.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Whether the application has a selection.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Capabilities the application can handle.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Capabilities the application can handle.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The GtkPageSetup to use.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The GtkPageSetup to use.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The GtkPrintSettings used for initializing the dialog.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The GtkPrintSettings used for initializing the dialog.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

The GtkPrinter which is selected.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Whether the dialog supports selection.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Whether the dialog supports selection.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
void Gtk::PrintUnixDialog::set_current_page ( int  current_page)

Sets the current page number.

If current_page is not -1, this enables the current page choice for the range of pages to print.

Since gtkmm 2.10:
Parameters:
current_pageThe current page number.
void Gtk::PrintUnixDialog::set_embed_page_setup ( bool  embed = true)

Embed page size combo box and orientation combo box into page setup page.

Since gtkmm 2.18:
Parameters:
embedEmbed page setup selection.
void Gtk::PrintUnixDialog::set_has_selection ( bool  has_selection = true)

Sets whether a selection exists.

Since gtkmm 2.18:
Parameters:
has_selectiontrue indicates that a selection exists.

This lets you specify the printing capabilities your application supports.

For instance, if you can handle scaling the output then you pass Gtk::PRINT_CAPABILITY_SCALE. If you don't pass that, then the dialog will only let you select the scale if the printing system automatically handles scaling.

Since gtkmm 2.10:
Parameters:
capabilitiesThe printing capabilities of your application.

Sets the page setup of the Gtk::PrintUnixDialog.

Since gtkmm 2.10:
Parameters:
page_setupA Gtk::PageSetup.

Sets the Gtk::PrintSettings for the Gtk::PrintUnixDialog.

Typically, this is used to restore saved print settings from a previous print operation before the print dialog is shown.

Since gtkmm 2.10:
Parameters:
settingsA Gtk::PrintSettings, or 0.

Friends And Related Function Documentation

Gtk::PrintUnixDialog* wrap ( GtkPrintUnixDialog *  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.

The documentation for this class was generated from the following file: