gtkunixprint.Printer — an object representing a print in Unix (new in PyGTK 2.10)
class gtkunixprint.Printer( |
|
def callback( |
This class is available in PyGTK 2.10 and above.
A gtkunixprint.Printer
object represents a printer. You only need to deal directly with
printers if you use the non-portable gtkunixprint.PrintUnixDialog
API.
A gtkunixprint.Printer
allows you to get status information about the printer, such as its
description, its location, the number of queued jobs, etc. Most
importantly, a gtkunixprint.Printer
object can be used to create a gtkunixprint.PrintJob
object, that lets you print to the printer.
def get_name()
Returns : | the name of the printer |
This method is available in PyGTK 2.10 and above.
The get_name
() method returns the name
of the printer.
def get_state_message()
Returns : | the state message of the printer |
This method is available in PyGTK 2.10 and above.
The get_state_message
() method returns
the state message describing the current state of the printer.
def get_description()
Returns : | the description of the printer |
This method is available in PyGTK 2.10 and above.
The get_description
() method returns
the description of the printer.
def get_capabilities()
Returns : | the printer's capabilities. |
This method is available in PyGTK 2.12 and above.
The get_capabilities
() method 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 gtkunixprint.Printer.has_details() and gtkunixprint.Printer.request_details().
def get_location()
Returns : | the location of the printer |
This method is available in PyGTK 2.10 and above.
The get_location
() method returns a
description of the location of the printer.
def get_icon_name()
Returns : | the icon name for the printer |
This method is available in PyGTK 2.10 and above.
The get_icon_name
() method returns the
name of the icon to use for the printer.
def get_job_count()
Returns : | the number of jobs on the printer |
This method is available in PyGTK 2.10 and above.
The get_job_count
() method returns the
number of jobs currently queued on the printer.
def has_details()
Returns : | True if printer details
are available |
This method is available in PyGTK 2.12 and above.
The has_details
() method returns
whether the printer details are available.
def request_details()
This method is available in PyGTK 2.12 and above.
The request_details
() method requests
the printer details. When the details are available,
the GtkPrinter::details-acquired signal will be emitted on printer.
def is_accepting_jobs()
Returns : | True if printer is accepting jobs. |
This method is available in PyGTK 2.14 and above.
The is_accepting_jobs
() method returns
whether the printer is accepting jobs
def is_active()
Returns : | True if the printer is active |
This method is available in PyGTK 2.10 and above.
The is_active
() method returns
True
if the printer is currently active (i.e.
accepts new jobs).
def is_paused()
Returns : | True if the printer is paused. |
This method is available in PyGTK 2.14 and above.
The is_paused
() method returns
whether the printer is currently paused. A paused printer still accepts
jobs, but it is not printing them.
def is_virtual()
Returns : | True if the printer is
virtual |
This method is available in PyGTK 2.10 and above.
The is_virtual
() method returns
True
if the printer is virtual (i.e. does not
represent actual printer hardware, but something like a CUPS
class).
def is_default()
Returns : | True if the printer is the default |
This method is available in PyGTK 2.10 and above.
The is_default
() method returns
True
if the printer is the default printer.
def compare(b
)
| a gtkunixprint.Printer |
Returns : | an integer indicating the result of the
comparison of the gtkunixprint.Printer
names. |
This method is available in PyGTK 2.10 and above.
The compare() method compares the name of the printer to the
name of the gtkunixprint.Printer
specified by b
and returns:
a negative integer if the name of the printer is less than
the name of b
.
a negative integer if the name of the printer is the same as
the name of b
.
a positive integer if the name of the printer is greater
than the name of b
.
def callback(printer
, success
, user_param1
, ...
)
| the printer that received the signal |
| True if the details were
successfully acquired |
| the first user parameter (if any) specified
with the connect () |
| additional user parameters (if any) |
This signal is available in GTK+ 2.10 and above.
The "details-acquired" signal is 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.