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.

Properties

current-page

The current page in the document.

Readable | Writeable

embed-page-setup

true if the page setup controls are embedded.

Readable | Writeable

has-selection

Whether the application has a selection.

Readable | Writeable

manual-capabilities

Capabilities the application can handle.

Readable | Writeable

page-setup

The PageSetup object to use.

Readable | Writeable

print-settings

The PrintSettings object used for this dialog.

Readable | Writeable

selected-printer

The Printer which is selected.

Readable

support-selection

Whether the dialog supports selection.

Readable | Writeable

Dialog

use-header-bar

true if the dialog uses a headerbar for action buttons instead of the action-area.

For technical reasons, this property is declared as an integer property, but you should only set it to true or false.

Creating a dialog with headerbar

Builtin Dialog subclasses such as ColorChooserDialog set this property according to platform conventions (using the gtk-dialogs-use-header setting).

Here is how you can achieve the same:

⚠️ The following code is in c ⚠️

g_object_get (settings, "gtk-dialogs-use-header", &header, NULL);
dialog = g_object_new (GTK_TYPE_DIALOG, header, TRUE, NULL);

Readable | Writeable | Construct Only

Window

application

The Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to None.

Readable | Writeable

child

The child widget.

Readable | Writeable

decorated

Whether the window should have a frame (also known as decorations).

Readable | Writeable

default-height

The default height of the window.

Readable | Writeable

default-widget

The default widget.

Readable | Writeable

default-width

The default width of the window.

Readable | Writeable

deletable

Whether the window frame should have a close button.

Readable | Writeable

destroy-with-parent

If this window should be destroyed when the parent is destroyed.

Readable | Writeable

display

The display that will display this window.

Readable | Writeable

focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

This property is maintained by GTK based on user input and should not be set by applications.

Readable | Writeable

focus-widget

The focus widget.

Readable | Writeable

fullscreened

Whether the window is fullscreen.

Setting this property is the equivalent of calling GtkWindowExt::fullscreen() or GtkWindowExt::unfullscreen(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

Readable | Writeable

hide-on-close

If this window should be hidden when the users clicks the close button.

Readable | Writeable

icon-name

Specifies the name of the themed icon to use as the window icon.

See IconTheme for more details.

Readable | Writeable

is-active

Whether the toplevel is the currently active window.

Readable

maximized

Whether the window is maximized.

Setting this property is the equivalent of calling GtkWindowExt::maximize() or GtkWindowExt::unmaximize(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

mnemonics-visible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

Readable | Writeable

modal

If true, the window is modal.

Readable | Writeable

resizable

If true, users can resize the window.

Readable | Writeable

startup-id

A write-only property for setting window’s startup notification identifier.

Writeable

title

The title of the window.

Readable | Writeable

titlebar

The titlebar widget.

Readable | Writeable

transient-for

The transient parent of the window.

Readable | Writeable | Construct

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

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 HasParamSpec for PrintUnixDialog

type ParamSpec = ParamSpecObject

type SetValue = PrintUnixDialog

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

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

fn param_spec_builder() -> Self::BuilderFn

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