1 /* GTK - The GIMP Toolkit
2 * gtkprintoperation.c: Print Operation
3 * Copyright (C) 2006, Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
27 #include "gtkprintoperation-private.h"
28 #include "gtkmarshalers.h"
29 #include <cairo-pdf.h>
31 #include "gtkprivate.h"
32 #include "gtkmessagedialog.h"
35 #define SHOW_PROGRESS_TIME 1200
37 #define GTK_PRINT_OPERATION_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationPrivate))
57 PROP_DEFAULT_PAGE_SETUP,
63 PROP_TRACK_PRINT_STATUS,
73 static guint signals[LAST_SIGNAL] = { 0 };
74 static int job_nr = 0;
76 static void preview_iface_init (GtkPrintOperationPreviewIface *iface);
77 static GtkPageSetup *create_page_setup (GtkPrintOperation *op);
78 static void common_render_page (GtkPrintOperation *op,
82 G_DEFINE_TYPE_WITH_CODE (GtkPrintOperation, gtk_print_operation, G_TYPE_OBJECT,
83 G_IMPLEMENT_INTERFACE (GTK_TYPE_PRINT_OPERATION_PREVIEW,
87 * gtk_print_error_quark:
89 * Registers an error quark for #GtkPrintOperation if necessary.
91 * Return value: The error quark used for #GtkPrintOperation errors.
96 gtk_print_error_quark (void)
98 static GQuark quark = 0;
100 quark = g_quark_from_static_string ("gtk-print-error-quark");
105 gtk_print_operation_finalize (GObject *object)
107 GtkPrintOperation *print_operation = GTK_PRINT_OPERATION (object);
108 GtkPrintOperationPrivate *priv = print_operation->priv;
110 if (priv->free_platform_data &&
113 priv->free_platform_data (priv->platform_data);
114 priv->free_platform_data = NULL;
117 if (priv->default_page_setup)
118 g_object_unref (priv->default_page_setup);
120 if (priv->print_settings)
121 g_object_unref (priv->print_settings);
123 g_free (priv->export_filename);
124 g_free (priv->job_name);
125 g_free (priv->custom_tab_label);
127 if (priv->print_pages_idle_id > 0)
128 g_source_remove (priv->print_pages_idle_id);
130 if (priv->show_progress_timeout_id > 0)
131 g_source_remove (priv->show_progress_timeout_id);
134 g_error_free (priv->error);
136 G_OBJECT_CLASS (gtk_print_operation_parent_class)->finalize (object);
140 gtk_print_operation_init (GtkPrintOperation *operation)
142 GtkPrintOperationPrivate *priv;
145 priv = operation->priv = GTK_PRINT_OPERATION_GET_PRIVATE (operation);
147 priv->status = GTK_PRINT_STATUS_INITIAL;
148 priv->status_string = g_strdup ("");
149 priv->default_page_setup = NULL;
150 priv->print_settings = NULL;
151 priv->nr_of_pages = -1;
152 priv->current_page = -1;
153 priv->use_full_page = FALSE;
154 priv->show_progress = FALSE;
155 priv->export_filename = NULL;
156 priv->track_print_status = FALSE;
157 priv->is_sync = FALSE;
160 priv->unit = GTK_UNIT_PIXEL;
162 appname = g_get_application_name ();
163 priv->job_name = g_strdup_printf ("%s job #%d", appname, ++job_nr);
167 preview_iface_render_page (GtkPrintOperationPreview *preview,
171 GtkPrintOperation *op;
173 op = GTK_PRINT_OPERATION (preview);
174 common_render_page (op, page_nr);
178 preview_iface_end_preview (GtkPrintOperationPreview *preview)
180 GtkPrintOperation *op;
182 op = GTK_PRINT_OPERATION (preview);
184 g_signal_emit (op, signals[END_PRINT], 0, op->priv->print_context);
187 g_main_loop_quit (op->priv->rloop);
189 op->priv->end_run (op, op->priv->is_sync, TRUE);
191 g_signal_emit (op, signals[DONE], 0,
192 GTK_PRINT_OPERATION_RESULT_APPLY);
196 preview_iface_is_selected (GtkPrintOperationPreview *preview,
199 GtkPrintOperation *op;
200 GtkPrintOperationPrivate *priv;
203 op = GTK_PRINT_OPERATION (preview);
206 switch (priv->print_pages)
208 case GTK_PRINT_PAGES_ALL:
209 return (page_nr >= 0) && (page_nr < priv->nr_of_pages);
210 case GTK_PRINT_PAGES_CURRENT:
211 return page_nr == priv->current_page;
212 case GTK_PRINT_PAGES_RANGES:
213 for (i = 0; i < priv->num_page_ranges; i++)
215 if (page_nr >= priv->page_ranges[i].start &&
216 page_nr <= priv->page_ranges[i].end)
225 preview_iface_init (GtkPrintOperationPreviewIface *iface)
227 iface->render_page = preview_iface_render_page;
228 iface->end_preview = preview_iface_end_preview;
229 iface->is_selected = preview_iface_is_selected;
233 preview_start_page (GtkPrintOperation *op,
234 GtkPrintContext *print_context,
235 GtkPageSetup *page_setup)
237 g_signal_emit_by_name (op, "got-page-size", print_context, page_setup);
241 preview_end_page (GtkPrintOperation *op,
242 GtkPrintContext *print_context)
247 preview_end_run (GtkPrintOperation *op,
251 g_free (op->priv->page_ranges);
252 op->priv->page_ranges = NULL;
254 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED, NULL);
259 gtk_print_operation_set_property (GObject *object,
264 GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
268 case PROP_DEFAULT_PAGE_SETUP:
269 gtk_print_operation_set_default_page_setup (op, g_value_get_object (value));
271 case PROP_PRINT_SETTINGS:
272 gtk_print_operation_set_print_settings (op, g_value_get_object (value));
275 gtk_print_operation_set_job_name (op, g_value_get_string (value));
278 gtk_print_operation_set_n_pages (op, g_value_get_int (value));
280 case PROP_CURRENT_PAGE:
281 gtk_print_operation_set_current_page (op, g_value_get_int (value));
283 case PROP_USE_FULL_PAGE:
284 gtk_print_operation_set_use_full_page (op, g_value_get_boolean (value));
286 case PROP_TRACK_PRINT_STATUS:
287 gtk_print_operation_set_track_print_status (op, g_value_get_boolean (value));
290 gtk_print_operation_set_unit (op, g_value_get_enum (value));
292 case PROP_ALLOW_ASYNC:
293 gtk_print_operation_set_allow_async (op, g_value_get_boolean (value));
295 case PROP_SHOW_PROGRESS:
296 gtk_print_operation_set_show_progress (op, g_value_get_boolean (value));
298 case PROP_EXPORT_FILENAME:
299 gtk_print_operation_set_export_filename (op, g_value_get_string (value));
301 case PROP_CUSTOM_TAB_LABEL:
302 gtk_print_operation_set_custom_tab_label (op, g_value_get_string (value));
305 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
311 gtk_print_operation_get_property (GObject *object,
316 GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
317 GtkPrintOperationPrivate *priv = op->priv;
321 case PROP_DEFAULT_PAGE_SETUP:
322 g_value_set_object (value, priv->default_page_setup);
324 case PROP_PRINT_SETTINGS:
325 g_value_set_object (value, priv->print_settings);
328 g_value_set_string (value, priv->job_name);
331 g_value_set_int (value, priv->nr_of_pages);
333 case PROP_CURRENT_PAGE:
334 g_value_set_int (value, priv->current_page);
336 case PROP_USE_FULL_PAGE:
337 g_value_set_boolean (value, priv->use_full_page);
339 case PROP_TRACK_PRINT_STATUS:
340 g_value_set_boolean (value, priv->track_print_status);
343 g_value_set_enum (value, priv->unit);
345 case PROP_ALLOW_ASYNC:
346 g_value_set_boolean (value, priv->allow_async);
348 case PROP_SHOW_PROGRESS:
349 g_value_set_boolean (value, priv->show_progress);
351 case PROP_EXPORT_FILENAME:
352 g_value_set_string (value, priv->export_filename);
355 g_value_set_enum (value, priv->status);
357 case PROP_STATUS_STRING:
358 g_value_set_string (value, priv->status_string);
360 case PROP_CUSTOM_TAB_LABEL:
361 g_value_set_string (value, priv->custom_tab_label);
364 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
371 GtkPrintOperationPreview *preview;
372 GtkPrintContext *print_context;
374 cairo_surface_t *surface;
381 preview_print_idle_done (gpointer data)
383 GtkPrintOperation *op;
384 PreviewOp *pop = (PreviewOp *) data;
386 GDK_THREADS_ENTER ();
388 op = GTK_PRINT_OPERATION (pop->preview);
390 cairo_surface_finish (pop->surface);
391 /* Surface is destroyed in launch_preview */
392 _gtk_print_operation_platform_backend_launch_preview (op,
397 g_free (pop->filename);
399 gtk_print_operation_preview_end_preview (pop->preview);
402 GDK_THREADS_LEAVE ();
406 preview_print_idle (gpointer data)
409 GtkPrintOperation *op;
410 gboolean retval = TRUE;
413 GDK_THREADS_ENTER ();
415 pop = (PreviewOp *) data;
416 op = GTK_PRINT_OPERATION (pop->preview);
418 gtk_print_operation_preview_render_page (pop->preview, pop->page_nr);
420 cr = gtk_print_context_get_cairo_context (pop->print_context);
421 _gtk_print_operation_platform_backend_preview_end_page (op, pop->surface, cr);
423 /* TODO: print out sheets not pages and follow ranges */
425 if (op->priv->nr_of_pages <= pop->page_nr)
428 GDK_THREADS_LEAVE ();
434 preview_got_page_size (GtkPrintOperationPreview *preview,
435 GtkPrintContext *context,
436 GtkPageSetup *page_setup,
439 GtkPrintOperation *op = GTK_PRINT_OPERATION (preview);
442 _gtk_print_operation_platform_backend_resize_preview_surface (op, page_setup, pop->surface);
444 cr = gtk_print_context_get_cairo_context (pop->print_context);
445 _gtk_print_operation_platform_backend_preview_start_page (op, pop->surface, cr);
450 preview_ready (GtkPrintOperationPreview *preview,
451 GtkPrintContext *context,
455 pop->print_context = context;
457 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE + 10,
460 preview_print_idle_done);
465 gtk_print_operation_preview_handler (GtkPrintOperation *op,
466 GtkPrintOperationPreview *preview,
467 GtkPrintContext *context,
470 gdouble dpi_x, dpi_y;
472 GtkPageSetup *page_setup;
475 pop = g_new0 (PreviewOp, 1);
476 pop->filename = NULL;
477 pop->preview = preview;
478 pop->parent = parent;
480 page_setup = gtk_print_context_get_page_setup (context);
483 _gtk_print_operation_platform_backend_create_preview_surface (op,
488 cr = cairo_create (pop->surface);
489 gtk_print_context_set_cairo_context (op->priv->print_context, cr,
493 g_signal_connect (preview, "ready", (GCallback) preview_ready, pop);
494 g_signal_connect (preview, "got-page-size", (GCallback) preview_got_page_size, pop);
500 gtk_print_operation_create_custom_widget (GtkPrintOperation *operation)
506 custom_widget_accumulator (GSignalInvocationHint *ihint,
508 const GValue *handler_return,
511 gboolean continue_emission;
514 widget = g_value_get_object (handler_return);
516 g_value_set_object (return_accu, widget);
517 continue_emission = (widget == NULL);
519 return continue_emission;
523 gtk_print_operation_class_init (GtkPrintOperationClass *class)
525 GObjectClass *gobject_class = (GObjectClass *)class;
527 gobject_class->set_property = gtk_print_operation_set_property;
528 gobject_class->get_property = gtk_print_operation_get_property;
529 gobject_class->finalize = gtk_print_operation_finalize;
531 class->preview = gtk_print_operation_preview_handler;
532 class->create_custom_widget = gtk_print_operation_create_custom_widget;
534 g_type_class_add_private (gobject_class, sizeof (GtkPrintOperationPrivate));
537 * GtkPrintOperation::done:
538 * @operation: the #GtkPrintOperation on which the signal was emitted
539 * @result: the result of the print operation
541 * Emitted when the print operation run has finished doing
542 * everything required for printing. @result gives you information
543 * about what happened during the run. If @result is
544 * %GTK_PRINT_OPERATION_RESULT_ERROR then you can call
545 * gtk_print_operation_get_error() for more information.
547 * If you enabled print status tracking then
548 * gtk_print_operation_is_finished() may still return %FALSE
549 * after this was emitted.
554 g_signal_new (I_("done"),
555 G_TYPE_FROM_CLASS (gobject_class),
557 G_STRUCT_OFFSET (GtkPrintOperationClass, done),
559 g_cclosure_marshal_VOID__ENUM,
560 G_TYPE_NONE, 1, GTK_TYPE_PRINT_OPERATION_RESULT);
563 * GtkPrintOperation::begin-print:
564 * @operation: the #GtkPrintOperation on which the signal was emitted
565 * @context: the #GtkPrintContext for the current operation
567 * Emitted after the user has finished changing print settings
568 * in the dialog, before the actual rendering starts.
570 * A typical use for this signal is to use the parameters from the
571 * #GtkPrintContext and paginate the document accordingly, and then
572 * set the number of pages with gtk_print_operation_set_n_pages().
576 signals[BEGIN_PRINT] =
577 g_signal_new (I_("begin-print"),
578 G_TYPE_FROM_CLASS (gobject_class),
580 G_STRUCT_OFFSET (GtkPrintOperationClass, begin_print),
582 g_cclosure_marshal_VOID__OBJECT,
583 G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);
586 * GtkPrintOperation::paginate:
587 * @operation: the #GtkPrintOperation on which the signal was emitted
588 * @context: the #GtkPrintContext for the current operation
590 * Emitted after the begin-print signal, but before the actual
591 * rendering starts. It keeps getting emitted until it returns %FALSE.
593 * This signal is intended to be used for paginating the document
594 * in small chunks, to avoid blocking the user interface for a long
595 * time. The signal handler should update the number of pages using
596 * gtk_print_operation_set_n_pages(), and return %TRUE if the document
597 * has been completely paginated.
599 * If you don't need to do pagination in chunks, you can simply do
600 * it all in the begin-print handler, and set the number of pages
603 * Return value: %TRUE if pagination is complete
608 g_signal_new (I_("paginate"),
609 G_TYPE_FROM_CLASS (gobject_class),
611 G_STRUCT_OFFSET (GtkPrintOperationClass, paginate),
612 _gtk_boolean_handled_accumulator, NULL,
613 _gtk_marshal_BOOLEAN__OBJECT,
614 G_TYPE_BOOLEAN, 1, GTK_TYPE_PRINT_CONTEXT);
618 * GtkPrintOperation::request-page-setup:
619 * @operation: the #GtkPrintOperation on which the signal was emitted
620 * @context: the #GtkPrintContext for the current operation
621 * @page_nr: the number of the currently printed page
622 * @setup: the #GtkPageSetup
624 * Emitted once for every page that is printed, to give
625 * the application a chance to modify the page setup. Any changes
626 * done to @setup will be in force only for printing this page.
630 signals[REQUEST_PAGE_SETUP] =
631 g_signal_new (I_("request-page-setup"),
632 G_TYPE_FROM_CLASS (gobject_class),
634 G_STRUCT_OFFSET (GtkPrintOperationClass, request_page_setup),
636 _gtk_marshal_VOID__OBJECT_INT_OBJECT,
638 GTK_TYPE_PRINT_CONTEXT,
640 GTK_TYPE_PAGE_SETUP);
643 * GtkPrintOperation::draw-page:
644 * @operation: the #GtkPrintOperation on which the signal was emitted
645 * @context: the #GtkPrintContext for the current operation
646 * @page_nr: the number of the currently printed page
648 * Emitted for every page that is printed. The signal handler
649 * must render the @page_nr's page onto the cairo context obtained
650 * from @context using gtk_print_context_get_cairo_context().
652 * <informalexample><programlisting>
654 * draw_page (GtkPrintOperation *operation,
655 * GtkPrintContext *context,
657 * gpointer user_data)
660 * PangoLayout *layout;
661 * gdouble width, text_height;
662 * gint layout_height;
663 * PangoFontDescription *desc;
665 * cr = gtk_print_context_get_cairo_context (context);
666 * width = gtk_print_context_get_width (context);
668 * cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);
670 * cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
673 * layout = gtk_print_context_create_pango_layout (context);
675 * desc = pango_font_description_from_string ("sans 14");
676 * pango_layout_set_font_description (layout, desc);
677 * pango_font_description_free (desc);
679 * pango_layout_set_text (layout, "some text", -1);
680 * pango_layout_set_width (layout, width);
681 * pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);
683 * pango_layout_get_size (layout, NULL, &layout_height);
684 * text_height = (gdouble)layout_height / PANGO_SCALE;
686 * cairo_move_to (cr, width / 2, (HEADER_HEIGHT - text_height) / 2);
687 * pango_cairo_show_layout (cr, layout);
689 * g_object_unref (layout);
691 * </programlisting></informalexample>
693 * Use gtk_print_operation_set_use_full_page() and
694 * gtk_print_operation_set_unit() before starting the print operation
695 * to set up the transformation of the cairo context according to your
701 g_signal_new (I_("draw-page"),
702 G_TYPE_FROM_CLASS (gobject_class),
704 G_STRUCT_OFFSET (GtkPrintOperationClass, draw_page),
706 _gtk_marshal_VOID__OBJECT_INT,
708 GTK_TYPE_PRINT_CONTEXT,
712 * GtkPrintOperation::end-print:
713 * @operation: the #GtkPrintOperation on which the signal was emitted
714 * @context: the #GtkPrintContext for the current operation
716 * Emitted after all pages have been rendered.
717 * A handler for this signal can clean up any resources that have
718 * been allocated in the ::begin-print handler.
723 g_signal_new (I_("end-print"),
724 G_TYPE_FROM_CLASS (gobject_class),
726 G_STRUCT_OFFSET (GtkPrintOperationClass, end_print),
728 g_cclosure_marshal_VOID__OBJECT,
729 G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);
732 * GtkPrintOperation::status-changed:
733 * @operation: the #GtkPrintOperation on which the signal was emitted
735 * Emitted at between the various phases of the print operation.
736 * See #GtkPrintStatus for the phases that are being discriminated.
737 * Use gtk_print_operation_get_status() to find out the current
742 signals[STATUS_CHANGED] =
743 g_signal_new (I_("status-changed"),
744 G_TYPE_FROM_CLASS (class),
746 G_STRUCT_OFFSET (GtkPrintOperationClass, status_changed),
748 g_cclosure_marshal_VOID__VOID,
753 * GtkPrintOperation::create-custom-widget:
754 * @operation: the #GtkPrintOperation on which the signal was emitted
756 * Emitted when displaying the print dialog. If you return a
757 * widget in a handler for this signal it will be added to a custom
758 * tab in the print dialog. You typically return a container widget
759 * with multiple widgets in it.
761 * The print dialog owns the returned widget, and its lifetime
762 * isn't controlled by the app. However, the widget is guaranteed
763 * to stay around until the custom-widget-apply signal is emitted
764 * on the operation. Then you can read out any information you need
767 * Returns: A custom widget that gets embedded in the print dialog,
772 signals[CREATE_CUSTOM_WIDGET] =
773 g_signal_new (I_("create-custom-widget"),
774 G_TYPE_FROM_CLASS (class),
776 G_STRUCT_OFFSET (GtkPrintOperationClass, create_custom_widget),
777 custom_widget_accumulator, NULL,
778 _gtk_marshal_OBJECT__VOID,
782 * GtkPrintOperation::custom-widget-apply:
783 * @operation: the #GtkPrintOperation on which the signal was emitted
784 * @widget: the custom widget added in create-custom-widget
786 * Emitted right before begin-print if you added
787 * a custom widget in the create-custom-widget handler. When you get
788 * this signal you should read the information from the custom widgets,
789 * as the widgets are not guaraneed to be around at a later time.
793 signals[CUSTOM_WIDGET_APPLY] =
794 g_signal_new (I_("custom-widget-apply"),
795 G_TYPE_FROM_CLASS (class),
797 G_STRUCT_OFFSET (GtkPrintOperationClass, custom_widget_apply),
799 g_cclosure_marshal_VOID__OBJECT,
800 G_TYPE_NONE, 1, GTK_TYPE_WIDGET);
803 * GtkPrintOperation::preview:
804 * @operation: the #GtkPrintOperation on which the signal was emitted
805 * @preview: the #GtkPrintPreviewOperation for the current operation
806 * @context: the #GtkPrintContext that will be used
807 * @parent: the #GtkWindow to use as window parent, or %NULL
809 * Gets emitted when a preview is requested from the native dialog.
811 * The default handler for this signal uses an external viewer
812 * application to preview.
814 * To implement a custom print preview, an application must return
815 * %TRUE from its handler for this signal. In order to use the
816 * provided @context for the preview implementation, it must be
817 * given a suitable cairo context with gtk_print_context_set_cairo_context().
819 * The custom preview implementation can use
820 * gtk_print_operation_preview_is_selected() and
821 * gtk_print_operation_preview_render_page() to find pages which
822 * are selected for print and render them. The preview must be
823 * finished by calling gtk_print_operation_preview_end_preview()
824 * (typically in response to the user clicking a close button).
826 * Returns: %TRUE if the listener wants to take over control of the preview
831 g_signal_new (I_("preview"),
832 G_TYPE_FROM_CLASS (gobject_class),
834 G_STRUCT_OFFSET (GtkPrintOperationClass, preview),
835 _gtk_boolean_handled_accumulator, NULL,
836 _gtk_marshal_BOOLEAN__OBJECT_OBJECT_OBJECT,
838 GTK_TYPE_PRINT_OPERATION_PREVIEW,
839 GTK_TYPE_PRINT_CONTEXT,
844 * GtkPrintOperation:default-page-setup:
846 * The #GtkPageSetup used by default.
848 * This page setup will be used by gtk_print_operation_run(),
849 * but it can be overridden on a per-page basis by connecting
850 * to the ::request-page-setup signal.
854 g_object_class_install_property (gobject_class,
855 PROP_DEFAULT_PAGE_SETUP,
856 g_param_spec_object ("default-page-setup",
857 P_("Default Page Setup"),
858 P_("The GtkPageSetup used by default"),
860 GTK_PARAM_READWRITE));
863 * GtkPrintOperation:print-settings:
865 * The #GtkPrintSettings used for initializing the dialog.
867 * Setting this property is typically used to re-establish
868 * print settings from a previous print operation, see
869 * gtk_print_operation_run().
873 g_object_class_install_property (gobject_class,
875 g_param_spec_object ("print-settings",
876 P_("Print Settings"),
877 P_("The GtkPrintSettings used for initializing the dialog"),
878 GTK_TYPE_PRINT_SETTINGS,
879 GTK_PARAM_READWRITE));
882 * GtkPrintOperation:job-name:
884 * A string used to identify the job (e.g. in monitoring
885 * applications like eggcups).
887 * If you don't set a job name, GTK+ picks a default one
888 * by numbering successive print jobs.
892 g_object_class_install_property (gobject_class,
894 g_param_spec_string ("job-name",
896 P_("A string used for identifying the print job."),
898 GTK_PARAM_READWRITE));
901 * GtkPrintOperation:n-pages:
903 * The number of pages in the document.
905 * This <emphasis>must</emphasis> be set to a positive number
906 * before the rendering starts. It may be set in a ::begin-print
909 * Note that the page numbers passed to the ::request-page-setup
910 * and ::draw-page signals are 0-based, i.e. if the user chooses
911 * to print all pages, the last ::draw-page signal will be for
916 g_object_class_install_property (gobject_class,
918 g_param_spec_int ("n-pages",
919 P_("Number of Pages"),
920 P_("The number of pages in the document."),
924 GTK_PARAM_READWRITE));
927 * GtkPrintOperation:current-page:
929 * The current page in the document.
931 * If this is set before gtk_print_operation_run(),
932 * the user will be able to select to print only the current page.
934 * Note that this only makes sense for pre-paginated documents.
938 g_object_class_install_property (gobject_class,
940 g_param_spec_int ("current-page",
942 P_("The current page in the document"),
946 GTK_PARAM_READWRITE));
949 * GtkPrintOperation:use-full-page:
951 * If %TRUE, the transformation for the cairo context obtained
952 * from #GtkPrintContext puts the origin at the top left corner
953 * of the page (which may not be the top left corner of the sheet,
954 * depending on page orientation and the number of pages per sheet).
955 * Otherwise, the origin is at the top left corner of the imageable
956 * area (i.e. inside the margins).
960 g_object_class_install_property (gobject_class,
962 g_param_spec_boolean ("use-full-page",
964 P_("TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area"),
966 GTK_PARAM_READWRITE));
970 * GtkPrintOperation:track-print-status:
972 * If %TRUE, the print operation will try to continue report on
973 * the status of the print job in the printer queues and printer.
974 * This can allow your application to show things like "out of paper"
975 * issues, and when the print job actually reaches the printer.
976 * However, this is often implemented using polling, and should
977 * not be enabled unless needed.
981 g_object_class_install_property (gobject_class,
982 PROP_TRACK_PRINT_STATUS,
983 g_param_spec_boolean ("track-print-status",
984 P_("Track Print Status"),
985 P_("TRUE if the print operation will continue to report on the print job status after the print data has been sent to the printer or print server."),
987 GTK_PARAM_READWRITE));
991 * GtkPrintOperation:unit:
993 * The transformation for the cairo context obtained from
994 * #GtkPrintContext is set up in such a way that distances
995 * are measured in units of @unit.
999 g_object_class_install_property (gobject_class,
1001 g_param_spec_enum ("unit",
1003 P_("The unit in which distances can be measured in the context"),
1006 GTK_PARAM_READWRITE));
1010 * GtkPrintOperation:show-progress:
1012 * Determines whether to show a progress dialog during the
1017 g_object_class_install_property (gobject_class,
1019 g_param_spec_boolean ("show-progress",
1021 P_("TRUE if a progress dialog is shown while printing."),
1023 GTK_PARAM_READWRITE));
1026 * GtkPrintOperation:allow-async:
1028 * Determines whether the print operation may run asynchronously or not.
1030 * Some systems don't support asynchronous printing, but those that do
1031 * will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and
1032 * emit the done signal when the operation is actually done.
1034 * The Windows port does not support asynchronous operation
1035 * at all (this is unlikely to change). On other platforms, all actions
1036 * except for %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous
1041 g_object_class_install_property (gobject_class,
1043 g_param_spec_boolean ("allow-async",
1045 P_("TRUE if print process may run asynchronous."),
1047 GTK_PARAM_READWRITE));
1050 * GtkPrintOperation:export-filename:
1052 * The name of a file file to generate instead of showing
1053 * the print dialog. Currently, PDF is the only supported
1056 * The intended use of this property is for implementing
1057 * "Export to PDF" actions.
1059 * "Print to PDF" support is independent of this and is done
1060 * by letting the user pick the "Print to PDF" item from the
1061 * list of printers in the print dialog.
1065 g_object_class_install_property (gobject_class,
1066 PROP_EXPORT_FILENAME,
1067 g_param_spec_string ("export-filename",
1068 P_("Export filename"),
1069 P_("Export filename"),
1071 GTK_PARAM_READWRITE));
1074 * GtkPrintOperation:status:
1076 * The status of the print operation.
1080 g_object_class_install_property (gobject_class,
1082 g_param_spec_enum ("status",
1084 P_("The status of the print operation"),
1085 GTK_TYPE_PRINT_STATUS,
1086 GTK_PRINT_STATUS_INITIAL,
1087 GTK_PARAM_READABLE));
1090 * GtkPrintOperation:status-string:
1092 * A string representation of the status of the print operation.
1093 * The string is translated and suitable for displaying the print
1094 * status e.g. in a #GtkStatusbar.
1096 * See the ::status property for a status value that is suitable
1097 * for programmatic use.
1101 g_object_class_install_property (gobject_class,
1103 g_param_spec_string ("status-string",
1104 P_("Status String"),
1105 P_("A human-readable description of the status"),
1107 GTK_PARAM_READABLE));
1111 * GtkPrintOperation:custom-tab-label:
1113 * Used as the label of the tab containing custom widgets.
1114 * Note that this property may be ignored on some platforms.
1116 * If this is %NULL, GTK+ uses a default label.
1120 g_object_class_install_property (gobject_class,
1121 PROP_CUSTOM_TAB_LABEL,
1122 g_param_spec_string ("custom-tab-label",
1123 P_("Custom tab label"),
1124 P_("Label for the tab containing custom widgets."),
1126 GTK_PARAM_READWRITE));
1131 * gtk_print_operation_new:
1133 * Creates a new #GtkPrintOperation.
1135 * Returns: a new #GtkPrintOperation
1140 gtk_print_operation_new (void)
1142 GtkPrintOperation *print_operation;
1144 print_operation = g_object_new (GTK_TYPE_PRINT_OPERATION, NULL);
1146 return print_operation;
1150 * gtk_print_operation_set_default_page_setup:
1151 * @op: a #GtkPrintOperation
1152 * @default_page_setup: a #GtkPageSetup, or %NULL
1154 * Makes @default_page_setup the default page setup for @op.
1156 * This page setup will be used by gtk_print_operation_run(),
1157 * but it can be overridden on a per-page basis by connecting
1158 * to the ::request-page-setup signal.
1163 gtk_print_operation_set_default_page_setup (GtkPrintOperation *op,
1164 GtkPageSetup *default_page_setup)
1166 GtkPrintOperationPrivate *priv;
1168 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1169 g_return_if_fail (default_page_setup == NULL ||
1170 GTK_IS_PAGE_SETUP (default_page_setup));
1174 if (default_page_setup != priv->default_page_setup)
1176 if (default_page_setup)
1177 g_object_ref (default_page_setup);
1179 if (priv->default_page_setup)
1180 g_object_unref (priv->default_page_setup);
1182 priv->default_page_setup = default_page_setup;
1184 g_object_notify (G_OBJECT (op), "default-page-setup");
1189 * gtk_print_operation_get_default_page_setup:
1190 * @op: a #GtkPrintOperation
1192 * Returns the default page setup, see
1193 * gtk_print_operation_set_default_page_setup().
1195 * Returns: the default page setup
1200 gtk_print_operation_get_default_page_setup (GtkPrintOperation *op)
1202 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);
1204 return op->priv->default_page_setup;
1209 * gtk_print_operation_set_print_settings:
1210 * @op: a #GtkPrintOperation
1211 * @print_settings: #GtkPrintSettings, or %NULL
1213 * Sets the print settings for @op. This is typically used to
1214 * re-establish print settings from a previous print operation,
1215 * see gtk_print_operation_run().
1220 gtk_print_operation_set_print_settings (GtkPrintOperation *op,
1221 GtkPrintSettings *print_settings)
1223 GtkPrintOperationPrivate *priv;
1225 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1226 g_return_if_fail (print_settings == NULL ||
1227 GTK_IS_PRINT_SETTINGS (print_settings));
1231 if (print_settings != priv->print_settings)
1234 g_object_ref (print_settings);
1236 if (priv->print_settings)
1237 g_object_unref (priv->print_settings);
1239 priv->print_settings = print_settings;
1241 g_object_notify (G_OBJECT (op), "print-settings");
1246 * gtk_print_operation_get_print_settings:
1247 * @op: a #GtkPrintOperation
1249 * Returns the current print settings.
1251 * Note that the return value is %NULL until either
1252 * gtk_print_operation_set_print_settings() or
1253 * gtk_print_operation_run() have been called.
1255 * Return value: the current print settings of @op.
1260 gtk_print_operation_get_print_settings (GtkPrintOperation *op)
1262 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);
1264 return op->priv->print_settings;
1268 * gtk_print_operation_set_job_name:
1269 * @op: a #GtkPrintOperation
1270 * @job_name: a string that identifies the print job
1272 * Sets the name of the print job. The name is used to identify
1273 * the job (e.g. in monitoring applications like eggcups).
1275 * If you don't set a job name, GTK+ picks a default one by
1276 * numbering successive print jobs.
1281 gtk_print_operation_set_job_name (GtkPrintOperation *op,
1282 const gchar *job_name)
1284 GtkPrintOperationPrivate *priv;
1286 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1287 g_return_if_fail (g_utf8_validate (job_name, -1, NULL));
1291 g_free (priv->job_name);
1292 priv->job_name = g_strdup (job_name);
1294 g_object_notify (G_OBJECT (op), "job-name");
1298 * gtk_print_operation_set_n_pages:
1299 * @op: a #GtkPrintOperation
1300 * @n_pages: the number of pages
1302 * Sets the number of pages in the document.
1304 * This <emphasis>must</emphasis> be set to a positive number
1305 * before the rendering starts. It may be set in a ::begin-print
1308 * Note that the page numbers passed to the ::request-page-setup
1309 * and ::draw-page signals are 0-based, i.e. if the user chooses
1310 * to print all pages, the last ::draw-page signal will be
1311 * for page @n_pages - 1.
1316 gtk_print_operation_set_n_pages (GtkPrintOperation *op,
1319 GtkPrintOperationPrivate *priv;
1321 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1322 g_return_if_fail (n_pages > 0);
1325 g_return_if_fail (priv->current_page == -1 ||
1326 priv->current_page < n_pages);
1328 if (priv->nr_of_pages != n_pages)
1330 priv->nr_of_pages = n_pages;
1332 g_object_notify (G_OBJECT (op), "n-pages");
1337 * gtk_print_operation_set_current_page:
1338 * @op: a #GtkPrintOperation
1339 * @current_page: the current page, 0-based
1341 * Sets the current page.
1343 * If this is called before gtk_print_operation_run(),
1344 * the user will be able to select to print only the current page.
1346 * Note that this only makes sense for pre-paginated documents.
1351 gtk_print_operation_set_current_page (GtkPrintOperation *op,
1354 GtkPrintOperationPrivate *priv;
1356 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1357 g_return_if_fail (current_page >= 0);
1360 g_return_if_fail (priv->nr_of_pages == -1 ||
1361 current_page < priv->nr_of_pages);
1363 if (priv->current_page != current_page)
1365 priv->current_page = current_page;
1367 g_object_notify (G_OBJECT (op), "current-page");
1372 * gtk_print_operation_set_use_full_page:
1373 * @op: a #GtkPrintOperation
1374 * @full_page: %TRUE to set up the #GtkPrintContext for the full page
1376 * If @full_page is %TRUE, the transformation for the cairo context
1377 * obtained from #GtkPrintContext puts the origin at the top left
1378 * corner of the page (which may not be the top left corner of the
1379 * sheet, depending on page orientation and the number of pages per
1380 * sheet). Otherwise, the origin is at the top left corner of the
1381 * imageable area (i.e. inside the margins).
1386 gtk_print_operation_set_use_full_page (GtkPrintOperation *op,
1389 GtkPrintOperationPrivate *priv;
1391 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1393 full_page = full_page != FALSE;
1397 if (priv->use_full_page != full_page)
1399 priv->use_full_page = full_page;
1401 g_object_notify (G_OBJECT (op), "use-full-page");
1406 * gtk_print_operation_set_unit:
1407 * @op: a #GtkPrintOperation
1408 * @unit: the unit to use
1410 * Sets up the transformation for the cairo context obtained from
1411 * #GtkPrintContext in such a way that distances are measured in
1417 gtk_print_operation_set_unit (GtkPrintOperation *op,
1420 GtkPrintOperationPrivate *priv;
1422 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1426 if (priv->unit != unit)
1430 g_object_notify (G_OBJECT (op), "unit");
1435 * gtk_print_operation_set_track_print_status:
1436 * @op: a #GtkPrintOperation
1437 * @track_status: %TRUE to track status after printing
1439 * If track_status is %TRUE, the print operation will try to continue report
1440 * on the status of the print job in the printer queues and printer. This
1441 * can allow your application to show things like "out of paper" issues,
1442 * and when the print job actually reaches the printer.
1444 * This function is often implemented using some form of polling, so it should
1445 * not be enabled unless needed.
1450 gtk_print_operation_set_track_print_status (GtkPrintOperation *op,
1451 gboolean track_status)
1453 GtkPrintOperationPrivate *priv;
1455 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1459 if (priv->track_print_status != track_status)
1461 priv->track_print_status = track_status;
1463 g_object_notify (G_OBJECT (op), "track-print-status");
1468 _gtk_print_operation_set_status (GtkPrintOperation *op,
1469 GtkPrintStatus status,
1470 const gchar *string)
1472 GtkPrintOperationPrivate *priv = op->priv;
1473 static const gchar *status_strs[] = {
1474 /* translators, strip the prefix up to and including the first | */
1475 N_("print operation status|Initial state"),
1476 /* translators, strip the prefix up to and including the first | */
1477 N_("print operation status|Preparing to print"),
1478 /* translators, strip the prefix up to and including the first | */
1479 N_("print operation status|Generating data"),
1480 /* translators, strip the prefix up to and including the first | */
1481 N_("print operation status|Sending data"),
1482 /* translators, strip the prefix up to and including the first | */
1483 N_("print operation status|Waiting"),
1484 /* translators, strip the prefix up to and including the first | */
1485 N_("print operation status|Blocking on issue"),
1486 /* translators, strip the prefix up to and including the first | */
1487 N_("print operation status|Printing"),
1488 /* translators, strip the prefix up to and including the first | */
1489 N_("print operation status|Finished"),
1490 /* translators, strip the prefix up to and including the first | */
1491 N_("print operation status|Finished with error")
1494 if (status < 0 || status > GTK_PRINT_STATUS_FINISHED_ABORTED)
1495 status = GTK_PRINT_STATUS_FINISHED_ABORTED;
1498 string = g_strip_context (status_strs[status],
1499 gettext (status_strs[status]));
1501 if (priv->status == status &&
1502 strcmp (string, priv->status_string) == 0)
1505 g_free (priv->status_string);
1506 priv->status_string = g_strdup (string);
1507 priv->status = status;
1509 g_object_notify (G_OBJECT (op), "status");
1510 g_object_notify (G_OBJECT (op), "status-string");
1512 g_signal_emit (op, signals[STATUS_CHANGED], 0);
1517 * gtk_print_operation_get_status:
1518 * @op: a #GtkPrintOperation
1520 * Returns the status of the print operation.
1521 * Also see gtk_print_operation_get_status_string().
1523 * Return value: the status of the print operation
1528 gtk_print_operation_get_status (GtkPrintOperation *op)
1530 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op),
1531 GTK_PRINT_STATUS_FINISHED_ABORTED);
1533 return op->priv->status;
1537 * gtk_print_operation_get_status_string:
1538 * @op: a #GtkPrintOperation
1540 * Returns a string representation of the status of the
1541 * print operation. The string is translated and suitable
1542 * for displaying the print status e.g. in a #GtkStatusbar.
1544 * Use gtk_print_operation_get_status() to obtain a status
1545 * value that is suitable for programmatic use.
1547 * Return value: a string representation of the status
1548 * of the print operation
1552 G_CONST_RETURN gchar *
1553 gtk_print_operation_get_status_string (GtkPrintOperation *op)
1555 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), "");
1557 return op->priv->status_string;
1561 * gtk_print_operation_is_finished:
1562 * @op: a #GtkPrintOperation
1564 * A convenience function to find out if the print operation
1565 * is finished, either successfully (%GTK_PRINT_STATUS_FINISHED)
1566 * or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED).
1568 * Note: when you enable print status tracking the print operation
1569 * can be in a non-finished state even after done has been called, as
1570 * the operation status then tracks the print job status on the printer.
1572 * Return value: %TRUE, if the print operation is finished.
1577 gtk_print_operation_is_finished (GtkPrintOperation *op)
1579 GtkPrintOperationPrivate *priv;
1581 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), TRUE);
1585 priv->status == GTK_PRINT_STATUS_FINISHED_ABORTED ||
1586 priv->status == GTK_PRINT_STATUS_FINISHED;
1590 * gtk_print_operation_set_show_progress:
1591 * @op: a #GtkPrintOperation
1592 * @show_progress: %TRUE to show a progress dialog
1594 * If @show_progress is %TRUE, the print operation will show a
1595 * progress dialog during the print operation.
1600 gtk_print_operation_set_show_progress (GtkPrintOperation *op,
1601 gboolean show_progress)
1603 GtkPrintOperationPrivate *priv;
1605 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1609 show_progress = show_progress != FALSE;
1611 if (priv->show_progress != show_progress)
1613 priv->show_progress = show_progress;
1615 g_object_notify (G_OBJECT (op), "show-progress");
1620 * gtk_print_operation_set_allow_async:
1621 * @op: a #GtkPrintOperation
1622 * @allow_async: %TRUE to allow asynchronous operation
1624 * Sets whether the gtk_print_operation_run() may return
1625 * before the print operation is completed. Note that
1626 * some platforms may not allow asynchronous operation.
1631 gtk_print_operation_set_allow_async (GtkPrintOperation *op,
1632 gboolean allow_async)
1634 GtkPrintOperationPrivate *priv;
1636 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1640 allow_async = allow_async != FALSE;
1642 if (priv->allow_async != allow_async)
1644 priv->allow_async = allow_async;
1646 g_object_notify (G_OBJECT (op), "allow-async");
1652 * gtk_print_operation_set_custom_tab_label:
1653 * @op: a #GtkPrintOperation
1654 * @label: the label to use, or %NULL to use the default label
1656 * Sets the label for the tab holding custom widgets.
1661 gtk_print_operation_set_custom_tab_label (GtkPrintOperation *op,
1664 GtkPrintOperationPrivate *priv;
1666 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1670 g_free (priv->custom_tab_label);
1671 priv->custom_tab_label = g_strdup (label);
1673 g_object_notify (G_OBJECT (op), "custom-tab-label");
1678 * gtk_print_operation_set_export_filename:
1679 * @op: a #GtkPrintOperation
1680 * @filename: the filename for the exported file
1682 * Sets up the #GtkPrintOperation to generate a file instead
1683 * of showing the print dialog. The indended use of this function
1684 * is for implementing "Export to PDF" actions. Currently, PDF
1685 * is the only supported format.
1687 * "Print to PDF" support is independent of this and is done
1688 * by letting the user pick the "Print to PDF" item from the list
1689 * of printers in the print dialog.
1694 gtk_print_operation_set_export_filename (GtkPrintOperation *op,
1695 const gchar *filename)
1697 GtkPrintOperationPrivate *priv;
1699 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1703 g_free (priv->export_filename);
1704 priv->export_filename = g_strdup (filename);
1706 g_object_notify (G_OBJECT (op), "export-filename");
1709 /* Creates the initial page setup used for printing unless the
1710 * app overrides this on a per-page basis using request_page_setup.
1712 * Data is taken from, in order, if existing:
1714 * PrintSettings returned from the print dialog
1715 * (initial dialog values are set from default_page_setup
1716 * if unset in app specified print_settings)
1717 * default_page_setup
1718 * per-locale default setup
1720 static GtkPageSetup *
1721 create_page_setup (GtkPrintOperation *op)
1723 GtkPrintOperationPrivate *priv = op->priv;
1724 GtkPageSetup *page_setup;
1725 GtkPrintSettings *settings;
1727 if (priv->default_page_setup)
1728 page_setup = gtk_page_setup_copy (priv->default_page_setup);
1730 page_setup = gtk_page_setup_new ();
1732 settings = priv->print_settings;
1735 GtkPaperSize *paper_size;
1737 if (gtk_print_settings_has_key (settings, GTK_PRINT_SETTINGS_ORIENTATION))
1738 gtk_page_setup_set_orientation (page_setup,
1739 gtk_print_settings_get_orientation (settings));
1742 paper_size = gtk_print_settings_get_paper_size (settings);
1745 gtk_page_setup_set_paper_size (page_setup, paper_size);
1746 gtk_paper_size_free (paper_size);
1749 /* TODO: Margins? */
1756 pdf_start_page (GtkPrintOperation *op,
1757 GtkPrintContext *print_context,
1758 GtkPageSetup *page_setup)
1760 GtkPaperSize *paper_size;
1761 cairo_surface_t *surface = op->priv->platform_data;
1764 paper_size = gtk_page_setup_get_paper_size (page_setup);
1766 w = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
1767 h = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
1769 cairo_pdf_surface_set_size (surface, w, h);
1773 pdf_end_page (GtkPrintOperation *op,
1774 GtkPrintContext *print_context)
1778 cr = gtk_print_context_get_cairo_context (print_context);
1779 cairo_show_page (cr);
1783 pdf_end_run (GtkPrintOperation *op,
1787 GtkPrintOperationPrivate *priv = op->priv;
1788 cairo_surface_t *surface = priv->platform_data;
1790 cairo_surface_finish (surface);
1791 cairo_surface_destroy (surface);
1794 static GtkPrintOperationResult
1795 run_pdf (GtkPrintOperation *op,
1799 GtkPrintOperationPrivate *priv = op->priv;
1800 GtkPageSetup *page_setup;
1801 cairo_surface_t *surface;
1803 gdouble width, height;
1805 priv->print_context = _gtk_print_context_new (op);
1807 page_setup = create_page_setup (op);
1808 _gtk_print_context_set_page_setup (priv->print_context, page_setup);
1810 /* This will be overwritten later by the non-default size, but
1811 we need to pass some size: */
1812 width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_POINTS);
1813 height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_POINTS);
1814 g_object_unref (page_setup);
1816 surface = cairo_pdf_surface_create (priv->export_filename,
1818 cairo_surface_set_fallback_resolution (surface, 300, 300);
1820 priv->platform_data = surface;
1821 priv->free_platform_data = (GDestroyNotify) cairo_surface_destroy;
1823 cr = cairo_create (surface);
1824 gtk_print_context_set_cairo_context (op->priv->print_context,
1829 priv->print_pages = GTK_PRINT_PAGES_ALL;
1830 priv->page_ranges = NULL;
1831 priv->num_page_ranges = 0;
1833 priv->manual_num_copies = 1;
1834 priv->manual_collation = FALSE;
1835 priv->manual_reverse = FALSE;
1836 priv->manual_page_set = GTK_PAGE_SET_ALL;
1837 priv->manual_scale = 1.0;
1838 priv->manual_orientation = TRUE;
1842 priv->start_page = pdf_start_page;
1843 priv->end_page = pdf_end_page;
1844 priv->end_run = pdf_end_run;
1846 return GTK_PRINT_OPERATION_RESULT_APPLY;
1851 GtkPrintOperation *op;
1852 gint uncollated_copies;
1853 gint collated_copies;
1854 gint uncollated, collated, total;
1856 gint range, num_ranges;
1857 GtkPageRange *ranges;
1858 GtkPageRange one_range;
1860 gint page, start, end, inc;
1862 GtkWidget *progress;
1864 gboolean initialized;
1865 gboolean is_preview;
1869 find_range (PrintPagesData *data)
1871 GtkPageRange *range;
1873 range = &data->ranges[data->range];
1877 data->start = range->end;
1878 data->end = range->start - 1;
1882 data->start = range->start;
1883 data->end = range->end + 1;
1888 increment_page_sequence (PrintPagesData *data)
1890 GtkPrintOperationPrivate *priv = data->op->priv;
1893 data->page += data->inc;
1894 if (data->page == data->end)
1896 data->range += data->inc;
1897 if (data->range == -1 || data->range == data->num_ranges)
1900 if (data->uncollated == data->uncollated_copies)
1903 data->range = data->inc < 0 ? data->num_ranges - 1 : 0;
1906 data->page = data->start;
1909 while ((priv->manual_page_set == GTK_PAGE_SET_EVEN && data->page % 2 == 0) ||
1910 (priv->manual_page_set == GTK_PAGE_SET_ODD && data->page % 2 == 1));
1916 print_pages_idle_done (gpointer user_data)
1918 PrintPagesData *data;
1919 GtkPrintOperationPrivate *priv;
1921 GDK_THREADS_ENTER ();
1923 data = (PrintPagesData*)user_data;
1924 priv = data->op->priv;
1926 priv->print_pages_idle_id = 0;
1928 if (priv->show_progress_timeout_id > 0)
1930 g_source_remove (priv->show_progress_timeout_id);
1931 priv->show_progress_timeout_id = 0;
1935 gtk_widget_destroy (data->progress);
1937 if (priv->rloop && !data->is_preview)
1938 g_main_loop_quit (priv->rloop);
1940 if (!data->is_preview)
1941 g_signal_emit (data->op, signals[DONE], 0,
1943 GTK_PRINT_OPERATION_RESULT_CANCEL :
1944 GTK_PRINT_OPERATION_RESULT_APPLY);
1946 g_object_unref (data->op);
1950 GDK_THREADS_LEAVE ();
1954 update_progress (PrintPagesData *data)
1956 GtkPrintOperationPrivate *priv;
1959 priv = data->op->priv;
1963 if (priv->status == GTK_PRINT_STATUS_PREPARING)
1965 if (priv->nr_of_pages > 0)
1966 text = g_strdup_printf (_("Preparing %d"), priv->nr_of_pages);
1968 text = g_strdup (_("Preparing"));
1970 else if (priv->status == GTK_PRINT_STATUS_GENERATING_DATA)
1971 text = g_strdup_printf (_("Printing %d"), data->total);
1975 g_object_set (data->progress, "text", text, NULL);
1982 common_render_page (GtkPrintOperation *op,
1985 GtkPrintOperationPrivate *priv = op->priv;
1986 GtkPageSetup *page_setup;
1987 GtkPrintContext *print_context;
1990 print_context = priv->print_context;
1992 page_setup = create_page_setup (op);
1994 g_signal_emit (op, signals[REQUEST_PAGE_SETUP], 0,
1995 print_context, page_nr, page_setup);
1997 _gtk_print_context_set_page_setup (print_context, page_setup);
1999 priv->start_page (op, print_context, page_setup);
2001 cr = gtk_print_context_get_cairo_context (print_context);
2004 if (priv->manual_scale != 1.0)
2007 priv->manual_scale);
2009 if (priv->manual_orientation)
2010 _gtk_print_context_rotate_according_to_orientation (print_context);
2012 if (!priv->use_full_page)
2013 _gtk_print_context_translate_into_margin (print_context);
2015 g_signal_emit (op, signals[DRAW_PAGE], 0,
2016 print_context, page_nr);
2018 priv->end_page (op, print_context);
2022 g_object_unref (page_setup);
2026 print_pages_idle (gpointer user_data)
2028 PrintPagesData *data;
2029 GtkPrintOperationPrivate *priv;
2030 GtkPageSetup *page_setup;
2031 gboolean done = FALSE;
2033 GDK_THREADS_ENTER ();
2035 data = (PrintPagesData*)user_data;
2036 priv = data->op->priv;
2038 if (priv->status == GTK_PRINT_STATUS_PREPARING)
2040 if (!data->initialized)
2042 data->initialized = TRUE;
2043 page_setup = create_page_setup (data->op);
2044 _gtk_print_context_set_page_setup (priv->print_context,
2046 g_object_unref (page_setup);
2048 g_signal_emit (data->op, signals[BEGIN_PRINT], 0, priv->print_context);
2050 if (priv->manual_collation)
2052 data->uncollated_copies = priv->manual_num_copies;
2053 data->collated_copies = 1;
2057 data->uncollated_copies = 1;
2058 data->collated_copies = priv->manual_num_copies;
2064 if (g_signal_has_handler_pending (data->op, signals[PAGINATE], 0, FALSE))
2066 gboolean paginated = FALSE;
2068 g_signal_emit (data->op, signals[PAGINATE], 0, priv->print_context, &paginated);
2073 /* FIXME handle this better */
2074 if (priv->nr_of_pages == 0)
2075 g_warning ("no pages to print");
2077 /* Initialize parts of PrintPagesData that depend on nr_of_pages
2079 if (priv->print_pages == GTK_PRINT_PAGES_RANGES)
2081 data->ranges = priv->page_ranges;
2082 data->num_ranges = priv->num_page_ranges;
2084 else if (priv->print_pages == GTK_PRINT_PAGES_CURRENT &&
2085 priv->current_page != -1)
2087 data->ranges = &data->one_range;
2088 data->num_ranges = 1;
2089 data->ranges[0].start = priv->current_page;
2090 data->ranges[0].end = priv->current_page;
2094 data->ranges = &data->one_range;
2095 data->num_ranges = 1;
2096 data->ranges[0].start = 0;
2097 data->ranges[0].end = priv->nr_of_pages - 1;
2100 if (priv->manual_reverse)
2102 data->range = data->num_ranges - 1;
2112 /* go back one page, since we preincrement below */
2113 data->page = data->start - data->inc;
2114 data->collated = data->collated_copies - 1;
2116 _gtk_print_operation_set_status (data->op,
2117 GTK_PRINT_STATUS_GENERATING_DATA,
2125 if (data->collated == data->collated_copies)
2128 if (!increment_page_sequence (data))
2136 if (data->is_preview)
2140 g_object_ref (data->op);
2142 g_signal_emit_by_name (data->op, "ready", priv->print_context);
2146 common_render_page (data->op, data->page);
2150 if (priv->cancelled)
2152 _gtk_print_operation_set_status (data->op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2157 if (done && !data->is_preview)
2159 g_signal_emit (data->op, signals[END_PRINT], 0, priv->print_context);
2160 priv->end_run (data->op, priv->is_sync, priv->cancelled);
2163 update_progress (data);
2165 GDK_THREADS_LEAVE ();
2171 handle_progress_response (GtkWidget *dialog,
2175 GtkPrintOperation *op = (GtkPrintOperation *)data;
2177 gtk_widget_hide (dialog);
2178 gtk_print_operation_cancel (op);
2182 show_progress_timeout (PrintPagesData *data)
2184 GDK_THREADS_ENTER ();
2186 gtk_window_present (GTK_WINDOW (data->progress));
2188 data->op->priv->show_progress_timeout_id = 0;
2190 GDK_THREADS_LEAVE ();
2196 print_pages (GtkPrintOperation *op,
2199 GtkPrintOperationResult result)
2201 GtkPrintOperationPrivate *priv = op->priv;
2202 PrintPagesData *data;
2206 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2207 g_signal_emit (op, signals[DONE], 0, result);
2211 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_PREPARING, NULL);
2213 data = g_new0 (PrintPagesData, 1);
2214 data->op = g_object_ref (op);
2215 data->is_preview = (priv->action == GTK_PRINT_OPERATION_ACTION_PREVIEW);
2217 if (priv->show_progress)
2219 GtkWidget *progress;
2221 progress = gtk_message_dialog_new (parent, 0,
2225 g_signal_connect (progress, "response",
2226 G_CALLBACK (handle_progress_response), op);
2228 priv->show_progress_timeout_id =
2229 g_timeout_add (SHOW_PROGRESS_TIME,
2230 (GSourceFunc)show_progress_timeout,
2233 data->progress = progress;
2236 if (data->is_preview)
2240 g_signal_emit_by_name (op, "preview",
2241 GTK_PRINT_OPERATION_PREVIEW (op),
2242 priv->print_context,
2247 gtk_print_context_get_cairo_context (priv->print_context) == NULL)
2249 /* Programmer error */
2250 g_error ("You must set a cairo context on the print context");
2253 priv->start_page = preview_start_page;
2254 priv->end_page = preview_end_page;
2255 priv->end_run = preview_end_run;
2257 priv->print_pages = gtk_print_settings_get_print_pages (priv->print_settings);
2258 priv->page_ranges = gtk_print_settings_get_page_ranges (priv->print_settings,
2259 &priv->num_page_ranges);
2260 priv->manual_num_copies = 1;
2261 priv->manual_collation = FALSE;
2262 priv->manual_reverse = FALSE;
2263 priv->manual_page_set = GTK_PAGE_SET_ALL;
2264 priv->manual_scale = 1.0;
2265 priv->manual_orientation = TRUE;
2268 priv->print_pages_idle_id = g_idle_add_full (G_PRIORITY_DEFAULT_IDLE + 10,
2271 print_pages_idle_done);
2273 /* Recursive main loop to make sure we don't exit on sync operations */
2276 priv->rloop = g_main_loop_new (NULL, FALSE);
2278 GDK_THREADS_LEAVE ();
2279 g_main_loop_run (priv->rloop);
2280 GDK_THREADS_ENTER ();
2282 g_main_loop_unref (priv->rloop);
2288 * gtk_print_operation_get_error:
2289 * @op: a #GtkPrintOperation
2290 * @error: return location for the error
2292 * Call this when the result of a print operation is
2293 * %GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by
2294 * gtk_print_operation_run(), or in the ::done signal handler.
2295 * The returned #GError will contain more details on what went wrong.
2300 gtk_print_operation_get_error (GtkPrintOperation *op,
2303 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
2305 g_propagate_error (error, op->priv->error);
2307 op->priv->error = NULL;
2312 * gtk_print_operation_run:
2313 * @op: a #GtkPrintOperation
2314 * @action: the action to start
2315 * @parent: Transient parent of the dialog, or %NULL
2316 * @error: Return location for errors, or %NULL
2318 * Runs the print operation, by first letting the user modify
2319 * print settings in the print dialog, and then print the
2322 * Normally that this function does not return until the rendering of all
2323 * pages is complete. You can connect to the ::status-changed signal on
2324 * @op to obtain some information about the progress of the print operation.
2325 * Furthermore, it may use a recursive mainloop to show the print dialog.
2327 * If you call gtk_print_operation_set_allow_async() or set the allow-async
2328 * property the operation will run asyncronously if this is supported on the
2329 * platform. The ::done signal will be emitted with the operation results when
2330 * the operation is done (i.e. when the dialog is canceled, or when the print
2331 * succeeds or fails).
2333 * <informalexample><programlisting>
2334 * if (settings != NULL)
2335 * gtk_print_operation_set_print_settings (print, settings);
2337 * if (page_setup != NULL)
2338 * gtk_print_operation_set_default_page_setup (print, page_setup);
2340 * g_signal_connect (print, "begin-print",
2341 * G_CALLBACK (begin_print), &data);
2342 * g_signal_connect (print, "draw-page",
2343 * G_CALLBACK (draw_page), &data);
2345 * res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, parent, &error);
2347 * if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
2349 * error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent),
2350 * GTK_DIALOG_DESTROY_WITH_PARENT,
2351 * GTK_MESSAGE_ERROR,
2352 * GTK_BUTTONS_CLOSE,
2353 * "Error printing file:\n%s",
2355 * g_signal_connect (error_dialog, "response",
2356 * G_CALLBACK (gtk_widget_destroy), NULL);
2357 * gtk_widget_show (error_dialog);
2358 * g_error_free (error);
2360 * else if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
2362 * if (settings != NULL)
2363 * g_object_unref (settings);
2364 * settings = g_object_ref (gtk_print_operation_get_print_settings (print));
2366 * </programlisting></informalexample>
2368 * Return value: the result of the print operation. A return value of
2369 * %GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was
2370 * completed successfully. In this case, it is a good idea to obtain
2371 * the used print settings with gtk_print_operation_get_print_settings()
2372 * and store them for reuse with the next print operation. A value of
2373 * %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
2374 * asynchronously, and will emit the ::done signal when done.
2378 GtkPrintOperationResult
2379 gtk_print_operation_run (GtkPrintOperation *op,
2380 GtkPrintOperationAction action,
2384 GtkPrintOperationPrivate *priv;
2385 GtkPrintOperationResult result;
2386 GtkPageSetup *page_setup;
2389 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op),
2390 GTK_PRINT_OPERATION_RESULT_ERROR);
2396 priv->action = action;
2398 if (priv->print_settings == NULL)
2399 priv->print_settings = gtk_print_settings_new ();
2401 if (action == GTK_PRINT_OPERATION_ACTION_EXPORT)
2403 /* note: if you implement async EXPORT, update the docs
2404 * docs for the allow-async property.
2406 priv->is_sync = TRUE;
2407 g_return_val_if_fail (priv->export_filename != NULL, GTK_PRINT_OPERATION_RESULT_ERROR);
2408 result = run_pdf (op, parent, &do_print);
2410 else if (action == GTK_PRINT_OPERATION_ACTION_PREVIEW)
2412 priv->is_sync = !priv->allow_async;
2413 priv->print_context = _gtk_print_context_new (op);
2414 page_setup = create_page_setup (op);
2415 _gtk_print_context_set_page_setup (priv->print_context, page_setup);
2416 g_object_unref (page_setup);
2418 result = priv->is_sync ? GTK_PRINT_OPERATION_RESULT_APPLY : GTK_PRINT_OPERATION_RESULT_IN_PROGRESS;
2421 else if (priv->allow_async)
2423 priv->is_sync = FALSE;
2424 _gtk_print_operation_platform_backend_run_dialog_async (op,
2425 action == GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
2428 result = GTK_PRINT_OPERATION_RESULT_IN_PROGRESS;
2433 priv->is_sync = TRUE;
2434 result = _gtk_print_operation_platform_backend_run_dialog (op,
2435 action == GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
2440 if (result != GTK_PRINT_OPERATION_RESULT_IN_PROGRESS)
2441 print_pages (op, parent, do_print, result);
2443 if (priv->error && error)
2444 *error = g_error_copy (priv->error);
2450 * gtk_print_operation_cancel:
2451 * @op: a #GtkPrintOperation
2453 * Cancels a running print operation. This function may
2454 * be called from a begin-print, paginate or draw-page
2455 * signal handler to stop the currently running print
2461 gtk_print_operation_cancel (GtkPrintOperation *op)
2463 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
2465 op->priv->cancelled = TRUE;
2470 #define __GTK_PRINT_OPERATION_C__
2471 #include "gtkaliasdef.c"