gi-webkit2-4.0.27: WebKit2 bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.WebKit2.Objects.PrintOperation

Description

No description available in the introspection data.

Synopsis

Exported types

newtype PrintOperation Source #

Memory-managed wrapper type.

Constructors

PrintOperation (ManagedPtr PrintOperation) 

Instances

Instances details
Eq PrintOperation Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

GObject PrintOperation Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

ManagedPtrNewtype PrintOperation Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

TypedObject PrintOperation Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

Methods

glibType :: IO GType

HasParentTypes PrintOperation Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

IsGValue (Maybe PrintOperation) Source #

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

Instance details

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 Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

type ParentTypes PrintOperation = '[Object]

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

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

Instances

Instances details
(GObject o, IsDescendantOf PrintOperation o) => IsPrintOperation o Source # 
Instance details

Defined in GI.WebKit2.Objects.PrintOperation

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

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

Methods

getPageSetup

printOperationGetPageSetup Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperation a) 
=> a

printOperation: a PrintOperation

-> m () 

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 finished signal is emitted when the printing operation finishes. If an error occurs while printing the signal failed is emitted before finished.

runDialog

printOperationRunDialog Source #

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 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 finished signal is emitted when the operation finishes. If an error occurs while printing, the signal failed is emitted before 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 Source #

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 Source #

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

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) Source #

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 () Source #

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) Source #

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) Source #

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 () Source #

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) Source #

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) Source #

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

get printOperation #webView

Signals

createCustomWidget

type C_PrintOperationCreateCustomWidgetCallback = Ptr () -> Ptr () -> IO (Ptr PrintCustomWidget) Source #

Type for the callback on the (unwrapped) C side.

type PrintOperationCreateCustomWidgetCallback Source #

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 apply is emitted.

Since: 2.16

afterPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationCreateCustomWidgetCallback -> m SignalHandlerId Source #

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

onPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationCreateCustomWidgetCallback -> m SignalHandlerId Source #

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 C_PrintOperationFailedCallback = Ptr () -> Ptr GError -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type PrintOperationFailedCallback Source #

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 finished signal is emitted after this one.

afterPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFailedCallback -> m SignalHandlerId Source #

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

onPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFailedCallback -> m SignalHandlerId Source #

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 C_PrintOperationFinishedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type PrintOperationFinishedCallback = IO () Source #

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

afterPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFinishedCallback -> m SignalHandlerId Source #

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

onPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFinishedCallback -> m SignalHandlerId Source #

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