GI.Gtk.Objects.Printer

A GtkPrinter object represents a printer.

You only need to deal directly with printers if you use the non-portable PrintUnixDialog 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 PrintJob object, which lets you print to the printer.

Exported types

newtype Printer

Memory-managed wrapper type.

Constructors

Printer (ManagedPtr Printer)

Instances

Eq Printer

Defined in GI.Gtk.Objects.Printer

Methods

(==) :: Printer -> Printer -> Bool

(/=) :: Printer -> Printer -> Bool

GObject Printer

Defined in GI.Gtk.Objects.Printer

ManagedPtrNewtype Printer

Defined in GI.Gtk.Objects.Printer

Methods

toManagedPtr :: Printer -> ManagedPtr Printer

TypedObject Printer

Defined in GI.Gtk.Objects.Printer

Methods

glibType :: IO GType

HasParentTypes Printer

Defined in GI.Gtk.Objects.Printer

IsGValue (Maybe Printer)

Convert Printer to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.Printer

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Printer -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Printer)

type ParentTypes Printer

Defined in GI.Gtk.Objects.Printer

type ParentTypes Printer = '[Object]

class (GObject o, IsDescendantOf Printer o) => IsPrinter o

Type class for types which can be safely cast to Printer, for instance with toPrinter.

Instances

(GObject o, IsDescendantOf Printer o) => IsPrinter o

Defined in GI.Gtk.Objects.Printer

toPrinter :: (MonadIO m, IsPrinter o) => o -> m Printer

Cast to Printer, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

acceptsPdf, acceptsPs, bindProperty, bindPropertyFull, compare, forceFloating, freezeNotify, getv, hasDetails, isAcceptingJobs, isActive, isDefault, isFloating, isPaused, isVirtual, listPapers, notify, notifyByPspec, ref, refSink, requestDetails, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getBackend, getCapabilities, getData, getDefaultPageSize, getDescription, getHardMargins, getHardMarginsForPaperSize, getIconName, getJobCount, getLocation, getName, getProperty, getQdata, getStateMessage.

Setters

setData, setDataFull, setProperty.

acceptsPdf

printerAcceptsPdf

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer accepts PDF

Returns whether the printer accepts input in PDF format.

acceptsPs

printerAcceptsPs

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer accepts PostScript

Returns whether the printer accepts input in PostScript format.

compare

printerCompare

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a, IsPrinter b)

=> a

a: a GtkPrinter

-> b

b: another GtkPrinter

-> m Int32

Returns: 0 if the printer match, a negative value if a < b, or a positive value if a > b

Compares two printers.

getBackend

printerGetBackend

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m PrintBackend

Returns: the backend of printer

Returns the backend of the printer.

getCapabilities

printerGetCapabilities

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m [PrintCapabilities]

Returns: the printer’s capabilities

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 printerHasDetails and printerRequestDetails.

getDefaultPageSize

printerGetDefaultPageSize

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m PageSetup

Returns: a newly allocated GtkPageSetup with default page size of the printer.

Returns default page size of printer.

getDescription

printerGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Text

Returns: the description of printer

Gets the description of the printer.

getHardMargins

printerGetHardMargins

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m (Bool, Double, Double, Double, Double)

Returns: True iff the hard margins were retrieved

Retrieve the hard margins of printer.

These are 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 printerHasDetails and printerRequestDetails.

getHardMarginsForPaperSize

printerGetHardMarginsForPaperSize

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> PaperSize

paperSize: a GtkPaperSize

-> m (Bool, Double, Double, Double, Double)

Returns: True iff the hard margins were retrieved

Retrieve the hard margins of printer for paperSize.

These are 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 printerHasDetails and printerRequestDetails.

getIconName

printerGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Text

Returns: the icon name for printer

Gets the name of the icon to use for the printer.

getJobCount

printerGetJobCount

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Int32

Returns: the number of jobs on printer

Gets the number of jobs currently queued on the printer.

getLocation

printerGetLocation

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Text

Returns: the location of printer

Returns a description of the location of the printer.

getName

printerGetName

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Text

Returns: the name of printer

Returns the name of the printer.

getStateMessage

printerGetStateMessage

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Text

Returns: the state message of printer

Returns the state message describing the current state of the printer.

hasDetails

printerHasDetails

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer details are available

Returns whether the printer details are available.

isAcceptingJobs

printerIsAcceptingJobs

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer is accepting jobs

Returns whether the printer is accepting jobs

isActive

printerIsActive

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer is active

Returns whether the printer is currently active (i.e. accepts new jobs).

isDefault

