Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype PrintOperation = PrintOperation (ManagedPtr PrintOperation)
- class (GObject o, IsDescendantOf PrintOperation o) => IsPrintOperation o
- toPrintOperation :: (MonadIO m, IsPrintOperation o) => o -> m PrintOperation
- noPrintOperation :: Maybe PrintOperation
- printOperationGetPageSetup :: (HasCallStack, MonadIO m, IsPrintOperation a) => a -> m (Maybe PageSetup)
- printOperationGetPrintSettings :: (HasCallStack, MonadIO m, IsPrintOperation a) => a -> m (Maybe 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, IsPageSetup a) => a -> IO (GValueConstruct o)
- getPrintOperationPageSetup :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe PageSetup)
- setPrintOperationPageSetup :: (MonadIO m, IsPrintOperation o, IsPageSetup a) => o -> a -> m ()
- constructPrintOperationPrintSettings :: (IsPrintOperation o, IsPrintSettings a) => a -> IO (GValueConstruct o)
- getPrintOperationPrintSettings :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe PrintSettings)
- setPrintOperationPrintSettings :: (MonadIO m, IsPrintOperation o, IsPrintSettings a) => o -> a -> m ()
- constructPrintOperationWebView :: (IsPrintOperation o, IsWebView a) => a -> IO (GValueConstruct o)
- getPrintOperationWebView :: (MonadIO m, IsPrintOperation o) => o -> m (Maybe WebView)
- type C_PrintOperationCreateCustomWidgetCallback = Ptr () -> Ptr () -> IO (Ptr PrintCustomWidget)
- type PrintOperationCreateCustomWidgetCallback = IO PrintCustomWidget
- afterPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationCreateCustomWidgetCallback -> m SignalHandlerId
- genClosure_PrintOperationCreateCustomWidget :: MonadIO m => PrintOperationCreateCustomWidgetCallback -> m (GClosure C_PrintOperationCreateCustomWidgetCallback)
- mk_PrintOperationCreateCustomWidgetCallback :: C_PrintOperationCreateCustomWidgetCallback -> IO (FunPtr C_PrintOperationCreateCustomWidgetCallback)
- noPrintOperationCreateCustomWidgetCallback :: Maybe PrintOperationCreateCustomWidgetCallback
- onPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationCreateCustomWidgetCallback -> m SignalHandlerId
- wrap_PrintOperationCreateCustomWidgetCallback :: PrintOperationCreateCustomWidgetCallback -> C_PrintOperationCreateCustomWidgetCallback
- type C_PrintOperationFailedCallback = Ptr () -> Ptr GError -> Ptr () -> IO ()
- type PrintOperationFailedCallback = GError -> IO ()
- afterPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFailedCallback -> m SignalHandlerId
- genClosure_PrintOperationFailed :: MonadIO m => PrintOperationFailedCallback -> m (GClosure C_PrintOperationFailedCallback)
- mk_PrintOperationFailedCallback :: C_PrintOperationFailedCallback -> IO (FunPtr C_PrintOperationFailedCallback)
- noPrintOperationFailedCallback :: Maybe PrintOperationFailedCallback
- onPrintOperationFailed :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFailedCallback -> m SignalHandlerId
- wrap_PrintOperationFailedCallback :: PrintOperationFailedCallback -> C_PrintOperationFailedCallback
- type C_PrintOperationFinishedCallback = Ptr () -> Ptr () -> IO ()
- type PrintOperationFinishedCallback = IO ()
- afterPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFinishedCallback -> m SignalHandlerId
- genClosure_PrintOperationFinished :: MonadIO m => PrintOperationFinishedCallback -> m (GClosure C_PrintOperationFinishedCallback)
- mk_PrintOperationFinishedCallback :: C_PrintOperationFinishedCallback -> IO (FunPtr C_PrintOperationFinishedCallback)
- noPrintOperationFinishedCallback :: Maybe PrintOperationFinishedCallback
- onPrintOperationFinished :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationFinishedCallback -> m SignalHandlerId
- wrap_PrintOperationFinishedCallback :: PrintOperationFinishedCallback -> C_PrintOperationFinishedCallback
Exported types
newtype PrintOperation Source #
Memory-managed wrapper type.
Instances
GObject PrintOperation Source # | |
Defined in GI.WebKit2.Objects.PrintOperation gobjectType :: IO GType # | |
HasParentTypes PrintOperation Source # | |
Defined in GI.WebKit2.Objects.PrintOperation | |
type ParentTypes PrintOperation Source # | |
Defined in GI.WebKit2.Objects.PrintOperation |
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.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
.
noPrintOperation :: Maybe PrintOperation Source #
A convenience alias for Nothing
:: Maybe
PrintOperation
.
Methods
getPageSetup
printOperationGetPageSetup Source #
:: (HasCallStack, MonadIO m, IsPrintOperation a) | |
=> a |
|
-> m (Maybe 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 #
:: (HasCallStack, MonadIO m, IsPrintOperation a) | |
=> a |
|
-> m (Maybe PrintSettings) | Returns: the current |
Return the current print settings of printOperation
. It returns Nothing
until
either printOperationSetPrintSettings
or printOperationRunDialog
have been called.
new
:: (HasCallStack, MonadIO m, IsWebView a) | |
=> a |
|
-> m PrintOperation | Returns: a new |
Create a new PrintOperation
to print webView
contents.
:: (HasCallStack, MonadIO m, IsPrintOperation a) | |
=> a |
|
-> 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 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 Source #
:: (HasCallStack, MonadIO m, IsPrintOperation a, IsWindow b) | |
=> a |
|
-> Maybe b |
|
-> m PrintOperationResponse | Returns: the |
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 #
:: (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 #
:: (HasCallStack, MonadIO m, IsPrintOperation a, IsPrintSettings b) | |
=> a |
|
-> b |
|
-> 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, IsPageSetup a) => a -> IO (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, IsPrintSettings a) => a -> IO (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, IsWebView a) => a -> IO (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 #
= IO PrintCustomWidget | Returns: A |
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 -> PrintOperationCreateCustomWidgetCallback -> m SignalHandlerId Source #
Connect a signal handler for the “create-custom-widget
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
printOperation #createCustomWidget callback
genClosure_PrintOperationCreateCustomWidget :: MonadIO m => PrintOperationCreateCustomWidgetCallback -> m (GClosure C_PrintOperationCreateCustomWidgetCallback) Source #
Wrap the callback into a GClosure
.
mk_PrintOperationCreateCustomWidgetCallback :: C_PrintOperationCreateCustomWidgetCallback -> IO (FunPtr C_PrintOperationCreateCustomWidgetCallback) Source #
Generate a function pointer callable from C code, from a C_PrintOperationCreateCustomWidgetCallback
.
noPrintOperationCreateCustomWidgetCallback :: Maybe PrintOperationCreateCustomWidgetCallback Source #
A convenience synonym for
.Nothing
:: Maybe
PrintOperationCreateCustomWidgetCallback
onPrintOperationCreateCustomWidget :: (IsPrintOperation a, MonadIO m) => a -> PrintOperationCreateCustomWidgetCallback -> m SignalHandlerId Source #
Connect a signal handler for the “create-custom-widget
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
printOperation #createCustomWidget callback
wrap_PrintOperationCreateCustomWidgetCallback :: PrintOperationCreateCustomWidgetCallback -> C_PrintOperationCreateCustomWidgetCallback Source #
failed
type C_PrintOperationFailedCallback = Ptr () -> Ptr GError -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type PrintOperationFailedCallback Source #
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 -> 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
genClosure_PrintOperationFailed :: MonadIO m => PrintOperationFailedCallback -> m (GClosure C_PrintOperationFailedCallback) Source #
Wrap the callback into a GClosure
.
mk_PrintOperationFailedCallback :: C_PrintOperationFailedCallback -> IO (FunPtr C_PrintOperationFailedCallback) Source #
Generate a function pointer callable from C code, from a C_PrintOperationFailedCallback
.
noPrintOperationFailedCallback :: Maybe PrintOperationFailedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
PrintOperationFailedCallback
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
wrap_PrintOperationFailedCallback :: PrintOperationFailedCallback -> C_PrintOperationFailedCallback Source #
Wrap a PrintOperationFailedCallback
into a C_PrintOperationFailedCallback
.
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
genClosure_PrintOperationFinished :: MonadIO m => PrintOperationFinishedCallback -> m (GClosure C_PrintOperationFinishedCallback) Source #
Wrap the callback into a GClosure
.
mk_PrintOperationFinishedCallback :: C_PrintOperationFinishedCallback -> IO (FunPtr C_PrintOperationFinishedCallback) Source #
Generate a function pointer callable from C code, from a C_PrintOperationFinishedCallback
.
noPrintOperationFinishedCallback :: Maybe PrintOperationFinishedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
PrintOperationFinishedCallback
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