logo top
Main Page   Widgets   Namespaces   Book  

Gtk::PrintUnixDialog Class Reference
[Printing]

Inheritance diagram for Gtk::PrintUnixDialog:

List of all members.


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:

Public Member Functions

void add_custom_tab (const Widget& child, const Widget& tab_label)
 Adds a custom tab to the print dialog.
void add_custom_tab (const Widget& child, const Glib::ustring& tab_label)
int get_current_page () const
 Gets the current page of the Gtk::PrintDialog.
Glib::RefPtr<const PageSetupget_page_setup () const
 Gets the page setup that is used by the Gtk::PrintUnixDialog.
Glib::RefPtr<PageSetupget_page_setup ()
 Gets the page setup that is used by the Gtk::PrintUnixDialog.
Glib::RefPtr<const Printerget_selected_printer () const
 Gets the currently selected printer.
Glib::RefPtr<Printerget_selected_printer ()
 Gets the currently selected printer.
Glib::RefPtr<const PrintSettingsget_settings () const
 Gets a new Gtk::PrintSettings object that represents the current values in the print dialog.
Glib::RefPtr<PrintSettingsget_settings ()
 Gets a new Gtk::PrintSettings object that represents the current values in the print dialog.
const GtkPrintUnixDialog* gobj () const
 Provides access to the underlying C GtkObject.
GtkPrintUnixDialog* gobj ()
 Provides access to the underlying C GtkObject.
 PrintUnixDialog (const Glib::ustring& title)
 PrintUnixDialog (Gtk::Window& parent, const Glib::ustring& title)
Glib::PropertyProxy_ReadOnly<int> property_current_page () const
 The current page in the document.
Glib::PropertyProxy<int> property_current_page ()
 The current page in the document.
Glib::PropertyProxy_ReadOnly
<Glib::RefPtr<PageSetup>> 
property_page_setup () const
 The GtkPageSetup to use.
Glib::PropertyProxy
<Glib::RefPtr<PageSetup>> 
property_page_setup ()
 The GtkPageSetup to use.
Glib::PropertyProxy_ReadOnly
<Glib::RefPtr<PrintSettings>> 
property_print_settings () const
 The GtkPrintSettings used for initializing the dialog.
Glib::PropertyProxy
<Glib::RefPtr<PrintSettings>> 
property_print_settings ()
 The GtkPrintSettings used for initializing the dialog.
Glib::PropertyProxy_ReadOnly
<Glib::RefPtr<Printer>> 
property_selected_printer () const
 The GtkPrinter which is selected.
void set_current_page (int current_page)
 Sets the current page number.
void set_manual_capabilities (PrintCapabilities capabilities)
 This lets you specify the printing capabilities your application supports.
void set_page_setup (const Glib::RefPtr<PageSetup>& page_setup)
 Sets the page setup of the Gtk::PrintUnixDialog.
void set_settings (const Glib::RefPtr<PrintSettings>& print_settings)
 Sets the Gtk::PrintSettings for the Gtk::PrintUnixDialog.
virtual ~PrintUnixDialog ()

Related Functions

(Note that these are not member functions.)

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

Constructor & Destructor Documentation

virtual Gtk::PrintUnixDialog::~PrintUnixDialog (  )  [virtual]

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

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


Member Function Documentation

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:
child The widget to put in the custom tab.
tab_label The widget to use as tab label.

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

int Gtk::PrintUnixDialog::get_current_page (  )  const

Gets the current page of the Gtk::PrintDialog.

Returns:
The current page of dialog
Since gtkmm 2.10:

Glib::RefPtr<const PageSetup> Gtk::PrintUnixDialog::get_page_setup (  )  const

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

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

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

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

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

Glib::RefPtr<const Printer> Gtk::PrintUnixDialog::get_selected_printer (  )  const

Gets the currently selected printer.

Returns:
The currently selected printer
Since gtkmm 2.10:

Glib::RefPtr<Printer> Gtk::PrintUnixDialog::get_selected_printer (  ) 

Gets the currently selected printer.

Returns:
The currently selected printer
Since gtkmm 2.10:

Glib::RefPtr<const PrintSettings> Gtk::PrintUnixDialog::get_settings (  )  const

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

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

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

Glib::RefPtr<PrintSettings> Gtk::PrintUnixDialog::get_settings (  ) 

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

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

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

Reimplemented from Gtk::Widget.

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

Glib::PropertyProxy_ReadOnly<int> Gtk::PrintUnixDialog::property_current_page (  )  const

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.

Glib::PropertyProxy<int> Gtk::PrintUnixDialog::property_current_page (  ) 

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.

Glib::PropertyProxy_ReadOnly<Glib::RefPtr<PageSetup>> Gtk::PrintUnixDialog::property_page_setup (  )  const

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.

Glib::PropertyProxy<Glib::RefPtr<PageSetup>> Gtk::PrintUnixDialog::property_page_setup (  ) 

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.

Glib::PropertyProxy_ReadOnly<Glib::RefPtr<PrintSettings>> Gtk::PrintUnixDialog::property_print_settings (  )  const

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.

Glib::PropertyProxy<Glib::RefPtr<PrintSettings>> Gtk::PrintUnixDialog::property_print_settings (  ) 

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.

Glib::PropertyProxy_ReadOnly<Glib::RefPtr<Printer>> Gtk::PrintUnixDialog::property_selected_printer (  )  const

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.

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_page The current page number.

void Gtk::PrintUnixDialog::set_manual_capabilities ( PrintCapabilities  capabilities  ) 

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:
capabilities The printing capabilities of your application.

void Gtk::PrintUnixDialog::set_page_setup ( const Glib::RefPtr<PageSetup>&  page_setup  ) 

Sets the page setup of the Gtk::PrintUnixDialog.

Since gtkmm 2.10:
Parameters:
page_setup A Gtk::PageSetup.

void Gtk::PrintUnixDialog::set_settings ( const Glib::RefPtr<PrintSettings>&  print_settings  ) 

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:
settings A 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:
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.


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

Generated for gtkmm 2.4 by Doxygen 1.5.6 © 1997-2001