Description
A GtkPrinter object represents a printer. You only need to
deal directly with printers if you use the non-portable
GtkPrintUnixDialog API.
A GtkPrinter allows to get status information about the printer,
such as its description, its location, the number of queued jobs,
etc. Most importantly, a GtkPrinter object can be used to create
a GtkPrintJob object, which lets you print to the printer.
Printing support was added in GTK+ 2.10.
Functions
gtk_printer_get_backend ()
GtkPrintBackend *
gtk_printer_get_backend (GtkPrinter *printer);
Returns the backend of the printer.
Returns
the backend of printer
.
[transfer none]
Since: 2.10
gtk_printer_get_name ()
const gchar *
gtk_printer_get_name (GtkPrinter *printer);
Returns the name of the printer.
Returns
the name of printer
Since: 2.10
gtk_printer_get_state_message ()
const gchar *
gtk_printer_get_state_message (GtkPrinter *printer);
Returns the state message describing the current state
of the printer.
Returns
the state message of printer
Since: 2.10
gtk_printer_get_description ()
const gchar *
gtk_printer_get_description (GtkPrinter *printer);
Gets the description of the printer.
Returns
the description of printer
Since: 2.10
gtk_printer_get_location ()
const gchar *
gtk_printer_get_location (GtkPrinter *printer);
Returns a description of the location of the printer.
Returns
the location of printer
Since: 2.10
gtk_printer_get_icon_name ()
const gchar *
gtk_printer_get_icon_name (GtkPrinter *printer);
Gets the name of the icon to use for the printer.
Returns
the icon name for printer
Since: 2.10
gtk_printer_get_job_count ()
gint
gtk_printer_get_job_count (GtkPrinter *printer);
Gets the number of jobs currently queued on the printer.
Returns
the number of jobs on printer
Since: 2.10
gtk_printer_is_active ()
gboolean
gtk_printer_is_active (GtkPrinter *printer);
Returns whether the printer is currently active (i.e.
accepts new jobs).
Returns
TRUE if printer
is active
Since: 2.10
gtk_printer_is_paused ()
gboolean
gtk_printer_is_paused (GtkPrinter *printer);
Returns whether the printer is currently paused.
A paused printer still accepts jobs, but it is not
printing them.
Returns
TRUE if printer
is paused
Since: 2.14
gtk_printer_is_accepting_jobs ()
gboolean
gtk_printer_is_accepting_jobs (GtkPrinter *printer);
Returns whether the printer is accepting jobs
Returns
TRUE if printer
is accepting jobs
Since: 2.14
gtk_printer_is_virtual ()
gboolean
gtk_printer_is_virtual (GtkPrinter *printer);
Returns whether the printer is virtual (i.e. does not
represent actual printer hardware, but something like
a CUPS class).
Returns
TRUE if printer
is virtual
Since: 2.10
gtk_printer_is_default ()
gboolean
gtk_printer_is_default (GtkPrinter *printer);
Returns whether the printer is the default printer.
Returns
TRUE if printer
is the default
Since: 2.10
gtk_printer_accepts_ps ()
gboolean
gtk_printer_accepts_ps (GtkPrinter *printer);
Returns whether the printer accepts input in
PostScript format.
Returns
TRUE if printer
accepts PostScript
Since: 2.10
gtk_printer_accepts_pdf ()
gboolean
gtk_printer_accepts_pdf (GtkPrinter *printer);
Returns whether the printer accepts input in
PDF format.
Returns
TRUE if printer
accepts PDF
Since: 2.10
gtk_printer_compare ()
gint
gtk_printer_compare (GtkPrinter *a,
GtkPrinter *b);
Compares two printers.
Returns
0 if the printer match, a negative value if a
< b
,
or a positive value if a
> b
Since: 2.10
gtk_printer_has_details ()
gboolean
gtk_printer_has_details (GtkPrinter *printer);
Returns whether the printer details are available.
Returns
TRUE if printer
details are available
Since: 2.12
gtk_printer_request_details ()
void
gtk_printer_request_details (GtkPrinter *printer);
Requests the printer details. When the details are available,
the “details-acquired” signal will be emitted on printer
.
Since: 2.12
gtk_printer_get_default_page_size ()
GtkPageSetup *
gtk_printer_get_default_page_size (GtkPrinter *printer);
Returns default page size of printer
.
Returns
a newly allocated GtkPageSetup with default page size of the printer.
Since: 2.14
GtkPrinterFunc ()
gboolean
(*GtkPrinterFunc) (GtkPrinter *printer,
gpointer data);
The type of function passed to gtk_enumerate_printers().
Note that you need to ref printer
, if you want to keep
a reference to it after the function has returned.
Returns
TRUE to stop the enumeration, FALSE to continue
Since: 2.10
Property Details
The “accepting-jobs” property
“accepting-jobs” gboolean
This property is TRUE if the printer is accepting jobs.
Owner: GtkPrinter
Flags: Read
Default value: TRUE
Since: 2.14
The “accepts-pdf” property
“accepts-pdf” gboolean
TRUE if this printer can accept PDF.
Owner: GtkPrinter
Flags: Read / Write / Construct Only
Default value: FALSE
The “accepts-ps” property
“accepts-ps” gboolean
TRUE if this printer can accept PostScript.
Owner: GtkPrinter
Flags: Read / Write / Construct Only
Default value: TRUE
The “backend” property
“backend” GtkPrintBackend *
Backend for the printer.
Owner: GtkPrinter
Flags: Read / Write / Construct Only
The “icon-name” property
“icon-name” gchar *
The icon name to use for the printer.
Owner: GtkPrinter
Flags: Read
Default value: ""
The “is-virtual” property
“is-virtual” gboolean
FALSE if this represents a real hardware printer.
Owner: GtkPrinter
Flags: Read / Write / Construct Only
Default value: FALSE
The “job-count” property
“job-count” gint
Number of jobs queued in the printer.
Owner: GtkPrinter
Flags: Read
Allowed values: >= 0
Default value: 0
The “location” property
“location” gchar *
The location of the printer.
Owner: GtkPrinter
Flags: Read
Default value: ""
The “name” property
“name” gchar *
Name of the printer.
Owner: GtkPrinter
Flags: Read / Write / Construct Only
Default value: ""
The “paused” property
“paused” gboolean
This property is TRUE if this printer is paused.
A paused printer still accepts jobs, but it does
not print them.
Owner: GtkPrinter
Flags: Read
Default value: FALSE
Since: 2.14
The “state-message” property
“state-message” gchar *
String giving the current state of the printer.
Owner: GtkPrinter
Flags: Read
Default value: ""