gtkmm: Gtk::PrintJob Class Reference
A PrintJob object represents a job that is sent to a printer. More...
#include <gtkmm/printjob.h>
Public Types | |
typedef sigc::slot< void(const Glib::RefPtr< PrintJob >&)> | SlotPrintJobComplete |
For example, void on_print_job_complete(const Glib::RefPtr<PrintJob>& job);. More... | |
Public Types inherited from Glib::Object | |
typedef void(*)(gpointer data | DestroyNotify) |
Public Types inherited from sigc::trackable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Types inherited from sigc::notifiable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Member Functions | |
PrintJob (PrintJob&& src) noexcept | |
PrintJob& | operator= (PrintJob&& src) noexcept |
~PrintJob () noexcept override | |
GtkPrintJob* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkPrintJob* | gobj () const |
Provides access to the underlying C GObject. More... | |
GtkPrintJob* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
Glib::RefPtr< PrintSettings > | get_settings () |
Gets the Gtk::PrintSettings of the print job. More... | |
Glib::RefPtr< const PrintSettings > | get_settings () const |
Gets the Gtk::PrintSettings of the print job. More... | |
Glib::RefPtr< Printer > | get_printer () |
Gets the Gtk::Printer of the print job. More... | |
Glib::RefPtr< const Printer > | get_printer () const |
Gets the Gtk::Printer of the print job. More... | |
Glib::ustring | get_title () const |
Gets the job title. More... | |
PrintStatus | get_status () const |
Gets the status of the print job. More... | |
void | set_source_file (const std::string& filename) |
Make the Gtk::PrintJob send an existing document to the printing system. More... | |
Cairo::RefPtr< Cairo::Surface > | get_surface () |
Gets a cairo surface onto which the pages of the print job should be rendered. More... | |
Cairo::RefPtr< const Cairo::Surface > | get_surface () const |
Gets a cairo surface onto which the pages of the print job should be rendered. More... | |
void | set_track_print_status (bool track_status=true) |
If track_status is true , the print job will try to continue report on the status of the print job in the printer queues and printer. More... | |
bool | get_track_print_status () const |
Returns whether jobs will be tracked after printing. More... | |
void | send (const SlotPrintJobComplete& slot) |
Sends the print job off to the printer. More... | |
PrintPages | get_pages () const |
Gets the Gtk::PrintPages setting for this job. More... | |
void | set_pages (PrintPages pages) |
Sets the Gtk::PrintPages setting for this job. More... | |
std::vector< PageRange > | get_page_ranges () const |
void | set_page_ranges (const std::vector< PageRange >& ranges) |
PageSet | get_page_set () const |
Gets the Gtk::PageSet setting for this job. More... | |
void | set_page_set (PageSet page_set) |
Sets the Gtk::PageSet setting for this job. More... | |
int | get_num_copies () const |
Gets the number of copies of this job. More... | |
void | set_num_copies (int num_copies) |
Sets the number of copies for this job. More... | |
double | get_scale () const |
Gets the scale for this job (where 1.0 means unscaled). More... | |
void | set_scale (double scale) |
Sets the scale for this job (where 1.0 means unscaled). More... | |
guint | get_n_up () const |
Gets the n-up setting for this job. More... | |
void | set_n_up (guint n_up) |
Sets the n-up setting for this job. More... | |
NumberUpLayout | get_n_up_layout () const |
Gets the n-up layout setting for this job. More... | |
void | set_n_up_layout (NumberUpLayout layout) |
Sets the n-up layout setting for this job. More... | |
bool | get_rotate () const |
Gets whether the job is printed rotated. More... | |
void | set_rotate (bool rotate=true) |
Sets whether this job is printed rotated. More... | |
bool | get_collate () const |
Gets whether this job is printed collated. More... | |
void | set_collate (bool collate=true) |
Sets whether this job is printed collated. More... | |
bool | get_reverse () const |
Gets whether this job is printed reversed. More... | |
void | set_reverse (bool reverse=true) |
Sets whether this job is printed reversed. More... | |
Glib::SignalProxy< void()> | signal_status_changed () |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_title () const |
Title of the print job. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Printer > > | property_printer () const |
Printer to print the job to. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< PrintSettings > > | property_settings () const |
Printer settings. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< PageSetup > > | property_page_setup () const |
Page Setup. More... | |
Glib::PropertyProxy< bool > | property_track_print_status () |
true if the print job will continue to emit status-changed signals 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 job will continue to emit status-changed signals after the print data has been sent to the printer or print server. More... | |
Public Member Functions inherited from Glib::Object | |
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) |
Public Member Functions inherited from Glib::ObjectBase | |
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 |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (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 |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) 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< PrintJob > | create (const Glib::ustring& title, const Glib::RefPtr< Printer >& printer, const Glib::RefPtr< PrintSettings >& settings, const Glib::RefPtr< PageSetup >& page_setup) |
Protected Member Functions | |
PrintJob (const Glib::ustring& title, const Glib::RefPtr< Printer >& printer, const Glib::RefPtr< PrintSettings >& settings, const Glib::RefPtr< PageSetup >& page_setup) | |
Protected Member Functions inherited from Glib::Object | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
Protected Member Functions inherited from Glib::ObjectBase | |
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) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::PrintJob > | wrap (GtkPrintJob* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Detailed Description
A PrintJob object represents a job that is sent to a printer.
You only need to deal directly with print jobs if you use the non-portable PrintUnixDialog API.
Use get_surface() to obtain the cairo surface onto which the pages must be drawn. Use send() to send the finished job to the printer.If you don't use cairo then PrintJob also supports printing of manually generated postscript, via set_source_file().
Member Typedef Documentation
typedef sigc::slot<void(const Glib::RefPtr<PrintJob>&)> Gtk::PrintJob::SlotPrintJobComplete |
For example, void on_print_job_complete(const Glib::RefPtr<PrintJob>& job);.
- Exceptions
-
exception
Constructor & Destructor Documentation
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
Member Function Documentation
|
static |
bool Gtk::PrintJob::get_collate | ( | ) | const |
Gets whether this job is printed collated.
- Returns
- Whether the job is printed collated.
guint Gtk::PrintJob::get_n_up | ( | ) | const |
Gets the n-up setting for this job.
- Returns
- The n-up setting.
NumberUpLayout Gtk::PrintJob::get_n_up_layout | ( | ) | const |
Gets the n-up layout setting for this job.
- Returns
- The n-up layout.
int Gtk::PrintJob::get_num_copies | ( | ) | const |
Gets the number of copies of this job.
- Returns
- The number of copies.
std::vector<PageRange> Gtk::PrintJob::get_page_ranges | ( | ) | const |
PageSet Gtk::PrintJob::get_page_set | ( | ) | const |
Gets the Gtk::PageSet setting for this job.
- Returns
- The Gtk::PageSet setting.
PrintPages Gtk::PrintJob::get_pages | ( | ) | const |
Gets the Gtk::PrintPages setting for this job.
- Returns
- The Gtk::PrintPages setting.
Glib::RefPtr<Printer> Gtk::PrintJob::get_printer | ( | ) |
Gets the Gtk::Printer of the print job.
- Returns
- The printer of job.
Glib::RefPtr<const Printer> Gtk::PrintJob::get_printer | ( | ) | const |
Gets the Gtk::Printer of the print job.
- Returns
- The printer of job.
bool Gtk::PrintJob::get_reverse | ( | ) | const |
Gets whether this job is printed reversed.
- Returns
- Whether the job is printed reversed.
bool Gtk::PrintJob::get_rotate | ( | ) | const |
Gets whether the job is printed rotated.
- Returns
- Whether the job is printed rotated.
double Gtk::PrintJob::get_scale | ( | ) | const |
Gets the scale for this job (where 1.0 means unscaled).
- Returns
- The scale.
Glib::RefPtr<PrintSettings> Gtk::PrintJob::get_settings | ( | ) |
Gets the Gtk::PrintSettings of the print job.
- Returns
- The settings of job.
Glib::RefPtr<const PrintSettings> Gtk::PrintJob::get_settings | ( | ) | const |
Gets the Gtk::PrintSettings of the print job.
- Returns
- The settings of job.
PrintStatus Gtk::PrintJob::get_status | ( | ) | const |
Gets the status of the print job.
- Returns
- The status of job.
Cairo::RefPtr<Cairo::Surface> Gtk::PrintJob::get_surface | ( | ) |
Gets a cairo surface onto which the pages of the print job should be rendered.
- Returns
- The cairo surface of job.
- Exceptions
-
Glib::Error
Cairo::RefPtr<const Cairo::Surface> Gtk::PrintJob::get_surface | ( | ) | const |
Gets a cairo surface onto which the pages of the print job should be rendered.
- Returns
- The cairo surface of job.
- Exceptions
-
Glib::Error
Glib::ustring Gtk::PrintJob::get_title | ( | ) | const |
Gets the job title.
- Returns
- The title of job.
bool Gtk::PrintJob::get_track_print_status | ( | ) | const |
Returns whether jobs will be tracked after printing.
For details, see set_track_print_status().
- Returns
true
if print job status will be reported after printing.
|
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.
GtkPrintJob* Gtk::PrintJob::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<PageSetup> > Gtk::PrintJob::property_page_setup | ( | ) | const |
Page Setup.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Printer> > Gtk::PrintJob::property_printer | ( | ) | const |
Printer to print the job to.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<PrintSettings> > Gtk::PrintJob::property_settings | ( | ) | const |
Printer settings.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::PrintJob::property_title | ( | ) | const |
Title of the print job.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::PrintJob::property_track_print_status | ( | ) |
true
if the print job will continue to emit status-changed signals after the print data has been sent to the printer or print server.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::PrintJob::property_track_print_status | ( | ) | const |
true
if the print job will continue to emit status-changed signals after the print data has been sent to the printer or print server.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::PrintJob::send | ( | const SlotPrintJobComplete& | slot | ) |
Sends the print job off to the printer.
- Parameters
-
slot A function to call when the job completes or an error occurs.
void Gtk::PrintJob::set_collate | ( | bool | collate = true | ) |
Sets whether this job is printed collated.
- Parameters
-
collate Whether the job is printed collated.
void Gtk::PrintJob::set_n_up | ( | guint | n_up | ) |
Sets the n-up setting for this job.
- Parameters
-
n_up The n-up value.
void Gtk::PrintJob::set_n_up_layout | ( | NumberUpLayout | layout | ) |
Sets the n-up layout setting for this job.
- Parameters
-
layout The n-up layout setting.
void Gtk::PrintJob::set_num_copies | ( | int | num_copies | ) |
Sets the number of copies for this job.
- Parameters
-
num_copies The number of copies.
void Gtk::PrintJob::set_page_ranges | ( | const std::vector< PageRange >& | ranges | ) |
void Gtk::PrintJob::set_page_set | ( | PageSet | page_set | ) |
Sets the Gtk::PageSet setting for this job.
- Parameters
-
page_set A Gtk::PageSet setting.
void Gtk::PrintJob::set_pages | ( | PrintPages | pages | ) |
Sets the Gtk::PrintPages setting for this job.
- Parameters
-
pages The Gtk::PrintPages setting.
void Gtk::PrintJob::set_reverse | ( | bool | reverse = true | ) |
Sets whether this job is printed reversed.
- Parameters
-
reverse Whether the job is printed reversed.
void Gtk::PrintJob::set_rotate | ( | bool | rotate = true | ) |
Sets whether this job is printed rotated.
- Parameters
-
rotate Whether to print rotated.
void Gtk::PrintJob::set_scale | ( | double | scale | ) |
Sets the scale for this job (where 1.0 means unscaled).
- Parameters
-
scale The scale.
void Gtk::PrintJob::set_source_file | ( | const std::string & | filename | ) |
Make the Gtk::PrintJob send an existing document to the printing system.
The file can be in any format understood by the platforms printing system (typically PostScript, but on many platforms PDF may work too). See Gtk::Printer::accepts_pdf() and Gtk::Printer::accepts_ps().
- Parameters
-
filename The file to be printed.
- Exceptions
-
Glib::Error
void Gtk::PrintJob::set_track_print_status | ( | bool | track_status = true | ) |
If track_status is true
, the print job 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.
- Parameters
-
track_status true
to track status after printing.
Glib::SignalProxy<void()> Gtk::PrintJob::signal_status_changed | ( | ) |
- Slot Prototype:
void on_my_status_changed()
Flags: Run Last
Gets emitted when the status of a job changes. The signal handler can use Gtk::PrintJob::get_status() to obtain the new status.
Friends And Related Function Documentation
|
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.