GI.Gtk.Objects.PrintJob

A GtkPrintJob 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 printJobGetSurface to obtain the cairo surface onto which the pages must be drawn. Use printJobSend to send the finished job to the printer. If you don’t use cairo GtkPrintJob also supports printing of manually generated PostScript, via printJobSetSourceFile.

Exported types

newtype PrintJob

Memory-managed wrapper type.

Constructors

PrintJob (ManagedPtr PrintJob)

Instances

Eq PrintJob

Defined in GI.Gtk.Objects.PrintJob

Methods

(==) :: PrintJob -> PrintJob -> Bool

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

GObject PrintJob

Defined in GI.Gtk.Objects.PrintJob

ManagedPtrNewtype PrintJob

Defined in GI.Gtk.Objects.PrintJob

Methods

toManagedPtr :: PrintJob -> ManagedPtr PrintJob

TypedObject PrintJob

Defined in GI.Gtk.Objects.PrintJob

Methods

glibType :: IO GType

HasParentTypes PrintJob

Defined in GI.Gtk.Objects.PrintJob

IsGValue (Maybe PrintJob)

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

Defined in GI.Gtk.Objects.PrintJob

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PrintJob

Defined in GI.Gtk.Objects.PrintJob

type ParentTypes PrintJob = '[Object]

class (GObject o, IsDescendantOf PrintJob o) => IsPrintJob o

Type class for types which can be safely cast to PrintJob, for instance with toPrintJob.

Instances

(GObject o, IsDescendantOf PrintJob o) => IsPrintJob o

Defined in GI.Gtk.Objects.PrintJob

toPrintJob :: (MonadIO m, IsPrintJob o) => o -> m PrintJob

Cast to PrintJob, 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

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, send, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCollate, getData, getNUp, getNUpLayout, getNumCopies, getPageRanges, getPageSet, getPages, getPrinter, getProperty, getQdata, getReverse, getRotate, getScale, getSettings, getStatus, getSurface, getTitle, getTrackPrintStatus.

Setters

setCollate, setData, setDataFull, setNUp, setNUpLayout, setNumCopies, setPageRanges, setPageSet, setPages, setProperty, setReverse, setRotate, setScale, setSourceFd, setSourceFile, setTrackPrintStatus.

getCollate

printJobGetCollate

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Bool

Returns: whether the job is printed collated

Gets whether this job is printed collated.

getNUp

printJobGetNUp

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Word32

Returns: the n-up setting

Gets the n-up setting for this job.

getNUpLayout

printJobGetNUpLayout

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m NumberUpLayout

Returns: the n-up layout

Gets the n-up layout setting for this job.

getNumCopies

printJobGetNumCopies

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Int32

Returns: the number of copies

Gets the number of copies of this job.

getPageRanges

printJobGetPageRanges

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m [PageRange]

Returns: a pointer to an array of GtkPageRange structs

Gets the page ranges for this job.

getPageSet

printJobGetPageSet

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m PageSet

Returns: the GtkPageSet setting

Gets the GtkPageSet setting for this job.

getPages

printJobGetPages

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m PrintPages

Returns: the GtkPrintPages setting

Gets the GtkPrintPages setting for this job.

getPrinter

printJobGetPrinter

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Printer

Returns: the printer of job

Gets the GtkPrinter of the print job.

getReverse

printJobGetReverse

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Bool

Returns: whether the job is printed reversed.

Gets whether this job is printed reversed.

getRotate

printJobGetRotate

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Bool

Returns: whether the job is printed rotated

Gets whether the job is printed rotated.

getScale

printJobGetScale

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Double

Returns: the scale

Gets the scale for this job.

getSettings

printJobGetSettings

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m PrintSettings

Returns: the settings of job

Gets the GtkPrintSettings of the print job.

getStatus

printJobGetStatus

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m PrintStatus

Returns: the status of job

Gets the status of the print job.

getSurface

printJobGetSurface

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Surface

Returns: the cairo surface of job (Can throw GError)

Gets a cairo surface onto which the pages of the print job should be rendered.

getTitle

printJobGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Text

Returns: the title of job

Gets the job title.

getTrackPrintStatus

printJobGetTrackPrintStatus

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> m Bool

Returns: True if print job status will be reported after printing

Returns whether jobs will be tracked after printing.

For details, see printJobSetTrackPrintStatus.

new

printJobNew

Arguments

:: (HasCallStack, MonadIO m, IsPrinter a, IsPrintSettings b, IsPageSetup c)

=> Text

title: the job title

-> a

printer: a GtkPrinter

-> b

settings: a GtkPrintSettings

-> c

pageSetup: a GtkPageSetup

-> m PrintJob

Returns: a new GtkPrintJob

