Struct gtk4::PrintDialog

pub struct PrintDialog { /* private fields */ }

Available on crate feature v4_14 only.

A PrintDialog object collects the arguments that are needed to present a print dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with the setup() function. The actual printing can be done with print() or print_file(). These APIs follows the GIO async pattern, and the results can be obtained by calling the corresponding finish methods.

Properties

accept-label

A label that may be shown on the accept button of a print dialog that is presented by PrintDialog::setup().

Readable | Writeable

modal

Whether the print dialog is modal.

Readable | Writeable

page-setup

The page setup to use.

Readable | Writeable

print-settings

The print settings to use.

Readable | Writeable

title

A title that may be shown on the print dialog that is presented by PrintDialog::setup().

Readable | Writeable

Implements

[trait@glib::ObjectExt]

Implementations

impl PrintDialog

pub fn new() -> PrintDialog

Creates a new PrintDialog object.

Returns

the new PrintDialog

pub fn builder() -> PrintDialogBuilder

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

This method returns an instance of PrintDialogBuilder which can be used to create PrintDialog objects.

pub fn accept_label(&self) -> GString

Returns the label that will be shown on the accept button of the print dialog.

Returns

the accept label

pub fn is_modal(&self) -> bool

Returns whether the print dialog blocks interaction with the parent window while it is presented.

Returns

whether the print dialog is modal

pub fn page_setup(&self) -> PageSetup

Returns the page setup.

Returns

the page setup

pub fn print_settings(&self) -> PrintSettings

Returns the print settings for the print dialog.

Returns

the settings

pub fn title(&self) -> GString

Returns the title that will be shown on the print dialog.

Returns

the title

pub fn print<P: FnOnce(Result<Option<OutputStream>, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, setup: Option<&PrintSetup>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function prints content from a stream.

If you pass NULL as @setup, then this method will present a print dialog. Otherwise, it will attempt to print directly, without user interaction.

The @callback will be called when the printing is done. It should call Gtk::PrintDialog::print_finish() to obtain the results.

parent

the parent Window

setup

the PrintSetup to use

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn print_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, setup: Option<&PrintSetup> ) -> Pin<Box_<dyn Future<Output = Result<Option<OutputStream>, Error>> + 'static>>

pub fn print_file<P: FnOnce(Result<(), Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, setup: Option<&PrintSetup>, file: &impl IsA<File>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function prints a file.

If you pass NULL as @setup, then this method will present a print dialog. Otherwise, it will attempt to print directly, without user interaction.

The @callback will be called when the printing is done. It should call Gtk::PrintDialog::print_file_finish() to obtain the results.

parent

the parent Window

setup

the PrintSetup to use

file

the GFile to print

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn print_file_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, setup: Option<&PrintSetup>, file: &(impl IsA<File> + Clone + 'static) ) -> Pin<Box_<dyn Future<Output = Result<(), Error>> + 'static>>

pub fn set_accept_label(&self, accept_label: &str)

Sets the label that will be shown on the accept button of the print dialog shown for setup().

accept_label

the new accept label

pub fn set_modal(&self, modal: bool)

Sets whether the print dialog blocks interaction with the parent window while it is presented.

modal

the new value

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

Set the page setup for the print dialog.

page_setup

the new page setup

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

Sets the print settings for the print dialog.

print_settings

the new print settings

pub fn set_title(&self, title: &str)

Sets the title that will be shown on the print dialog.

title

the new title

pub fn setup<P: FnOnce(Result<Option<PrintSetup>, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function presents a print dialog to let the user select a printer, and set up print settings and page setup.

The @callback will be called when the dialog is dismissed. It should call Gtk::PrintDialog::setup_finish() to obtain the results in the form of a PrintSetup, that can then be passed to print() or print_file().

One possible use for this method is to have the user select a printer, then show a page setup UI in the application (e.g. to arrange images on a page), then call print() on @self to do the printing without further user interaction.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn setup_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)> ) -> Pin<Box_<dyn Future<Output = Result<Option<PrintSetup>, Error>> + 'static>>

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

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

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

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

Trait Implementations

impl Clone for PrintDialog

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrintDialog

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

Formats the value using the given formatter.

impl Default for PrintDialog

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for PrintDialog

type ParamSpec = ParamSpecObject

type SetValue = PrintDialog

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PrintDialog

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

where H: Hasher,

Feeds this value into the given Hasher.

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 PrintDialog

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

This method returns an Ordering between self and other.

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 PrintDialog

type Parent = Object

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

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

This method tests for self and other values to be equal, and is used by ==.

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 PrintDialog

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

This method returns an ordering between self and other values if one exists.

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 PrintDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintDialog