gtkmm
2.24.4
|
PrintOperation is the high-level, portable printing API. More...
Public Member Functions | |
PrintOperation (PrintOperation&& src) noexcept | |
PrintOperation& | operator= (PrintOperation&& src) noexcept |
~PrintOperation () noexceptoverride | |
GtkPrintOperation* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkPrintOperation* | gobj () const |
Provides access to the underlying C GObject. More... | |
GtkPrintOperation* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
void | set_default_page_setup (const Glib::RefPtr< PageSetup >& default_page_setup) |
Makes default_page_setup the default page setup for op. More... | |
Glib::RefPtr< PageSetup > | get_default_page_setup () const |
Returns the default page setup, see set_default_page_setup(). More... | |
void | set_print_settings (const Glib::RefPtr< PrintSettings >& print_settings) |
Sets the print settings for op. More... | |
Glib::RefPtr< PrintSettings > | get_print_settings () const |
Returns the current print settings. More... | |
void | set_job_name (const Glib::ustring& job_name) |
Sets the name of the print job. More... | |
void | set_n_pages (int n_pages) |
Sets the number of pages in the document. More... | |
void | set_current_page (int current_page) |
Sets the current page. More... | |
void | set_use_full_page (bool use_full_page=true) |
If use_full_page is true , the transformation for the cairo context obtained from Gtk::PrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). More... | |
void | set_unit (Unit unit) |
Sets up the transformation for the cairo context obtained from Gtk::PrintContext in such a way that distances are measured in units of unit. More... | |
void | set_export_filename (const std::string& filename) |
Sets up the Gtk::PrintOperation to generate a file instead of showing the print dialog. More... | |
void | set_track_print_status (bool track_status=true) |
If track_status is true , the print operation will try to continue report on the status of the print job in the printer queues and printer. More... | |
void | set_show_progress (bool show_progress=true) |
If show_progress is true , the print operation will show a progress dialog during the print operation. More... | |
void | set_allow_async (bool allow_async=true) |
Sets whether the run() may return before the print operation is completed. More... | |
void | set_custom_tab_label (const Glib::ustring& label) |
Sets the label for the tab holding custom widgets. More... | |
PrintOperationResult | run (PrintOperationAction action=PRINT_OPERATION_ACTION_PRINT_DIALOG) |
PrintOperationResult | run (PrintOperationAction action, Window& parent) |
Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document. More... | |
PrintStatus | get_status () const |
Returns the status of the print operation. More... | |
Glib::ustring | get_status_string () const |
Returns a string representation of the status of the print operation. More... | |
void | cancel () |
Cancels a running print operation. More... | |
bool | is_finished () const |
A convenience function to find out if the print operation is finished, either successfully (Gtk::PRINT_STATUS_FINISHED) or unsuccessfully (Gtk::PRINT_STATUS_FINISHED_ABORTED). More... | |
void | draw_page_finish () |
Signalize that drawing of particular page is complete. More... | |
void | set_defer_drawing () |
Sets up the Gtk::PrintOperation to wait for calling of draw_page_finish() from application. More... | |
void | set_support_selection (bool support_selection=true) |
Sets whether selection is supported by Gtk::PrintOperation. More... | |
bool | get_support_selection () const |
Gets the value of Gtk::PrintOperation::property_support_selection() property. More... | |
void | set_has_selection (bool has_selection=true) |
Sets whether there is a selection to print. More... | |
bool | get_has_selection () const |
Gets the value of Gtk::PrintOperation::property_has_selection() property. More... | |
void | set_embed_page_setup (bool embed=true) |
Embed page size combo box and orientation combo box into page setup page. More... | |
bool | get_embed_page_setup () const |
Gets the value of Gtk::PrintOperation::property_embed_page_setup() property. More... | |
int | get_n_pages_to_print () const |
Returns the number of pages that will be printed. More... | |
Glib::SignalProxy< void, PrintOperationResult > | signal_done () |
Glib::SignalProxy< void, const Glib::RefPtr< PrintContext >& > | signal_begin_print () |
Glib::SignalProxy< bool, const Glib::RefPtr< PrintContext >& > | signal_paginate () |
Glib::SignalProxy< void, const Glib::RefPtr< PrintContext >&, int, const Glib::RefPtr< PageSetup >& > | signal_request_page_setup () |
Glib::SignalProxy< void, const Glib::RefPtr< PrintContext >&, int > | signal_draw_page () |
Glib::SignalProxy< void, const Glib::RefPtr< PrintContext >& > | signal_end_print () |
Glib::SignalProxy< void > | signal_status_changed () |
Glib::SignalProxy< Widget* > | signal_create_custom_widget () |
Glib::SignalProxy< void, Widget* > | signal_custom_widget_apply () |
Glib::SignalProxy< bool, const Glib::RefPtr< PrintOperationPreview >&, const Glib::RefPtr< PrintContext >&, Window* > | signal_preview () |
Glib::SignalProxy< void, Gtk::Widget*, const Glib::RefPtr< PageSetup >&, const Glib::RefPtr< PrintSettings >& > | signal_update_custom_widget () |
Glib::PropertyProxy< Glib::RefPtr< PageSetup > > | property_default_page_setup () |
The GtkPageSetup used by default. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< PageSetup > > | property_default_page_setup () const |
The GtkPageSetup used by default. More... | |
Glib::PropertyProxy< Glib::RefPtr< PrintSettings > > | property_print_settings () |
The GtkPrintSettings used for initializing the dialog. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< PrintSettings > > | property_print_settings () const |
The GtkPrintSettings used for initializing the dialog. More... | |
Glib::PropertyProxy< Glib::ustring > | property_job_name () |
A string used for identifying the print job. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_job_name () const |
A string used for identifying the print job. More... | |
Glib::PropertyProxy< int > | property_n_pages () |
The number of pages in the document. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_n_pages () const |
The number of pages in the document. More... | |
Glib::PropertyProxy< int > | property_current_page () |
The current page in the document. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_current_page () const |
The current page in the document. More... | |
Glib::PropertyProxy< bool > | property_use_full_page () |
TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_use_full_page () const |
TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area. More... | |
Glib::PropertyProxy< bool > | property_track_print_status () |
TRUE if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_track_print_status () const |
TRUE if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server. More... | |
Glib::PropertyProxy< Unit > | property_unit () |
The unit in which distances can be measured in the context. More... | |
Glib::PropertyProxy_ReadOnly< Unit > | property_unit () const |
The unit in which distances can be measured in the context. More... | |
Glib::PropertyProxy< bool > | property_show_progress () |
TRUE if a progress dialog is shown while printing. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_show_progress () const |
TRUE if a progress dialog is shown while printing. More... | |
Glib::PropertyProxy< bool > | property_allow_async () |
TRUE if print process may run asynchronous. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_allow_async () const |
TRUE if print process may run asynchronous. More... | |
Glib::PropertyProxy< std::string > | property_export_filename () |
Export filename. More... | |
Glib::PropertyProxy_ReadOnly< std::string > | property_export_filename () const |
Export filename. More... | |
Glib::PropertyProxy_ReadOnly< PrintStatus > | property_status () const |
The status of the print operation. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_status_string () const |
A human-readable description of the status. More... | |
Glib::PropertyProxy< Glib::ustring > | property_custom_tab_label () |
Label for the tab containing custom widgets. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_custom_tab_label () const |
Label for the tab containing custom widgets. More... | |
Glib::PropertyProxy< bool > | property_support_selection () |
TRUE if the print operation will support print of selection. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_support_selection () const |
TRUE if the print operation will support print of selection. More... | |
Glib::PropertyProxy< bool > | property_has_selection () |
TRUE if a selection exists. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_selection () const |
TRUE if a selection exists. More... | |
Glib::PropertyProxy< bool > | property_embed_page_setup () |
TRUE if page setup combos are embedded in GtkPrintDialog. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_embed_page_setup () const |
TRUE if page setup combos are embedded in GtkPrintDialog. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_n_pages_to_print () const |
The number of pages that will be printed. More... | |
![]() | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
![]() | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
void | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot) |
void | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot) |
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot) |
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
![]() | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
![]() | |
PrintOperationPreview (PrintOperationPreview&& src) noexcept | |
PrintOperationPreview& | operator= (PrintOperationPreview&& src) noexcept |
~PrintOperationPreview () noexceptoverride | |
GtkPrintOperationPreview* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkPrintOperationPreview* | gobj () const |
Provides access to the underlying C GObject. More... | |
void | render_page (int page_nr) |
Renders a page to the preview, using the print context that was passed to the Gtk::PrintOperation::signal_preview() handler together with preview. More... | |
void | end_preview () |
Ends a preview. More... | |
bool | is_selected (int page_nr) const |
Returns whether the given page is included in the set of pages that have been selected for printing. More... | |
virtual void | render_page_vfunc (int page_nr) |
virtual void | end_preview_vfunc () |
virtual bool | is_selected_vfunc (int page_nr) const |
Glib::SignalProxy< void, const Glib::RefPtr< PrintContext >& > | signal_ready () |
Glib::SignalProxy< void, const Glib::RefPtr< PrintContext >&, const Glib::RefPtr< PageSetup >& > | signal_got_page_size () |
![]() | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexceptoverride | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
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< PrintOperation > | create () |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
PrintOperation () | |
virtual void | on_done (PrintOperationResult result) |
This is a default handler for the signal signal_done(). More... | |
virtual void | on_begin_print (const Glib::RefPtr< PrintContext >& context) |
This is a default handler for the signal signal_begin_print(). More... | |
virtual bool | on_paginate (const Glib::RefPtr< PrintContext >& context) |
This is a default handler for the signal signal_paginate(). More... | |
virtual void | on_request_page_setup (const Glib::RefPtr< PrintContext >& context, int page_no, const Glib::RefPtr< PageSetup >& setup) |
This is a default handler for the signal signal_request_page_setup(). More... | |
virtual void | on_draw_page (const Glib::RefPtr< PrintContext >& context, int page_nr) |
This is a default handler for the signal signal_draw_page(). More... | |
virtual void | on_end_print (const Glib::RefPtr< PrintContext >& context) |
This is a default handler for the signal signal_end_print(). More... | |
virtual void | on_status_changed () |
This is a default handler for the signal signal_status_changed(). More... | |
virtual Widget* | on_create_custom_widget () |
This is a default handler for the signal signal_create_custom_widget(). More... | |
virtual void | on_custom_widget_apply (Widget* widget) |
This is a default handler for the signal signal_custom_widget_apply(). More... | |
virtual bool | on_preview (const Glib::RefPtr< PrintOperationPreview >& preview, const Glib::RefPtr< PrintContext >& context, Window* parent) |
This is a default handler for the signal signal_preview(). More... | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexceptoverride | |
![]() | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
![]() | |
PrintOperationPreview () | |
You should derive from this class to use it. More... | |
virtual void | on_ready (const Glib::RefPtr< PrintContext >& context) |
This is a default handler for the signal signal_ready(). More... | |
virtual void | on_got_page_size (const Glib::RefPtr< PrintContext >& context, const Glib::RefPtr< PageSetup >& page_setup) |
This is a default handler for the signal signal_got_page_size(). More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::PrintOperation > | wrap (GtkPrintOperation* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::PrintOperationPreview > | wrap (GtkPrintOperationPreview* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
PrintOperation is the high-level, portable printing API.
It looks a bit different than other GTK+ dialogs such as the FileChooser, since some platforms don't expose enough infrastructure to implement a good print dialog. On such platforms, PrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK+ uses its own, see PrintUnixDialog.
The typical way to use the high-level printing API is to create a PrintOperation object when the user chooses to print. Then you set some properties on it,such as the page size, any PrintSettings from previous print operations, the number of pages, the current page, etc.
Then you start the print operation by calling run(). It will then show a dialog to let the user select a printer and options. When the user finishes the dialog various signals will be emitted by the PrintOperation for you to handle, the main one being draw_page. You should then render the page on the provided PrintContext using Cairo.
|
noexcept |
|
overridenoexcept |
|
protected |
void Gtk::PrintOperation::cancel | ( | ) |
Cancels a running print operation.
This function may be called from a Gtk::PrintOperation::signal_begin_print(), Gtk::PrintOperation::signal_paginate() or Gtk::PrintOperation::signal_draw_page() signal handler to stop the currently running print operation.
|
static |
void Gtk::PrintOperation::draw_page_finish | ( | ) |
Signalize that drawing of particular page is complete.
It is called after completion of page drawing (e.g. drawing in another thread). If set_defer_drawing() was called before, then this function has to be called by application. In another case it is called by the library itself.
Glib::RefPtr<PageSetup> Gtk::PrintOperation::get_default_page_setup | ( | ) | const |
Returns the default page setup, see set_default_page_setup().
bool Gtk::PrintOperation::get_embed_page_setup | ( | ) | const |
Gets the value of Gtk::PrintOperation::property_embed_page_setup() property.
bool Gtk::PrintOperation::get_has_selection | ( | ) | const |
Gets the value of Gtk::PrintOperation::property_has_selection() property.
int Gtk::PrintOperation::get_n_pages_to_print | ( | ) | const |
Returns the number of pages that will be printed.
Note that this value is set during print preparation phase (Gtk::PRINT_STATUS_PREPARING), so this function should never be called before the data generation phase (Gtk::PRINT_STATUS_GENERATING_DATA). You can connect to the Gtk::PrintOperation::signal_status_changed() signal and call get_n_pages_to_print() when print status is Gtk::PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation.
Glib::RefPtr<PrintSettings> Gtk::PrintOperation::get_print_settings | ( | ) | const |
Returns the current print settings.
Note that the return value is nullptr
until either set_print_settings() or run() have been called.
PrintStatus Gtk::PrintOperation::get_status | ( | ) | const |
Returns the status of the print operation.
Also see get_status_string().
Glib::ustring Gtk::PrintOperation::get_status_string | ( | ) | const |
Returns a string representation of the status of the print operation.
The string is translated and suitable for displaying the print status e.g. in a Gtk::Statusbar.
Use get_status() to obtain a status value that is suitable for programmatic use.
bool Gtk::PrintOperation::get_support_selection | ( | ) | const |
Gets the value of Gtk::PrintOperation::property_support_selection() property.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GtkPrintOperation* Gtk::PrintOperation::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gtk::PrintOperation::is_finished | ( | ) | const |
A convenience function to find out if the print operation is finished, either successfully (Gtk::PRINT_STATUS_FINISHED) or unsuccessfully (Gtk::PRINT_STATUS_FINISHED_ABORTED).
true
, if the print operation is finished.
|
protectedvirtual |
This is a default handler for the signal signal_begin_print().
|
protectedvirtual |
This is a default handler for the signal signal_create_custom_widget().
|
protectedvirtual |
This is a default handler for the signal signal_custom_widget_apply().
|
protectedvirtual |
This is a default handler for the signal signal_done().
|
protectedvirtual |
This is a default handler for the signal signal_draw_page().
|
protectedvirtual |
This is a default handler for the signal signal_end_print().
|
protectedvirtual |
This is a default handler for the signal signal_paginate().
|
protectedvirtual |
This is a default handler for the signal signal_preview().
|
protectedvirtual |
This is a default handler for the signal signal_request_page_setup().
|
protectedvirtual |
This is a default handler for the signal signal_status_changed().
|
noexcept |
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_allow_async | ( | ) |
TRUE if print process may run asynchronous.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_allow_async | ( | ) | const |
TRUE if print process may run asynchronous.
Glib::PropertyProxy< int > Gtk::PrintOperation::property_current_page | ( | ) |
The current page in the document.
Glib::PropertyProxy_ReadOnly< int > Gtk::PrintOperation::property_current_page | ( | ) | const |
The current page in the document.
Glib::PropertyProxy< Glib::ustring > Gtk::PrintOperation::property_custom_tab_label | ( | ) |
Label for the tab containing custom widgets.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::PrintOperation::property_custom_tab_label | ( | ) | const |
Label for the tab containing custom widgets.
Glib::PropertyProxy< Glib::RefPtr<PageSetup> > Gtk::PrintOperation::property_default_page_setup | ( | ) |
The GtkPageSetup used by default.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<PageSetup> > Gtk::PrintOperation::property_default_page_setup | ( | ) | const |
The GtkPageSetup used by default.
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_embed_page_setup | ( | ) |
TRUE if page setup combos are embedded in GtkPrintDialog.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_embed_page_setup | ( | ) | const |
TRUE if page setup combos are embedded in GtkPrintDialog.
Glib::PropertyProxy< std::string > Gtk::PrintOperation::property_export_filename | ( | ) |
Export filename.
Glib::PropertyProxy_ReadOnly< std::string > Gtk::PrintOperation::property_export_filename | ( | ) | const |
Export filename.
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_has_selection | ( | ) |
TRUE if a selection exists.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_has_selection | ( | ) | const |
TRUE if a selection exists.
Glib::PropertyProxy< Glib::ustring > Gtk::PrintOperation::property_job_name | ( | ) |
A string used for identifying the print job.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::PrintOperation::property_job_name | ( | ) | const |
A string used for identifying the print job.
Glib::PropertyProxy< int > Gtk::PrintOperation::property_n_pages | ( | ) |
The number of pages in the document.
Glib::PropertyProxy_ReadOnly< int > Gtk::PrintOperation::property_n_pages | ( | ) | const |
The number of pages in the document.
Glib::PropertyProxy_ReadOnly< int > Gtk::PrintOperation::property_n_pages_to_print | ( | ) | const |
The number of pages that will be printed.
Glib::PropertyProxy< Glib::RefPtr<PrintSettings> > Gtk::PrintOperation::property_print_settings | ( | ) |
The GtkPrintSettings used for initializing the dialog.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<PrintSettings> > Gtk::PrintOperation::property_print_settings | ( | ) | const |
The GtkPrintSettings used for initializing the dialog.
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_show_progress | ( | ) |
TRUE if a progress dialog is shown while printing.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_show_progress | ( | ) | const |
TRUE if a progress dialog is shown while printing.
Glib::PropertyProxy_ReadOnly< PrintStatus > Gtk::PrintOperation::property_status | ( | ) | const |
The status of the print operation.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::PrintOperation::property_status_string | ( | ) | const |
A human-readable description of the status.
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_support_selection | ( | ) |
TRUE if the print operation will support print of selection.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_support_selection | ( | ) | const |
TRUE if the print operation will support print of selection.
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_track_print_status | ( | ) |
TRUE if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_track_print_status | ( | ) | const |
TRUE if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server.
Glib::PropertyProxy< Unit > Gtk::PrintOperation::property_unit | ( | ) |
The unit in which distances can be measured in the context.
Glib::PropertyProxy_ReadOnly< Unit > Gtk::PrintOperation::property_unit | ( | ) | const |
The unit in which distances can be measured in the context.
Glib::PropertyProxy< bool > Gtk::PrintOperation::property_use_full_page | ( | ) |
TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintOperation::property_use_full_page | ( | ) | const |
TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area.
PrintOperationResult Gtk::PrintOperation::run | ( | PrintOperationAction | action = PRINT_OPERATION_ACTION_PRINT_DIALOG | ) |
PrintOperationResult Gtk::PrintOperation::run | ( | PrintOperationAction | action, |
Window& | parent | ||
) |
Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document.
Normally that this function does not return until the rendering of all pages is complete. You can connect to the Gtk::PrintOperation::signal_status_changed() signal on op to obtain some information about the progress of the print operation. Furthermore, it may use a recursive mainloop to show the print dialog.
If you call set_allow_async() or set the Gtk::PrintOperation::property_allow_async() property the operation will run asynchronously if this is supported on the platform. The Gtk::PrintOperation::signal_done() signal will be emitted with the result of the operation when the it is done (i.e. when the dialog is canceled, or when the print succeeds or fails).
[C example ellipted]
Note that run() can only be called once on a given Gtk::PrintOperation.
action | The action to start. |
parent | Transient parent of the dialog. |
void Gtk::PrintOperation::set_allow_async | ( | bool | allow_async = true | ) |
Sets whether the run() may return before the print operation is completed.
Note that some platforms may not allow asynchronous operation.
allow_async | true to allow asynchronous operation. |
void Gtk::PrintOperation::set_current_page | ( | int | current_page | ) |
Sets the current page.
If this is called before run(), the user will be able to select to print only the current page.
Note that this only makes sense for pre-paginated documents.
current_page | The current page, 0-based. |
void Gtk::PrintOperation::set_custom_tab_label | ( | const Glib::ustring & | label | ) |
Sets the label for the tab holding custom widgets.
label | The label to use, or nullptr to use the default label. |
void Gtk::PrintOperation::set_default_page_setup | ( | const Glib::RefPtr< PageSetup >& | default_page_setup | ) |
Makes default_page_setup the default page setup for op.
This page setup will be used by run(), but it can be overridden on a per-page basis by connecting to the Gtk::PrintOperation::signal_request_page_setup() signal.
default_page_setup | A Gtk::PageSetup, or nullptr . |
void Gtk::PrintOperation::set_defer_drawing | ( | ) |
Sets up the Gtk::PrintOperation to wait for calling of draw_page_finish() from application.
It can be used for drawing page in another thread.
This function must be called in the callback of "draw-page" signal.
void Gtk::PrintOperation::set_embed_page_setup | ( | bool | embed = true | ) |
Embed page size combo box and orientation combo box into page setup page.
Selected page setup is stored as default page setup in Gtk::PrintOperation.
embed | true to embed page setup selection in the Gtk::PrintDialog. |
void Gtk::PrintOperation::set_export_filename | ( | const std::string & | filename | ) |
Sets up the Gtk::PrintOperation to generate a file instead of showing the print dialog.
The indended use of this function is for implementing "Export to PDF" actions. Currently, PDF is the only supported format.
"Print to PDF" support is independent of this and is done by letting the user pick the "Print to PDF" item from the list of printers in the print dialog.
filename | The filename for the exported file. |
void Gtk::PrintOperation::set_has_selection | ( | bool | has_selection = true | ) |
Sets whether there is a selection to print.
Application has to set number of pages to which the selection will draw by set_n_pages() in a callback of Gtk::PrintOperation::signal_begin_print().
has_selection | true indicates that a selection exists. |
void Gtk::PrintOperation::set_job_name | ( | const Glib::ustring & | job_name | ) |
Sets the name of the print job.
The name is used to identify the job (e.g. in monitoring applications like eggcups).
If you don't set a job name, GTK+ picks a default one by numbering successive print jobs.
job_name | A string that identifies the print job. |
void Gtk::PrintOperation::set_n_pages | ( | int | n_pages | ) |
Sets the number of pages in the document.
This must be set to a positive number before the rendering starts. It may be set in a Gtk::PrintOperation::signal_begin_print() signal hander.
Note that the page numbers passed to the Gtk::PrintOperation::signal_request_page_setup() and Gtk::PrintOperation::signal_draw_page() signals are 0-based, i.e. if the user chooses to print all pages, the last signal_draw_page() signal will be for page n_pages - 1.
n_pages | The number of pages. |
void Gtk::PrintOperation::set_print_settings | ( | const Glib::RefPtr< PrintSettings >& | print_settings | ) |
Sets the print settings for op.
This is typically used to re-establish print settings from a previous print operation, see run().
print_settings | Gtk::PrintSettings. |
void Gtk::PrintOperation::set_show_progress | ( | bool | show_progress = true | ) |
If show_progress is true
, the print operation will show a progress dialog during the print operation.
show_progress | true to show a progress dialog. |
void Gtk::PrintOperation::set_support_selection | ( | bool | support_selection = true | ) |
Sets whether selection is supported by Gtk::PrintOperation.
support_selection | true to support selection. |
void Gtk::PrintOperation::set_track_print_status | ( | bool | track_status = true | ) |
If track_status is true
, the print operation will try to continue report on the status of the print job in the printer queues and printer.
This can allow your application to show things like "out of paper" issues, and when the print job actually reaches the printer.
This function is often implemented using some form of polling, so it should not be enabled unless needed.
track_status | true to track status after printing. |
void Gtk::PrintOperation::set_unit | ( | Unit | unit | ) |
Sets up the transformation for the cairo context obtained from Gtk::PrintContext in such a way that distances are measured in units of unit.
unit | The unit to use. |
void Gtk::PrintOperation::set_use_full_page | ( | bool | use_full_page = true | ) |
If use_full_page is true
, the transformation for the cairo context obtained from Gtk::PrintContext puts the origin at the top left corner of the page (which may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet).
Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins).
use_full_page | true to set up the Gtk::PrintContext for the full page. |
Glib::SignalProxy< void,const Glib::RefPtr<PrintContext>& > Gtk::PrintOperation::signal_begin_print | ( | ) |
void on_my_begin_print(const Glib::RefPtr<PrintContext>& context)
Glib::SignalProxy< Widget* > Gtk::PrintOperation::signal_create_custom_widget | ( | ) |
Widget* on_my_create_custom_widget()
Glib::SignalProxy< void,Widget* > Gtk::PrintOperation::signal_custom_widget_apply | ( | ) |
void on_my_custom_widget_apply(Widget* widget)
Glib::SignalProxy< void,PrintOperationResult > Gtk::PrintOperation::signal_done | ( | ) |
void on_my_done(PrintOperationResult result)
Glib::SignalProxy< void,const Glib::RefPtr<PrintContext>&,int > Gtk::PrintOperation::signal_draw_page | ( | ) |
void on_my_draw_page(const Glib::RefPtr<PrintContext>& context, int page_nr)
Glib::SignalProxy< void,const Glib::RefPtr<PrintContext>& > Gtk::PrintOperation::signal_end_print | ( | ) |
void on_my_end_print(const Glib::RefPtr<PrintContext>& context)
Glib::SignalProxy< bool,const Glib::RefPtr<PrintContext>& > Gtk::PrintOperation::signal_paginate | ( | ) |
bool on_my_paginate(const Glib::RefPtr<PrintContext>& context)
Glib::SignalProxy< bool,const Glib::RefPtr<PrintOperationPreview>&,const Glib::RefPtr<PrintContext>&,Window* > Gtk::PrintOperation::signal_preview | ( | ) |
bool on_my_preview(const Glib::RefPtr<PrintOperationPreview>& preview, const Glib::RefPtr<PrintContext>& context, Window* parent)
Glib::SignalProxy< void,const Glib::RefPtr<PrintContext>&,int,const Glib::RefPtr<PageSetup>& > Gtk::PrintOperation::signal_request_page_setup | ( | ) |
void on_my_request_page_setup(const Glib::RefPtr<PrintContext>& context, int page_no, const Glib::RefPtr<PageSetup>& setup)
Glib::SignalProxy< void > Gtk::PrintOperation::signal_status_changed | ( | ) |
void on_my_status_changed()
Glib::SignalProxy< void,Gtk::Widget*,const Glib::RefPtr<PageSetup>&,const Glib::RefPtr<PrintSettings>& > Gtk::PrintOperation::signal_update_custom_widget | ( | ) |
void on_my_update_custom_widget(Gtk::Widget* widget, const Glib::RefPtr<PageSetup>& setup, const Glib::RefPtr<PrintSettings>& settings)
|
related |
A Glib::wrap() method for this object.
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. |