Creates a new GtkPrintJob.

send

printJobSend

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> PrintJobCompleteFunc

callback: function to call when the job completes or an error occurs

-> m ()

Sends the print job off to the printer.

setCollate

printJobSetCollate

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Bool

collate: whether the job is printed collated

-> m ()

Sets whether this job is printed collated.

setNUp

printJobSetNUp

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Word32

nUp: the n-up value

-> m ()

Sets the n-up setting for this job.

setNUpLayout

printJobSetNUpLayout

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> NumberUpLayout

layout: the n-up layout setting

-> m ()

Sets the n-up layout setting for this job.

setNumCopies

printJobSetNumCopies

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Int32

numCopies: the number of copies

-> m ()

Sets the number of copies for this job.

setPageRanges

printJobSetPageRanges

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> [PageRange]

ranges: pointer to an array of GtkPageRange structs

-> m ()

Sets the page ranges for this job.

setPageSet

printJobSetPageSet

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> PageSet

pageSet: a GtkPageSet setting

-> m ()

Sets the GtkPageSet setting for this job.

setPages

printJobSetPages

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> PrintPages

pages: the GtkPrintPages setting

-> m ()

Sets the GtkPrintPages setting for this job.

setReverse

printJobSetReverse

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Bool

reverse: whether the job is printed reversed

-> m ()

Sets whether this job is printed reversed.

setRotate

printJobSetRotate

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Bool

rotate: whether to print rotated

-> m ()

Sets whether this job is printed rotated.

setScale

printJobSetScale

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Double

scale: the scale

-> m ()

Sets the scale for this job.

1. 0 means unscaled.

setSourceFd

printJobSetSourceFd

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Int32

fd: a file descriptor

-> m ()

(Can throw GError)

Make the GtkPrintJob 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 printerAcceptsPdf and printerAcceptsPs.

This is similar to printJobSetSourceFile, but takes expects an open file descriptor for the file, instead of a filename.

setSourceFile

printJobSetSourceFile

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> [Char]

filename: the file to be printed

-> m ()

(Can throw GError)

Make the GtkPrintJob 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 printerAcceptsPdf and printerAcceptsPs.

setTrackPrintStatus

printJobSetTrackPrintStatus

Arguments

:: (HasCallStack, MonadIO m, IsPrintJob a)

=> a

job: a GtkPrintJob

-> Bool

trackStatus: True to track status after printing

-> m ()

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.

Properties

pageSetup

Page setup.

constructPrintJobPageSetup :: (IsPrintJob o, MonadIO m, IsPageSetup a) => a -> m (GValueConstruct o)

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

getPrintJobPageSetup :: (MonadIO m, IsPrintJob o) => o -> m (Maybe PageSetup)

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

get printJob #pageSetup

printer

The printer to send the job to.

constructPrintJobPrinter :: (IsPrintJob o, MonadIO m, IsPrinter a) => a -> m (GValueConstruct o)

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

getPrintJobPrinter :: (MonadIO m, IsPrintJob o) => o -> m Printer

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

get printJob #printer

settings

Printer settings.

constructPrintJobSettings :: (IsPrintJob o, MonadIO m, IsPrintSettings a) => a -> m (GValueConstruct o)

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

getPrintJobSettings :: (MonadIO m, IsPrintJob o) => o -> m PrintSettings

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

get printJob #settings

title

The title of the print job.

constructPrintJobTitle :: (IsPrintJob o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPrintJobTitle :: (MonadIO m, IsPrintJob o) => o -> m Text

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

get printJob #title

trackPrintStatus

True if the print job will continue to emit status-changed signals after the print data has been setn to the printer.

constructPrintJobTrackPrintStatus :: (IsPrintJob o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPrintJobTrackPrintStatus :: (MonadIO m, IsPrintJob o) => o -> m Bool

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

get printJob #trackPrintStatus

setPrintJobTrackPrintStatus :: (MonadIO m, IsPrintJob o) => o -> Bool -> m ()

Set the value of the “track-print-status” property. When overloading is enabled, this is equivalent to

set printJob [ #trackPrintStatus := value ]

Signals

statusChanged

type PrintJobStatusChangedCallback = IO ()

Emitted when the status of a job changes.

The signal handler can use printJobGetStatus to obtain the new status.

afterPrintJobStatusChanged :: (IsPrintJob a, MonadIO m) => a -> ((?self :: a) => PrintJobStatusChangedCallback) -> m SignalHandlerId

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

after printJob #statusChanged 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.

onPrintJobStatusChanged :: (IsPrintJob a, MonadIO m) => a -> ((?self :: a) => PrintJobStatusChangedCallback) -> m SignalHandlerId

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

on printJob #statusChanged callback