:right-sidebar: True PrintOperation =================================================================== .. currentmodule:: gi.repository.Gtk .. class:: PrintOperation(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Implemented Interfaces: :class:`~gi.repository.Gtk.PrintOperationPreview` ``GtkPrintOperation`` is the 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 :obj:`~gi.repository.Gtk.PrintUnixDialog`. The typical way to use the high-level printing API is to create a ``GtkPrintOperation`` object with :obj:`~gi.repository.Gtk.PrintOperation.new` when the user selects to print. Then you set some properties on it, e.g. the page size, any :obj:`~gi.repository.Gtk.PrintSettings` from previous print operations, the number of pages, the current page, etc. Then you start the print operation by calling :obj:`~gi.repository.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 :obj:`~gi.repository.Gtk.PrintOperation.signals.draw_page`, which you are supposed to handle and render the page on the provided :obj:`~gi.repository.Gtk.PrintContext` using Cairo. The high-level printing API --------------------------- .. code-block:: c :dedent: 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 :obj:`~gi.repository.Gtk.PrintOperationPreview.render_page`, :obj:`~gi.repository.Gtk.PrintOperationPreview.end_preview` and :obj:`~gi.repository.Gtk.PrintOperationPreview.is_selected` are useful when implementing a print preview. Constructors ------------ .. rst-class:: interim-class .. class:: PrintOperation :no-index: .. classmethod:: new() -> ~gi.repository.Gtk.PrintOperation Creates a new ``GtkPrintOperation``. Methods ------- .. rst-class:: interim-class .. class:: PrintOperation :no-index: .. method:: cancel() -> None Cancels a running print operation. This function may be called from a :obj:`~gi.repository.Gtk.PrintOperation.signals.begin_print`, :obj:`~gi.repository.Gtk.PrintOperation.signals.paginate` or :obj:`~gi.repository.Gtk.PrintOperation.signals.draw_page` signal handler to stop the currently running print operation. .. method:: draw_page_finish() -> None Signal that drawing of particular page is complete. It is called after completion of page drawing (e.g. drawing in another thread). If :obj:`~gi.repository.Gtk.PrintOperation.set_defer_drawing` was called before, then this function has to be called by application. Otherwise it is called by GTK itself. .. method:: get_default_page_setup() -> ~gi.repository.Gtk.PageSetup Returns the default page setup. .. method:: get_embed_page_setup() -> bool Gets whether page setup selection combos are embedded .. method:: get_error() -> None Call this when the result of a print operation is :const:`~gi.repository.Gtk.PrintOperationResult.ERROR`. It can be called either after :obj:`~gi.repository.Gtk.PrintOperation.run` returns, or in the :obj:`~gi.repository.Gtk.PrintOperation.signals.done` signal handler. The returned ``GError`` will contain more details on what went wrong. .. method:: get_has_selection() -> bool Gets whether there is a selection. .. method:: get_n_pages_to_print() -> int Returns the number of pages that will be printed. Note that this value is set during print preparation phase (:const:`~gi.repository.Gtk.PrintStatus.PREPARING`), so this function should never be called before the data generation phase (:const:`~gi.repository.Gtk.PrintStatus.GENERATING_DATA`). You can connect to the :obj:`~gi.repository.Gtk.PrintOperation.signals.status_changed` signal and call :func:`~gi.repository.Gtk.PrintOperation.get_n_pages_to_print` when print status is :const:`~gi.repository.Gtk.PrintStatus.GENERATING_DATA`. This is typically used to track the progress of print operation. .. method:: get_print_settings() -> ~gi.repository.Gtk.PrintSettings | None Returns the current print settings. Note that the return value is :const:`None` until either :obj:`~gi.repository.Gtk.PrintOperation.set_print_settings` or :obj:`~gi.repository.Gtk.PrintOperation.run` have been called. .. method:: get_status() -> ~gi.repository.Gtk.PrintStatus Returns the status of the print operation. Also see :obj:`~gi.repository.Gtk.PrintOperation.get_status_string`. .. method:: get_status_string() -> str 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 :obj:`~gi.repository.Gtk.PrintOperation.get_status` to obtain a status value that is suitable for programmatic use. .. method:: get_support_selection() -> bool Gets whether the application supports print of selection .. method:: is_finished() -> bool A convenience function to find out if the print operation is finished. a print operation is finished if its status is either :const:`~gi.repository.Gtk.PrintStatus.FINISHED` or :const:`~gi.repository.Gtk.PrintStatus.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. .. method:: run(action: ~gi.repository.Gtk.PrintOperationAction, parent: ~gi.repository.Gtk.Window | None = None) -> ~gi.repository.Gtk.PrintOperationResult Runs the print operation. Normally that this function does not return until the rendering of all pages is complete. You can connect to the :obj:`~gi.repository.Gtk.PrintOperation.signals.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 :obj:`~gi.repository.Gtk.PrintOperation.signals.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). .. code-block:: c :dedent: 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 :func:`~gi.repository.Gtk.PrintOperation.run` can only be called once on a given ``GtkPrintOperation``. :param action: the action to start :param parent: Transient parent of the dialog .. method:: set_allow_async(allow_async: bool) -> None Sets whether :func:`~gi.repository.Gtk.PrintOperation.run` may return before the print operation is completed. Note that some platforms may not allow asynchronous operation. :param allow_async: :const:`True` to allow asynchronous operation .. method:: set_current_page(current_page: int) -> None Sets the current page. If this is called before :obj:`~gi.repository.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. :param current_page: the current page, 0-based .. method:: set_custom_tab_label(label: str | None = None) -> None Sets the label for the tab holding custom widgets. :param label: the label to use, or :const:`None` to use the default label .. method:: set_default_page_setup(default_page_setup: ~gi.repository.Gtk.PageSetup | None = None) -> None Makes ``default_page_setup`` the default page setup for ``op``. This page setup will be used by :obj:`~gi.repository.Gtk.PrintOperation.run`, but it can be overridden on a per-page basis by connecting to the :obj:`~gi.repository.Gtk.PrintOperation.signals.request_page_setup` signal. :param default_page_setup: a ``GtkPageSetup`` .. method:: set_defer_drawing() -> None 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 :obj:`~gi.repository.Gtk.PrintOperation.signals.draw_page` signal. .. method:: set_embed_page_setup(embed: bool) -> None Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in ``GtkPrintOperation``. :param embed: :const:`True` to embed page setup selection in the ``GtkPrintUnixDialog`` .. method:: set_export_filename(filename: str) -> None 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. :param filename: the filename for the exported file .. method:: set_has_selection(has_selection: bool) -> None Sets whether there is a selection to print. Application has to set number of pages to which the selection will draw by :obj:`~gi.repository.Gtk.PrintOperation.set_n_pages` in a handler for the :obj:`~gi.repository.Gtk.PrintOperation.signals.begin_print` signal. :param has_selection: :const:`True` indicates that a selection exists .. method:: set_job_name(job_name: str) -> None 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. :param job_name: a string that identifies the print job .. method:: set_n_pages(n_pages: int) -> None 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 :obj:`~gi.repository.Gtk.PrintOperation.signals.begin_print` signal handler. Note that the page numbers passed to the :obj:`~gi.repository.Gtk.PrintOperation.signals.request_page_setup` and :obj:`~gi.repository.Gtk.PrintOperation.signals.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. :param n_pages: the number of pages .. method:: set_print_settings(print_settings: ~gi.repository.Gtk.PrintSettings | None = None) -> None Sets the print settings for ``op``. This is typically used to re-establish print settings from a previous print operation, see :obj:`~gi.repository.Gtk.PrintOperation.run`. :param print_settings: ``GtkPrintSettings`` .. method:: set_show_progress(show_progress: bool) -> None If ``show_progress`` is :const:`True`, the print operation will show a progress dialog during the print operation. :param show_progress: :const:`True` to show a progress dialog .. method:: set_support_selection(support_selection: bool) -> None Sets whether selection is supported by ``GtkPrintOperation``. :param support_selection: :const:`True` to support selection .. method:: set_track_print_status(track_status: bool) -> None If track_status is :const:`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. :param track_status: :const:`True` to track status after printing .. method:: set_unit(unit: ~gi.repository.Gtk.Unit) -> None Sets up the transformation for the cairo context obtained from ``GtkPrintContext`` in such a way that distances are measured in units of ``unit``. :param unit: the unit to use .. method:: set_use_full_page(full_page: bool) -> None If ``full_page`` is :const:`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). :param full_page: :const:`True` to set up the ``GtkPrintContext`` for the full page Properties ---------- .. rst-class:: interim-class .. class:: PrintOperation :no-index: .. attribute:: props.allow_async :type: bool The type of the None singleton. .. attribute:: props.current_page :type: int The type of the None singleton. .. attribute:: props.custom_tab_label :type: str The type of the None singleton. .. attribute:: props.default_page_setup :type: ~gi.repository.Gtk.PageSetup The type of the None singleton. .. attribute:: props.embed_page_setup :type: bool The type of the None singleton. .. attribute:: props.export_filename :type: str The type of the None singleton. .. attribute:: props.has_selection :type: bool The type of the None singleton. .. attribute:: props.job_name :type: str The type of the None singleton. .. attribute:: props.n_pages :type: int The type of the None singleton. .. attribute:: props.n_pages_to_print :type: int The type of the None singleton. .. attribute:: props.print_settings :type: ~gi.repository.Gtk.PrintSettings The type of the None singleton. .. attribute:: props.show_progress :type: bool The type of the None singleton. .. attribute:: props.status :type: ~gi.repository.Gtk.PrintStatus The type of the None singleton. .. attribute:: props.status_string :type: str The type of the None singleton. .. attribute:: props.support_selection :type: bool The type of the None singleton. .. attribute:: props.track_print_status :type: bool The type of the None singleton. .. attribute:: props.unit :type: ~gi.repository.Gtk.Unit The type of the None singleton. .. attribute:: props.use_full_page :type: bool The type of the None singleton. Signals ------- .. rst-class:: interim-class .. class:: PrintOperation.signals :no-index: .. method:: begin_print(context: ~gi.repository.Gtk.PrintContext) -> None The type of the None singleton. :param context: the ``GtkPrintContext`` for the current operation .. method:: create_custom_widget() -> ~gi.repository.GObject.Object | None The type of the None singleton. .. method:: custom_widget_apply(widget: ~gi.repository.Gtk.Widget) -> None The type of the None singleton. :param widget: the custom widget added in ::create-custom-widget .. method:: done(result: ~gi.repository.Gtk.PrintOperationResult) -> None The type of the None singleton. :param result: the result of the print operation .. method:: draw_page(context: ~gi.repository.Gtk.PrintContext, page_nr: int) -> None The type of the None singleton. :param context: the ``GtkPrintContext`` for the current operation :param page_nr: the number of the currently printed page (0-based) .. method:: end_print(context: ~gi.repository.Gtk.PrintContext) -> None The type of the None singleton. :param context: the ``GtkPrintContext`` for the current operation .. method:: paginate(context: ~gi.repository.Gtk.PrintContext) -> bool The type of the None singleton. :param context: the ``GtkPrintContext`` for the current operation .. method:: preview(preview: ~gi.repository.Gtk.PrintOperationPreview, context: ~gi.repository.Gtk.PrintContext, parent: ~gi.repository.Gtk.Window | None = None) -> bool The type of the None singleton. :param preview: the ``GtkPrintOperationPreview`` for the current operation :param context: the ``GtkPrintContext`` that will be used :param parent: the ``GtkWindow`` to use as window parent .. method:: request_page_setup(context: ~gi.repository.Gtk.PrintContext, page_nr: int, setup: ~gi.repository.Gtk.PageSetup) -> None The type of the None singleton. :param context: the ``GtkPrintContext`` for the current operation :param page_nr: the number of the currently printed page (0-based) :param setup: the ``GtkPageSetup`` .. method:: status_changed() -> None The type of the None singleton. .. method:: update_custom_widget(widget: ~gi.repository.Gtk.Widget, setup: ~gi.repository.Gtk.PageSetup, settings: ~gi.repository.Gtk.PrintSettings) -> None The type of the None singleton. :param widget: the custom widget added in ::create-custom-widget :param setup: actual page setup :param settings: actual print settings Virtual Methods --------------- .. rst-class:: interim-class .. class:: PrintOperation :no-index: .. method:: do_begin_print(context: ~gi.repository.Gtk.PrintContext) -> None The type of the None singleton. :param context: .. method:: do_custom_widget_apply(widget: ~gi.repository.Gtk.Widget) -> None The type of the None singleton. :param widget: .. method:: do_done(result: ~gi.repository.Gtk.PrintOperationResult) -> None The type of the None singleton. :param result: .. method:: do_draw_page(context: ~gi.repository.Gtk.PrintContext, page_nr: int) -> None The type of the None singleton. :param context: :param page_nr: .. method:: do_end_print(context: ~gi.repository.Gtk.PrintContext) -> None The type of the None singleton. :param context: .. method:: do_paginate(context: ~gi.repository.Gtk.PrintContext) -> bool The type of the None singleton. :param context: .. method:: do_preview(preview: ~gi.repository.Gtk.PrintOperationPreview, context: ~gi.repository.Gtk.PrintContext, parent: ~gi.repository.Gtk.Window) -> bool The type of the None singleton. :param preview: :param context: :param parent: .. method:: do_request_page_setup(context: ~gi.repository.Gtk.PrintContext, page_nr: int, setup: ~gi.repository.Gtk.PageSetup) -> None The type of the None singleton. :param context: :param page_nr: :param setup: .. method:: do_status_changed() -> None The type of the None singleton. .. method:: do_update_custom_widget(widget: ~gi.repository.Gtk.Widget, setup: ~gi.repository.Gtk.PageSetup, settings: ~gi.repository.Gtk.PrintSettings) -> None The type of the None singleton. :param widget: :param setup: :param settings: Fields ------ .. rst-class:: interim-class .. class:: PrintOperation :no-index: .. attribute:: parent_instance .. attribute:: priv