| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.WebKit.Objects.PrintOperation
Description
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.
Synopsis
- newtype PrintOperation = PrintOperation (ManagedPtr PrintOperation)
- class (GObject o, IsDescendantOf PrintOperation o) => IsPrintOperation o
- toPrintOperation :: (MonadIO m, IsPrintOperation o) => o -> m PrintOperation
- printOperationGetPageSetup :: (HasCallStack, MonadIO m, IsPrintOperation a) => a -> m PageSetup
- printOperationGetPrintSettings :: (HasCallStack, MonadIO m, IsPrintOperation a) => a -> m PrintSettings
- printOperationNew :: (HasCallStack, MonadIO m, IsWebView a) => a -> m PrintOperation
- printOperationPrint :: (HasCallStack, MonadIO m, IsPrintOperation a) => a -> m ()
- printOperationRunDialog :: (HasCallStack, MonadIO m, IsPrintOperation a, IsWindow b) => a -> Maybe b -> m PrintOperationResponse
- printOperationSetPageSetup :: (HasCallStack, MonadIO m, IsPrintOperation a, IsPageSetup b) => a -> b -> m ()
- printOperationSetPrintSettings :: (HasCallStack, MonadIO m, IsPrintOperation a, IsPrintSettings b) => a -> b -> m ()
- constructPrintOperationPageSetup :: (IsPrintOperation o, MonadIO m, IsPageSetup a) => a -> m (GValueConstruct o)
- getPrintOperationPageSetup :: (MonadIO m, IsPrintOperation o) => o -> m PageSetup
- setPrintOperationPageSetup :: (MonadIO m, IsPrintOperation o, IsPageSetup a) => o -> a -> m ()
- constructPrintOperationPrintSettings :: (IsPrintOperation o, MonadIO m, IsPrintSettings a) => a -> m (GValueConstruct o)
- getPrintOperationPrintSettings :: (MonadIO m, IsPrintOperation o) => o -> m PrintSettings
- setPrintOperationPrintSettings :: (MonadIO m, IsPrintOperation o, IsPrintSettings a) => o -> a -> m ()
- constructPrintOperationWebView :: (IsPrintOperation o, MonadIO m, IsWebView a) => a -> m (GValueConstruct o)
- getPrintOperationWebView :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe WebView)
- type PrintOperationFailedCallback = GError -> IO ()
- afterPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFailedCallback) -> m SignalHandlerId
- onPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFailedCallback) -> m SignalHandlerId
- type PrintOperationFinishedCallback = IO ()
- afterPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFinishedCallback) -> m SignalHandlerId
- onPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: a) => PrintOperationFinishedCallback) -> m SignalHandlerId
Exported types
newtype PrintOperation Source #
Memory-managed wrapper type.
Constructors
| PrintOperation (ManagedPtr PrintOperation) |
Instances
| Eq PrintOperation Source # | |
Defined in GI.WebKit.Objects.PrintOperation Methods (==) :: PrintOperation -> PrintOperation -> Bool # (/=) :: PrintOperation -> PrintOperation -> Bool # | |
| GObject PrintOperation Source # | |
Defined in GI.WebKit.Objects.PrintOperation | |
| ManagedPtrNewtype PrintOperation Source # | |
Defined in GI.WebKit.Objects.PrintOperation Methods toManagedPtr :: PrintOperation -> ManagedPtr PrintOperation | |
| TypedObject PrintOperation Source # | |
Defined in GI.WebKit.Objects.PrintOperation | |
| HasParentTypes PrintOperation Source # | |
Defined in GI.WebKit.Objects.PrintOperation | |
| IsGValue (Maybe PrintOperation) Source # | Convert |
Defined in GI.WebKit.Objects.PrintOperation Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe PrintOperation -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe PrintOperation) | |
| type ParentTypes PrintOperation Source # | |
Defined in GI.WebKit.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
| (GObject o, IsDescendantOf PrintOperation o) => IsPrintOperation o Source # | |
Defined in GI.WebKit.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
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 Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintOperation a) | |
| => a |
|
| -> m PageSetup | Returns: the current |
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 |
|
| -> m PrintSettings | Returns: the current |
Return the current print settings of printOperation.
It returns Nothing until
either printOperationSetPrintSettings or printOperationRunDialog
have been called.
new
Arguments
| :: (HasCallStack, MonadIO m, IsWebView a) | |
| => a |
|
| -> m PrintOperation | Returns: a new |
Create a new PrintOperation to print webView contents.
Arguments
| :: (HasCallStack, MonadIO m, IsPrintOperation a) | |
| => a |
|
| -> 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.
If the app is running in a sandbox, this function only works if printing to a file that is in a location accessible to the sandbox, usually acquired through the File Chooser portal. This function will not work for physical printers when running in a sandbox.
runDialog
printOperationRunDialog Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintOperation a, IsWindow b) | |
| => a |
|
| -> Maybe b |
|
| -> m PrintOperationResponse | Returns: the |
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 Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPrintOperation a, IsPageSetup b) | |
| => a |
|
| -> b |
|
| -> 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 |
|
| -> b |
|
| -> 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) 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 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
setprintOperation [ #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 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
setprintOperation [ #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
failed
type PrintOperationFailedCallback Source #
Arguments
| = GError |
|
| -> 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 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
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 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 PrintOperationFinishedCallback = IO () Source #
Emitted when the print operation has finished doing everything required for printing.
afterPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> ((?self :: 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
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 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