GI.Gtk.Interfaces.PrintOperationPreview

GtkPrintOperationPreview is the interface that is used to implement print preview.

A GtkPrintOperationPreview object is passed to the PrintOperation::preview signal by PrintOperation.

Exported types

newtype PrintOperationPreview

Memory-managed wrapper type.

Constructors

PrintOperationPreview (ManagedPtr PrintOperationPreview)

Instances

Eq PrintOperationPreview

Defined in GI.Gtk.Interfaces.PrintOperationPreview

Methods

(==) :: PrintOperationPreview -> PrintOperationPreview -> Bool

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

GObject PrintOperationPreview

Defined in GI.Gtk.Interfaces.PrintOperationPreview

ManagedPtrNewtype PrintOperationPreview

Defined in GI.Gtk.Interfaces.PrintOperationPreview

Methods

toManagedPtr :: PrintOperationPreview -> ManagedPtr PrintOperationPreview

TypedObject PrintOperationPreview

Defined in GI.Gtk.Interfaces.PrintOperationPreview

Methods

glibType :: IO GType

HasParentTypes PrintOperationPreview

Defined in GI.Gtk.Interfaces.PrintOperationPreview

IsGValue (Maybe PrintOperationPreview)

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

Defined in GI.Gtk.Interfaces.PrintOperationPreview

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PrintOperationPreview

Defined in GI.Gtk.Interfaces.PrintOperationPreview

type ParentTypes PrintOperationPreview = '[Object]

class (GObject o, IsDescendantOf PrintOperationPreview o) => IsPrintOperationPreview o

Type class for types which can be safely cast to PrintOperationPreview, for instance with toPrintOperationPreview.

Instances

(GObject o, IsDescendantOf PrintOperationPreview o) => IsPrintOperationPreview o

Defined in GI.Gtk.Interfaces.PrintOperationPreview

toPrintOperationPreview :: (MonadIO m, IsPrintOperationPreview o) => o -> m PrintOperationPreview

Cast to PrintOperationPreview, 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, endPreview, forceFloating, freezeNotify, getv, isFloating, isSelected, notify, notifyByPspec, ref, refSink, renderPage, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

endPreview

printOperationPreviewEndPreview

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperationPreview a)

=> a

preview: a GtkPrintOperationPreview

-> m ()

Ends a preview.

This function must be called to finish a custom print preview.

isSelected

printOperationPreviewIsSelected

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperationPreview a)

=> a

preview: a GtkPrintOperationPreview

-> Int32

pageNr: a page number

-> m Bool

Returns: True if the page has been selected for printing

Returns whether the given page is included in the set of pages that have been selected for printing.

renderPage

printOperationPreviewRenderPage

Arguments

:: (HasCallStack, MonadIO m, IsPrintOperationPreview a)

=> a

preview: a GtkPrintOperationPreview

-> Int32

pageNr: the page to render

-> m ()

Renders a page to the preview.

This is using the print context that was passed to the PrintOperation::preview handler together with preview.

A custom print preview should use this function to render the currently selected page.

Note that this function requires a suitable cairo context to be associated with the print context.

Signals

gotPageSize

type PrintOperationPreviewGotPageSizeCallback

Arguments

 = PrintContext

context: the current GtkPrintContext

-> PageSetup

pageSetup: the GtkPageSetup for the current page

-> IO ()

Emitted once for each page that gets rendered to the preview.

A handler for this signal should update the context according to pageSetup and set up a suitable cairo context, using printContextSetCairoContext.

afterPrintOperationPreviewGotPageSize :: (IsPrintOperationPreview a, MonadIO m) => a -> ((?self :: a) => PrintOperationPreviewGotPageSizeCallback) -> m SignalHandlerId

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

after printOperationPreview #gotPageSize 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.

onPrintOperationPreviewGotPageSize :: (IsPrintOperationPreview a, MonadIO m) => a -> ((?self :: a) => PrintOperationPreviewGotPageSizeCallback) -> m SignalHandlerId

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

on printOperationPreview #gotPageSize callback

ready

type PrintOperationPreviewReadyCallback

Arguments

 = PrintContext

context: the current GtkPrintContext

-> IO ()

The ready signal gets emitted once per preview operation, before the first page is rendered.

A handler for this signal can be used for setup tasks.

afterPrintOperationPreviewReady :: (IsPrintOperationPreview a, MonadIO m) => a -> ((?self :: a) => PrintOperationPreviewReadyCallback) -> m SignalHandlerId

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

after printOperationPreview #ready 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.

onPrintOperationPreviewReady :: (IsPrintOperationPreview a, MonadIO m) => a -> ((?self :: a) => PrintOperationPreviewReadyCallback) -> m SignalHandlerId

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

on printOperationPreview #ready callback