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 [classGtk.PrintUnixDialog].
The typical way to use the high-level printing API is to create a GtkPrintOperation object with [ctorGtk.PrintOperation.new] when the user selects to print. Then you set some properties on it, e.g. the page size, any [classGtk.PrintSettings] from previous print operations, the number of pages, the current page, etc.
Then you start the print operation by calling [methodGtk.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 [signalGtk.PrintOperation::draw-page], which you are supposed to handle and render the page on the provided [classGtk.PrintContext] using Cairo.
# The high-level printing API
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
[methodGtk.PrintOperationPreview.render_page],
[methodGtk.PrintOperationPreview.end_preview] and
[methodGtk.PrintOperationPreview.is_selected] are useful when implementing
a print preview.
function "+"
(Widget : access Gtk_Print_Operation_Record'Class)
return Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview
function "-"
(Interf : Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview)
return Gtk_Print_Operation
Allow_Async_Property : constant Glib.Properties.Property_Boolean;
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.Print_Operation_Result_In_Progress as the status, and emit the [signalGtk.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.Print_Operation_Action_Export support asynchronous operation.
procedure Cancel (Self : not null access Gtk_Print_Operation_Record)
Cancels a running print operation. This function may be called from a [signalGtk.PrintOperation::begin-print], [signalGtk.PrintOperation::paginate] or [signalGtk.PrintOperation::draw-page] signal handler to stop the currently running print operation.
type Cb_GObject_GObject is not null access function
(Self : access Glib.Object.GObject_Record'Class)
return Glib.Object.GObject;
type Cb_GObject_Gtk_Print_Context_Boolean is not null access function
(Self : access Glib.Object.GObject_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class)
return Boolean;
type Cb_GObject_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
Page_Nr : Glib.Gint;
Setup : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class);
type Cb_GObject_Gtk_Print_Context_Gint_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
Page_Nr : Glib.Gint);
type Cb_GObject_Gtk_Print_Context_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class);
type Cb_GObject_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Or_Null_Boolean is not null access function
(Self : access Glib.Object.GObject_Record'Class;
Preview : Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
Parent : access Gtk.Window.Gtk_Window_Record'Class)
return Boolean;
type Cb_GObject_Gtk_Print_Operation_Result_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Result : Gtk_Print_Operation_Result);
type Cb_GObject_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class;
Setup : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class;
Settings : not null access Gtk.Print_Settings.Gtk_Print_Settings_Record'Class);
type Cb_GObject_Gtk_Widget_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_GObject_Void is not null access procedure
(Self : access Glib.Object.GObject_Record'Class);
type Cb_Gtk_Print_Operation_GObject is not null access function
(Self : access Gtk_Print_Operation_Record'Class)
return Glib.Object.GObject;
type Cb_Gtk_Print_Operation_Gtk_Print_Context_Boolean is not null access function
(Self : access Gtk_Print_Operation_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class)
return Boolean;
type Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
Page_Nr : Glib.Gint;
Setup : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class);
type Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
Page_Nr : Glib.Gint);
type Cb_Gtk_Print_Operation_Gtk_Print_Context_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class);
type Cb_Gtk_Print_Operation_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Or_Null_Boolean is not null access function
(Self : access Gtk_Print_Operation_Record'Class;
Preview : Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview;
Context : not null access Gtk.Print_Context.Gtk_Print_Context_Record'Class;
Parent : access Gtk.Window.Gtk_Window_Record'Class)
return Boolean;
type Cb_Gtk_Print_Operation_Gtk_Print_Operation_Result_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class;
Result : Gtk_Print_Operation_Result);
type Cb_Gtk_Print_Operation_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class;
Setup : not null access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class;
Settings : not null access Gtk.Print_Settings.Gtk_Print_Settings_Record'Class);
type Cb_Gtk_Print_Operation_Gtk_Widget_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class;
Widget : not null access Gtk.Widget.Gtk_Widget_Record'Class);
type Cb_Gtk_Print_Operation_Void is not null access procedure
(Self : access Gtk_Print_Operation_Record'Class);
Current_Page_Property : constant Glib.Properties.Property_Int;
The current page in the document.
If this is set before [methodGtk.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.
Custom_Tab_Label_Property : constant Glib.Properties.Property_String;
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.
Default_Page_Setup_Property : constant Glib.Properties.Property_Object;
Type: Gtk.Page_Setup.Gtk_Page_Setup The GtkPageSetup used by default.
This page setup will be used by [methodGtk.PrintOperation.run], but it can be overridden on a per-page basis by connecting to the [signalGtk.PrintOperation::request-page-setup] signal.
procedure Draw_Page_Finish
(Self : not null access Gtk_Print_Operation_Record)
Signal that drawing of particular page is complete. It is called after completion of page drawing (e.g. drawing in another thread). If [methodGtk.PrintOperation.set_defer_drawing] was called before, then this function has to be called by application. Otherwise it is called by GTK itself.
Embed_Page_Setup_Property : constant Glib.Properties.Property_Boolean;
If True, page size combo box and orientation combo box are embedded into page setup page.
procedure End_Preview (Self : not null access Gtk_Print_Operation_Record)
Export_Filename_Property : constant Glib.Properties.Property_String;
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.
function Get_Default_Page_Setup
(Self : not null access Gtk_Print_Operation_Record)
return Gtk.Page_Setup.Gtk_Page_Setup
Returns the default page setup.
the default page setup. Has transfer-ownership='none'.
function Get_Embed_Page_Setup
(Self : not null access Gtk_Print_Operation_Record) return Boolean
Gets whether page setup selection combos are embedded
whether page setup selection combos are embedded
procedure Get_Error
(Self : not null access Gtk_Print_Operation_Record;
Error : out Glib.Error.GError)
Call this when the result of a print operation is Gtk.Print_Operation.Print_Operation_Result_Error. It can be called either after [methodGtk.PrintOperation.run] returns, or in the [signalGtk.PrintOperation::done] signal handler. The returned GError will contain more details on what went wrong.
the return location for a recoverable error
function Get_Has_Selection
(Self : not null access Gtk_Print_Operation_Record) return Boolean
Gets whether there is a selection.
whether there is a selection
function Get_N_Pages_To_Print
(Self : not null access Gtk_Print_Operation_Record) return Glib.Gint
Returns the number of pages that will be printed. Note that this value is set during print preparation phase (Gtk.Enums.Print_Status_Preparing), so this function should never be called before the data generation phase (Gtk.Enums.Print_Status_Generating_Data). You can connect to the [signalGtk.PrintOperation::status-changed] signal and call Gtk.Print_Operation.Get_N_Pages_To_Print when print status is Gtk.Enums.Print_Status_Generating_Data. This is typically used to track the progress of print operation.
the number of pages that will be printed
function Get_Print_Settings
(Self : not null access Gtk_Print_Operation_Record)
return Gtk.Print_Settings.Gtk_Print_Settings
Returns the current print settings. Note that the return value is null until either [methodGtk.PrintOperation.set_print_settings] or [methodGtk.PrintOperation.run] have been called.
the current print settings of Op. Has transfer-ownership='none'.
function Get_Status
(Self : not null access Gtk_Print_Operation_Record)
return Gtk.Enums.Gtk_Print_Status
Returns the status of the print operation. Also see [methodGtk.PrintOperation.get_status_string].
the status of the print operation
function Get_Status_String
(Self : not null access Gtk_Print_Operation_Record) return UTF8_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 [methodGtk.PrintOperation.get_status] to obtain a status value that is suitable for programmatic use.
a string representation of the status of the print operation
function Get_Support_Selection
(Self : not null access Gtk_Print_Operation_Record) return Boolean
Gets whether the application supports print of selection
whether the application supports print of selection
function Get_Type return Glib.GType
procedure Gtk_New (Self : out Gtk_Print_Operation)
Creates a new GtkPrintOperation. Initialize does nothing if the object was already created with another call to Initialize* or G_New.
type Gtk_Print_Operation is access all Gtk_Print_Operation_Record'Class;
type Gtk_Print_Operation_Action is (
Print_Operation_Action_Print_Dialog,
Print_Operation_Action_Print,
Print_Operation_Action_Preview,
Print_Operation_Action_Export);
Determines what action the print operation should perform.
A parameter of this typs is passed to [methodGtk.PrintOperation.run].
package Gtk_Print_Operation_Action_Properties is
new Generic_Internal_Discrete_Property (Gtk_Print_Operation_Action);
function Gtk_Print_Operation_New return Gtk_Print_Operation
Creates a new GtkPrintOperation.
type Gtk_Print_Operation_Record is new GObject_Record with null record;
type Gtk_Print_Operation_Result is (
Print_Operation_Result_Error,
Print_Operation_Result_Apply,
Print_Operation_Result_Cancel,
Print_Operation_Result_In_Progress);
The result of a print operation.
A value of this type is returned by [methodGtk.PrintOperation.run].
package Gtk_Print_Operation_Result_Properties is
new Generic_Internal_Discrete_Property (Gtk_Print_Operation_Result);
Has_Selection_Property : constant Glib.Properties.Property_Boolean;
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.
package Implements_Gtk_Print_Operation_Preview is new Glib.Types.Implements
(Gtk.Print_Operation_Preview.Gtk_Print_Operation_Preview, Gtk_Print_Operation_Record, Gtk_Print_Operation);
procedure Initialize
(Self : not null access Gtk_Print_Operation_Record'Class)
Creates a new GtkPrintOperation. Initialize does nothing if the object was already created with another call to Initialize* or G_New.
function Is_Finished
(Self : not null access Gtk_Print_Operation_Record) return Boolean
A convenience function to find out if the print operation is finished. a print operation is finished if its status is either Gtk.Enums.Print_Status_Finished or Gtk.Enums.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.
True, if the print operation is finished.
function Is_Selected
(Self : not null access Gtk_Print_Operation_Record;
Page_Nr : Glib.Gint) return Boolean
Job_Name_Property : constant Glib.Properties.Property_String;
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.
N_Pages_Property : constant Glib.Properties.Property_Int;
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 [signalGtk.PrintOperation::begin-print] signal handler.
Note that the page numbers passed to the [signalGtk.PrintOperation::request-page-setup] and [signalGtk.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.
N_Pages_To_Print_Property : constant Glib.Properties.Property_Int;
The number of pages that will be printed.
Note that this value is set during print preparation phase (Gtk.Enums.Print_Status_Preparing), so this value should never be get before the data generation phase (Gtk.Enums.Print_Status_Generating_Data). You can connect to the [signalGtk.PrintOperation::status-changed] signal and call [methodGtk.PrintOperation.get_n_pages_to_print] when print status is Gtk.Enums.Print_Status_Generating_Data.
This is typically used to track the progress of print operation.
procedure On_Begin_Print
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Context_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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 [classGtk.PrintContext] and paginate the document accordingly, and then set the number of pages with [methodGtk.PrintOperation.set_n_pages].
procedure On_Begin_Print
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Context_Void;
After : Boolean := False)
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 [classGtk.PrintContext] and paginate the document accordingly, and then set the number of pages with [methodGtk.PrintOperation.set_n_pages].
procedure On_Create_Custom_Widget
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_GObject;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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 [signalGtk.PrintOperation::custom-widget-apply] signal is emitted on the operation. Then you can read out any information you need from the widgets.
Callback parameters:
procedure On_Create_Custom_Widget
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_GObject;
After : Boolean := False)
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 [signalGtk.PrintOperation::custom-widget-apply] signal is emitted on the operation. Then you can read out any information you need from the widgets.
Callback parameters:
procedure On_Custom_Widget_Apply
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Widget_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
procedure On_Custom_Widget_Apply
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Widget_Void;
After : Boolean := False)
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.
procedure On_Done
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Operation_Result_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.Print_Operation_Result_Error then you can call [methodGtk.PrintOperation.get_error] for more information.
If you enabled print status tracking then [methodGtk.PrintOperation.is_finished] may still return False after the ::done signal was emitted.
procedure On_Done
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Operation_Result_Void;
After : Boolean := False)
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.Print_Operation_Result_Error then you can call [methodGtk.PrintOperation.get_error] for more information.
If you enabled print status tracking then [methodGtk.PrintOperation.is_finished] may still return False after the ::done signal was emitted.
procedure On_Draw_Page
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Context_Gint_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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 [methodGtk.PrintContext.get_cairo_context].
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 [methodGtk.PrintOperation.set_use_full_page] and
[methodGtk.PrintOperation.set_unit] before starting the print operation
to set up the transformation of the cairo context according to your
needs.
Callback parameters:
-- @param Context the `GtkPrintContext` for the current operation
-- @param Page_Nr the number of the currently printed page (0-based)
procedure On_Draw_Page
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Void;
After : Boolean := False)
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 [methodGtk.PrintContext.get_cairo_context].
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 [methodGtk.PrintOperation.set_use_full_page] and
[methodGtk.PrintOperation.set_unit] before starting the print operation
to set up the transformation of the cairo context according to your
needs.
Callback parameters:
-- @param Context the `GtkPrintContext` for the current operation
-- @param Page_Nr the number of the currently printed page (0-based)
procedure On_End_Print
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Context_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
Emitted after all pages have been rendered.
A handler for this signal can clean up any resources that have been allocated in the [signalGtk.PrintOperation::begin-print] handler.
procedure On_End_Print
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Context_Void;
After : Boolean := False)
Emitted after all pages have been rendered.
A handler for this signal can clean up any resources that have been allocated in the [signalGtk.PrintOperation::begin-print] handler.
procedure On_Paginate
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Context_Boolean;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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 [methodGtk.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.
Callback parameters: -- @param Context the GtkPrintContext for the current operation
procedure On_Paginate
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Context_Boolean;
After : Boolean := False)
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 [methodGtk.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.
Callback parameters: -- @param Context the GtkPrintContext for the current operation
procedure On_Preview
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Or_Null_Boolean;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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 [methodGtk.PrintContext.set_cairo_context].
The custom preview implementation can use [methodGtk.PrintOperationPreview.is_selected] and [methodGtk.PrintOperationPreview.render_page] to find pages which are selected for print and render them. The preview must be finished by calling [methodGtk.PrintOperationPreview.end_preview] (typically in response to the user clicking a close button).
Callback parameters: -- @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
procedure On_Preview
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Operation_Preview_Gtk_Print_Context_Gtk_Window_Or_Null_Boolean;
After : Boolean := False)
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 [methodGtk.PrintContext.set_cairo_context].
The custom preview implementation can use [methodGtk.PrintOperationPreview.is_selected] and [methodGtk.PrintOperationPreview.render_page] to find pages which are selected for print and render them. The preview must be finished by calling [methodGtk.PrintOperationPreview.end_preview] (typically in response to the user clicking a close button).
Callback parameters: -- @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
procedure On_Request_Page_Setup
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
Callback parameters: -- @param Context the GtkPrintContext for the current operation -- @param Page_Nr the number of the currently printed page (0-based) -- @param Setup the GtkPageSetup
procedure On_Request_Page_Setup
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Print_Context_Gint_Gtk_Page_Setup_Void;
After : Boolean := False)
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.
Callback parameters: -- @param Context the GtkPrintContext for the current operation -- @param Page_Nr the number of the currently printed page (0-based) -- @param Setup the GtkPageSetup
procedure On_Status_Changed
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
Emitted at between the various phases of the print operation.
See [enumGtk.PrintStatus] for the phases that are being discriminated. Use [methodGtk.PrintOperation.get_status] to find out the current status.
procedure On_Status_Changed
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Void;
After : Boolean := False)
Emitted at between the various phases of the print operation.
See [enumGtk.PrintStatus] for the phases that are being discriminated. Use [methodGtk.PrintOperation.get_status] to find out the current status.
procedure On_Update_Custom_Widget
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_GObject_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void;
Slot : not null access Glib.Object.GObject_Record'Class;
After : Boolean := False)
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.
Callback parameters: -- @param Widget the custom widget added in ::create-custom-widget -- @param Setup actual page setup -- @param Settings actual print settings
procedure On_Update_Custom_Widget
(Self : not null access Gtk_Print_Operation_Record;
Call : Cb_Gtk_Print_Operation_Gtk_Widget_Gtk_Page_Setup_Gtk_Print_Settings_Void;
After : Boolean := False)
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.
Callback parameters: -- @param Widget the custom widget added in ::create-custom-widget -- @param Setup actual page setup -- @param Settings actual print settings
Print_Settings_Property : constant Glib.Properties.Property_Object;
Type: Gtk.Print_Settings.Gtk_Print_Settings The GtkPrintSettings used for initializing the dialog.
Setting this property is typically used to re-establish print settings from a previous print operation, see [methodGtk.PrintOperation.run].
type Property_Gtk_Print_Operation_Action is new Gtk_Print_Operation_Action_Properties.Property;
type Property_Gtk_Print_Operation_Result is new Gtk_Print_Operation_Result_Properties.Property;
procedure Render_Page
(Self : not null access Gtk_Print_Operation_Record;
Page_Nr : Glib.Gint)
function Run
(Self : not null access Gtk_Print_Operation_Record;
Action : Gtk_Print_Operation_Action;
Parent : access Gtk.Window.Gtk_Window_Record'Class;
Error : out Glib.Error.GError) return Gtk_Print_Operation_Result
Runs the print operation. Normally that this function does not return until the rendering of all pages is complete. You can connect to the [signalGtk.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 [signalGtk.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).
(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`.
the action to start
Transient parent of the dialog
the return location for a recoverable error
the result of the print operation. A return value of Gtk.Print_Operation.Print_Operation_Result_Apply indicates that the printing was completed successfully. In this case, it is a good idea to obtain the used print settings with [methodGtk.PrintOperation.get_print_settings] and store them for reuse with the next print operation. A value of Gtk.Print_Operation.Print_Operation_Result_In_Progress means the operation is running asynchronously, and will emit the [signalGtk.PrintOperation::done] signal when done.
procedure Set_Allow_Async
(Self : not null access Gtk_Print_Operation_Record;
Allow_Async : Boolean)
Sets whether Gtk.Print_Operation.Run may return before the print operation is completed. Note that some platforms may not allow asynchronous operation.
True to allow asynchronous operation
procedure Set_Current_Page
(Self : not null access Gtk_Print_Operation_Record;
Current_Page : Glib.Gint)
Sets the current page. If this is called before [methodGtk.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.
the current page, 0-based
procedure Set_Custom_Tab_Label
(Self : not null access Gtk_Print_Operation_Record;
Label : UTF8_String := "")
Sets the label for the tab holding custom widgets.
the label to use, or null to use the default label
procedure Set_Default_Page_Setup
(Self : not null access Gtk_Print_Operation_Record;
Default_Page_Setup : access Gtk.Page_Setup.Gtk_Page_Setup_Record'Class)
Makes Default_Page_Setup the default page setup for Op. This page setup will be used by [methodGtk.PrintOperation.run], but it can be overridden on a per-page basis by connecting to the [signalGtk.PrintOperation::request-page-setup] signal.
a GtkPageSetup
procedure Set_Defer_Drawing
(Self : not null access Gtk_Print_Operation_Record)
Sets up the GtkPrintOperation to wait for calling of [methodGtk.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 [signalGtk.PrintOperation::draw-page] signal.
procedure Set_Embed_Page_Setup
(Self : not null access Gtk_Print_Operation_Record;
Embed : Boolean)
Embed page size combo box and orientation combo box into page setup page. Selected page setup is stored as default page setup in GtkPrintOperation.
True to embed page setup selection in the GtkPrintUnixDialog
procedure Set_Export_Filename
(Self : not null access Gtk_Print_Operation_Record;
Filename : UTF8_String)
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.
the filename for the exported file
procedure Set_Has_Selection
(Self : not null access Gtk_Print_Operation_Record;
Has_Selection : Boolean)
Sets whether there is a selection to print. Application has to set number of pages to which the selection will draw by [methodGtk.PrintOperation.set_n_pages] in a handler for the [signalGtk.PrintOperation::begin-print] signal.
True indicates that a selection exists
procedure Set_Job_Name
(Self : not null access Gtk_Print_Operation_Record;
Job_Name : UTF8_String)
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.
a string that identifies the print job
procedure Set_N_Pages
(Self : not null access Gtk_Print_Operation_Record;
N_Pages : Glib.Gint)
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 [signalGtk.PrintOperation::begin-print] signal handler. Note that the page numbers passed to the [signalGtk.PrintOperation::request-page-setup] and [signalGtk.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.
the number of pages
procedure Set_Print_Settings
(Self : not null access Gtk_Print_Operation_Record;
Print_Settings : access Gtk.Print_Settings.Gtk_Print_Settings_Record'Class)
Sets the print settings for Op. This is typically used to re-establish print settings from a previous print operation, see [methodGtk.PrintOperation.run].
GtkPrintSettings
procedure Set_Show_Progress
(Self : not null access Gtk_Print_Operation_Record;
Show_Progress : Boolean)
If Show_Progress is True, the print operation will show a progress dialog during the print operation.
True to show a progress dialog
procedure Set_Support_Selection
(Self : not null access Gtk_Print_Operation_Record;
Support_Selection : Boolean)
Sets whether selection is supported by GtkPrintOperation.
True to support selection
procedure Set_Track_Print_Status
(Self : not null access Gtk_Print_Operation_Record;
Track_Status : Boolean)
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.
True to track status after printing
procedure Set_Unit
(Self : not null access Gtk_Print_Operation_Record;
Unit : Gtk.Enums.Gtk_Unit)
Sets up the transformation for the cairo context obtained from GtkPrintContext in such a way that distances are measured in units of Unit.
the unit to use
procedure Set_Use_Full_Page
(Self : not null access Gtk_Print_Operation_Record;
Full_Page : Boolean)
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).
True to set up the GtkPrintContext for the full page
Show_Progress_Property : constant Glib.Properties.Property_Boolean;
Determines whether to show a progress dialog during the print operation.
Signal_Begin_Print : constant Glib.Signal_Name := "begin-print";
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 [classGtk.PrintContext] and paginate the document accordingly, and then set the number of pages with [methodGtk.PrintOperation.set_n_pages].
Signal_Create_Custom_Widget : constant Glib.Signal_Name := "create-custom-widget";
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 [signalGtk.PrintOperation::custom-widget-apply] signal is emitted on the operation. Then you can read out any information you need from the widgets.
Callback parameters:
Signal_Custom_Widget_Apply : constant Glib.Signal_Name := "custom-widget-apply";
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.
Signal_Done : constant Glib.Signal_Name := "done";
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.Print_Operation_Result_Error then you can call [methodGtk.PrintOperation.get_error] for more information.
If you enabled print status tracking then [methodGtk.PrintOperation.is_finished] may still return False after the ::done signal was emitted.
Signal_Draw_Page : constant Glib.Signal_Name := "draw-page";
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 [methodGtk.PrintContext.get_cairo_context].
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 [methodGtk.PrintOperation.set_use_full_page] and
[methodGtk.PrintOperation.set_unit] before starting the print operation
to set up the transformation of the cairo context according to your
needs.
Callback parameters:
-- @param Context the `GtkPrintContext` for the current operation
-- @param Page_Nr the number of the currently printed page (0-based)
Signal_End_Print : constant Glib.Signal_Name := "end-print";
Emitted after all pages have been rendered.
A handler for this signal can clean up any resources that have been allocated in the [signalGtk.PrintOperation::begin-print] handler.
Signal_Paginate : constant Glib.Signal_Name := "paginate";
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 [methodGtk.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.
Callback parameters: -- @param Context the GtkPrintContext for the current operation
Signal_Preview : constant Glib.Signal_Name := "preview";
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 [methodGtk.PrintContext.set_cairo_context].
The custom preview implementation can use [methodGtk.PrintOperationPreview.is_selected] and [methodGtk.PrintOperationPreview.render_page] to find pages which are selected for print and render them. The preview must be finished by calling [methodGtk.PrintOperationPreview.end_preview] (typically in response to the user clicking a close button).
Callback parameters: -- @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
Signal_Request_Page_Setup : constant Glib.Signal_Name := "request-page-setup";
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.
Callback parameters: -- @param Context the GtkPrintContext for the current operation -- @param Page_Nr the number of the currently printed page (0-based) -- @param Setup the GtkPageSetup
Signal_Status_Changed : constant Glib.Signal_Name := "status-changed";
Emitted at between the various phases of the print operation.
See [enumGtk.PrintStatus] for the phases that are being discriminated. Use [methodGtk.PrintOperation.get_status] to find out the current status.
Signal_Update_Custom_Widget : constant Glib.Signal_Name := "update-custom-widget";
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.
Callback parameters: -- @param Widget the custom widget added in ::create-custom-widget -- @param Setup actual page setup -- @param Settings actual print settings
Status_Property : constant Gtk.Enums.Property_Gtk_Print_Status;
The status of the print operation.
Status_String_Property : constant Glib.Properties.Property_String;
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.
See the [propertyGtk.PrintOperation:status] property for a status value that is suitable for programmatic use.
Support_Selection_Property : constant Glib.Properties.Property_Boolean;
If True, the print operation will support print of selection.
This allows the print dialog to show a "Selection" button.
Track_Print_Status_Property : constant Glib.Properties.Property_Boolean;
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.
Unit_Property : constant Gtk.Enums.Property_Gtk_Unit;
The transformation for the cairo context obtained from GtkPrintContext is set up in such a way that distances are measured in units of Unit.
Use_Full_Page_Property : constant Glib.Properties.Property_Boolean;
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).