![]() |
![]() |
![]() |
GTK+ Reference Manual | ![]() |
---|---|---|---|---|
#include <gtk/gtk.h> GtkPrintOperation; enum GtkPrintStatus; enum GtkPrintOperationAction; enum GtkPrintOperationResult; enum GtkPrintError; #define GTK_PRINT_ERROR GtkPrintOperation* gtk_print_operation_new (void); void gtk_print_operation_set_allow_async (GtkPrintOperation *op, gboolean allow_async); void gtk_print_operation_get_error (GtkPrintOperation *op, GError **error); void gtk_print_operation_set_default_page_setup (GtkPrintOperation *op, GtkPageSetup *default_page_setup); GtkPageSetup* gtk_print_operation_get_default_page_setup (GtkPrintOperation *op); void gtk_print_operation_set_print_settings (GtkPrintOperation *op, GtkPrintSettings *print_settings); GtkPrintSettings* gtk_print_operation_get_print_settings (GtkPrintOperation *op); void gtk_print_operation_set_job_name (GtkPrintOperation *op, const gchar *job_name); void gtk_print_operation_set_n_pages (GtkPrintOperation *op, gint n_pages); void gtk_print_operation_set_current_page (GtkPrintOperation *op, gint current_page); void gtk_print_operation_set_use_full_page (GtkPrintOperation *op, gboolean full_page); void gtk_print_operation_set_unit (GtkPrintOperation *op, GtkUnit unit); void gtk_print_operation_set_export_filename (GtkPrintOperation *op, const gchar *filename); void gtk_print_operation_set_show_progress (GtkPrintOperation *op, gboolean show_progress); void gtk_print_operation_set_track_print_status (GtkPrintOperation *op, gboolean track_status); void gtk_print_operation_set_custom_tab_label (GtkPrintOperation *op, const gchar *label); GtkPrintOperationResult gtk_print_operation_run (GtkPrintOperation *op, GtkPrintOperationAction action, GtkWindow *parent, GError **error); void gtk_print_operation_cancel (GtkPrintOperation *op); GtkPrintStatus gtk_print_operation_get_status (GtkPrintOperation *op); const gchar* gtk_print_operation_get_status_string (GtkPrintOperation *op); gboolean gtk_print_operation_is_finished (GtkPrintOperation *op); GtkPageSetup* gtk_print_run_page_setup_dialog (GtkWindow *parent, GtkPageSetup *page_setup, GtkPrintSettings *settings); void (*GtkPageSetupDoneFunc) (GtkPageSetup *page_setup, gpointer data); void gtk_print_run_page_setup_dialog_async (GtkWindow *parent, GtkPageSetup *page_setup, GtkPrintSettings *settings, GtkPageSetupDoneFunc done_cb, gpointer data); GtkPrintOperationPreview; void gtk_print_operation_preview_end_preview (GtkPrintOperationPreview *preview); gboolean gtk_print_operation_preview_is_selected (GtkPrintOperationPreview *preview, gint page_nr); void gtk_print_operation_preview_render_page (GtkPrintOperationPreview *preview, gint page_nr);
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 GtkPrintUnixDialog.
The typical way to use the high-level printing API is to create a
GtkPrintOperation object with gtk_print_operation_new()
when the user
selects to print. Then you set some properties on it, e.g. the page size,
any GtkPrintSettings from previous print operations, the number of pages,
the current page, etc.
Then you start the print operation by calling gtk_print_operation_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 ::draw-page, which you are supposed
to catch and render the page on the provided GtkPrintContext using Cairo.
Example 39. The high-level printing API
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
gtk_print_operation_print_preview_render_page()
,
gtk_print_operation_preview_end_preview()
and
gtk_print_operation_preview_is_selected()
are useful
when implementing a print preview.
Printing support was added in GTK+ 2.10.
typedef struct { GObject parent_instance; GtkPrintOperationPrivate *priv; } GtkPrintOperation;
typedef enum { GTK_PRINT_STATUS_INITIAL, GTK_PRINT_STATUS_PREPARING, GTK_PRINT_STATUS_GENERATING_DATA, GTK_PRINT_STATUS_SENDING_DATA, GTK_PRINT_STATUS_PENDING, GTK_PRINT_STATUS_PENDING_ISSUE, GTK_PRINT_STATUS_PRINTING, GTK_PRINT_STATUS_FINISHED, GTK_PRINT_STATUS_FINISHED_ABORTED } GtkPrintStatus;
The status gives a rough indication of the completion of a running print operation.
The printing has not started yet; this status is set initially, and while the print dialog is shown. | |
This status is set while the begin-print signal is emitted and during pagination. | |
This status is set while the pages are being rendered. | |
The print job is being sent off to the printer. | |
The print job has been sent to the printer, but is not printed for some reason, e.g. the printer may be stopped. | |
Some problem has occurred during printing, e.g. a paper jam. | |
The printer is processing the print job. | |
The printing has been completed successfully. | |
The printing has been aborted. |
typedef enum { GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, GTK_PRINT_OPERATION_ACTION_PRINT, GTK_PRINT_OPERATION_ACTION_PREVIEW, GTK_PRINT_OPERATION_ACTION_EXPORT } GtkPrintOperationAction;
The action
parameter to gtk_print_operation_run()
determines what action the print operation should perform.
Show the print dialog. | |
Start to print without showing the print dialog, based on the current print settings. | |
Show the print preview. | |
Export to a file. This requires the export-filename property to be set. |
typedef enum { GTK_PRINT_OPERATION_RESULT_ERROR, GTK_PRINT_OPERATION_RESULT_APPLY, GTK_PRINT_OPERATION_RESULT_CANCEL, GTK_PRINT_OPERATION_RESULT_IN_PROGRESS } GtkPrintOperationResult;
A value of this type is returned by gtk_print_operation_run()
.
An error has occured. | |
The print settings should be stored. | |
The print operation has been canceled, the print settings should not be stored. | |
The print operation is complete yet. This value will only be returned when running asynchronously. |
typedef enum { GTK_PRINT_ERROR_GENERAL, GTK_PRINT_ERROR_INTERNAL_ERROR, GTK_PRINT_ERROR_NOMEM, GTK_PRINT_ERROR_INVALID_FILE } GtkPrintError;
#define GTK_PRINT_ERROR gtk_print_error_quark ()
The GQuark used for GtkPrintError errors.
GtkPrintOperation* gtk_print_operation_new (void);
Creates a new GtkPrintOperation.
Returns : |
a new GtkPrintOperation |
Since 2.10
void gtk_print_operation_set_allow_async (GtkPrintOperation *op, gboolean allow_async);
Sets whether the gtk_print_operation_run()
may return
before the print operation is completed. Note that
some platforms may not allow asynchronous operation.
|
a GtkPrintOperation |
|
TRUE to allow asynchronous operation
|
Since 2.10
void gtk_print_operation_get_error (GtkPrintOperation *op, GError **error);
Call this when the result of a print operation is
GTK_PRINT_OPERATION_RESULT_ERROR
, either as returned by
gtk_print_operation_run()
, or in the GtkPrintOperation::done signal
handler. The returned GError will contain more details on what went wrong.
|
a GtkPrintOperation |
|
return location for the error |
Since 2.10
void gtk_print_operation_set_default_page_setup (GtkPrintOperation *op, GtkPageSetup *default_page_setup);
Makes default_page_setup
the default page setup for op
.
This page setup will be used by gtk_print_operation_run()
,
but it can be overridden on a per-page basis by connecting
to the GtkPrintOperation::request-page-setup signal.
|
a GtkPrintOperation |
|
a GtkPageSetup, or NULL
|
Since 2.10
GtkPageSetup* gtk_print_operation_get_default_page_setup (GtkPrintOperation *op);
Returns the default page setup, see
gtk_print_operation_set_default_page_setup()
.
|
a GtkPrintOperation |
Returns : |
the default page setup |
Since 2.10
void gtk_print_operation_set_print_settings (GtkPrintOperation *op, GtkPrintSettings *print_settings);
Sets the print settings for op
. This is typically used to
re-establish print settings from a previous print operation,
see gtk_print_operation_run()
.
|
a GtkPrintOperation |
|
GtkPrintSettings, or NULL
|
Since 2.10
GtkPrintSettings* gtk_print_operation_get_print_settings (GtkPrintOperation *op);
Returns the current print settings.
Note that the return value is NULL
until either
gtk_print_operation_set_print_settings()
or
gtk_print_operation_run()
have been called.
|
a GtkPrintOperation |
Returns : |
the current print settings of op .
|
Since 2.10
void gtk_print_operation_set_job_name (GtkPrintOperation *op, const gchar *job_name);
Sets the name of the print job. The name is used to identify the job (e.g. in monitoring applications like eggcups).
If you don't set a job name, GTK+ picks a default one by numbering successive print jobs.
|
a GtkPrintOperation |
|
a string that identifies the print job |
Since 2.10
void gtk_print_operation_set_n_pages (GtkPrintOperation *op, gint n_pages);
Sets the number of pages in the document.
This must be set to a positive number before the rendering starts. It may be set in a GtkPrintOperation::begin-print signal hander.
Note that the page numbers passed to the
GtkPrintOperation::request-page-setup
and GtkPrintOperation::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.
|
a GtkPrintOperation |
|
the number of pages |
Since 2.10
void gtk_print_operation_set_current_page (GtkPrintOperation *op, gint current_page);
Sets the current page.
If this is called before gtk_print_operation_run()
,
the user will be able to select to print only the current page.
Note that this only makes sense for pre-paginated documents.
|
a GtkPrintOperation |
|
the current page, 0-based |
Since 2.10
void gtk_print_operation_set_use_full_page (GtkPrintOperation *op, gboolean full_page);
If full_page
is TRUE
, the transformation for the cairo context
obtained from GtkPrintContext puts the origin at the top left
corner of the page (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).
|
a GtkPrintOperation |
|
TRUE to set up the GtkPrintContext for the full page
|
Since 2.10
void gtk_print_operation_set_unit (GtkPrintOperation *op, GtkUnit unit);
Sets up the transformation for the cairo context obtained from
GtkPrintContext in such a way that distances are measured in
units of unit
.
|
a GtkPrintOperation |
|
the unit to use |
Since 2.10
void gtk_print_operation_set_export_filename (GtkPrintOperation *op, const gchar *filename);
Sets up the GtkPrintOperation 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.
|
a GtkPrintOperation |
|
the filename for the exported file |
Since 2.10
void gtk_print_operation_set_show_progress (GtkPrintOperation *op, gboolean show_progress);
If show_progress
is TRUE
, the print operation will show a
progress dialog during the print operation.
|
a GtkPrintOperation |
|
TRUE to show a progress dialog
|
Since 2.10
void gtk_print_operation_set_track_print_status (GtkPrintOperation *op, gboolean track_status);
If track_status is TRUE
, the print operation will try to continue report
on the status of the print job in the printer queues and printer. This
can allow your application to show things like "out of paper" issues,
and when the print job actually reaches the printer.
This function is often implemented using some form of polling, so it should not be enabled unless needed.
|
a GtkPrintOperation |
|
TRUE to track status after printing
|
Since 2.10
void gtk_print_operation_set_custom_tab_label (GtkPrintOperation *op, const gchar *label);
Sets the label for the tab holding custom widgets.
|
a GtkPrintOperation |
|
the label to use, or NULL to use the default label
|
Since 2.10
GtkPrintOperationResult gtk_print_operation_run (GtkPrintOperation *op, GtkPrintOperationAction action, GtkWindow *parent, GError **error);
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
GtkPrintOperation::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 gtk_print_operation_set_allow_async()
or set the allow-async
property the operation will run asyncronously if this is supported on the
platform. The GtkPrintOperation::done signal will be emitted with the
operation results when the operation is done (i.e. when the dialog is
canceled, or when the print succeeds or fails).
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 gtk_print_operation_run()
can only be called once on a
given GtkPrintOperation.
|
a GtkPrintOperation |
|
the action to start |
|
Transient parent of the dialog, or NULL
|
|
Return location for errors, or NULL
|
Returns : |
the result of the print operation. A return value of
GTK_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 gtk_print_operation_get_print_settings()
and store them for reuse with the next print operation. A value of
GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
asynchronously, and will emit the ::done signal when done.
|
Since 2.10
void gtk_print_operation_cancel (GtkPrintOperation *op);
Cancels a running print operation. This function may be called from a GtkPrintOperation::begin-print, GtkPrintOperation::paginate or GtkPrintOperation::draw-page signal handler to stop the currently running print operation.
|
a GtkPrintOperation |
Since 2.10
GtkPrintStatus gtk_print_operation_get_status (GtkPrintOperation *op);
Returns the status of the print operation.
Also see gtk_print_operation_get_status_string()
.
|
a GtkPrintOperation |
Returns : |
the status of the print operation |
Since 2.10
const gchar* gtk_print_operation_get_status_string (GtkPrintOperation *op);
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 gtk_print_operation_get_status()
to obtain a status
value that is suitable for programmatic use.
|
a GtkPrintOperation |
Returns : |
a string representation of the status of the print operation |
Since 2.10
gboolean gtk_print_operation_is_finished (GtkPrintOperation *op);
A convenience function to find out if the print operation
is finished, either successfully (GTK_PRINT_STATUS_FINISHED
)
or unsuccessfully (GTK_PRINT_STATUS_FINISHED_ABORTED
).
Note: when you enable print status tracking the print operation can be in a non-finished state even after done has been called, as the operation status then tracks the print job status on the printer.
|
a GtkPrintOperation |
Returns : |
TRUE , if the print operation is finished.
|
Since 2.10
GtkPageSetup* gtk_print_run_page_setup_dialog (GtkWindow *parent, GtkPageSetup *page_setup, GtkPrintSettings *settings);
Runs a page setup dialog, letting the user modify the values from
page_setup
. If the user cancels the dialog, the returned GtkPageSetup
is identical to the passed in page_setup
, otherwise it contains the
modifications done in the dialog.
Note that this function may use a recursive mainloop to show the page
setup dialog. See gtk_print_run_page_setup_dialog_async()
if this is
a problem.
|
transient parent, or NULL
|
|
an existing GtkPageSetup, or NULL
|
|
a GtkPrintSettings |
Returns : |
a new GtkPageSetup |
Since 2.10
void (*GtkPageSetupDoneFunc) (GtkPageSetup *page_setup, gpointer data);
The type of function that is passed to gtk_print_run_page_setup_dialog_async()
.
This function will be called when the page setup dialog is dismissed, and
also serves as destroy notify for data
.
|
the GtkPageSetup that has been |
|
user data that has been passed to
gtk_print_run_page_setup_dialog_async() .
|
void gtk_print_run_page_setup_dialog_async (GtkWindow *parent, GtkPageSetup *page_setup, GtkPrintSettings *settings, GtkPageSetupDoneFunc done_cb, gpointer data);
Runs a page setup dialog, letting the user modify the values from page_setup
.
In contrast to gtk_print_run_page_setup_dialog()
, this function returns after
showing the page setup dialog on platforms that support this, and calls done_cb
from a signal handler for the ::response signal of the dialog.
|
transient parent, or NULL
|
|
an existing GtkPageSetup, or NULL
|
|
a GtkPrintSettings |
|
a function to call when the user saves the modified page setup |
|
user data to pass to done_cb
|
Since 2.10
void gtk_print_operation_preview_end_preview (GtkPrintOperationPreview *preview);
Ends a preview.
This function must be called to finish a custom print preview.
|
a GtkPrintOperationPreview |
Since 2.10
gboolean gtk_print_operation_preview_is_selected (GtkPrintOperationPreview *preview, gint page_nr);
Returns whether the given page is included in the set of pages that have been selected for printing.
|
a GtkPrintOperationPreview |
|
a page number |
Returns : |
TRUE if the page has been selected for printing
|
Since 2.10
void gtk_print_operation_preview_render_page (GtkPrintOperationPreview *preview, gint page_nr);
Renders a page to the preview, using the print context that
was passed to the GtkPrintOperation::preview handler together
with preview
.
Note that this function requires a suitable cairo context to be associated with the print context.
|
a GtkPrintOperationPreview |
|
the page to render |
Since 2.10