Struct gtk4::PrintUnixDialog

#[repr(transparent)]
pub struct PrintUnixDialog { /* private fields */ }

Available on Linux only.

PrintUnixDialog implements a print dialog for platforms which don’t provide a native print dialog, like Unix.

It can be used very much like any other GTK dialog, at the cost of the portability offered by the high-level printing API with PrintOperation.

In order to print something with PrintUnixDialog, you need to use selected_printer() to obtain a Printer object and use it to construct a PrintJob using PrintJob::new().

PrintUnixDialog uses the following response values:

• ResponseType::Ok: for the “Print” button
• ResponseType::Apply: for the “Preview” button
• ResponseType::Cancel: for the “Cancel” button

GtkPrintUnixDialog as GtkBuildable

The PrintUnixDialog implementation of the Buildable interface exposes its @notebook internal children with the name “notebook”.

An example of a PrintUnixDialog UI definition fragment:

<object class="GtkPrintUnixDialog" id="dialog1">
  <child internal-child="notebook">
    <object class="GtkNotebook" id="notebook">
      <child>
        <object type="GtkNotebookPage">
          <property name="tab_expand">False</property>
          <property name="tab_fill">False</property>
          <property name="tab">
            <object class="GtkLabel" id="tablabel">
              <property name="label">Tab label</property>
            </object>
          </property>
          <property name="child">
            <object class="GtkLabel" id="tabcontent">
              <property name="label">Content on notebook tab</property>
            </object>
          </property>
        </object>
      </child>
    </object>
  </child>
</object>

CSS nodes

PrintUnixDialog has a single CSS node with name window. The style classes dialog and print are added.

Implements

DialogExt, GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, DialogExtManual, WidgetExtManual, AccessibleExtManual

Implementations

impl PrintUnixDialog

pub fn new( title: Option<&str>, parent: Option<&impl IsA<Window>> ) -> PrintUnixDialog

Creates a new PrintUnixDialog.

title

Title of the dialog

parent

Transient parent of the dialog

Returns

a new PrintUnixDialog

pub fn builder() -> PrintUnixDialogBuilder

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

This method returns an instance of PrintUnixDialogBuilder which can be used to create PrintUnixDialog objects.

pub fn add_custom_tab( &self, child: &impl IsA<Widget>, tab_label: &impl IsA<Widget> )

Adds a custom tab to the print dialog.

child

the widget to put in the custom tab

tab_label

the widget to use as tab label

pub fn current_page(&self) -> i32

Gets the current page of the PrintUnixDialog.

Returns

the current page of @self

pub fn embeds_page_setup(&self) -> bool

Gets whether to embed the page setup.

Returns

whether to embed the page setup

pub fn has_selection(&self) -> bool

Gets whether there is a selection.

Returns

whether there is a selection

pub fn manual_capabilities(&self) -> PrintCapabilities

Gets the capabilities that have been set on this PrintUnixDialog.

Returns

the printing capabilities

pub fn page_setup(&self) -> PageSetup

Gets the page setup that is used by the PrintUnixDialog.

Returns

the page setup of @self.

pub fn is_page_setup_set(&self) -> bool

Gets whether a page setup was set by the user.

Returns

whether a page setup was set by user.

pub fn selected_printer(&self) -> Option<Printer>

Gets the currently selected printer.

Returns

the currently selected printer

pub fn settings(&self) -> PrintSettings

Gets a new PrintSettings object that represents the current values in the print dialog.

Note that this creates a new object, and you need to unref it if don’t want to keep it.

Returns

a new PrintSettings object with the values from @self

pub fn supports_selection(&self) -> bool

Gets whether the print dialog allows user to print a selection.

Returns

whether the application supports print of selection

pub fn set_current_page(&self, current_page: i32)

Sets the current page number.

If @current_page is not -1, this enables the current page choice for the range of pages to print.

current_page

the current page number.

pub fn set_embed_page_setup(&self, embed: bool)

Embed page size combo box and orientation combo box into page setup page.

embed

embed page setup selection

pub fn set_has_selection(&self, has_selection: bool)

Sets whether a selection exists.

has_selection

true indicates that a selection exists

pub fn set_manual_capabilities(&self, capabilities: PrintCapabilities)

This lets you specify the printing capabilities your application supports.

For instance, if you can handle scaling the output then you pass PrintCapabilities::SCALE. If you don’t pass that, then the dialog will only let you select the scale if the printing system automatically handles scaling.

capabilities

the printing capabilities of your application

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

Sets the page setup of the PrintUnixDialog.

page_setup

a PageSetup

pub fn set_settings(&self, settings: Option<&PrintSettings>)

Sets the PrintSettings for the PrintUnixDialog.

Typically, this is used to restore saved print settings from a previous print operation before the print dialog is shown.

settings

a PrintSettings

pub fn set_support_selection(&self, support_selection: bool)

Sets whether the print dialog allows user to print a selection.

support_selection

true to allow print selection

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

The PrintSettings object used for this dialog.

pub fn set_print_settings(&self, print_settings: Option<&PrintSettings>)

The PrintSettings object used for this dialog.

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

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

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

pub fn connect_manual_capabilities_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_selected_printer_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

Trait Implementations

impl Clone for PrintUnixDialog

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 PrintUnixDialog

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

Formats the value using the given formatter.

impl Default for PrintUnixDialog

fn default() -> Self

Returns the “default value” for a type.

impl Display for PrintUnixDialog

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

Formats the value using the given formatter.

impl Hash for PrintUnixDialog

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 PrintUnixDialog

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for PrintUnixDialog

type Parent = Dialog

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

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 PrintUnixDialog

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 PrintUnixDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintUnixDialog

impl IsA<Accessible> for PrintUnixDialog

impl IsA<Buildable> for PrintUnixDialog

impl IsA<ConstraintTarget> for PrintUnixDialog

impl IsA<Dialog> for PrintUnixDialog

impl IsA<Native> for PrintUnixDialog

impl IsA<Root> for PrintUnixDialog

impl IsA<ShortcutManager> for PrintUnixDialog

impl IsA<Widget> for PrintUnixDialog

impl IsA<Window> for PrintUnixDialog