Struct gtk4::PrintOperation

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

PrintOperation is the high-level, portable printing API.

It looks a bit different than other GTK dialogs such as the FileChooser, since some platforms don’t expose enough infrastructure to implement a good print dialog. On such platforms, PrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK uses its own, see PrintUnixDialog.

The typical way to use the high-level printing API is to create a PrintOperation object with new() when the user selects to print. Then you set some properties on it, e.g. the page size, any PrintSettings from previous print operations, the number of pages, the current page, etc.

Then you start the print operation by calling PrintOperationExt::run(). It will then show a dialog, let the user select a printer and options. When the user finished the dialog, various signals will be emitted on the PrintOperation, the main one being signal::PrintOperation::draw-page, which you are supposed to handle and render the page on the provided PrintContext using Cairo.

The high-level printing API

⚠️ The following code is in c ⚠️

static GtkPrintSettings *settings = NULL;

static void
do_print (void)
{
  GtkPrintOperation *print;
  GtkPrintOperationResult res;

  print = gtk_print_operation_new ();

  if (settings != NULL)
    gtk_print_operation_set_print_settings (print, settings);

  g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), NULL);
  g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), NULL);

  res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
                                 GTK_WINDOW (main_window), NULL);

  if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
    {
      if (settings != NULL)
        g_object_unref (settings);
      settings = g_object_ref (gtk_print_operation_get_print_settings (print));
    }

  g_object_unref (print);
}

By default PrintOperation uses an external application to do print preview. To implement a custom print preview, an application must connect to the preview signal. The functions PrintOperationPreviewExt::render_page(), PrintOperationPreviewExt::end_preview() and PrintOperationPreviewExt::is_selected() are useful when implementing a print preview.

Implements

PrintOperationExt, glib::ObjectExt, PrintOperationPreviewExt

Implementations

impl PrintOperation

pub const NONE: Option<&'static PrintOperation> = None

pub fn new() -> PrintOperation

Creates a new PrintOperation.

Returns

a new PrintOperation

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.

impl PrintOperation

pub fn error(&self) -> Option<Error>

Trait Implementations

impl Clone for PrintOperation

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 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 Display for PrintOperation

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

Formats the value using the given formatter.

impl Hash for PrintOperation

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<T: PrintOperationImpl> IsSubclassable<T> for PrintOperation

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for PrintOperation

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 PrintOperation

type Parent = Object

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

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 PrintOperation

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 PrintOperation

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PrintOperation

impl IsA<PrintOperationPreview> for PrintOperation