Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: PrintOperationPreviewCallback

[1611:7] extends: object

Generated low-level callback wrapper for GIR callback preview.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationPreviewCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, preview, context, parent, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationDrawpageCallback

[1398:7] extends: object

Generated low-level callback wrapper for GIR callback draw-page.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationDrawpageCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, context, page_nr, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationRequestpagesetupCallback

[1684:7] extends: object

Generated low-level callback wrapper for GIR callback request-page-setup.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationRequestpagesetupCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, context, page_nr, setup, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationStatuschangedCallback

[1756:7] extends: object

Generated low-level callback wrapper for GIR callback status-changed.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationStatuschangedCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationCustomwidgetapplyCallback

[1256:7] extends: object

Generated low-level callback wrapper for GIR callback custom-widget-apply.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationCustomwidgetapplyCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, widget, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperation

[45:7] extends: object

High-level, portable printing API. It looks a bit different than other GTK dialogs such as the GtkFileChooser, since some platforms don’t expose enough infrastructure to implement a good print dialog. On such platforms, GtkPrintOperation uses the native print dialog. On platforms which do not provide a native print dialog, GTK uses its own, see [class@Gtk.PrintUnixDialog]. The typical way to use the high-level printing API is to create a GtkPrintOperation object with [ctor@Gtk.PrintOperation.new] when the user selects to print. Then you set some properties on it, e.g. the page size, any [class@Gtk.PrintSettings] from previous print operations, the number of pages, the current page, etc. Then you start the print operation by calling [method@Gtk.PrintOperation.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 GtkPrintOperation, the main one being [signal@Gtk.PrintOperation::draw-page], which you are supposed to handle and render the page on the provided [class@Gtk.PrintContext] using Cairo. # The high-level printing API 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 GtkPrintOperation uses an external application to do print preview. To implement a custom print preview, an application must connect to the preview signal. The functions [method@Gtk.PrintOperationPreview.render_page], [method@Gtk.PrintOperationPreview.end_preview] and [method@Gtk.PrintOperationPreview.is_selected] are useful when implementing a print preview.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • PrintOperation ()

    Creates a new GtkPrintOperation.

  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.

  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.

  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.

  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.

  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.

  • asObject ()

    Wraps this handle as Object.

    • @r A Object object.

  • asPrintOperationPreview ()

    Wraps this handle as PrintOperationPreview.

    • @r A PrintOperationPreview object.

  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.

  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.

  • setOnBeginprint (callback Fn, UserData = null)

    Emitted after the user has finished changing print settings in the dialog, before the actual rendering starts. A typical use for ::begin-print is to use the parameters from the [class@Gtk.PrintContext] and paginate the document accordingly, and then set the number of pages with [method@Gtk.PrintOperation.set_n_pages].

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, PrintContext Context).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnCreatecustomwidget (callback Fn, UserData = null)

    Emitted when displaying the print dialog. If you return a widget in a handler for this signal it will be added to a custom tab in the print dialog. You typically return a container widget with multiple widgets in it. The print dialog owns the returned widget, and its lifetime is not controlled by the application. However, the widget is guaranteed to stay around until the [signal@Gtk.PrintOperation::custom-widget-apply] signal is emitted on the operation. Then you can read out any information you need from the widgets.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnCustomwidgetapply (callback Fn, UserData = null)

    Emitted right before ::begin-print if you added a custom widget in the ::create-custom-widget handler. When you get this signal you should read the information from the custom widgets, as the widgets are not guaranteed to be around at a later time.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, Widget Widget).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnDone (callback Fn, UserData = null)

    Emitted when the print operation run has finished doing everything required for printing. @result gives you information about what happened during the run. If @result is %GTK_PRINT_OPERATION_RESULT_ERROR then you can call [method@Gtk.PrintOperation.get_error] for more information. If you enabled print status tracking then [method@Gtk.PrintOperation.is_finished] may still return %FALSE after the ::done signal was emitted.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, string Result).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnDrawpage (callback Fn, UserData = null)

    Emitted for every page that is printed. The signal handler must render the @page_nr's page onto the cairo context obtained from @context using [method@Gtk.PrintContext.get_cairo_context]. c static void draw_page (GtkPrintOperation *operation, GtkPrintContext *context, int page_nr, gpointer user_data) { cairo_t *cr; PangoLayout *layout; double width, text_height; int layout_height; PangoFontDescription *desc; cr = gtk_print_context_get_cairo_context (context); width = gtk_print_context_get_width (context); cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT); cairo_set_source_rgb (cr, 0.8, 0.8, 0.8); cairo_fill (cr); layout = gtk_print_context_create_pango_layout (context); desc = pango_font_description_from_string ("sans 14"); pango_layout_set_font_description (layout, desc); pango_font_description_free (desc); pango_layout_set_text (layout, "some text", -1); pango_layout_set_width (layout, width * PANGO_SCALE); pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER); pango_layout_get_size (layout, NULL, &layout_height); text_height = (double)layout_height / PANGO_SCALE; cairo_move_to (cr, width / 2, (HEADER_HEIGHT - text_height) / 2); pango_cairo_show_layout (cr, layout); g_object_unref (layout); } Use [method@Gtk.PrintOperation.set_use_full_page] and [method@Gtk.PrintOperation.set_unit] before starting the print operation to set up the transformation of the cairo context according to your needs.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, PrintContext Context, int Page_nr).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnEndprint (callback Fn, UserData = null)

    Emitted after all pages have been rendered. A handler for this signal can clean up any resources that have been allocated in the [signal@Gtk.PrintOperation::begin-print] handler.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, PrintContext Context).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnPaginate (callback Fn, UserData = null)

    Emitted after the ::begin-print signal, but before the actual rendering starts. It keeps getting emitted until a connected signal handler returns %TRUE. The ::paginate signal is intended to be used for paginating a document in small chunks, to avoid blocking the user interface for a long time. The signal handler should update the number of pages using [method@Gtk.PrintOperation.set_n_pages], and return %TRUE if the document has been completely paginated. If you don't need to do pagination in chunks, you can simply do it all in the ::begin-print handler, and set the number of pages from there.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, PrintContext Context).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnPreview (callback Fn, UserData = null)

    Gets emitted when a preview is requested from the native dialog. The default handler for this signal uses an external viewer application to preview. To implement a custom print preview, an application must return %TRUE from its handler for this signal. In order to use the provided

    • @context for the preview implementation, it must be given a suitable cairo context with [method@Gtk.PrintContext.set_cairo_context]. The custom preview implementation can use [method@Gtk.PrintOperationPreview.is_selected] and [method@Gtk.PrintOperationPreview.render_page] to find pages which are selected for print and render them. The preview must be finished by calling [method@Gtk.PrintOperationPreview.end_preview] (typically in response to the user clicking a close button).
    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, PrintOperationPreview Preview, PrintContext Context, Window Parent).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnRequestpagesetup (callback Fn, UserData = null)

    Emitted once for every page that is printed. This gives the application a chance to modify the page setup. Any changes done to @setup will be in force only for printing this page.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, PrintContext Context, int Page_nr, PageSetup Setup).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnStatuschanged (callback Fn, UserData = null)

    Emitted at between the various phases of the print operation. See [enum@Gtk.PrintStatus] for the phases that are being discriminated. Use [method@Gtk.PrintOperation.get_status] to find out the current status.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • setOnUpdatecustomwidget (callback Fn, UserData = null)

    Emitted after change of selected printer. The actual page setup and print settings are passed to the custom widget, which can actualize itself according to this change.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (PrintOperation Self, Widget Widget, PageSetup Setup, PrintSettings Settings).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.

  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setAllowasync (bool Value)

    Determines whether the print operation may run asynchronously or not. Some systems don't support asynchronous printing, but those that do will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and emit the [signal@Gtk.PrintOperation::done] signal when the operation is actually done. The Windows port does not support asynchronous operation at all (this is unlikely to change). On other platforms, all actions except for %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous operation.

    • @p Value is the new property value.
    • @r None.

  • setCurrentpage (int Value)

    The current page in the document. If this is set before [method@Gtk.PrintOperation.run], the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents.

    • @p Value is the new property value.
    • @r None.

  • setCustomtablabel (string Value)

    Used as the label of the tab containing custom widgets. Note that this property may be ignored on some platforms. If this is %NULL, GTK uses a default label.

    • @p Value is the new property value.
    • @r None.

  • setDefaultpagesetup (object Value)

    The GtkPageSetup used by default. This page setup will be used by [method@Gtk.PrintOperation.run], but it can be overridden on a per-page basis by connecting to the [signal@Gtk.PrintOperation::request-page-setup] signal.

    • @p Value is the new property value.
    • @r None.

  • setEmbedpagesetup (bool Value)

    If %TRUE, page size combo box and orientation combo box are embedded into page setup page.

    • @p Value is the new property value.
    • @r None.

  • setExportfilename (string Value)

    The name of a file to generate instead of showing the print dialog. Currently, PDF is the only supported format. The intended use of this property is for implementing “Export to PDF” actions. “Print to PDF” support is independent of this and is done by letting the user pick the “Print to PDF” item from the list of printers in the print dialog.

    • @p Value is the new property value.
    • @r None.

  • setHasselection (bool Value)

    Determines whether there is a selection in your application. This can allow your application to print the selection. This is typically used to make a "Selection" button sensitive.

    • @p Value is the new property value.
    • @r None.

  • setJobname (string Value)

    A string used to identify the job (e.g. in monitoring applications like eggcups). If you don't set a job name, GTK picks a default one by numbering successive print jobs.

    • @p Value is the new property value.
    • @r None.

  • setNpages (int Value)

    The number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a [signal@Gtk.PrintOperation::begin-print] signal handler. Note that the page numbers passed to the [signal@Gtk.PrintOperation::request-page-setup] and [signal@Gtk.PrintOperation::draw-page] signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page @n_pages - 1.

    • @p Value is the new property value.
    • @r None.

  • setPrintsettings (object Value)

    The GtkPrintSettings used for initializing the dialog. Setting this property is typically used to re-establish print settings from a previous print operation, see [method@Gtk.PrintOperation.run].

    • @p Value is the new property value.
    • @r None.

  • setShowprogress (bool Value)

    Determines whether to show a progress dialog during the print operation.

    • @p Value is the new property value.
    • @r None.

  • setSupportselection (bool Value)

    If %TRUE, the print operation will support print of selection. This allows the print dialog to show a "Selection" button.

    • @p Value is the new property value.
    • @r None.

  • setTrackprintstatus (bool Value)

    If %TRUE, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like “out of paper” issues, and when the print job actually reaches the printer. However, this is often implemented using polling, and should not be enabled unless needed.

    • @p Value is the new property value.
    • @r None.

  • setUnit (string Value)

    The transformation for the cairo context obtained from GtkPrintContext is set up in such a way that distances are measured in units of @unit.

    • @p Value is the new property value.
    • @r None.

  • setUsefullpage (bool Value)

    If %TRUE, the transformation for the cairo context obtained from GtkPrintContext puts the origin at the top left corner of the page. This may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet. Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins).

    • @p Value is the new property value.
    • @r None.

  • cancel ()

    Cancels a running print operation. This function may be called from a [signal@Gtk.PrintOperation::begin-print], [signal@Gtk.PrintOperation::paginate] or [signal@Gtk.PrintOperation::draw-page] signal handler to stop the currently running print operation.

    • @r None.

  • draw_page_finish ()

    Signal that drawing of particular page is complete. It is called after completion of page drawing (e.g. drawing in another thread). If [method@Gtk.PrintOperation.set_defer_drawing] was called before, then this function has to be called by application. Otherwise it is called by GTK itself.

    • @r None.

  • get_default_page_setup ()

    Returns the default page setup.

  • get_embed_page_setup ()

    Gets whether page setup selection combos are embedded

  • get_error ()

    Call this when the result of a print operation is %GTK_PRINT_OPERATION_RESULT_ERROR. It can be called either after [method@Gtk.PrintOperation.run] returns, or in the [signal@Gtk.PrintOperation::done] signal handler. The returned GError will contain more details on what went wrong.

    • @r None.

  • get_has_selection ()

    Gets whether there is a selection.

  • get_n_pages_to_print ()

    Returns the number of pages that will be printed. Note that this value is set during print preparation phase (%GTK_PRINT_STATUS_PREPARING), so this function should never be called before the data generation phase (%GTK_PRINT_STATUS_GENERATING_DATA). You can connect to the [signal@Gtk.PrintOperation::status-changed] signal and call gtk_print_operation_get_n_pages_to_print() when print status is %GTK_PRINT_STATUS_GENERATING_DATA. This is typically used to track the progress of print operation.

  • get_print_settings ()

    Returns the current print settings. Note that the return value is %NULL until either [method@Gtk.PrintOperation.set_print_settings] or [method@Gtk.PrintOperation.run] have been called.

  • get_status ()

    Returns the status of the print operation. Also see [method@Gtk.PrintOperation.get_status_string].

  • get_status_string ()

    Returns a string representation of the status of the print operation. The string is translated and suitable for displaying the print status e.g. in a GtkStatusbar. Use [method@Gtk.PrintOperation.get_status] to obtain a status value that is suitable for programmatic use.

  • get_support_selection ()

    Gets whether the application supports print of selection

  • is_finished ()

    A convenience function to find out if the print operation is finished. a print operation is finished if its status is either %GTK_PRINT_STATUS_FINISHED or %GTK_PRINT_STATUS_FINISHED_ABORTED. Note: when you enable print status tracking the print operation can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer.

  • run (string action, object parent)

    Runs the print operation. Normally that this function does not return until the rendering of all pages is complete. You can connect to the [signal@Gtk.PrintOperation::status-changed] signal on @op to obtain some information about the progress of the print operation. Furthermore, it may use a recursive mainloop to show the print dialog. If you set the [Gtk.PrintOperation:allow-async] property, the operation will run asynchronously if this is supported on the platform. The [signal@Gtk.PrintOperation::done] signal will be emitted with the result of the operation when the it is done (i.e. when the dialog is canceled, or when the print succeeds or fails). c if (settings != NULL) gtk_print_operation_set_print_settings (print, settings); if (page_setup != NULL) gtk_print_operation_set_default_page_setup (print, page_setup); g_signal_connect (print, "begin-print", G_CALLBACK (begin_print), &data); g_signal_connect (print, "draw-page", G_CALLBACK (draw_page), &data); res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, parent, &error); if (res == GTK_PRINT_OPERATION_RESULT_ERROR) { error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent), GTK_DIALOG_DESTROY_WITH_PARENT, GTK_MESSAGE_ERROR, GTK_BUTTONS_CLOSE, "Error printing file:\n%s", error->message); g_signal_connect (error_dialog, "response", G_CALLBACK (gtk_window_destroy), NULL); gtk_window_present (GTK_WINDOW (error_dialog)); g_error_free (error); } else 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)); } Note that gtk_print_operation_run() can only be called once on a given GtkPrintOperation.

    • @p action is the action to start.
    • @p parent is Transient parent of the dialog.

  • set_allow_async (bool allow_async)

    Sets whether gtk_print_operation_run() may return before the print operation is completed. Note that some platforms may not allow asynchronous operation.

    • @p allow_async is %TRUE to allow asynchronous operation.
    • @r None.

  • set_current_page (int current_page)

    Sets the current page. If this is called before [method@Gtk.PrintOperation.run], the user will be able to select to print only the current page. Note that this only makes sense for pre-paginated documents.

    • @p current_page is the current page, 0-based.
    • @r None.

  • set_custom_tab_label (string label)

    Sets the label for the tab holding custom widgets.

    • @p label is the label to use, or %NULL to use the default label.
    • @r None.

  • set_default_page_setup (object default_page_setup)

    Makes @default_page_setup the default page setup for @op. This page setup will be used by [method@Gtk.PrintOperation.run], but it can be overridden on a per-page basis by connecting to the [signal@Gtk.PrintOperation::request-page-setup] signal.

    • @p default_page_setup is a GtkPageSetup.
    • @r None.

  • set_defer_drawing ()

    Sets up the GtkPrintOperation to wait for calling of [method@Gtk.PrintOperation.draw_page_finish from application. This can be used for drawing page in another thread. This function must be called in the callback of the [signal@Gtk.PrintOperation::draw-page] signal.

    • @r None.

  • set_embed_page_setup (bool embed)

    Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in GtkPrintOperation.

    • @p embed is %TRUE to embed page setup selection in the GtkPrintUnixDialog.
    • @r None.

  • set_export_filename (string filename)

    Sets up the GtkPrintOperation to generate a file instead of showing the print dialog. The intended use of this function is for implementing “Export to PDF” actions. Currently, PDF is the only supported format. “Print to PDF” support is independent of this and is done by letting the user pick the “Print to PDF” item from the list of printers in the print dialog.

    • @p filename is the filename for the exported file.
    • @r None.

  • set_has_selection (bool has_selection)

    Sets whether there is a selection to print. Application has to set number of pages to which the selection will draw by [method@Gtk.PrintOperation.set_n_pages] in a handler for the [signal@Gtk.PrintOperation::begin-print] signal.

    • @p has_selection is %TRUE indicates that a selection exists.
    • @r None.

  • set_job_name (string job_name)

    Sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups). If you don’t set a job name, GTK picks a default one by numbering successive print jobs.

    • @p job_name is a string that identifies the print job.
    • @r None.

  • set_n_pages (int n_pages)

    Sets the number of pages in the document. This must be set to a positive number before the rendering starts. It may be set in a [signal@Gtk.PrintOperation::begin-print] signal handler. Note that the page numbers passed to the [signal@Gtk.PrintOperation::request-page-setup] and [signal@Gtk.PrintOperation::draw-page] signals are 0-based, i.e. if the user chooses to print all pages, the last ::draw-page signal will be for page @n_pages - 1.

    • @p n_pages is the number of pages.
    • @r None.

  • set_print_settings (object print_settings)

    Sets the print settings for @op. This is typically used to re-establish print settings from a previous print operation, see [method@Gtk.PrintOperation.run].

    • @p print_settings is GtkPrintSettings.
    • @r None.

  • set_show_progress (bool show_progress)

    If @show_progress is %TRUE, the print operation will show a progress dialog during the print operation.

    • @p show_progress is %TRUE to show a progress dialog.
    • @r None.

  • set_support_selection (bool support_selection)

    Sets whether selection is supported by GtkPrintOperation.

    • @p support_selection is %TRUE to support selection.
    • @r None.

  • set_track_print_status (bool track_status)

    If track_status is %TRUE, the print operation will try to continue report on the status of the print job in the printer queues and printer. This can allow your application to show things like “out of paper” issues, and when the print job actually reaches the printer. This function is often implemented using some form of polling, so it should not be enabled unless needed.

    • @p track_status is %TRUE to track status after printing.
    • @r None.

  • set_unit (string unit)

    Sets up the transformation for the cairo context obtained from GtkPrintContext in such a way that distances are measured in units of

    • @unit. ``
    • @p unit is the unit to use.
    • @r None.

  • set_use_full_page (bool full_page)

    If @full_page is %TRUE, the transformation for the cairo context obtained from GtkPrintContext puts the origin at the top left corner of the page. This may not be the top left corner of the sheet, depending on page orientation and the number of pages per sheet). Otherwise, the origin is at the top left corner of the imageable area (i.e. inside the margins).

    • @p full_page is %TRUE to set up the GtkPrintContext for the full page.
    • @r None.

class: PrintOperationDoneCallback

[1327:7] extends: object

Generated low-level callback wrapper for GIR callback done.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationDoneCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, result, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationUpdatecustomwidgetCallback

[1826:7] extends: object

Generated low-level callback wrapper for GIR callback update-custom-widget.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationUpdatecustomwidgetCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, widget, setup, settings, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationPaginateCallback

[1540:7] extends: object

Generated low-level callback wrapper for GIR callback paginate.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationPaginateCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, context, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationMeta

[1899:14] static extends: object

Generated metadata helpers for PrintOperation class surfaces.

Methods

  • properties ()

    Returns property metadata for PrintOperation.

    • @r A list.

  • signals ()

    Returns signal metadata for PrintOperation.

    • @r A list.

class: PrintOperationEndprintCallback

[1469:7] extends: object

Generated low-level callback wrapper for GIR callback end-print.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationEndprintCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, context, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationBeginprintCallback

[1115:7] extends: object

Generated low-level callback wrapper for GIR callback begin-print.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationBeginprintCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, context, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: PrintOperationCreatecustomwidgetCallback

[1186:7] extends: object

Generated low-level callback wrapper for GIR callback create-custom-widget.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • PrintOperationCreatecustomwidgetCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.

  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

Aussom

Write once. Embed everywhere.

Language

Tools

Community

Copyright 2026 Austin Lehman. All rights reserved.