Struct webkit6::PrintOperation

pub struct PrintOperation { /* private fields */ }

Controls a print operation.

A #WebKitPrintOperation controls a print operation in WebKit. With a similar API to #GtkPrintOperation, it lets you set the print settings with webkit_print_operation_set_print_settings() or display the print dialog with webkit_print_operation_run_dialog().

Properties

page-setup

The initial #GtkPageSetup for the print operation.

Readable | Writeable

print-settings

The initial #GtkPrintSettings for the print operation.

Readable | Writeable

web-view

The #WebKitWebView that will be printed.

Readable | Writeable | Construct Only

Signals

failed

Emitted when an error occurs while printing. The given @error, of the domain WEBKIT_PRINT_ERROR, contains further details of the failure. The #WebKitPrintOperation::finished signal is emitted after this one.

finished

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

GLib type: GObject with reference counted clone semantics.

Implementations

impl PrintOperation

pub fn new(web_view: &impl IsA<WebView>) -> PrintOperation

Create a new #WebKitPrintOperation to print @web_view contents.

web_view

a #WebKitWebView

Returns

a new #WebKitPrintOperation.

pub fn builder() -> PrintOperationBuilder

Creates a new builder-pattern struct instance to construct PrintOperation objects.

This method returns an instance of PrintOperationBuilder which can be used to create PrintOperation objects.

pub fn page_setup(&self) -> Option<PageSetup>

Return the current page setup of @self.

It returns None until either webkit_print_operation_set_page_setup() or webkit_print_operation_run_dialog() have been called.

Returns

the current #GtkPageSetup of @self.

pub fn print_settings(&self) -> Option<PrintSettings>

Return the current print settings of @self.

It returns None until either webkit_print_operation_set_print_settings() or webkit_print_operation_run_dialog() have been called.

Returns

the current #GtkPrintSettings of @self.

pub fn print(&self)

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 webkit_print_operation_set_print_settings() and webkit_print_operation_set_page_setup(), the default options will be used and the print job will be sent to the default printer. The #WebKitPrintOperation::finished signal is emitted when the printing operation finishes. If an error occurs while printing the signal #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::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.

pub fn run_dialog( &self, parent: Option<&impl IsA<Window>>, ) -> PrintOperationResponse

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 PrintOperationResponse::Cancel is returned. If the user clicks on the print button, PrintOperationResponse::Print is returned and the print operation starts. In this case, the #WebKitPrintOperation::finished signal is emitted when the operation finishes. If an error occurs while printing, the signal #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::finished. If the print dialog is not cancelled current print settings and page setup of @self 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 webkit_print_operation_get_print_settings() and webkit_print_operation_get_page_setup() after this method.

parent

transient parent of the print dialog

Returns

the #WebKitPrintOperationResponse of the print dialog

pub fn set_page_setup(&self, page_setup: &PageSetup)

Set the current page setup of @self.

Current page setup is used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called.

page_setup

a #GtkPageSetup to set

pub fn set_print_settings(&self, print_settings: &PrintSettings)

Set the current print settings of @self.

Set the current print settings of @self. Current print settings are used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called.

print_settings

a #GtkPrintSettings to set

pub fn web_view(&self) -> Option<WebView>

The #WebKitWebView that will be printed.

pub fn connect_failed<F: Fn(&Self, &Error) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when an error occurs while printing. The given @error, of the domain WEBKIT_PRINT_ERROR, contains further details of the failure. The #WebKitPrintOperation::finished signal is emitted after this one.

error

the #GError that was triggered

pub fn connect_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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

pub fn connect_page_setup_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_print_settings_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for PrintOperation

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrintOperation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PrintOperation

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for PrintOperation

type ParamSpec = ParamSpecObject

type SetValue = PrintOperation

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, PrintOperation>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PrintOperation

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PrintOperation

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PrintOperation

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for PrintOperation

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for PrintOperation

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PrintOperation

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintOperation