Memory-managed wrapper type.

Type class for types which can be safely cast to PrintOperation, for instance with toPrintOperation.

Cast to PrintOperation, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe PrintOperation.

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

Since: 2.10

Signalize that drawing of particular page is complete.

It is called after completion of page drawing (e.g. drawing in another thread). If printOperationSetDeferDrawing was called before, then this function has to be called by application. In another case it is called by the library itself.

Since: 2.16

Returns the default page setup, see printOperationSetDefaultPageSetup.

Since: 2.10

Gets the value of PrintOperation:embed-page-setup property.

Since: 2.18

Call this when the result of a print operation is PrintOperationResultError, either as returned by printOperationRun, or in the PrintOperation::done signal handler. The returned GError will contain more details on what went wrong.

Since: 2.10

Gets the value of PrintOperation:has-selection property.

Since: 2.18

Returns the number of pages that will be printed.

Note that this value is set during print preparation phase (PrintStatusPreparing), so this function should never be called before the data generation phase (PrintStatusGeneratingData). You can connect to the PrintOperation::status-changed signal and call printOperationGetNPagesToPrint when print status is PrintStatusGeneratingData. This is typically used to track the progress of print operation.

Since: 2.18

Returns the current print settings.

Note that the return value is Nothing until either printOperationSetPrintSettings or printOperationRun have been called.

Since: 2.10

Returns the status of the print operation. Also see printOperationGetStatusString.

Since: 2.10

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 Statusbar.

Use printOperationGetStatus to obtain a status value that is suitable for programmatic use.

Since: 2.10

Gets the value of PrintOperation:support-selection property.

Since: 2.18

A convenience function to find out if the print operation is finished, either successfully (PrintStatusFinished) or unsuccessfully (PrintStatusFinishedAborted).

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.

Since: 2.10

Creates a new PrintOperation.

Since: 2.10

Runs the print operation, by first letting the user modify print settings in the print dialog, and then print the document.

Normally that this function does not return until the rendering of all pages is complete. You can connect to the 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 call printOperationSetAllowAsync or set the PrintOperation:allow-async property the operation will run asynchronously if this is supported on the platform. The 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 code

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_widget_destroy), NULL);
   gtk_widget_show (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 printOperationRun can only be called once on a given PrintOperation.

Since: 2.10

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

Since: 2.10

Sets the current page.

If this is called before printOperationRun, the user will be able to select to print only the current page.

Note that this only makes sense for pre-paginated documents.

Since: 2.10

Sets the label for the tab holding custom widgets.

Since: 2.10

Makes defaultPageSetup the default page setup for op.

This page setup will be used by printOperationRun, but it can be overridden on a per-page basis by connecting to the PrintOperation::request-page-setup signal.

Since: 2.10

Sets up the PrintOperation to wait for calling of printOperationDrawPageFinish from application. It can be used for drawing page in another thread.

This function must be called in the callback of “draw-page” signal.

Since: 2.16

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

Since: 2.18

Sets up the PrintOperation to generate a file instead of showing the print dialog. The indended 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.

Since: 2.10

Sets whether there is a selection to print.

Application has to set number of pages to which the selection will draw by printOperationSetNPages in a callback of PrintOperation::begin-print.

Since: 2.18

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.

Since: 2.10

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 PrintOperation::begin-print signal hander.

Note that the page numbers passed to the PrintOperation::request-page-setup and 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 nPages - 1.

Since: 2.10

Sets the print settings for op. This is typically used to re-establish print settings from a previous print operation, see printOperationRun.

Since: 2.10

If showProgress is True, the print operation will show a progress dialog during the print operation.

Since: 2.10

Sets whether selection is supported by PrintOperation.

Since: 2.18

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.

Since: 2.10

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

Since: 2.10

If fullPage is True, the transformation for the cairo context obtained from PrintContext puts the origin at the top left corner of the page (which 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).

Since: 2.10

Construct a GValueConstruct with valid value for the “allow-async” property. This is rarely needed directly, but it is used by new.

Get the value of the “allow-async” property. When overloading is enabled, this is equivalent to

get printOperation #allowAsync

Set the value of the “allow-async” property. When overloading is enabled, this is equivalent to

set printOperation [ #allowAsync := value ]

Construct a GValueConstruct with valid value for the “current-page” property. This is rarely needed directly, but it is used by new.

Get the value of the “current-page” property. When overloading is enabled, this is equivalent to

get printOperation #currentPage

Set the value of the “current-page” property. When overloading is enabled, this is equivalent to

set printOperation [ #currentPage := value ]

Set the value of the “custom-tab-label” property to Nothing. When overloading is enabled, this is equivalent to

clear #customTabLabel

Construct a GValueConstruct with valid value for the “custom-tab-label” property. This is rarely needed directly, but it is used by new.

Get the value of the “custom-tab-label” property. When overloading is enabled, this is equivalent to

get printOperation #customTabLabel

Set the value of the “custom-tab-label” property. When overloading is enabled, this is equivalent to

set printOperation [ #customTabLabel := value ]

Set the value of the “default-page-setup” property to Nothing. When overloading is enabled, this is equivalent to

clear #defaultPageSetup

Construct a GValueConstruct with valid value for the “default-page-setup” property. This is rarely needed directly, but it is used by new.

Get the value of the “default-page-setup” property. When overloading is enabled, this is equivalent to

get printOperation #defaultPageSetup

Set the value of the “default-page-setup” property. When overloading is enabled, this is equivalent to

set printOperation [ #defaultPageSetup := value ]

Construct a GValueConstruct with valid value for the “embed-page-setup” property. This is rarely needed directly, but it is used by new.

Get the value of the “embed-page-setup” property. When overloading is enabled, this is equivalent to

get printOperation #embedPageSetup

Set the value of the “embed-page-setup” property. When overloading is enabled, this is equivalent to

set printOperation [ #embedPageSetup := value ]

Set the value of the “export-filename” property to Nothing. When overloading is enabled, this is equivalent to

clear #exportFilename

Construct a GValueConstruct with valid value for the “export-filename” property. This is rarely needed directly, but it is used by new.

Get the value of the “export-filename” property. When overloading is enabled, this is equivalent to

get printOperation #exportFilename

Set the value of the “export-filename” property. When overloading is enabled, this is equivalent to

set printOperation [ #exportFilename := value ]

Construct a GValueConstruct with valid value for the “has-selection” property. This is rarely needed directly, but it is used by new.

Get the value of the “has-selection” property. When overloading is enabled, this is equivalent to

get printOperation #hasSelection

Set the value of the “has-selection” property. When overloading is enabled, this is equivalent to

set printOperation [ #hasSelection := value ]

Construct a GValueConstruct with valid value for the “job-name” property. This is rarely needed directly, but it is used by new.

Get the value of the “job-name” property. When overloading is enabled, this is equivalent to

get printOperation #jobName

Set the value of the “job-name” property. When overloading is enabled, this is equivalent to

set printOperation [ #jobName := value ]

Construct a GValueConstruct with valid value for the “n-pages” property. This is rarely needed directly, but it is used by new.

Get the value of the “n-pages” property. When overloading is enabled, this is equivalent to

get printOperation #nPages

Set the value of the “n-pages” property. When overloading is enabled, this is equivalent to

set printOperation [ #nPages := value ]

Get the value of the “n-pages-to-print” property. When overloading is enabled, this is equivalent to

get printOperation #nPagesToPrint

Set the value of the “print-settings” property to Nothing. When overloading is enabled, this is equivalent to

clear #printSettings

Construct a GValueConstruct with valid value for the “print-settings” property. This is rarely needed directly, but it is used by new.

Get the value of the “print-settings” property. When overloading is enabled, this is equivalent to

get printOperation #printSettings

Set the value of the “print-settings” property. When overloading is enabled, this is equivalent to

set printOperation [ #printSettings := value ]

Construct a GValueConstruct with valid value for the “show-progress” property. This is rarely needed directly, but it is used by new.

Get the value of the “show-progress” property. When overloading is enabled, this is equivalent to

get printOperation #showProgress

Set the value of the “show-progress” property. When overloading is enabled, this is equivalent to

set printOperation [ #showProgress := value ]

Get the value of the “status” property. When overloading is enabled, this is equivalent to

get printOperation #status

Get the value of the “status-string” property. When overloading is enabled, this is equivalent to

get printOperation #statusString

Construct a GValueConstruct with valid value for the “support-selection” property. This is rarely needed directly, but it is used by new.

Get the value of the “support-selection” property. When overloading is enabled, this is equivalent to

get printOperation #supportSelection

Set the value of the “support-selection” property. When overloading is enabled, this is equivalent to

set printOperation [ #supportSelection := value ]

Construct a GValueConstruct with valid value for the “track-print-status” property. This is rarely needed directly, but it is used by new.

Get the value of the “track-print-status” property. When overloading is enabled, this is equivalent to

get printOperation #trackPrintStatus

Set the value of the “track-print-status” property. When overloading is enabled, this is equivalent to

set printOperation [ #trackPrintStatus := value ]

Construct a GValueConstruct with valid value for the “unit” property. This is rarely needed directly, but it is used by new.

Get the value of the “unit” property. When overloading is enabled, this is equivalent to

get printOperation #unit

Set the value of the “unit” property. When overloading is enabled, this is equivalent to

set printOperation [ #unit := value ]

Construct a GValueConstruct with valid value for the “use-full-page” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-full-page” property. When overloading is enabled, this is equivalent to

get printOperation #useFullPage

Set the value of the “use-full-page” property. When overloading is enabled, this is equivalent to

set printOperation [ #useFullPage := value ]

Type for the callback on the (unwrapped) C side.

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 PrintContext and paginate the document accordingly, and then set the number of pages with printOperationSetNPages.

Since: 2.10

Connect a signal handler for the “begin-print” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #beginPrint callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationBeginPrintCallback.

A convenience synonym for Nothing :: Maybe PrintOperationBeginPrintCallback.

Connect a signal handler for the “begin-print” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #beginPrint callback

Wrap a PrintOperationBeginPrintCallback into a C_PrintOperationBeginPrintCallback.

Type for the callback on the (unwrapped) C side.

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 PrintOperation::custom-widget-apply signal is emitted on the operation. Then you can read out any information you need from the widgets.

Since: 2.10

Connect a signal handler for the “create-custom-widget” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #createCustomWidget callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationCreateCustomWidgetCallback.

A convenience synonym for Nothing :: Maybe PrintOperationCreateCustomWidgetCallback.

Connect a signal handler for the “create-custom-widget” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #createCustomWidget callback

Wrap a PrintOperationCreateCustomWidgetCallback into a C_PrintOperationCreateCustomWidgetCallback.

Type for the callback on the (unwrapped) C side.

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

Since: 2.10

Connect a signal handler for the “custom-widget-apply” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #customWidgetApply callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationCustomWidgetApplyCallback.

A convenience synonym for Nothing :: Maybe PrintOperationCustomWidgetApplyCallback.

Connect a signal handler for the “custom-widget-apply” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #customWidgetApply callback

Wrap a PrintOperationCustomWidgetApplyCallback into a C_PrintOperationCustomWidgetApplyCallback.

Type for the callback on the (unwrapped) C side.

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 PrintOperationResultError then you can call printOperationGetError for more information.

If you enabled print status tracking then printOperationIsFinished may still return False after PrintOperation::done was emitted.

Since: 2.10

Connect a signal handler for the “done” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #done callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationDoneCallback.

A convenience synonym for Nothing :: Maybe PrintOperationDoneCallback.

Connect a signal handler for the “done” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #done callback

Wrap a PrintOperationDoneCallback into a C_PrintOperationDoneCallback.

Type for the callback on the (unwrapped) C side.

Emitted for every page that is printed. The signal handler must render the pageNr's page onto the cairo context obtained from context using printContextGetCairoContext.

C code

static void
draw_page (GtkPrintOperation *operation,
           GtkPrintContext   *context,
           gint               page_nr,
           gpointer           user_data)
{
  cairo_t *cr;
  PangoLayout *layout;
  gdouble width, text_height;
  gint 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 = (gdouble)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 printOperationSetUseFullPage and printOperationSetUnit before starting the print operation to set up the transformation of the cairo context according to your needs.

Since: 2.10

Connect a signal handler for the “draw-page” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #drawPage callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationDrawPageCallback.

A convenience synonym for Nothing :: Maybe PrintOperationDrawPageCallback.

Connect a signal handler for the “draw-page” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #drawPage callback

Wrap a PrintOperationDrawPageCallback into a C_PrintOperationDrawPageCallback.

Type for the callback on the (unwrapped) C side.

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

Since: 2.10

Connect a signal handler for the “end-print” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #endPrint callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationEndPrintCallback.

A convenience synonym for Nothing :: Maybe PrintOperationEndPrintCallback.

Connect a signal handler for the “end-print” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #endPrint callback

Wrap a PrintOperationEndPrintCallback into a C_PrintOperationEndPrintCallback.

Type for the callback on the (unwrapped) C side.

Emitted after the PrintOperation::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 printOperationSetNPages, 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.

Since: 2.10

Connect a signal handler for the “paginate” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #paginate callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationPaginateCallback.

A convenience synonym for Nothing :: Maybe PrintOperationPaginateCallback.

Connect a signal handler for the “paginate” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #paginate callback

Wrap a PrintOperationPaginateCallback into a C_PrintOperationPaginateCallback.

Type for the callback on the (unwrapped) C side.

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 printContextSetCairoContext.

The custom preview implementation can use printOperationPreviewIsSelected and printOperationPreviewRenderPage to find pages which are selected for print and render them. The preview must be finished by calling printOperationPreviewEndPreview (typically in response to the user clicking a close button).

Since: 2.10

Connect a signal handler for the “preview” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #preview callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationPreviewCallback.

A convenience synonym for Nothing :: Maybe PrintOperationPreviewCallback.

Connect a signal handler for the “preview” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #preview callback

Wrap a PrintOperationPreviewCallback into a C_PrintOperationPreviewCallback.

Type for the callback on the (unwrapped) C side.

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

Since: 2.10

Connect a signal handler for the “request-page-setup” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #requestPageSetup callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationRequestPageSetupCallback.

A convenience synonym for Nothing :: Maybe PrintOperationRequestPageSetupCallback.

Connect a signal handler for the “request-page-setup” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #requestPageSetup callback

Wrap a PrintOperationRequestPageSetupCallback into a C_PrintOperationRequestPageSetupCallback.

Type for the callback on the (unwrapped) C side.

Emitted at between the various phases of the print operation. See PrintStatus for the phases that are being discriminated. Use printOperationGetStatus to find out the current status.

Since: 2.10

Connect a signal handler for the “status-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #statusChanged callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationStatusChangedCallback.

A convenience synonym for Nothing :: Maybe PrintOperationStatusChangedCallback.

Connect a signal handler for the “status-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #statusChanged callback

Wrap a PrintOperationStatusChangedCallback into a C_PrintOperationStatusChangedCallback.

Type for the callback on the (unwrapped) C side.

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.

Since: 2.18

Connect a signal handler for the “update-custom-widget” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after printOperation #updateCustomWidget callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_PrintOperationUpdateCustomWidgetCallback.

A convenience synonym for Nothing :: Maybe PrintOperationUpdateCustomWidgetCallback.

Connect a signal handler for the “update-custom-widget” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on printOperation #updateCustomWidget callback

Wrap a PrintOperationUpdateCustomWidgetCallback into a C_PrintOperationUpdateCustomWidgetCallback.