struct GtkPrinter

struct GtkPrinter;

GtkPrintBackend

typedef struct _GtkPrintBackend GtkPrintBackend;

gtk_printer_new ()

GtkPrinter *        gtk_printer_new                     (const gchar *name,
                                                         GtkPrintBackend *backend,
                                                         gboolean virtual_);

Creates a new GtkPrinter.

Since 2.10

gtk_printer_get_backend ()

GtkPrintBackend *   gtk_printer_get_backend             (GtkPrinter *printer);

Returns the backend of the printer.

Since 2.10

gtk_printer_get_name ()

const gchar *             gtk_printer_get_name          (GtkPrinter *printer);

Returns the name of the 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.

Since 2.10

gtk_printer_get_description ()

const gchar *             gtk_printer_get_description   (GtkPrinter *printer);

Gets the description of the 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.

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.

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.

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).

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.

Since 2.14

gtk_printer_is_accepting_jobs ()

gboolean            gtk_printer_is_accepting_jobs       (GtkPrinter *printer);

Returns whether the 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).

Since 2.10

gtk_printer_is_default ()

gboolean            gtk_printer_is_default              (GtkPrinter *printer);

Returns whether the printer is the default printer.

Since 2.10

gtk_printer_accepts_ps ()

gboolean            gtk_printer_accepts_ps              (GtkPrinter *printer);

Returns whether the printer accepts input in PostScript format.

Since 2.10

gtk_printer_accepts_pdf ()

gboolean            gtk_printer_accepts_pdf             (GtkPrinter *printer);

Returns whether the printer accepts input in PDF format.

Since 2.10

gtk_printer_list_papers ()

GList *             gtk_printer_list_papers             (GtkPrinter *printer);

Lists all the paper sizes printer supports. This will return and empty list unless the printer's details are available, see gtk_printer_has_details() and gtk_printer_request_details().

Since 2.12

gtk_printer_compare ()

gint                gtk_printer_compare                 (GtkPrinter *a,
                                                         GtkPrinter *b);

Compares two printers.

Since 2.10

gtk_printer_has_details ()

gboolean            gtk_printer_has_details             (GtkPrinter *printer);

Returns whether the 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_capabilities ()

GtkPrintCapabilities  gtk_printer_get_capabilities      (GtkPrinter *printer);

Returns the printer's capabilities.

This is useful when you're using GtkPrintUnixDialog's manual-capabilities setting and need to know which settings the printer can handle and which you must handle yourself.

This will return 0 unless the printer's details are available, see gtk_printer_has_details() and gtk_printer_request_details().

Since 2.12

gtk_printer_get_default_page_size ()

GtkPageSetup *      gtk_printer_get_default_page_size   (GtkPrinter *printer);

Returns default page size of printer.

Since 2.14

gtk_printer_get_hard_margins ()

gboolean            gtk_printer_get_hard_margins        (GtkPrinter *printer,
                                                         gdouble *top,
                                                         gdouble *bottom,
                                                         gdouble *left,
                                                         gdouble *right);

Retrieve the hard margins of printer, i.e. the margins that define the area at the borders of the paper that the printer cannot print to.

Note: This will not succeed unless the printer's details are available, see gtk_printer_has_details() and gtk_printer_request_details().

Since 2.20

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.

gtk_enumerate_printers ()

void                gtk_enumerate_printers              (GtkPrinterFunc func,
                                                         gpointer data,
                                                         GDestroyNotify destroy,
                                                         gboolean wait);

Calls a function for all GtkPrinters. If func returns TRUE, the enumeration is stopped.

Since 2.10

The "accepting-jobs" property

  "accepting-jobs"           gboolean              : Read

This property is TRUE if the printer is accepting jobs.

Default value: TRUE

Since 2.14

The "accepts-pdf" property

  "accepts-pdf"              gboolean              : Read / Write / Construct Only

TRUE if this printer can accept PDF.

Default value: FALSE

The "accepts-ps" property

  "accepts-ps"               gboolean              : Read / Write / Construct Only

TRUE if this printer can accept PostScript.

Default value: TRUE

The "backend" property

  "backend"                  GtkPrintBackend*      : Read / Write / Construct Only

Backend for the printer.

The "icon-name" property

  "icon-name"                gchar*                : Read

The icon name to use for the printer.

Default value: ""

The "is-virtual" property

  "is-virtual"               gboolean              : Read / Write / Construct Only

FALSE if this represents a real hardware printer.

Default value: FALSE

The "job-count" property

  "job-count"                gint                  : Read

Number of jobs queued in the printer.

Allowed values: >= 0

Default value: 0

The "location" property

  "location"                 gchar*                : Read

The location of the printer.

Default value: ""

The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Name of the printer.

Default value: ""

The "paused" property

  "paused"                   gboolean              : Read

This property is TRUE if this printer is paused. A paused printer still accepts jobs, but it does not print them.

Default value: FALSE

Since 2.14

The "state-message" property

  "state-message"            gchar*                : Read

String giving the current state of the printer.

Default value: ""

The "details-acquired" signal

void                user_function                      (GtkPrinter *printer,
                                                        gboolean    success,
                                                        gpointer    user_data)      : Run Last

Gets emitted in response to a request for detailed information about a printer from the print backend. The success parameter indicates if the information was actually obtained.

Since 2.10