GI.WebKit2.Objects.PrintOperation

Controls a print operation.

A PrintOperation controls a print operation in WebKit. With a similar API to PrintOperation, it lets you set the print settings with printOperationSetPrintSettings or display the print dialog with printOperationRunDialog.

Exported types

newtype PrintOperation

Memory-managed wrapper type.

Constructors

PrintOperation (ManagedPtr PrintOperation)

Instances

Eq PrintOperation

Defined in GI.WebKit2.Objects.PrintOperation

Methods

(==) :: PrintOperation -> PrintOperation -> Bool

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

GObject PrintOperation

Defined in GI.WebKit2.Objects.PrintOperation

ManagedPtrNewtype PrintOperation

Defined in GI.WebKit2.Objects.PrintOperation

Methods

toManagedPtr :: PrintOperation -> ManagedPtr PrintOperation

TypedObject PrintOperation

Defined in GI.WebKit2.Objects.PrintOperation

Methods

glibType :: IO GType

HasParentTypes PrintOperation

Defined in GI.WebKit2.Objects.PrintOperation

IsGValue (Maybe PrintOperation)

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

Defined in GI.WebKit2.Objects.PrintOperation

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PrintOperation

Defined in GI.WebKit2.Objects.PrintOperation

type ParentTypes PrintOperation = '[Object]

class (GObject o, IsDescendantOf PrintOperation o) => IsPrintOperation o

Type class for types which can be safely cast to PrintOperation, for instance with toPrintOperation.

Instances

(GObject o, IsDescendantOf PrintOperation o) => IsPrintOperation o

Defined in GI.WebKit2.Objects.PrintOperation

toPrintOperation :: (MonadIO m, IsPrintOperation o) => o -> m PrintOperation

Cast to PrintOperation, 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, print, ref, refSink, runDialog, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getPageSetup, getPrintSettings, getProperty, getQdata.

Setters

setData, setDataFull, setPageSetup, setPrintSettings, setProperty.

getPageSetup

printOperationGetPageSetup

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a)

=> a

printOperation: a PrintOperation

-> m (Maybe PageSetup)

Returns: the current PageSetup of printOperation.

Return the current page setup of printOperation.

It returns Nothing until either printOperationSetPageSetup or printOperationRunDialog have been called.

getPrintSettings

printOperationGetPrintSettings

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a)

=> a

printOperation: a PrintOperation

-> m (Maybe PrintSettings)

Returns: the current PrintSettings of printOperation.

Return the current print settings of printOperation.

It returns Nothing until either printOperationSetPrintSettings or printOperationRunDialog have been called.

new

printOperationNew

Arguments

:: (HasCallStack, MonadIO m, IsWebView a)

=> a

webView: a WebView

-> m PrintOperation

Returns: a new PrintOperation.

Create a new PrintOperation to print webView contents.

print

printOperationPrint

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a)

=> a

printOperation: a PrintOperation

-> m ()

Start a print operation using current print settings and page setup.

Start a print operation using current print settings and page setup without showing the print dialog. If either print settings or page setup are not set with printOperationSetPrintSettings and printOperationSetPageSetup, the default options will be used and the print job will be sent to the default printer. The PrintOperation::finished signal is emitted when the printing operation finishes. If an error occurs while printing the signal PrintOperation::failed is emitted before PrintOperation::finished.

runDialog

printOperationRunDialog

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a, IsWindow b)

=> a

printOperation: a PrintOperation

-> Maybe b

parent: transient parent of the print dialog

-> m PrintOperationResponse

Returns: the PrintOperationResponse of the print dialog

Run the print dialog and start printing.

Run the print dialog and start printing using the options selected by the user. This method returns when the print dialog is closed. If the print dialog is cancelled PrintOperationResponseCancel is returned. If the user clicks on the print button, PrintOperationResponsePrint is returned and the print operation starts. In this case, the PrintOperation::finished signal is emitted when the operation finishes. If an error occurs while printing, the signal PrintOperation::failed is emitted before PrintOperation::finished. If the print dialog is not cancelled current print settings and page setup of printOperation are updated with options selected by the user when Print button is pressed in print dialog. You can get the updated print settings and page setup by calling printOperationGetPrintSettings and printOperationGetPageSetup after this method.

setPageSetup

printOperationSetPageSetup

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a, IsPageSetup b)

=> a

printOperation: a PrintOperation

-> b

pageSetup: a PageSetup to set

-> m ()

Set the current page setup of printOperation.

Current page setup is used for the initial values of the print dialog when printOperationRunDialog is called.

setPrintSettings

printOperationSetPrintSettings

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a, IsPrintSettings b)

=> a

printOperation: a PrintOperation

-> b

printSettings: a PrintSettings to set

-> m ()

Set the current print settings of printOperation.

Set the current print settings of printOperation. Current print settings are used for the initial values of the print dialog when printOperationRunDialog is called.

Properties

pageSetup

The initial PageSetup for the print operation.

constructPrintOperationPageSetup :: (IsPrintOperation 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.

getPrintOperationPageSetup :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe PageSetup)

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

get printOperation #pageSetup

setPrintOperationPageSetup :: (MonadIO m, IsPrintOperation o, IsPageSetup a) => o -> a -> m ()

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

set printOperation [ #pageSetup := value ]

printSettings

The initial PrintSettings for the print operation.

constructPrintOperationPrintSettings :: (IsPrintOperation o, MonadIO m, IsPrintSettings a) => a -> m (GValueConstruct o)

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

getPrintOperationPrintSettings :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe PrintSettings)

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

get printOperation #printSettings

setPrintOperationPrintSettings :: (MonadIO m, IsPrintOperation o, IsPrintSettings a) => o -> a -> m ()

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

set printOperation [ #printSettings := value ]

webView

The WebView that will be printed.

constructPrintOperationWebView :: (IsPrintOperation o, MonadIO m, IsWebView a) => a -> m (GValueConstruct o)

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

getPrintOperationWebView :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe WebView)

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

get printOperation #webView

Signals

createCustomWidget

type PrintOperationCreateCustomWidgetCallback

Arguments

 = IO PrintCustomWidget

Returns: A PrintCustomWidget that will be embedded in the dialog.

Emitted when displaying the print dialog with printOperationRunDialog. The returned PrintCustomWidget will be added to the print dialog and it will be owned by the printOperation. However, the object is guaranteed to be alive until the PrintCustomWidget::apply is emitted.

Since: 2.16

afterPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationCreateCustomWidgetCallback) -> m SignalHandlerId

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

after printOperation #createCustomWidget 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.

onPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationCreateCustomWidgetCallback) -> m SignalHandlerId

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

on printOperation #createCustomWidget callback

failed

type PrintOperationFailedCallback

Arguments

 = GError

error: the GError that was triggered

-> IO ()

Emitted when an error occurs while printing. The given error, of the domain WEBKIT_PRINT_ERROR, contains further details of the failure. The PrintOperation::finished signal is emitted after this one.

afterPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFailedCallback) -> m SignalHandlerId

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

after printOperation #failed 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.

onPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFailedCallback) -> m SignalHandlerId

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

on printOperation #failed callback

finished

type PrintOperationFinishedCallback = IO ()

Emitted when the print operation has finished doing everything required for printing.

afterPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFinishedCallback) -> m SignalHandlerId

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

after printOperation #finished 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.

onPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFinishedCallback) -> m SignalHandlerId

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

on printOperation #finished callback