printerIsDefault

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer is the default

Returns whether the printer is the default printer.

isPaused

printerIsPaused

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer is paused

Returns whether the printer is currently paused.

A paused printer still accepts jobs, but it is not printing them.

isVirtual

printerIsVirtual

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m Bool

Returns: True if printer is virtual

Returns whether the printer is virtual (i.e. does not represent actual printer hardware, but something like a CUPS class).

listPapers

printerListPapers

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m [PageSetup]

Returns: a newly allocated list of newly allocated GtkPageSetups.

Lists all the paper sizes printer supports.

This will return and empty list unless the printer’s details are available, see printerHasDetails and printerRequestDetails.

new

printerNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the printer

-> PrintBackend

backend: a GtkPrintBackend

-> Bool

virtual_: whether the printer is virtual

-> m Printer

Returns: a new GtkPrinter

Creates a new GtkPrinter.

requestDetails

printerRequestDetails

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a)

=> a

printer: a GtkPrinter

-> m ()

Requests the printer details.

When the details are available, the Printer::detailsAcquired signal will be emitted on printer.

Properties

acceptingJobs

True if the printer is accepting jobs.

getPrinterAcceptingJobs :: (MonadIO m, IsPrinter o) => o -> m Bool

Get the value of the “accepting-jobs” property. When overloading is enabled, this is equivalent to

get printer #acceptingJobs

acceptsPdf

True if this printer can accept PDF.

constructPrinterAcceptsPdf :: (IsPrinter o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “accepts-pdf” property. This is rarely needed directly, but it is used by new.

getPrinterAcceptsPdf :: (MonadIO m, IsPrinter o) => o -> m Bool

Get the value of the “accepts-pdf” property. When overloading is enabled, this is equivalent to

get printer #acceptsPdf

acceptsPs

True if this printer can accept PostScript.

constructPrinterAcceptsPs :: (IsPrinter o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “accepts-ps” property. This is rarely needed directly, but it is used by new.

getPrinterAcceptsPs :: (MonadIO m, IsPrinter o) => o -> m Bool

Get the value of the “accepts-ps” property. When overloading is enabled, this is equivalent to

get printer #acceptsPs

iconName

Icon name to use for the printer.

getPrinterIconName :: (MonadIO m, IsPrinter o) => o -> m Text

Get the value of the “icon-name” property. When overloading is enabled, this is equivalent to

get printer #iconName

isVirtual

False if this represents a real hardware device.

constructPrinterIsVirtual :: (IsPrinter o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “is-virtual” property. This is rarely needed directly, but it is used by new.

getPrinterIsVirtual :: (MonadIO m, IsPrinter o) => o -> m Bool

Get the value of the “is-virtual” property. When overloading is enabled, this is equivalent to

get printer #isVirtual

jobCount

Number of jobs queued in the printer.

getPrinterJobCount :: (MonadIO m, IsPrinter o) => o -> m Int32

Get the value of the “job-count” property. When overloading is enabled, this is equivalent to

get printer #jobCount

location

Information about the location of the printer.

getPrinterLocation :: (MonadIO m, IsPrinter o) => o -> m Text

Get the value of the “location” property. When overloading is enabled, this is equivalent to

get printer #location

name

The name of the printer.

constructPrinterName :: (IsPrinter o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.

getPrinterName :: (MonadIO m, IsPrinter o) => o -> m Text

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get printer #name

paused

True if this printer is paused.

A paused printer still accepts jobs, but it does not print them.

getPrinterPaused :: (MonadIO m, IsPrinter o) => o -> m Bool

Get the value of the “paused” property. When overloading is enabled, this is equivalent to

get printer #paused

stateMessage

String giving the current status of the printer.

getPrinterStateMessage :: (MonadIO m, IsPrinter o) => o -> m Text

Get the value of the “state-message” property. When overloading is enabled, this is equivalent to

get printer #stateMessage

Signals

detailsAcquired

type PrinterDetailsAcquiredCallback

Arguments

 = Bool

success: True if the details were successfully acquired

-> IO ()

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.

afterPrinterDetailsAcquired :: (IsPrinter a, MonadIO m) => a -> ((?self :: a) => PrinterDetailsAcquiredCallback) -> m SignalHandlerId

Connect a signal handler for the detailsAcquired signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printer #detailsAcquired callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onPrinterDetailsAcquired :: (IsPrinter a, MonadIO m) => a -> ((?self :: a) => PrinterDetailsAcquiredCallback) -> m SignalHandlerId

Connect a signal handler for the detailsAcquired signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printer #detailsAcquired callback