Package org.gnome.gtk

Interface PrintOperationPreview

All Superinterfaces:

Proxy

All Known Implementing Classes:

PrintOperation, PrintOperationPreview.PrintOperationPreview$Impl

@Generated("io.github.jwharm.JavaGI")
public interface PrintOperationPreview
extends Proxy

The interface that is used to implement print preview.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PrintOperationPreview.GotPageSizeCallback	Functional interface declaration of the GotPageSizeCallback callback.
static class	PrintOperationPreview.PrintOperationPreview$Impl	The PrintOperationPreview$Impl type represents a native instance of the PrintOperationPreview interface.
static class	PrintOperationPreview.PrintOperationPreviewIface
static interface	PrintOperationPreview.ReadyCallback	Functional interface declaration of the ReadyCallback callback.

Method Summary

Modifier and Type	Method	Description
default void	emitGotPageSize(@Nullable PrintContext context, @Nullable PageSetup pageSetup)	Emits the "got-page-size" signal.
default void	emitReady(@Nullable PrintContext context)	Emits the "ready" signal.
default void	endPreview()	Ends a preview.
static @Nullable Type	getType()	Get the GType of the PrintOperationPreview class
default boolean	isSelected(int pageNr)	Returns whether the given page is included in the set of pages that have been selected for printing.
default SignalConnection<PrintOperationPreview.GotPageSizeCallback>	onGotPageSize(PrintOperationPreview.GotPageSizeCallback handler)	Emitted once for each page that gets rendered to the preview.
default SignalConnection<PrintOperationPreview.ReadyCallback>	onReady(PrintOperationPreview.ReadyCallback handler)	The ::ready signal gets emitted once per preview operation, before the first page is rendered.
default void	renderPage(int pageNr)	Renders a page to the preview.

Methods inherited from interface org.javagi.base.Proxy

handle

Method Details

getType

static @Nullable Type getType()

Get the GType of the PrintOperationPreview class

Returns:

the GType

endPreview

default void endPreview()

Ends a preview.

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

isSelected

default boolean isSelected(int pageNr)

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

Parameters:

pageNr - a page number

Returns:

true if the page has been selected for printing

renderPage

default void renderPage(int pageNr)

Renders a page to the preview.

This is using the print context that was passed to the Gtk.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.

Parameters:

pageNr - the page to render

onGotPageSize

default SignalConnection<PrintOperationPreview.GotPageSizeCallback> onGotPageSize(PrintOperationPreview.GotPageSizeCallback handler)

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 PrintContext.setCairoContext(org.freedesktop.cairo.Context, double, double).

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• PrintOperationPreview.GotPageSizeCallback.run(org.gnome.gtk.PrintContext, org.gnome.gtk.PageSetup)

emitGotPageSize

default void emitGotPageSize(@Nullable PrintContext context,
 @Nullable PageSetup pageSetup)

Emits the "got-page-size" signal. See onGotPageSize(org.gnome.gtk.PrintOperationPreview.GotPageSizeCallback).

onReady

default SignalConnection<PrintOperationPreview.ReadyCallback> onReady(PrintOperationPreview.ReadyCallback handler)

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• PrintOperationPreview.ReadyCallback.run(org.gnome.gtk.PrintContext)

emitReady

default void emitReady(@Nullable PrintContext context)

Emits the "ready" signal. See onReady(org.gnome.gtk.PrintOperationPreview.ReadyCallback).