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);
126 g_free (priv->status_string);
128 if (priv->print_pages_idle_id > 0)
129 g_source_remove (priv->print_pages_idle_id);
131 if (priv->show_progress_timeout_id > 0)
132 g_source_remove (priv->show_progress_timeout_id);
135 g_error_free (priv->error);
137 G_OBJECT_CLASS (gtk_print_operation_parent_class)->finalize (object);
141 gtk_print_operation_init (GtkPrintOperation *operation)
143 GtkPrintOperationPrivate *priv;
146 priv = operation->priv = GTK_PRINT_OPERATION_GET_PRIVATE (operation);
148 priv->status = GTK_PRINT_STATUS_INITIAL;
149 priv->status_string = g_strdup ("");
150 priv->default_page_setup = NULL;
151 priv->print_settings = NULL;
152 priv->nr_of_pages = -1;
153 priv->current_page = -1;
154 priv->use_full_page = FALSE;
155 priv->show_progress = FALSE;
156 priv->export_filename = NULL;
157 priv->track_print_status = FALSE;
158 priv->is_sync = FALSE;
161 priv->unit = GTK_UNIT_PIXEL;
163 appname = g_get_application_name ();
164 priv->job_name = g_strdup_printf ("%s job #%d", appname, ++job_nr);
168 preview_iface_render_page (GtkPrintOperationPreview *preview,
172 GtkPrintOperation *op;
174 op = GTK_PRINT_OPERATION (preview);
175 common_render_page (op, page_nr);
179 preview_iface_end_preview (GtkPrintOperationPreview *preview)
181 GtkPrintOperation *op;
183 op = GTK_PRINT_OPERATION (preview);
185 g_signal_emit (op, signals[END_PRINT], 0, op->priv->print_context);
188 g_main_loop_quit (op->priv->rloop);
190 if (op->priv->end_run)
191 op->priv->end_run (op, op->priv->is_sync, TRUE);
193 g_signal_emit (op, signals[DONE], 0,
194 GTK_PRINT_OPERATION_RESULT_APPLY);
198 preview_iface_is_selected (GtkPrintOperationPreview *preview,
201 GtkPrintOperation *op;
202 GtkPrintOperationPrivate *priv;
205 op = GTK_PRINT_OPERATION (preview);
208 switch (priv->print_pages)
210 case GTK_PRINT_PAGES_ALL:
211 return (page_nr >= 0) && (page_nr < priv->nr_of_pages);
212 case GTK_PRINT_PAGES_CURRENT:
213 return page_nr == priv->current_page;
214 case GTK_PRINT_PAGES_RANGES:
215 for (i = 0; i < priv->num_page_ranges; i++)
217 if (page_nr >= priv->page_ranges[i].start &&
218 (page_nr <= priv->page_ranges[i].end || priv->page_ranges[i].end == -1))
227 preview_iface_init (GtkPrintOperationPreviewIface *iface)
229 iface->render_page = preview_iface_render_page;
230 iface->end_preview = preview_iface_end_preview;
231 iface->is_selected = preview_iface_is_selected;
235 preview_start_page (GtkPrintOperation *op,
236 GtkPrintContext *print_context,
237 GtkPageSetup *page_setup)
239 g_signal_emit_by_name (op, "got-page-size", print_context, page_setup);
243 preview_end_page (GtkPrintOperation *op,
244 GtkPrintContext *print_context)
249 preview_end_run (GtkPrintOperation *op,
253 g_free (op->priv->page_ranges);
254 op->priv->page_ranges = NULL;
256 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED, NULL);
261 gtk_print_operation_set_property (GObject *object,
266 GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
270 case PROP_DEFAULT_PAGE_SETUP:
271 gtk_print_operation_set_default_page_setup (op, g_value_get_object (value));
273 case PROP_PRINT_SETTINGS:
274 gtk_print_operation_set_print_settings (op, g_value_get_object (value));
277 gtk_print_operation_set_job_name (op, g_value_get_string (value));
280 gtk_print_operation_set_n_pages (op, g_value_get_int (value));
282 case PROP_CURRENT_PAGE:
283 gtk_print_operation_set_current_page (op, g_value_get_int (value));
285 case PROP_USE_FULL_PAGE:
286 gtk_print_operation_set_use_full_page (op, g_value_get_boolean (value));
288 case PROP_TRACK_PRINT_STATUS:
289 gtk_print_operation_set_track_print_status (op, g_value_get_boolean (value));
292 gtk_print_operation_set_unit (op, g_value_get_enum (value));
294 case PROP_ALLOW_ASYNC:
295 gtk_print_operation_set_allow_async (op, g_value_get_boolean (value));
297 case PROP_SHOW_PROGRESS:
298 gtk_print_operation_set_show_progress (op, g_value_get_boolean (value));
300 case PROP_EXPORT_FILENAME:
301 gtk_print_operation_set_export_filename (op, g_value_get_string (value));
303 case PROP_CUSTOM_TAB_LABEL:
304 gtk_print_operation_set_custom_tab_label (op, g_value_get_string (value));
307 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
313 gtk_print_operation_get_property (GObject *object,
318 GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
319 GtkPrintOperationPrivate *priv = op->priv;
323 case PROP_DEFAULT_PAGE_SETUP:
324 g_value_set_object (value, priv->default_page_setup);
326 case PROP_PRINT_SETTINGS:
327 g_value_set_object (value, priv->print_settings);
330 g_value_set_string (value, priv->job_name);
333 g_value_set_int (value, priv->nr_of_pages);
335 case PROP_CURRENT_PAGE:
336 g_value_set_int (value, priv->current_page);
338 case PROP_USE_FULL_PAGE:
339 g_value_set_boolean (value, priv->use_full_page);
341 case PROP_TRACK_PRINT_STATUS:
342 g_value_set_boolean (value, priv->track_print_status);
345 g_value_set_enum (value, priv->unit);
347 case PROP_ALLOW_ASYNC:
348 g_value_set_boolean (value, priv->allow_async);
350 case PROP_SHOW_PROGRESS:
351 g_value_set_boolean (value, priv->show_progress);
353 case PROP_EXPORT_FILENAME:
354 g_value_set_string (value, priv->export_filename);
357 g_value_set_enum (value, priv->status);
359 case PROP_STATUS_STRING:
360 g_value_set_string (value, priv->status_string);
362 case PROP_CUSTOM_TAB_LABEL:
363 g_value_set_string (value, priv->custom_tab_label);
366 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
373 GtkPrintOperationPreview *preview;
374 GtkPrintContext *print_context;
376 cairo_surface_t *surface;
383 preview_print_idle_done (gpointer data)
385 GtkPrintOperation *op;
386 PreviewOp *pop = (PreviewOp *) data;
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);
404 preview_print_idle (gpointer data)
407 GtkPrintOperation *op;
408 gboolean retval = TRUE;
411 pop = (PreviewOp *) data;
412 op = GTK_PRINT_OPERATION (pop->preview);
414 gtk_print_operation_preview_render_page (pop->preview, pop->page_nr);
416 cr = gtk_print_context_get_cairo_context (pop->print_context);
417 _gtk_print_operation_platform_backend_preview_end_page (op, pop->surface, cr);
419 /* TODO: print out sheets not pages and follow ranges */
421 if (op->priv->nr_of_pages <= pop->page_nr)
428 preview_got_page_size (GtkPrintOperationPreview *preview,
429 GtkPrintContext *context,
430 GtkPageSetup *page_setup,
433 GtkPrintOperation *op = GTK_PRINT_OPERATION (preview);
436 _gtk_print_operation_platform_backend_resize_preview_surface (op, page_setup, pop->surface);
438 cr = gtk_print_context_get_cairo_context (pop->print_context);
439 _gtk_print_operation_platform_backend_preview_start_page (op, pop->surface, cr);
444 preview_ready (GtkPrintOperationPreview *preview,
445 GtkPrintContext *context,
449 pop->print_context = context;
451 gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE + 10,
454 preview_print_idle_done);
459 gtk_print_operation_preview_handler (GtkPrintOperation *op,
460 GtkPrintOperationPreview *preview,
461 GtkPrintContext *context,
464 gdouble dpi_x, dpi_y;
466 GtkPageSetup *page_setup;
469 pop = g_new0 (PreviewOp, 1);
470 pop->filename = NULL;
471 pop->preview = preview;
472 pop->parent = parent;
474 page_setup = gtk_print_context_get_page_setup (context);
477 _gtk_print_operation_platform_backend_create_preview_surface (op,
482 cr = cairo_create (pop->surface);
483 gtk_print_context_set_cairo_context (op->priv->print_context, cr,
487 g_signal_connect (preview, "ready", (GCallback) preview_ready, pop);
488 g_signal_connect (preview, "got-page-size", (GCallback) preview_got_page_size, pop);
494 gtk_print_operation_create_custom_widget (GtkPrintOperation *operation)
500 custom_widget_accumulator (GSignalInvocationHint *ihint,
502 const GValue *handler_return,
505 gboolean continue_emission;
508 widget = g_value_get_object (handler_return);
510 g_value_set_object (return_accu, widget);
511 continue_emission = (widget == NULL);
513 return continue_emission;
517 gtk_print_operation_class_init (GtkPrintOperationClass *class)
519 GObjectClass *gobject_class = (GObjectClass *)class;
521 gobject_class->set_property = gtk_print_operation_set_property;
522 gobject_class->get_property = gtk_print_operation_get_property;
523 gobject_class->finalize = gtk_print_operation_finalize;
525 class->preview = gtk_print_operation_preview_handler;
526 class->create_custom_widget = gtk_print_operation_create_custom_widget;
528 g_type_class_add_private (gobject_class, sizeof (GtkPrintOperationPrivate));
531 * GtkPrintOperation::done:
532 * @operation: the #GtkPrintOperation on which the signal was emitted
533 * @result: the result of the print operation
535 * Emitted when the print operation run has finished doing
536 * everything required for printing. @result gives you information
537 * about what happened during the run. If @result is
538 * %GTK_PRINT_OPERATION_RESULT_ERROR then you can call
539 * gtk_print_operation_get_error() for more information.
541 * If you enabled print status tracking then
542 * gtk_print_operation_is_finished() may still return %FALSE
543 * after this was emitted.
548 g_signal_new (I_("done"),
549 G_TYPE_FROM_CLASS (gobject_class),
551 G_STRUCT_OFFSET (GtkPrintOperationClass, done),
553 g_cclosure_marshal_VOID__ENUM,
554 G_TYPE_NONE, 1, GTK_TYPE_PRINT_OPERATION_RESULT);
557 * GtkPrintOperation::begin-print:
558 * @operation: the #GtkPrintOperation on which the signal was emitted
559 * @context: the #GtkPrintContext for the current operation
561 * Emitted after the user has finished changing print settings
562 * in the dialog, before the actual rendering starts.
564 * A typical use for this signal is to use the parameters from the
565 * #GtkPrintContext and paginate the document accordingly, and then
566 * set the number of pages with gtk_print_operation_set_n_pages().
570 signals[BEGIN_PRINT] =
571 g_signal_new (I_("begin-print"),
572 G_TYPE_FROM_CLASS (gobject_class),
574 G_STRUCT_OFFSET (GtkPrintOperationClass, begin_print),
576 g_cclosure_marshal_VOID__OBJECT,
577 G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);
580 * GtkPrintOperation::paginate:
581 * @operation: the #GtkPrintOperation on which the signal was emitted
582 * @context: the #GtkPrintContext for the current operation
584 * Emitted after the begin-print signal, but before the actual
585 * rendering starts. It keeps getting emitted until it returns %FALSE.
587 * This signal is intended to be used for paginating the document
588 * in small chunks, to avoid blocking the user interface for a long
589 * time. The signal handler should update the number of pages using
590 * gtk_print_operation_set_n_pages(), and return %TRUE if the document
591 * has been completely paginated.
593 * If you don't need to do pagination in chunks, you can simply do
594 * it all in the begin-print handler, and set the number of pages
597 * Return value: %TRUE if pagination is complete
602 g_signal_new (I_("paginate"),
603 G_TYPE_FROM_CLASS (gobject_class),
605 G_STRUCT_OFFSET (GtkPrintOperationClass, paginate),
606 _gtk_boolean_handled_accumulator, NULL,
607 _gtk_marshal_BOOLEAN__OBJECT,
608 G_TYPE_BOOLEAN, 1, GTK_TYPE_PRINT_CONTEXT);
612 * GtkPrintOperation::request-page-setup:
613 * @operation: the #GtkPrintOperation on which the signal was emitted
614 * @context: the #GtkPrintContext for the current operation
615 * @page_nr: the number of the currently printed page
616 * @setup: the #GtkPageSetup
618 * Emitted once for every page that is printed, to give
619 * the application a chance to modify the page setup. Any changes
620 * done to @setup will be in force only for printing this page.
624 signals[REQUEST_PAGE_SETUP] =
625 g_signal_new (I_("request-page-setup"),
626 G_TYPE_FROM_CLASS (gobject_class),
628 G_STRUCT_OFFSET (GtkPrintOperationClass, request_page_setup),
630 _gtk_marshal_VOID__OBJECT_INT_OBJECT,
632 GTK_TYPE_PRINT_CONTEXT,
634 GTK_TYPE_PAGE_SETUP);
637 * GtkPrintOperation::draw-page:
638 * @operation: the #GtkPrintOperation on which the signal was emitted
639 * @context: the #GtkPrintContext for the current operation
640 * @page_nr: the number of the currently printed page
642 * Emitted for every page that is printed. The signal handler
643 * must render the @page_nr's page onto the cairo context obtained
644 * from @context using gtk_print_context_get_cairo_context().
646 * <informalexample><programlisting>
648 * draw_page (GtkPrintOperation *operation,
649 * GtkPrintContext *context,
651 * gpointer user_data)
654 * PangoLayout *layout;
655 * gdouble width, text_height;
656 * gint layout_height;
657 * PangoFontDescription *desc;
659 * cr = gtk_print_context_get_cairo_context (context);
660 * width = gtk_print_context_get_width (context);
662 * cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);
664 * cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
667 * layout = gtk_print_context_create_pango_layout (context);
669 * desc = pango_font_description_from_string ("sans 14");
670 * pango_layout_set_font_description (layout, desc);
671 * pango_font_description_free (desc);
673 * pango_layout_set_text (layout, "some text", -1);
674 * pango_layout_set_width (layout, width * PANGO_SCALE);
675 * pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);
677 * pango_layout_get_size (layout, NULL, &layout_height);
678 * text_height = (gdouble)layout_height / PANGO_SCALE;
680 * cairo_move_to (cr, width / 2, (HEADER_HEIGHT - text_height) / 2);
681 * pango_cairo_show_layout (cr, layout);
683 * g_object_unref (layout);
685 * </programlisting></informalexample>
687 * Use gtk_print_operation_set_use_full_page() and
688 * gtk_print_operation_set_unit() before starting the print operation
689 * to set up the transformation of the cairo context according to your
695 g_signal_new (I_("draw-page"),
696 G_TYPE_FROM_CLASS (gobject_class),
698 G_STRUCT_OFFSET (GtkPrintOperationClass, draw_page),
700 _gtk_marshal_VOID__OBJECT_INT,
702 GTK_TYPE_PRINT_CONTEXT,
706 * GtkPrintOperation::end-print:
707 * @operation: the #GtkPrintOperation on which the signal was emitted
708 * @context: the #GtkPrintContext for the current operation
710 * Emitted after all pages have been rendered.
711 * A handler for this signal can clean up any resources that have
712 * been allocated in the ::begin-print handler.
717 g_signal_new (I_("end-print"),
718 G_TYPE_FROM_CLASS (gobject_class),
720 G_STRUCT_OFFSET (GtkPrintOperationClass, end_print),
722 g_cclosure_marshal_VOID__OBJECT,
723 G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);
726 * GtkPrintOperation::status-changed:
727 * @operation: the #GtkPrintOperation on which the signal was emitted
729 * Emitted at between the various phases of the print operation.
730 * See #GtkPrintStatus for the phases that are being discriminated.
731 * Use gtk_print_operation_get_status() to find out the current
736 signals[STATUS_CHANGED] =
737 g_signal_new (I_("status-changed"),
738 G_TYPE_FROM_CLASS (class),
740 G_STRUCT_OFFSET (GtkPrintOperationClass, status_changed),
742 g_cclosure_marshal_VOID__VOID,
747 * GtkPrintOperation::create-custom-widget:
748 * @operation: the #GtkPrintOperation on which the signal was emitted
750 * Emitted when displaying the print dialog. If you return a
751 * widget in a handler for this signal it will be added to a custom
752 * tab in the print dialog. You typically return a container widget
753 * with multiple widgets in it.
755 * The print dialog owns the returned widget, and its lifetime
756 * isn't controlled by the app. However, the widget is guaranteed
757 * to stay around until the custom-widget-apply signal is emitted
758 * on the operation. Then you can read out any information you need
761 * Returns: A custom widget that gets embedded in the print dialog,
766 signals[CREATE_CUSTOM_WIDGET] =
767 g_signal_new (I_("create-custom-widget"),
768 G_TYPE_FROM_CLASS (class),
770 G_STRUCT_OFFSET (GtkPrintOperationClass, create_custom_widget),
771 custom_widget_accumulator, NULL,
772 _gtk_marshal_OBJECT__VOID,
776 * GtkPrintOperation::custom-widget-apply:
777 * @operation: the #GtkPrintOperation on which the signal was emitted
778 * @widget: the custom widget added in create-custom-widget
780 * Emitted right before begin-print if you added
781 * a custom widget in the create-custom-widget handler. When you get
782 * this signal you should read the information from the custom widgets,
783 * as the widgets are not guaraneed to be around at a later time.
787 signals[CUSTOM_WIDGET_APPLY] =
788 g_signal_new (I_("custom-widget-apply"),
789 G_TYPE_FROM_CLASS (class),
791 G_STRUCT_OFFSET (GtkPrintOperationClass, custom_widget_apply),
793 g_cclosure_marshal_VOID__OBJECT,
794 G_TYPE_NONE, 1, GTK_TYPE_WIDGET);
797 * GtkPrintOperation::preview:
798 * @operation: the #GtkPrintOperation on which the signal was emitted
799 * @preview: the #GtkPrintPreviewOperation for the current operation
800 * @context: the #GtkPrintContext that will be used
801 * @parent: the #GtkWindow to use as window parent, or %NULL
803 * Gets emitted when a preview is requested from the native dialog.
805 * The default handler for this signal uses an external viewer
806 * application to preview.
808 * To implement a custom print preview, an application must return
809 * %TRUE from its handler for this signal. In order to use the
810 * provided @context for the preview implementation, it must be
811 * given a suitable cairo context with gtk_print_context_set_cairo_context().
813 * The custom preview implementation can use
814 * gtk_print_operation_preview_is_selected() and
815 * gtk_print_operation_preview_render_page() to find pages which
816 * are selected for print and render them. The preview must be
817 * finished by calling gtk_print_operation_preview_end_preview()
818 * (typically in response to the user clicking a close button).
820 * Returns: %TRUE if the listener wants to take over control of the preview
825 g_signal_new (I_("preview"),
826 G_TYPE_FROM_CLASS (gobject_class),
828 G_STRUCT_OFFSET (GtkPrintOperationClass, preview),
829 _gtk_boolean_handled_accumulator, NULL,
830 _gtk_marshal_BOOLEAN__OBJECT_OBJECT_OBJECT,
832 GTK_TYPE_PRINT_OPERATION_PREVIEW,
833 GTK_TYPE_PRINT_CONTEXT,
838 * GtkPrintOperation:default-page-setup:
840 * The #GtkPageSetup used by default.
842 * This page setup will be used by gtk_print_operation_run(),
843 * but it can be overridden on a per-page basis by connecting
844 * to the ::request-page-setup signal.
848 g_object_class_install_property (gobject_class,
849 PROP_DEFAULT_PAGE_SETUP,
850 g_param_spec_object ("default-page-setup",
851 P_("Default Page Setup"),
852 P_("The GtkPageSetup used by default"),
854 GTK_PARAM_READWRITE));
857 * GtkPrintOperation:print-settings:
859 * The #GtkPrintSettings used for initializing the dialog.
861 * Setting this property is typically used to re-establish
862 * print settings from a previous print operation, see
863 * gtk_print_operation_run().
867 g_object_class_install_property (gobject_class,
869 g_param_spec_object ("print-settings",
870 P_("Print Settings"),
871 P_("The GtkPrintSettings used for initializing the dialog"),
872 GTK_TYPE_PRINT_SETTINGS,
873 GTK_PARAM_READWRITE));
876 * GtkPrintOperation:job-name:
878 * A string used to identify the job (e.g. in monitoring
879 * applications like eggcups).
881 * If you don't set a job name, GTK+ picks a default one
882 * by numbering successive print jobs.
886 g_object_class_install_property (gobject_class,
888 g_param_spec_string ("job-name",
890 P_("A string used for identifying the print job."),
892 GTK_PARAM_READWRITE));
895 * GtkPrintOperation:n-pages:
897 * The number of pages in the document.
899 * This <emphasis>must</emphasis> be set to a positive number
900 * before the rendering starts. It may be set in a ::begin-print
903 * Note that the page numbers passed to the ::request-page-setup
904 * and ::draw-page signals are 0-based, i.e. if the user chooses
905 * to print all pages, the last ::draw-page signal will be for
910 g_object_class_install_property (gobject_class,
912 g_param_spec_int ("n-pages",
913 P_("Number of Pages"),
914 P_("The number of pages in the document."),
918 GTK_PARAM_READWRITE));
921 * GtkPrintOperation:current-page:
923 * The current page in the document.
925 * If this is set before gtk_print_operation_run(),
926 * the user will be able to select to print only the current page.
928 * Note that this only makes sense for pre-paginated documents.
932 g_object_class_install_property (gobject_class,
934 g_param_spec_int ("current-page",
936 P_("The current page in the document"),
940 GTK_PARAM_READWRITE));
943 * GtkPrintOperation:use-full-page:
945 * If %TRUE, the transformation for the cairo context obtained
946 * from #GtkPrintContext puts the origin at the top left corner
947 * of the page (which may not be the top left corner of the sheet,
948 * depending on page orientation and the number of pages per sheet).
949 * Otherwise, the origin is at the top left corner of the imageable
950 * area (i.e. inside the margins).
954 g_object_class_install_property (gobject_class,
956 g_param_spec_boolean ("use-full-page",
958 P_("TRUE if the origin of the context should be at the corner of the page and not the corner of the imageable area"),
960 GTK_PARAM_READWRITE));
964 * GtkPrintOperation:track-print-status:
966 * If %TRUE, the print operation will try to continue report on
967 * the status of the print job in the printer queues and printer.
968 * This can allow your application to show things like "out of paper"
969 * issues, and when the print job actually reaches the printer.
970 * However, this is often implemented using polling, and should
971 * not be enabled unless needed.
975 g_object_class_install_property (gobject_class,
976 PROP_TRACK_PRINT_STATUS,
977 g_param_spec_boolean ("track-print-status",
978 P_("Track Print Status"),
979 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."),
981 GTK_PARAM_READWRITE));
985 * GtkPrintOperation:unit:
987 * The transformation for the cairo context obtained from
988 * #GtkPrintContext is set up in such a way that distances
989 * are measured in units of @unit.
993 g_object_class_install_property (gobject_class,
995 g_param_spec_enum ("unit",
997 P_("The unit in which distances can be measured in the context"),
1000 GTK_PARAM_READWRITE));
1004 * GtkPrintOperation:show-progress:
1006 * Determines whether to show a progress dialog during the
1011 g_object_class_install_property (gobject_class,
1013 g_param_spec_boolean ("show-progress",
1015 P_("TRUE if a progress dialog is shown while printing."),
1017 GTK_PARAM_READWRITE));
1020 * GtkPrintOperation:allow-async:
1022 * Determines whether the print operation may run asynchronously or not.
1024 * Some systems don't support asynchronous printing, but those that do
1025 * will return %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS as the status, and
1026 * emit the done signal when the operation is actually done.
1028 * The Windows port does not support asynchronous operation
1029 * at all (this is unlikely to change). On other platforms, all actions
1030 * except for %GTK_PRINT_OPERATION_ACTION_EXPORT support asynchronous
1035 g_object_class_install_property (gobject_class,
1037 g_param_spec_boolean ("allow-async",
1039 P_("TRUE if print process may run asynchronous."),
1041 GTK_PARAM_READWRITE));
1044 * GtkPrintOperation:export-filename:
1046 * The name of a file file to generate instead of showing
1047 * the print dialog. Currently, PDF is the only supported
1050 * The intended use of this property is for implementing
1051 * "Export to PDF" actions.
1053 * "Print to PDF" support is independent of this and is done
1054 * by letting the user pick the "Print to PDF" item from the
1055 * list of printers in the print dialog.
1059 g_object_class_install_property (gobject_class,
1060 PROP_EXPORT_FILENAME,
1061 g_param_spec_string ("export-filename",
1062 P_("Export filename"),
1063 P_("Export filename"),
1065 GTK_PARAM_READWRITE));
1068 * GtkPrintOperation:status:
1070 * The status of the print operation.
1074 g_object_class_install_property (gobject_class,
1076 g_param_spec_enum ("status",
1078 P_("The status of the print operation"),
1079 GTK_TYPE_PRINT_STATUS,
1080 GTK_PRINT_STATUS_INITIAL,
1081 GTK_PARAM_READABLE));
1084 * GtkPrintOperation:status-string:
1086 * A string representation of the status of the print operation.
1087 * The string is translated and suitable for displaying the print
1088 * status e.g. in a #GtkStatusbar.
1090 * See the ::status property for a status value that is suitable
1091 * for programmatic use.
1095 g_object_class_install_property (gobject_class,
1097 g_param_spec_string ("status-string",
1098 P_("Status String"),
1099 P_("A human-readable description of the status"),
1101 GTK_PARAM_READABLE));
1105 * GtkPrintOperation:custom-tab-label:
1107 * Used as the label of the tab containing custom widgets.
1108 * Note that this property may be ignored on some platforms.
1110 * If this is %NULL, GTK+ uses a default label.
1114 g_object_class_install_property (gobject_class,
1115 PROP_CUSTOM_TAB_LABEL,
1116 g_param_spec_string ("custom-tab-label",
1117 P_("Custom tab label"),
1118 P_("Label for the tab containing custom widgets."),
1120 GTK_PARAM_READWRITE));
1125 * gtk_print_operation_new:
1127 * Creates a new #GtkPrintOperation.
1129 * Returns: a new #GtkPrintOperation
1134 gtk_print_operation_new (void)
1136 GtkPrintOperation *print_operation;
1138 print_operation = g_object_new (GTK_TYPE_PRINT_OPERATION, NULL);
1140 return print_operation;
1144 * gtk_print_operation_set_default_page_setup:
1145 * @op: a #GtkPrintOperation
1146 * @default_page_setup: a #GtkPageSetup, or %NULL
1148 * Makes @default_page_setup the default page setup for @op.
1150 * This page setup will be used by gtk_print_operation_run(),
1151 * but it can be overridden on a per-page basis by connecting
1152 * to the ::request-page-setup signal.
1157 gtk_print_operation_set_default_page_setup (GtkPrintOperation *op,
1158 GtkPageSetup *default_page_setup)
1160 GtkPrintOperationPrivate *priv;
1162 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1163 g_return_if_fail (default_page_setup == NULL ||
1164 GTK_IS_PAGE_SETUP (default_page_setup));
1168 if (default_page_setup != priv->default_page_setup)
1170 if (default_page_setup)
1171 g_object_ref (default_page_setup);
1173 if (priv->default_page_setup)
1174 g_object_unref (priv->default_page_setup);
1176 priv->default_page_setup = default_page_setup;
1178 g_object_notify (G_OBJECT (op), "default-page-setup");
1183 * gtk_print_operation_get_default_page_setup:
1184 * @op: a #GtkPrintOperation
1186 * Returns the default page setup, see
1187 * gtk_print_operation_set_default_page_setup().
1189 * Returns: the default page setup
1194 gtk_print_operation_get_default_page_setup (GtkPrintOperation *op)
1196 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);
1198 return op->priv->default_page_setup;
1203 * gtk_print_operation_set_print_settings:
1204 * @op: a #GtkPrintOperation
1205 * @print_settings: #GtkPrintSettings, or %NULL
1207 * Sets the print settings for @op. This is typically used to
1208 * re-establish print settings from a previous print operation,
1209 * see gtk_print_operation_run().
1214 gtk_print_operation_set_print_settings (GtkPrintOperation *op,
1215 GtkPrintSettings *print_settings)
1217 GtkPrintOperationPrivate *priv;
1219 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1220 g_return_if_fail (print_settings == NULL ||
1221 GTK_IS_PRINT_SETTINGS (print_settings));
1225 if (print_settings != priv->print_settings)
1228 g_object_ref (print_settings);
1230 if (priv->print_settings)
1231 g_object_unref (priv->print_settings);
1233 priv->print_settings = print_settings;
1235 g_object_notify (G_OBJECT (op), "print-settings");
1240 * gtk_print_operation_get_print_settings:
1241 * @op: a #GtkPrintOperation
1243 * Returns the current print settings.
1245 * Note that the return value is %NULL until either
1246 * gtk_print_operation_set_print_settings() or
1247 * gtk_print_operation_run() have been called.
1249 * Return value: the current print settings of @op.
1254 gtk_print_operation_get_print_settings (GtkPrintOperation *op)
1256 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);
1258 return op->priv->print_settings;
1262 * gtk_print_operation_set_job_name:
1263 * @op: a #GtkPrintOperation
1264 * @job_name: a string that identifies the print job
1266 * Sets the name of the print job. The name is used to identify
1267 * the job (e.g. in monitoring applications like eggcups).
1269 * If you don't set a job name, GTK+ picks a default one by
1270 * numbering successive print jobs.
1275 gtk_print_operation_set_job_name (GtkPrintOperation *op,
1276 const gchar *job_name)
1278 GtkPrintOperationPrivate *priv;
1280 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1281 g_return_if_fail (g_utf8_validate (job_name, -1, NULL));
1285 g_free (priv->job_name);
1286 priv->job_name = g_strdup (job_name);
1288 g_object_notify (G_OBJECT (op), "job-name");
1292 * gtk_print_operation_set_n_pages:
1293 * @op: a #GtkPrintOperation
1294 * @n_pages: the number of pages
1296 * Sets the number of pages in the document.
1298 * This <emphasis>must</emphasis> be set to a positive number
1299 * before the rendering starts. It may be set in a ::begin-print
1302 * Note that the page numbers passed to the ::request-page-setup
1303 * and ::draw-page signals are 0-based, i.e. if the user chooses
1304 * to print all pages, the last ::draw-page signal will be
1305 * for page @n_pages - 1.
1310 gtk_print_operation_set_n_pages (GtkPrintOperation *op,
1313 GtkPrintOperationPrivate *priv;
1315 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1316 g_return_if_fail (n_pages > 0);
1319 g_return_if_fail (priv->current_page == -1 ||
1320 priv->current_page < n_pages);
1322 if (priv->nr_of_pages != n_pages)
1324 priv->nr_of_pages = n_pages;
1326 g_object_notify (G_OBJECT (op), "n-pages");
1331 * gtk_print_operation_set_current_page:
1332 * @op: a #GtkPrintOperation
1333 * @current_page: the current page, 0-based
1335 * Sets the current page.
1337 * If this is called before gtk_print_operation_run(),
1338 * the user will be able to select to print only the current page.
1340 * Note that this only makes sense for pre-paginated documents.
1345 gtk_print_operation_set_current_page (GtkPrintOperation *op,
1348 GtkPrintOperationPrivate *priv;
1350 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1351 g_return_if_fail (current_page >= 0);
1354 g_return_if_fail (priv->nr_of_pages == -1 ||
1355 current_page < priv->nr_of_pages);
1357 if (priv->current_page != current_page)
1359 priv->current_page = current_page;
1361 g_object_notify (G_OBJECT (op), "current-page");
1366 * gtk_print_operation_set_use_full_page:
1367 * @op: a #GtkPrintOperation
1368 * @full_page: %TRUE to set up the #GtkPrintContext for the full page
1370 * If @full_page is %TRUE, the transformation for the cairo context
1371 * obtained from #GtkPrintContext puts the origin at the top left
1372 * corner of the page (which may not be the top left corner of the
1373 * sheet, depending on page orientation and the number of pages per
1374 * sheet). Otherwise, the origin is at the top left corner of the
1375 * imageable area (i.e. inside the margins).
1380 gtk_print_operation_set_use_full_page (GtkPrintOperation *op,
1383 GtkPrintOperationPrivate *priv;
1385 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1387 full_page = full_page != FALSE;
1391 if (priv->use_full_page != full_page)
1393 priv->use_full_page = full_page;
1395 g_object_notify (G_OBJECT (op), "use-full-page");
1400 * gtk_print_operation_set_unit:
1401 * @op: a #GtkPrintOperation
1402 * @unit: the unit to use
1404 * Sets up the transformation for the cairo context obtained from
1405 * #GtkPrintContext in such a way that distances are measured in
1411 gtk_print_operation_set_unit (GtkPrintOperation *op,
1414 GtkPrintOperationPrivate *priv;
1416 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1420 if (priv->unit != unit)
1424 g_object_notify (G_OBJECT (op), "unit");
1429 * gtk_print_operation_set_track_print_status:
1430 * @op: a #GtkPrintOperation
1431 * @track_status: %TRUE to track status after printing
1433 * If track_status is %TRUE, the print operation will try to continue report
1434 * on the status of the print job in the printer queues and printer. This
1435 * can allow your application to show things like "out of paper" issues,
1436 * and when the print job actually reaches the printer.
1438 * This function is often implemented using some form of polling, so it should
1439 * not be enabled unless needed.
1444 gtk_print_operation_set_track_print_status (GtkPrintOperation *op,
1445 gboolean track_status)
1447 GtkPrintOperationPrivate *priv;
1449 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1453 if (priv->track_print_status != track_status)
1455 priv->track_print_status = track_status;
1457 g_object_notify (G_OBJECT (op), "track-print-status");
1462 _gtk_print_operation_set_status (GtkPrintOperation *op,
1463 GtkPrintStatus status,
1464 const gchar *string)
1466 GtkPrintOperationPrivate *priv = op->priv;
1467 static const gchar *status_strs[] = {
1468 /* translators, strip the prefix up to and including the first | */
1469 N_("print operation status|Initial state"),
1470 /* translators, strip the prefix up to and including the first | */
1471 N_("print operation status|Preparing to print"),
1472 /* translators, strip the prefix up to and including the first | */
1473 N_("print operation status|Generating data"),
1474 /* translators, strip the prefix up to and including the first | */
1475 N_("print operation status|Sending data"),
1476 /* translators, strip the prefix up to and including the first | */
1477 N_("print operation status|Waiting"),
1478 /* translators, strip the prefix up to and including the first | */
1479 N_("print operation status|Blocking on issue"),
1480 /* translators, strip the prefix up to and including the first | */
1481 N_("print operation status|Printing"),
1482 /* translators, strip the prefix up to and including the first | */
1483 N_("print operation status|Finished"),
1484 /* translators, strip the prefix up to and including the first | */
1485 N_("print operation status|Finished with error")
1488 if (status < 0 || status > GTK_PRINT_STATUS_FINISHED_ABORTED)
1489 status = GTK_PRINT_STATUS_FINISHED_ABORTED;
1492 string = g_strip_context (status_strs[status],
1493 gettext (status_strs[status]));
1495 if (priv->status == status &&
1496 strcmp (string, priv->status_string) == 0)
1499 g_free (priv->status_string);
1500 priv->status_string = g_strdup (string);
1501 priv->status = status;
1503 g_object_notify (G_OBJECT (op), "status");
1504 g_object_notify (G_OBJECT (op), "status-string");
1506 g_signal_emit (op, signals[STATUS_CHANGED], 0);
1511 * gtk_print_operation_get_status:
1512 * @op: a #GtkPrintOperation
1514 * Returns the status of the print operation.
1515 * Also see gtk_print_operation_get_status_string().
1517 * Return value: the status of the print operation
1522 gtk_print_operation_get_status (GtkPrintOperation *op)
1524 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op),
1525 GTK_PRINT_STATUS_FINISHED_ABORTED);
1527 return op->priv->status;
1531 * gtk_print_operation_get_status_string:
1532 * @op: a #GtkPrintOperation
1534 * Returns a string representation of the status of the
1535 * print operation. The string is translated and suitable
1536 * for displaying the print status e.g. in a #GtkStatusbar.
1538 * Use gtk_print_operation_get_status() to obtain a status
1539 * value that is suitable for programmatic use.
1541 * Return value: a string representation of the status
1542 * of the print operation
1546 G_CONST_RETURN gchar *
1547 gtk_print_operation_get_status_string (GtkPrintOperation *op)
1549 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), "");
1551 return op->priv->status_string;
1555 * gtk_print_operation_is_finished:
1556 * @op: a #GtkPrintOperation
1558 * A convenience function to find out if the print operation
1559 * is finished, either successfully (%GTK_PRINT_STATUS_FINISHED)
1560 * or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED).
1562 * Note: when you enable print status tracking the print operation
1563 * can be in a non-finished state even after done has been called, as
1564 * the operation status then tracks the print job status on the printer.
1566 * Return value: %TRUE, if the print operation is finished.
1571 gtk_print_operation_is_finished (GtkPrintOperation *op)
1573 GtkPrintOperationPrivate *priv;
1575 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), TRUE);
1579 priv->status == GTK_PRINT_STATUS_FINISHED_ABORTED ||
1580 priv->status == GTK_PRINT_STATUS_FINISHED;
1584 * gtk_print_operation_set_show_progress:
1585 * @op: a #GtkPrintOperation
1586 * @show_progress: %TRUE to show a progress dialog
1588 * If @show_progress is %TRUE, the print operation will show a
1589 * progress dialog during the print operation.
1594 gtk_print_operation_set_show_progress (GtkPrintOperation *op,
1595 gboolean show_progress)
1597 GtkPrintOperationPrivate *priv;
1599 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1603 show_progress = show_progress != FALSE;
1605 if (priv->show_progress != show_progress)
1607 priv->show_progress = show_progress;
1609 g_object_notify (G_OBJECT (op), "show-progress");
1614 * gtk_print_operation_set_allow_async:
1615 * @op: a #GtkPrintOperation
1616 * @allow_async: %TRUE to allow asynchronous operation
1618 * Sets whether the gtk_print_operation_run() may return
1619 * before the print operation is completed. Note that
1620 * some platforms may not allow asynchronous operation.
1625 gtk_print_operation_set_allow_async (GtkPrintOperation *op,
1626 gboolean allow_async)
1628 GtkPrintOperationPrivate *priv;
1630 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1634 allow_async = allow_async != FALSE;
1636 if (priv->allow_async != allow_async)
1638 priv->allow_async = allow_async;
1640 g_object_notify (G_OBJECT (op), "allow-async");
1646 * gtk_print_operation_set_custom_tab_label:
1647 * @op: a #GtkPrintOperation
1648 * @label: the label to use, or %NULL to use the default label
1650 * Sets the label for the tab holding custom widgets.
1655 gtk_print_operation_set_custom_tab_label (GtkPrintOperation *op,
1658 GtkPrintOperationPrivate *priv;
1660 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1664 g_free (priv->custom_tab_label);
1665 priv->custom_tab_label = g_strdup (label);
1667 g_object_notify (G_OBJECT (op), "custom-tab-label");
1672 * gtk_print_operation_set_export_filename:
1673 * @op: a #GtkPrintOperation
1674 * @filename: the filename for the exported file
1676 * Sets up the #GtkPrintOperation to generate a file instead
1677 * of showing the print dialog. The indended use of this function
1678 * is for implementing "Export to PDF" actions. Currently, PDF
1679 * is the only supported format.
1681 * "Print to PDF" support is independent of this and is done
1682 * by letting the user pick the "Print to PDF" item from the list
1683 * of printers in the print dialog.
1688 gtk_print_operation_set_export_filename (GtkPrintOperation *op,
1689 const gchar *filename)
1691 GtkPrintOperationPrivate *priv;
1693 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1697 g_free (priv->export_filename);
1698 priv->export_filename = g_strdup (filename);
1700 g_object_notify (G_OBJECT (op), "export-filename");
1703 /* Creates the initial page setup used for printing unless the
1704 * app overrides this on a per-page basis using request_page_setup.
1706 * Data is taken from, in order, if existing:
1708 * PrintSettings returned from the print dialog
1709 * (initial dialog values are set from default_page_setup
1710 * if unset in app specified print_settings)
1711 * default_page_setup
1712 * per-locale default setup
1714 static GtkPageSetup *
1715 create_page_setup (GtkPrintOperation *op)
1717 GtkPrintOperationPrivate *priv = op->priv;
1718 GtkPageSetup *page_setup;
1719 GtkPrintSettings *settings;
1721 if (priv->default_page_setup)
1722 page_setup = gtk_page_setup_copy (priv->default_page_setup);
1724 page_setup = gtk_page_setup_new ();
1726 settings = priv->print_settings;
1729 GtkPaperSize *paper_size;
1731 if (gtk_print_settings_has_key (settings, GTK_PRINT_SETTINGS_ORIENTATION))
1732 gtk_page_setup_set_orientation (page_setup,
1733 gtk_print_settings_get_orientation (settings));
1736 paper_size = gtk_print_settings_get_paper_size (settings);
1739 gtk_page_setup_set_paper_size (page_setup, paper_size);
1740 gtk_paper_size_free (paper_size);
1743 /* TODO: Margins? */
1750 pdf_start_page (GtkPrintOperation *op,
1751 GtkPrintContext *print_context,
1752 GtkPageSetup *page_setup)
1754 GtkPaperSize *paper_size;
1755 cairo_surface_t *surface = op->priv->platform_data;
1758 paper_size = gtk_page_setup_get_paper_size (page_setup);
1760 w = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
1761 h = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
1763 cairo_pdf_surface_set_size (surface, w, h);
1767 pdf_end_page (GtkPrintOperation *op,
1768 GtkPrintContext *print_context)
1772 cr = gtk_print_context_get_cairo_context (print_context);
1773 cairo_show_page (cr);
1777 pdf_end_run (GtkPrintOperation *op,
1781 GtkPrintOperationPrivate *priv = op->priv;
1782 cairo_surface_t *surface = priv->platform_data;
1784 cairo_surface_finish (surface);
1785 cairo_surface_destroy (surface);
1788 static GtkPrintOperationResult
1789 run_pdf (GtkPrintOperation *op,
1793 GtkPrintOperationPrivate *priv = op->priv;
1794 GtkPageSetup *page_setup;
1795 cairo_surface_t *surface;
1797 gdouble width, height;
1799 priv->print_context = _gtk_print_context_new (op);
1801 page_setup = create_page_setup (op);
1802 _gtk_print_context_set_page_setup (priv->print_context, page_setup);
1804 /* This will be overwritten later by the non-default size, but
1805 we need to pass some size: */
1806 width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_POINTS);
1807 height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_POINTS);
1808 g_object_unref (page_setup);
1810 surface = cairo_pdf_surface_create (priv->export_filename,
1812 cairo_surface_set_fallback_resolution (surface, 300, 300);
1814 priv->platform_data = surface;
1815 priv->free_platform_data = (GDestroyNotify) cairo_surface_destroy;
1817 cr = cairo_create (surface);
1818 gtk_print_context_set_cairo_context (op->priv->print_context,
1823 priv->print_pages = GTK_PRINT_PAGES_ALL;
1824 priv->page_ranges = NULL;
1825 priv->num_page_ranges = 0;
1827 priv->manual_num_copies = 1;
1828 priv->manual_collation = FALSE;
1829 priv->manual_reverse = FALSE;
1830 priv->manual_page_set = GTK_PAGE_SET_ALL;
1831 priv->manual_scale = 1.0;
1832 priv->manual_orientation = TRUE;
1836 priv->start_page = pdf_start_page;
1837 priv->end_page = pdf_end_page;
1838 priv->end_run = pdf_end_run;
1840 return GTK_PRINT_OPERATION_RESULT_APPLY;
1845 GtkPrintOperation *op;
1846 gint uncollated_copies;
1847 gint collated_copies;
1848 gint uncollated, collated, total;
1850 gint range, num_ranges;
1851 GtkPageRange *ranges;
1852 GtkPageRange one_range;
1854 gint page, start, end, inc;
1856 GtkWidget *progress;
1858 gboolean initialized;
1859 gboolean is_preview;
1863 find_range (PrintPagesData *data)
1865 GtkPageRange *range;
1867 range = &data->ranges[data->range];
1871 data->start = range->end;
1872 data->end = range->start - 1;
1876 data->start = range->start;
1877 data->end = range->end + 1;
1882 increment_page_sequence (PrintPagesData *data)
1884 GtkPrintOperationPrivate *priv = data->op->priv;
1887 data->page += data->inc;
1888 if (data->page == data->end)
1890 data->range += data->inc;
1891 if (data->range == -1 || data->range == data->num_ranges)
1894 if (data->uncollated == data->uncollated_copies)
1897 data->range = data->inc < 0 ? data->num_ranges - 1 : 0;
1900 data->page = data->start;
1903 while ((priv->manual_page_set == GTK_PAGE_SET_EVEN && data->page % 2 == 0) ||
1904 (priv->manual_page_set == GTK_PAGE_SET_ODD && data->page % 2 == 1));
1910 print_pages_idle_done (gpointer user_data)
1912 PrintPagesData *data;
1913 GtkPrintOperationPrivate *priv;
1915 data = (PrintPagesData*)user_data;
1916 priv = data->op->priv;
1918 priv->print_pages_idle_id = 0;
1920 if (priv->show_progress_timeout_id > 0)
1922 g_source_remove (priv->show_progress_timeout_id);
1923 priv->show_progress_timeout_id = 0;
1927 gtk_widget_destroy (data->progress);
1929 if (priv->rloop && !data->is_preview)
1930 g_main_loop_quit (priv->rloop);
1932 if (!data->is_preview)
1933 g_signal_emit (data->op, signals[DONE], 0,
1935 GTK_PRINT_OPERATION_RESULT_CANCEL :
1936 GTK_PRINT_OPERATION_RESULT_APPLY);
1938 g_object_unref (data->op);
1944 update_progress (PrintPagesData *data)
1946 GtkPrintOperationPrivate *priv;
1949 priv = data->op->priv;
1953 if (priv->status == GTK_PRINT_STATUS_PREPARING)
1955 if (priv->nr_of_pages > 0)
1956 text = g_strdup_printf (_("Preparing %d"), priv->nr_of_pages);
1958 text = g_strdup (_("Preparing"));
1960 else if (priv->status == GTK_PRINT_STATUS_GENERATING_DATA)
1961 text = g_strdup_printf (_("Printing %d"), data->total);
1965 g_object_set (data->progress, "text", text, NULL);
1972 common_render_page (GtkPrintOperation *op,
1975 GtkPrintOperationPrivate *priv = op->priv;
1976 GtkPageSetup *page_setup;
1977 GtkPrintContext *print_context;
1980 print_context = priv->print_context;
1982 page_setup = create_page_setup (op);
1984 g_signal_emit (op, signals[REQUEST_PAGE_SETUP], 0,
1985 print_context, page_nr, page_setup);
1987 _gtk_print_context_set_page_setup (print_context, page_setup);
1989 priv->start_page (op, print_context, page_setup);
1991 cr = gtk_print_context_get_cairo_context (print_context);
1994 if (priv->manual_scale != 1.0)
1997 priv->manual_scale);
1999 if (priv->manual_orientation)
2000 _gtk_print_context_rotate_according_to_orientation (print_context);
2002 if (!priv->use_full_page)
2003 _gtk_print_context_translate_into_margin (print_context);
2005 g_signal_emit (op, signals[DRAW_PAGE], 0,
2006 print_context, page_nr);
2008 priv->end_page (op, print_context);
2012 g_object_unref (page_setup);
2016 print_pages_idle (gpointer user_data)
2018 PrintPagesData *data;
2019 GtkPrintOperationPrivate *priv;
2020 GtkPageSetup *page_setup;
2021 gboolean done = FALSE;
2024 data = (PrintPagesData*)user_data;
2025 priv = data->op->priv;
2027 if (priv->status == GTK_PRINT_STATUS_PREPARING)
2029 if (!data->initialized)
2031 data->initialized = TRUE;
2032 page_setup = create_page_setup (data->op);
2033 _gtk_print_context_set_page_setup (priv->print_context,
2035 g_object_unref (page_setup);
2037 g_signal_emit (data->op, signals[BEGIN_PRINT], 0, priv->print_context);
2039 if (priv->manual_collation)
2041 data->uncollated_copies = priv->manual_num_copies;
2042 data->collated_copies = 1;
2046 data->uncollated_copies = 1;
2047 data->collated_copies = priv->manual_num_copies;
2053 if (GTK_PRINT_OPERATION_GET_CLASS (data->op)->paginage != NULL ||
2054 g_signal_has_handler_pending (data->op, signals[PAGINATE], 0, FALSE))
2056 gboolean paginated = FALSE;
2058 g_signal_emit (data->op, signals[PAGINATE], 0, priv->print_context, &paginated);
2063 /* FIXME handle this better */
2064 if (priv->nr_of_pages == 0)
2065 g_warning ("no pages to print");
2067 /* Initialize parts of PrintPagesData that depend on nr_of_pages
2069 if (priv->print_pages == GTK_PRINT_PAGES_RANGES)
2071 data->ranges = priv->page_ranges;
2072 data->num_ranges = priv->num_page_ranges;
2073 for (i = 0; i < data->num_ranges; i++)
2074 if (data->ranges[i].end == -1)
2075 data->ranges[i].end = priv->nr_of_pages - 1;
2077 else if (priv->print_pages == GTK_PRINT_PAGES_CURRENT &&
2078 priv->current_page != -1)
2080 data->ranges = &data->one_range;
2081 data->num_ranges = 1;
2082 data->ranges[0].start = priv->current_page;
2083 data->ranges[0].end = priv->current_page;
2087 data->ranges = &data->one_range;
2088 data->num_ranges = 1;
2089 data->ranges[0].start = 0;
2090 data->ranges[0].end = priv->nr_of_pages - 1;
2093 if (priv->manual_reverse)
2095 data->range = data->num_ranges - 1;
2105 /* go back one page, since we preincrement below */
2106 data->page = data->start - data->inc;
2107 data->collated = data->collated_copies - 1;
2109 _gtk_print_operation_set_status (data->op,
2110 GTK_PRINT_STATUS_GENERATING_DATA,
2118 if (data->collated == data->collated_copies)
2121 if (!increment_page_sequence (data))
2129 if (data->is_preview)
2133 g_object_ref (data->op);
2135 g_signal_emit_by_name (data->op, "ready", priv->print_context);
2139 common_render_page (data->op, data->page);
2143 if (priv->cancelled)
2145 _gtk_print_operation_set_status (data->op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2150 if (done && !data->is_preview)
2152 g_signal_emit (data->op, signals[END_PRINT], 0, priv->print_context);
2153 priv->end_run (data->op, priv->is_sync, priv->cancelled);
2156 update_progress (data);
2162 handle_progress_response (GtkWidget *dialog,
2166 GtkPrintOperation *op = (GtkPrintOperation *)data;
2168 gtk_widget_hide (dialog);
2169 gtk_print_operation_cancel (op);
2173 show_progress_timeout (PrintPagesData *data)
2175 gtk_window_present (GTK_WINDOW (data->progress));
2177 data->op->priv->show_progress_timeout_id = 0;
2183 print_pages (GtkPrintOperation *op,
2186 GtkPrintOperationResult result)
2188 GtkPrintOperationPrivate *priv = op->priv;
2189 PrintPagesData *data;
2193 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2194 g_signal_emit (op, signals[DONE], 0, result);
2198 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_PREPARING, NULL);
2200 data = g_new0 (PrintPagesData, 1);
2201 data->op = g_object_ref (op);
2202 data->is_preview = (priv->action == GTK_PRINT_OPERATION_ACTION_PREVIEW);
2204 if (priv->show_progress)
2206 GtkWidget *progress;
2208 progress = gtk_message_dialog_new (parent, 0,
2212 g_signal_connect (progress, "response",
2213 G_CALLBACK (handle_progress_response), op);
2215 priv->show_progress_timeout_id =
2216 gdk_threads_add_timeout (SHOW_PROGRESS_TIME,
2217 (GSourceFunc)show_progress_timeout,
2220 data->progress = progress;
2223 if (data->is_preview)
2227 g_signal_emit_by_name (op, "preview",
2228 GTK_PRINT_OPERATION_PREVIEW (op),
2229 priv->print_context,
2234 gtk_print_context_get_cairo_context (priv->print_context) == NULL)
2236 /* Programmer error */
2237 g_error ("You must set a cairo context on the print context");
2240 priv->start_page = preview_start_page;
2241 priv->end_page = preview_end_page;
2242 priv->end_run = preview_end_run;
2244 priv->print_pages = gtk_print_settings_get_print_pages (priv->print_settings);
2245 priv->page_ranges = gtk_print_settings_get_page_ranges (priv->print_settings,
2246 &priv->num_page_ranges);
2247 priv->manual_num_copies = 1;
2248 priv->manual_collation = FALSE;
2249 priv->manual_reverse = FALSE;
2250 priv->manual_page_set = GTK_PAGE_SET_ALL;
2251 priv->manual_scale = 1.0;
2252 priv->manual_orientation = TRUE;
2255 priv->print_pages_idle_id = gdk_threads_add_idle_full (G_PRIORITY_DEFAULT_IDLE + 10,
2258 print_pages_idle_done);
2260 /* Recursive main loop to make sure we don't exit on sync operations */
2263 priv->rloop = g_main_loop_new (NULL, FALSE);
2266 GDK_THREADS_LEAVE ();
2267 g_main_loop_run (priv->rloop);
2268 GDK_THREADS_ENTER ();
2270 g_main_loop_unref (priv->rloop);
2272 g_object_unref (op);
2277 * gtk_print_operation_get_error:
2278 * @op: a #GtkPrintOperation
2279 * @error: return location for the error
2281 * Call this when the result of a print operation is
2282 * %GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by
2283 * gtk_print_operation_run(), or in the ::done signal handler.
2284 * The returned #GError will contain more details on what went wrong.
2289 gtk_print_operation_get_error (GtkPrintOperation *op,
2292 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
2294 g_propagate_error (error, op->priv->error);
2296 op->priv->error = NULL;
2301 * gtk_print_operation_run:
2302 * @op: a #GtkPrintOperation
2303 * @action: the action to start
2304 * @parent: Transient parent of the dialog, or %NULL
2305 * @error: Return location for errors, or %NULL
2307 * Runs the print operation, by first letting the user modify
2308 * print settings in the print dialog, and then print the
2311 * Normally that this function does not return until the rendering of all
2312 * pages is complete. You can connect to the ::status-changed signal on
2313 * @op to obtain some information about the progress of the print operation.
2314 * Furthermore, it may use a recursive mainloop to show the print dialog.
2316 * If you call gtk_print_operation_set_allow_async() or set the allow-async
2317 * property the operation will run asyncronously if this is supported on the
2318 * platform. The ::done signal will be emitted with the operation results when
2319 * the operation is done (i.e. when the dialog is canceled, or when the print
2320 * succeeds or fails).
2322 * <informalexample><programlisting>
2323 * if (settings != NULL)
2324 * gtk_print_operation_set_print_settings (print, settings);
2326 * if (page_setup != NULL)
2327 * gtk_print_operation_set_default_page_setup (print, page_setup);
2329 * g_signal_connect (print, "begin-print",
2330 * G_CALLBACK (begin_print), &data);
2331 * g_signal_connect (print, "draw-page",
2332 * G_CALLBACK (draw_page), &data);
2334 * res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, parent, &error);
2336 * if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
2338 * error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent),
2339 * GTK_DIALOG_DESTROY_WITH_PARENT,
2340 * GTK_MESSAGE_ERROR,
2341 * GTK_BUTTONS_CLOSE,
2342 * "Error printing file:\n%s",
2344 * g_signal_connect (error_dialog, "response",
2345 * G_CALLBACK (gtk_widget_destroy), NULL);
2346 * gtk_widget_show (error_dialog);
2347 * g_error_free (error);
2349 * else if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
2351 * if (settings != NULL)
2352 * g_object_unref (settings);
2353 * settings = g_object_ref (gtk_print_operation_get_print_settings (print));
2355 * </programlisting></informalexample>
2357 * Return value: the result of the print operation. A return value of
2358 * %GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was
2359 * completed successfully. In this case, it is a good idea to obtain
2360 * the used print settings with gtk_print_operation_get_print_settings()
2361 * and store them for reuse with the next print operation. A value of
2362 * %GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
2363 * asynchronously, and will emit the ::done signal when done.
2367 GtkPrintOperationResult
2368 gtk_print_operation_run (GtkPrintOperation *op,
2369 GtkPrintOperationAction action,
2373 GtkPrintOperationPrivate *priv;
2374 GtkPrintOperationResult result;
2375 GtkPageSetup *page_setup;
2377 gboolean run_print_pages;
2379 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op),
2380 GTK_PRINT_OPERATION_RESULT_ERROR);
2384 run_print_pages = TRUE;
2387 priv->action = action;
2389 if (priv->print_settings == NULL)
2390 priv->print_settings = gtk_print_settings_new ();
2392 if (action == GTK_PRINT_OPERATION_ACTION_EXPORT)
2394 /* note: if you implement async EXPORT, update the docs
2395 * docs for the allow-async property.
2397 priv->is_sync = TRUE;
2398 g_return_val_if_fail (priv->export_filename != NULL, GTK_PRINT_OPERATION_RESULT_ERROR);
2399 result = run_pdf (op, parent, &do_print);
2401 else if (action == GTK_PRINT_OPERATION_ACTION_PREVIEW)
2403 priv->is_sync = !priv->allow_async;
2404 priv->print_context = _gtk_print_context_new (op);
2405 page_setup = create_page_setup (op);
2406 _gtk_print_context_set_page_setup (priv->print_context, page_setup);
2407 g_object_unref (page_setup);
2409 result = priv->is_sync ? GTK_PRINT_OPERATION_RESULT_APPLY : GTK_PRINT_OPERATION_RESULT_IN_PROGRESS;
2412 else if (priv->allow_async)
2414 priv->is_sync = FALSE;
2415 _gtk_print_operation_platform_backend_run_dialog_async (op,
2416 action == GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
2419 result = GTK_PRINT_OPERATION_RESULT_IN_PROGRESS;
2420 run_print_pages = FALSE; /* print_pages is called asynchronously from dialog */
2425 priv->is_sync = TRUE;
2426 result = _gtk_print_operation_platform_backend_run_dialog (op,
2427 action == GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
2432 if (run_print_pages)
2433 print_pages (op, parent, do_print, result);
2435 if (priv->error && error)
2436 *error = g_error_copy (priv->error);
2442 * gtk_print_operation_cancel:
2443 * @op: a #GtkPrintOperation
2445 * Cancels a running print operation. This function may
2446 * be called from a begin-print, paginate or draw-page
2447 * signal handler to stop the currently running print
2453 gtk_print_operation_cancel (GtkPrintOperation *op)
2455 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
2457 op->priv->cancelled = TRUE;
2462 #define __GTK_PRINT_OPERATION_C__
2463 #include "gtkaliasdef.c"