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))
54 PROP_DEFAULT_PAGE_SETUP,
60 PROP_TRACK_PRINT_STATUS,
71 static guint signals[LAST_SIGNAL] = { 0 };
72 static int job_nr = 0;
74 static void preview_iface_init (GtkPrintOperationPreviewIface *iface);
75 static GtkPageSetup *create_page_setup (GtkPrintOperation *op);
76 static void common_render_page (GtkPrintOperation *op,
80 G_DEFINE_TYPE_WITH_CODE (GtkPrintOperation, gtk_print_operation, G_TYPE_OBJECT,
81 G_IMPLEMENT_INTERFACE (GTK_TYPE_PRINT_OPERATION_PREVIEW,
85 * gtk_print_error_quark:
87 * Registers an error quark for #GtkPrintOperation if necessary.
89 * Return value: The error quark used for #GtkPrintOperation errors.
94 gtk_print_error_quark (void)
96 static GQuark quark = 0;
98 quark = g_quark_from_static_string ("gtk-print-error-quark");
103 gtk_print_operation_finalize (GObject *object)
105 GtkPrintOperation *print_operation = GTK_PRINT_OPERATION (object);
106 GtkPrintOperationPrivate *priv = print_operation->priv;
108 if (priv->free_platform_data &&
111 priv->free_platform_data (priv->platform_data);
112 priv->free_platform_data = NULL;
115 if (priv->default_page_setup)
116 g_object_unref (priv->default_page_setup);
118 if (priv->print_settings)
119 g_object_unref (priv->print_settings);
121 g_free (priv->pdf_target);
122 g_free (priv->job_name);
123 g_free (priv->custom_tab_label);
125 if (priv->print_pages_idle_id > 0)
126 g_source_remove (priv->print_pages_idle_id);
128 if (priv->show_progress_timeout_id > 0)
129 g_source_remove (priv->show_progress_timeout_id);
131 G_OBJECT_CLASS (gtk_print_operation_parent_class)->finalize (object);
135 gtk_print_operation_init (GtkPrintOperation *operation)
137 GtkPrintOperationPrivate *priv;
140 priv = operation->priv = GTK_PRINT_OPERATION_GET_PRIVATE (operation);
142 priv->status = GTK_PRINT_STATUS_INITIAL;
143 priv->status_string = g_strdup ("");
144 priv->default_page_setup = NULL;
145 priv->print_settings = NULL;
146 priv->nr_of_pages = -1;
147 priv->current_page = -1;
148 priv->use_full_page = FALSE;
149 priv->show_dialog = TRUE;
150 priv->show_preview = FALSE;
151 priv->show_progress = FALSE;
152 priv->pdf_target = NULL;
153 priv->track_print_status = FALSE;
154 priv->is_sync = FALSE;
157 priv->unit = GTK_UNIT_PIXEL;
159 appname = g_get_application_name ();
160 priv->job_name = g_strdup_printf ("%s job #%d", appname, ++job_nr);
164 preview_iface_render_page (GtkPrintOperationPreview *preview,
167 GtkPrintOperation *op;
169 op = GTK_PRINT_OPERATION (preview);
170 common_render_page (op, page_nr);
174 preview_iface_end_preview (GtkPrintOperationPreview *preview)
176 GtkPrintOperation *op;
178 op = GTK_PRINT_OPERATION (preview);
180 g_signal_emit (op, signals[END_PRINT], 0, op->priv->print_context);
183 g_main_loop_quit (op->priv->rloop);
185 op->priv->end_run (op, op->priv->is_sync, TRUE);
189 preview_iface_is_selected (GtkPrintOperationPreview *preview,
192 GtkPrintOperation *op;
193 GtkPrintOperationPrivate *priv;
196 op = GTK_PRINT_OPERATION (preview);
199 switch (priv->print_pages)
201 case GTK_PRINT_PAGES_ALL:
202 return (page_nr >= 0) && (page_nr < priv->nr_of_pages);
203 case GTK_PRINT_PAGES_CURRENT:
204 return page_nr == priv->current_page;
205 case GTK_PRINT_PAGES_RANGES:
206 for (i = 0; i < priv->num_page_ranges; i++)
208 if (page_nr >= priv->page_ranges[i].start &&
209 page_nr <= priv->page_ranges[i].end)
218 preview_iface_init (GtkPrintOperationPreviewIface *iface)
220 iface->render_page = preview_iface_render_page;
221 iface->end_preview = preview_iface_end_preview;
222 iface->is_selected = preview_iface_is_selected;
226 preview_start_page (GtkPrintOperation *op,
227 GtkPrintContext *print_context,
228 GtkPageSetup *page_setup)
230 g_signal_emit_by_name (op, "got-page-size",print_context, page_setup);
234 preview_end_page (GtkPrintOperation *op,
235 GtkPrintContext *print_context)
240 preview_end_run (GtkPrintOperation *op,
244 g_free (op->priv->page_ranges);
245 op->priv->page_ranges = NULL;
247 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED, NULL);
252 gtk_print_operation_set_property (GObject *object,
257 GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
261 case PROP_DEFAULT_PAGE_SETUP:
262 gtk_print_operation_set_default_page_setup (op, g_value_get_object (value));
264 case PROP_PRINT_SETTINGS:
265 gtk_print_operation_set_print_settings (op, g_value_get_object (value));
268 gtk_print_operation_set_job_name (op, g_value_get_string (value));
271 gtk_print_operation_set_n_pages (op, g_value_get_int (value));
273 case PROP_CURRENT_PAGE:
274 gtk_print_operation_set_current_page (op, g_value_get_int (value));
276 case PROP_USE_FULL_PAGE:
277 gtk_print_operation_set_use_full_page (op, g_value_get_boolean (value));
279 case PROP_TRACK_PRINT_STATUS:
280 gtk_print_operation_set_track_print_status (op, g_value_get_boolean (value));
283 gtk_print_operation_set_unit (op, g_value_get_enum (value));
285 case PROP_SHOW_DIALOG:
286 gtk_print_operation_set_show_dialog (op, g_value_get_boolean (value));
288 case PROP_SHOW_PREVIEW:
289 gtk_print_operation_set_show_preview (op, g_value_get_boolean (value));
291 case PROP_SHOW_PROGRESS:
292 gtk_print_operation_set_show_progress (op, g_value_get_boolean (value));
294 case PROP_PDF_TARGET:
295 gtk_print_operation_set_pdf_target (op, g_value_get_string (value));
297 case PROP_CUSTOM_TAB_LABEL:
298 gtk_print_operation_set_custom_tab_label (op, g_value_get_string (value));
301 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
307 gtk_print_operation_get_property (GObject *object,
312 GtkPrintOperation *op = GTK_PRINT_OPERATION (object);
313 GtkPrintOperationPrivate *priv = op->priv;
317 case PROP_DEFAULT_PAGE_SETUP:
318 g_value_set_object (value, priv->default_page_setup);
320 case PROP_PRINT_SETTINGS:
321 g_value_set_object (value, priv->print_settings);
324 g_value_set_string (value, priv->job_name);
327 g_value_set_int (value, priv->nr_of_pages);
329 case PROP_CURRENT_PAGE:
330 g_value_set_int (value, priv->current_page);
332 case PROP_USE_FULL_PAGE:
333 g_value_set_boolean (value, priv->use_full_page);
335 case PROP_TRACK_PRINT_STATUS:
336 g_value_set_boolean (value, priv->track_print_status);
339 g_value_set_enum (value, priv->unit);
341 case PROP_SHOW_DIALOG:
342 g_value_set_boolean (value, priv->show_dialog);
344 case PROP_SHOW_PREVIEW:
345 g_value_set_boolean (value, priv->show_preview);
347 case PROP_SHOW_PROGRESS:
348 g_value_set_boolean (value, priv->show_progress);
350 case PROP_PDF_TARGET:
351 g_value_set_string (value, priv->pdf_target);
354 g_value_set_enum (value, priv->status);
356 case PROP_STATUS_STRING:
357 g_value_set_string (value, priv->status_string);
359 case PROP_CUSTOM_TAB_LABEL:
360 g_value_set_string (value, priv->custom_tab_label);
363 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
370 GtkPrintOperationPreview *preview;
371 GtkPrintContext *print_context;
373 cairo_surface_t *surface;
380 preview_print_idle_done (gpointer data)
382 GtkPrintOperation *op;
383 PreviewOp *pop = (PreviewOp *) data;
385 GDK_THREADS_ENTER ();
387 op = GTK_PRINT_OPERATION (pop->preview);
389 _gtk_print_operation_platform_backend_launch_preview (op,
393 g_free (pop->filename);
394 cairo_surface_finish (pop->surface);
395 cairo_surface_destroy (pop->surface);
397 gtk_print_operation_preview_end_preview (pop->preview);
400 GDK_THREADS_LEAVE ();
404 preview_print_idle (gpointer data)
407 GtkPrintOperation *op;
408 gboolean retval = TRUE;
411 GDK_THREADS_ENTER ();
413 pop = (PreviewOp *) data;
414 op = GTK_PRINT_OPERATION (pop->preview);
416 gtk_print_operation_preview_render_page (pop->preview, pop->page_nr);
418 cr = gtk_print_context_get_cairo_context (pop->print_context);
419 cairo_show_page (cr);
421 /* TODO: print out sheets not pages and follow ranges */
423 if (op->priv->nr_of_pages <= pop->page_nr)
426 GDK_THREADS_LEAVE ();
432 preview_got_page_size (GtkPrintOperationPreview *preview,
433 GtkPrintContext *context,
434 GtkPageSetup *page_setup,
437 GtkPrintOperation *op = GTK_PRINT_OPERATION (preview);
439 _gtk_print_operation_platform_backend_resize_preview_surface (op, page_setup, pop->surface);
443 preview_ready (GtkPrintOperationPreview *preview,
444 GtkPrintContext *context,
449 pop->print_context = context;
451 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
454 preview_print_idle_done);
459 * gtk_print_operation_preview_handler:
461 * Default handler for preview operations
464 gtk_print_operation_preview_handler (GtkPrintOperation *op,
465 GtkPrintOperationPreview *preview,
466 GtkPrintContext *context,
469 gdouble dpi_x, dpi_y;
472 gchar *preview_filename;
474 GtkPageSetup *page_setup;
477 dir_template = g_build_filename (g_get_tmp_dir (), "print-preview-XXXXXX", NULL);
479 /* use temp dirs because apps like evince need to have extentions
480 to determine the mine type */
481 tmp_dir = mkdtemp(dir_template);
483 preview_filename = g_build_filename (tmp_dir,
487 g_free (dir_template);
489 pop = g_new0 (PreviewOp, 1);
490 pop->filename = preview_filename;
491 pop->preview = preview;
492 pop->parent = parent;
494 page_setup = gtk_print_context_get_page_setup (context);
497 _gtk_print_operation_platform_backend_create_preview_surface (op,
502 cr = cairo_create (pop->surface);
503 gtk_print_context_set_cairo_context (op->priv->print_context, cr,
507 g_signal_connect (preview, "ready", (GCallback) preview_ready, pop);
508 g_signal_connect (preview, "got-page-size", (GCallback) preview_got_page_size, pop);
514 gtk_print_operation_create_custom_widget (GtkPrintOperation *operation)
520 custom_widget_accumulator (GSignalInvocationHint *ihint,
522 const GValue *handler_return,
525 gboolean continue_emission;
528 widget = g_value_get_pointer (handler_return);
530 g_value_set_pointer (return_accu, widget);
531 continue_emission = (widget == NULL);
533 return continue_emission;
537 gtk_print_operation_class_init (GtkPrintOperationClass *class)
539 GObjectClass *gobject_class = (GObjectClass *)class;
541 gobject_class->set_property = gtk_print_operation_set_property;
542 gobject_class->get_property = gtk_print_operation_get_property;
543 gobject_class->finalize = gtk_print_operation_finalize;
545 class->preview = gtk_print_operation_preview_handler;
546 class->create_custom_widget = gtk_print_operation_create_custom_widget;
548 g_type_class_add_private (gobject_class, sizeof (GtkPrintOperationPrivate));
551 * GtkPrintOperation::begin-print:
552 * @operation: the #GtkPrintOperation on which the signal was emitted
553 * @context: the #GtkPrintContext for the current operation
555 * Gets emitted after the user has finished changing print settings
556 * in the dialog, before the actual rendering starts.
558 * A typical use for this signal is to use the parameters from the
559 * #GtkPrintContext and paginate the document accordingly, and then
560 * set the number of pages with gtk_print_operation_set_n_pages().
564 signals[BEGIN_PRINT] =
565 g_signal_new (I_("begin-print"),
566 G_TYPE_FROM_CLASS (gobject_class),
568 G_STRUCT_OFFSET (GtkPrintOperationClass, begin_print),
570 g_cclosure_marshal_VOID__OBJECT,
571 G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);
574 * Gtkprintoperation::paginate:
575 * @operation: the #GtkPrintOperation on which the signal was emitted
576 * @context: the #GtkPrintContext for the current operation
578 * Gets emitted after the begin-print signal, but before the actual
579 * rendering starts. It keeps getting emitted until it returns %FALSE.
581 * This signal is intended to be used for paginating the document
582 * in small chunks, to avoid blocking the user interface for a long
583 * time. The signal handler should update the number of pages using
584 * gtk_print_operation_set_n_pages(), and return %TRUE if the document
585 * has been completely paginated.
587 * If you don't need to do pagination in chunks, you can simply do
588 * it all in the begin-print handler, and set the number of pages
594 g_signal_new (I_("paginate"),
595 G_TYPE_FROM_CLASS (gobject_class),
597 G_STRUCT_OFFSET (GtkPrintOperationClass, paginate),
598 _gtk_boolean_handled_accumulator, NULL,
599 _gtk_marshal_BOOLEAN__OBJECT,
600 G_TYPE_BOOLEAN, 1, GTK_TYPE_PRINT_CONTEXT);
604 * GtkPrintOperation::request-page-setup:
605 * @operation: the #GtkPrintOperation on which the signal was emitted
606 * @context: the #GtkPrintContext for the current operation
607 * @page_nr: the number of the currently printed page
608 * @setup: the #GtkPageSetup
610 * Gets emitted once for every page that is printed, to give
611 * the application a chance to modify the page setup. Any changes
612 * done to @setup will be in force only for printing this page.
616 signals[REQUEST_PAGE_SETUP] =
617 g_signal_new (I_("request-page-setup"),
618 G_TYPE_FROM_CLASS (gobject_class),
620 G_STRUCT_OFFSET (GtkPrintOperationClass, request_page_setup),
622 _gtk_marshal_VOID__OBJECT_INT_OBJECT,
624 GTK_TYPE_PRINT_CONTEXT,
626 GTK_TYPE_PAGE_SETUP);
629 * GtkPrintOperation::draw-page:
630 * @operation: the #GtkPrintOperation on which the signal was emitted
631 * @context: the #GtkPrintContext for the current operation
632 * @page_nr: the number of the currently printed page
634 * Gets emitted for every page that is printed. The signal handler
635 * must render the @page_nr's page onto the cairo context obtained
636 * from @context using gtk_print_context_get_cairo_context().
638 * <informalexample><programlisting>
640 * draw_page (GtkPrintOperation *operation,
641 * GtkPrintContext *context,
643 * gpointer user_data)
646 * PangoLayout *layout;
647 * gdouble width, text_height;
648 * gint layout_height;
649 * PangoFontDescription *desc;
651 * cr = gtk_print_context_get_cairo_context (context);
652 * width = gtk_print_context_get_width (context);
654 * cairo_rectangle (cr, 0, 0, width, HEADER_HEIGHT);
656 * cairo_set_source_rgb (cr, 0.8, 0.8, 0.8);
659 * layout = gtk_print_context_create_pango_layout (context);
661 * desc = pango_font_description_from_string ("sans 14");
662 * pango_layout_set_font_description (layout, desc);
663 * pango_font_description_free (desc);
665 * pango_layout_set_text (layout, "some text", -1);
666 * pango_layout_set_width (layout, width);
667 * pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);
669 * pango_layout_get_size (layout, NULL, &layout_height);
670 * text_height = (gdouble)layout_height / PANGO_SCALE;
672 * cairo_move_to (cr, width / 2, (HEADER_HEIGHT - text_height) / 2);
673 * pango_cairo_show_layout (cr, layout);
675 * g_object_unref (layout);
677 * </programlisting></informalexample>
679 * Use gtk_print_operation_set_use_full_page() and
680 * gtk_print_operation_set_unit() before starting the print operation
681 * to set up the transformation of the cairo context according to your
687 g_signal_new (I_("draw-page"),
688 G_TYPE_FROM_CLASS (gobject_class),
690 G_STRUCT_OFFSET (GtkPrintOperationClass, draw_page),
692 _gtk_marshal_VOID__OBJECT_INT,
694 GTK_TYPE_PRINT_CONTEXT,
698 * GtkPrintOperation::end-print:
699 * @operation: the #GtkPrintOperation on which the signal was emitted
700 * @context: the #GtkPrintContext for the current operation
702 * Gets emitted after all pages have been rendered.
703 * A handler for this signal can clean up any resources that have
704 * been allocated in the ::begin-print handler.
709 g_signal_new (I_("end-print"),
710 G_TYPE_FROM_CLASS (gobject_class),
712 G_STRUCT_OFFSET (GtkPrintOperationClass, end_print),
714 g_cclosure_marshal_VOID__OBJECT,
715 G_TYPE_NONE, 1, GTK_TYPE_PRINT_CONTEXT);
718 * GtkPrintOperation::status-changed:
719 * @operation: the #GtkPrintOperation on which the signal was emitted
721 * Gets emitted at between the various phases of the print operation.
722 * See #GtkPrintStatus for the phases that are being discriminated.
723 * Use gtk_print_operation_get_status() to find out the current
728 signals[STATUS_CHANGED] =
729 g_signal_new (I_("status-changed"),
730 G_TYPE_FROM_CLASS (class),
732 G_STRUCT_OFFSET (GtkPrintOperationClass, status_changed),
734 g_cclosure_marshal_VOID__VOID,
739 * GtkPrintOperation::create-custom-widget:
740 * @operation: the #GtkPrintOperation on which the signal was emitted
742 * Gets emitted when displaying the print dialog. If you return a
743 * widget in a handler for this signal it will be added to a custom
744 * tab in the print dialog. You typically return a container widget
745 * with multiple widgets in it.
747 * The print dialog owns the returned widget, and its lifetime
748 * isn't controlled by the app. However, the widget is guaranteed
749 * to stay around until the custom-widget-apply signal is emitted
750 * on the operation. Then you can read out any information you need
753 * Returns: A custom widget that gets embedded in the print dialog,
758 signals[CREATE_CUSTOM_WIDGET] =
759 g_signal_new (I_("create-custom-widget"),
760 G_TYPE_FROM_CLASS (class),
762 G_STRUCT_OFFSET (GtkPrintOperationClass, create_custom_widget),
763 custom_widget_accumulator, NULL,
764 _gtk_marshal_POINTER__VOID,
768 * GtkPrintOperation::custom-widget-apply:
769 * @operation: the #GtkPrintOperation on which the signal was emitted
770 * @widget: the custom widget added in create-custom-widget
772 * This signal gets emitted right before begin-print if you added
773 * a custom widget in the create-custom-widget handler. When you get
774 * this signal you should read the information from the custom widgets,
775 * as the widgets are not guaraneed to be around at a later time.
779 signals[CUSTOM_WIDGET_APPLY] =
780 g_signal_new (I_("custom-widget-apply"),
781 G_TYPE_FROM_CLASS (class),
783 G_STRUCT_OFFSET (GtkPrintOperationClass, custom_widget_apply),
785 g_cclosure_marshal_VOID__OBJECT,
786 G_TYPE_NONE, 1, GTK_TYPE_WIDGET);
789 * GtkPrintOperation::preview:
790 * @operation: the #GtkPrintOperation on which the signal was emitted
791 * @preview: the #GtkPrintPreviewOperation for the current operation
792 * @context: the #GtkPrintContext that will be used
793 * @parent: the #GtkWindow to use as window parent, or NULL
795 * Gets emitted when a preview is requested from the native dialog.
796 * If you handle this you must set the cairo context on the printing context.
798 * If you don't override this a default implementation using an external
799 * viewer will be used.
801 * Returns: #TRUE if the listener wants to take over control of the preview
806 g_signal_new (I_("preview"),
807 G_TYPE_FROM_CLASS (gobject_class),
809 G_STRUCT_OFFSET (GtkPrintOperationClass, preview),
810 _gtk_boolean_handled_accumulator, NULL,
811 _gtk_marshal_BOOLEAN__OBJECT_OBJECT_OBJECT,
813 GTK_TYPE_PRINT_OPERATION_PREVIEW,
814 GTK_TYPE_PRINT_CONTEXT,
819 * GtkPrintOperation:default-page-setup:
821 * The #GtkPageSetup used by default.
823 * This page setup will be used by gtk_print_operation_run(),
824 * but it can be overridden on a per-page basis by connecting
825 * to the ::request-page-setup signal.
829 g_object_class_install_property (gobject_class,
830 PROP_DEFAULT_PAGE_SETUP,
831 g_param_spec_object ("default-page-setup",
832 P_("Default Page Setup"),
833 P_("The GtkPageSetup used by default"),
835 GTK_PARAM_READWRITE));
838 * GtkPrintOperation:print-settings:
840 * The #GtkPrintSettings used for initializing the dialog.
842 * Setting this property is typically used to re-establish
843 * print settings from a previous print operation, see
844 * gtk_print_operation_run().
848 g_object_class_install_property (gobject_class,
850 g_param_spec_object ("print-settings",
851 P_("Print Settings"),
852 P_("The GtkPrintSettings used for initializing the dialog"),
853 GTK_TYPE_PRINT_SETTINGS,
854 GTK_PARAM_READWRITE));
857 * GtkPrintOperation:job-name:
859 * A string used to identify the job (e.g. in monitoring
860 * applications like eggcups).
862 * If you don't set a job name, GTK+ picks a default one
863 * by numbering successive print jobs.
867 g_object_class_install_property (gobject_class,
869 g_param_spec_string ("job-name",
871 P_("A string used for identifying the print job."),
873 GTK_PARAM_READWRITE));
876 * GtkPrintOperation:n-pages:
878 * The number of pages in the document.
880 * This <emphasis>must</emphasis> be set to a positive number
881 * before the rendering starts. It may be set in a ::begin-print
884 * Note that the page numbers passed to the ::request-page-setup
885 * and ::draw-page signals are 0-based, i.e. if the user chooses
886 * to print all pages, the last ::draw-page signal will be for
891 g_object_class_install_property (gobject_class,
893 g_param_spec_int ("n-pages",
894 P_("Number of Pages"),
895 P_("The number of pages in the document."),
899 GTK_PARAM_READWRITE));
902 * GtkPrintOperation:current-page:
904 * The current page in the document.
906 * If this is set before gtk_print_operation_run(),
907 * the user will be able to select to print only the current page.
909 * Note that this only makes sense for pre-paginated documents.
913 g_object_class_install_property (gobject_class,
915 g_param_spec_int ("current-page",
917 P_("The current page in the document."),
921 GTK_PARAM_READWRITE));
924 * GtkPrintOperation:use-full-page:
926 * If %TRUE, the transformation for the cairo context obtained
927 * from #GtkPrintContext puts the origin at the top left corner
928 * of the page (which may not be the top left corner of the sheet,
929 * depending on page orientation and the number of pages per sheet).
930 * Otherwise, the origin is at the top left corner of the imageable
931 * area (i.e. inside the margins).
935 g_object_class_install_property (gobject_class,
937 g_param_spec_boolean ("use-full-page",
939 P_("TRUE if the the origin of the context should be at the corner of the page and not the corner of the imageable area"),
941 GTK_PARAM_READWRITE));
945 * GtkPrintOperation:track-print-status:
947 * If %TRUE, the print operation will try to continue report on
948 * the status of the print job in the printer queues and printer.
949 * This can allow your application to show things like "out of paper"
950 * issues, and when the print job actually reaches the printer.
951 * However, this is often implemented using polling, and should
952 * not be enabled unless needed.
956 g_object_class_install_property (gobject_class,
958 g_param_spec_boolean ("track-print-status",
959 P_("Track Print Status"),
960 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."),
962 GTK_PARAM_READWRITE));
966 * GtkPrintOperation:unit:
968 * The transformation for the cairo context obtained from
969 * #GtkPrintContext is set up in such a way that distances
970 * are measured in units of @unit.
974 g_object_class_install_property (gobject_class,
976 g_param_spec_enum ("unit",
978 P_("The unit in which distances can be measured in the context"),
981 GTK_PARAM_READWRITE));
985 * GtkPrintOperation:show-dialog:
987 * Determines whether calling gtk_print_operation_run() will present
988 * a print dialog to the user, or just print to the default printer.
992 g_object_class_install_property (gobject_class,
994 g_param_spec_boolean ("show-dialog",
996 P_("TRUE if gtk_print_operation_run() should show the print dialog."),
998 GTK_PARAM_READWRITE));
1001 * GtkPrintOperation:show-preview:
1003 * Determines whether calling gtk_print_operation_run() will present
1004 * the print preview to the user.
1008 g_object_class_install_property (gobject_class,
1010 g_param_spec_boolean ("show-preview",
1012 P_("TRUE if gtk_print_operation_run() should show the print preview."),
1014 GTK_PARAM_READWRITE));
1017 * GtkPrintOperation:show-progress:
1019 * Determines whether to show a progress dialog during the
1024 g_object_class_install_property (gobject_class,
1026 g_param_spec_boolean ("show-progress",
1028 P_("TRUE if a progress dialog is shown while printing."),
1030 GTK_PARAM_READWRITE));
1034 * GtkPrintOperation:pdf-target:
1036 * The name of a PDF file to generate instead of showing
1039 * The intended use of this property is for implementing
1040 * "Export to PDF" actions.
1042 * "Print to PDF" support is independent of this and is done
1043 * by letting the user pick the "Print to PDF" item from the
1044 * list of printers in the print dialog.
1048 g_object_class_install_property (gobject_class,
1050 g_param_spec_string ("pdf-target",
1051 P_("PDF target filename"),
1052 P_("PDF target filename"),
1054 GTK_PARAM_READWRITE));
1057 * GtkPrintOperation:status:
1059 * The status of the print operation.
1063 g_object_class_install_property (gobject_class,
1065 g_param_spec_enum ("status",
1067 P_("The status of the print operation"),
1068 GTK_TYPE_PRINT_STATUS,
1069 GTK_PRINT_STATUS_INITIAL,
1070 GTK_PARAM_READABLE));
1073 * GtkPrintOperation:status-string:
1075 * A string representation of the status of the print operation.
1076 * The string is translated and suitable for displaying the print
1077 * status e.g. in a #GtkStatusbar.
1079 * See the ::status property for a status value that is suitable
1080 * for programmatic use.
1084 g_object_class_install_property (gobject_class,
1086 g_param_spec_string ("status-string",
1087 P_("Status String"),
1088 P_("A human-readable description of the status"),
1090 GTK_PARAM_READABLE));
1094 * GtkPrintOperation:custom-tab-label:
1096 * Used as the label of the tab containing custom widgets.
1097 * Note that this property may be ignored on some platforms.
1099 * If this is %NULL, GTK+ uses a default label.
1103 g_object_class_install_property (gobject_class,
1104 PROP_CUSTOM_TAB_LABEL,
1105 g_param_spec_string ("custom-tab-label",
1106 P_("Custom tab label"),
1107 P_("Label for the tab containing custom widgets."),
1109 GTK_PARAM_READWRITE));
1114 * gtk_print_operation_new:
1116 * Creates a new #GtkPrintOperation.
1118 * Returns: a new #GtkPrintOperation
1123 gtk_print_operation_new (void)
1125 GtkPrintOperation *print_operation;
1127 print_operation = g_object_new (GTK_TYPE_PRINT_OPERATION, NULL);
1129 return print_operation;
1133 * gtk_print_operation_set_default_page_setup:
1134 * @op: a #GtkPrintOperation
1135 * @default_page_setup: a #GtkPageSetup, or %NULL
1137 * Makes @default_page_setup the default page setup for @op.
1139 * This page setup will be used by gtk_print_operation_run(),
1140 * but it can be overridden on a per-page basis by connecting
1141 * to the ::request-page-setup signal.
1146 gtk_print_operation_set_default_page_setup (GtkPrintOperation *op,
1147 GtkPageSetup *default_page_setup)
1149 GtkPrintOperationPrivate *priv;
1151 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1152 g_return_if_fail (default_page_setup == NULL ||
1153 GTK_IS_PAGE_SETUP (default_page_setup));
1157 if (default_page_setup != priv->default_page_setup)
1159 if (default_page_setup)
1160 g_object_ref (default_page_setup);
1162 if (priv->default_page_setup)
1163 g_object_unref (priv->default_page_setup);
1165 priv->default_page_setup = default_page_setup;
1167 g_object_notify (G_OBJECT (op), "default-page-setup");
1172 * gtk_print_operation_get_default_page_setup:
1173 * @op: a #GtkPrintOperation
1175 * Returns the default page setup, see
1176 * gtk_print_operation_set_default_page_setup().
1178 * Returns: the default page setup
1183 gtk_print_operation_get_default_page_setup (GtkPrintOperation *op)
1185 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);
1187 return op->priv->default_page_setup;
1192 * gtk_print_operation_set_print_settings:
1193 * @op: a #GtkPrintOperation
1194 * @print_settings: #GtkPrintSettings, or %NULL
1196 * Sets the print settings for @op. This is typically used to
1197 * re-establish print settings from a previous print operation,
1198 * see gtk_print_operation_run().
1203 gtk_print_operation_set_print_settings (GtkPrintOperation *op,
1204 GtkPrintSettings *print_settings)
1206 GtkPrintOperationPrivate *priv;
1208 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1209 g_return_if_fail (print_settings == NULL ||
1210 GTK_IS_PRINT_SETTINGS (print_settings));
1214 if (print_settings != priv->print_settings)
1217 g_object_ref (print_settings);
1219 if (priv->print_settings)
1220 g_object_unref (priv->print_settings);
1222 priv->print_settings = print_settings;
1224 g_object_notify (G_OBJECT (op), "print-settings");
1229 * gtk_print_operation_get_print_settings:
1230 * @op: a #GtkPrintOperation
1232 * Returns the current print settings.
1234 * Note that the return value is %NULL until either
1235 * gtk_print_operation_set_print_settings() or
1236 * gtk_print_operation_run() have been called.
1238 * Return value: the current print settings of @op.
1243 gtk_print_operation_get_print_settings (GtkPrintOperation *op)
1245 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), NULL);
1247 return op->priv->print_settings;
1251 * gtk_print_operation_set_job_name:
1252 * @op: a #GtkPrintOperation
1253 * @job_name: a string that identifies the print job
1255 * Sets the name of the print job. The name is used to identify
1256 * the job (e.g. in monitoring applications like eggcups).
1258 * If you don't set a job name, GTK+ picks a default one by
1259 * numbering successive print jobs.
1264 gtk_print_operation_set_job_name (GtkPrintOperation *op,
1265 const gchar *job_name)
1267 GtkPrintOperationPrivate *priv;
1269 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1270 g_return_if_fail (g_utf8_validate (job_name, -1, NULL));
1274 g_free (priv->job_name);
1275 priv->job_name = g_strdup (job_name);
1277 g_object_notify (G_OBJECT (op), "job-name");
1281 * gtk_print_operation_set_n_pages:
1282 * @op: a #GtkPrintOperation
1283 * @n_pages: the number of pages
1285 * Sets the number of pages in the document.
1287 * This <emphasis>must</emphasis> be set to a positive number
1288 * before the rendering starts. It may be set in a ::begin-print
1291 * Note that the page numbers passed to the ::request-page-setup
1292 * and ::draw-page signals are 0-based, i.e. if the user chooses
1293 * to print all pages, the last ::draw-page signal will be
1294 * for page @n_pages - 1.
1299 gtk_print_operation_set_n_pages (GtkPrintOperation *op,
1302 GtkPrintOperationPrivate *priv;
1304 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1305 g_return_if_fail (n_pages > 0);
1308 g_return_if_fail (priv->current_page == -1 ||
1309 priv->current_page < n_pages);
1311 if (priv->nr_of_pages != n_pages)
1313 priv->nr_of_pages = n_pages;
1315 g_object_notify (G_OBJECT (op), "n-pages");
1320 * gtk_print_operation_set_current_page:
1321 * @op: a #GtkPrintOperation
1322 * @current_page: the current page, 0-based
1324 * Sets the current page.
1326 * If this is called before gtk_print_operation_run(),
1327 * the user will be able to select to print only the current page.
1329 * Note that this only makes sense for pre-paginated documents.
1334 gtk_print_operation_set_current_page (GtkPrintOperation *op,
1337 GtkPrintOperationPrivate *priv;
1339 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1340 g_return_if_fail (current_page >= 0);
1343 g_return_if_fail (priv->nr_of_pages == -1 ||
1344 current_page < priv->nr_of_pages);
1346 if (priv->current_page != current_page)
1348 priv->current_page = current_page;
1350 g_object_notify (G_OBJECT (op), "current-page");
1355 * gtk_print_operation_set_use_full_page:
1356 * @op: a #GtkPrintOperation
1357 * @full_page: %TRUE to set up the #GtkPrintContext for the full page
1359 * If @full_page is %TRUE, the transformation for the cairo context
1360 * obtained from #GtkPrintContext puts the origin at the top left
1361 * corner of the page (which may not be the top left corner of the
1362 * sheet, depending on page orientation and the number of pages per
1363 * sheet). Otherwise, the origin is at the top left corner of the
1364 * imageable area (i.e. inside the margins).
1369 gtk_print_operation_set_use_full_page (GtkPrintOperation *op,
1372 GtkPrintOperationPrivate *priv;
1374 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1376 full_page = full_page != FALSE;
1380 if (priv->use_full_page != full_page)
1382 priv->use_full_page = full_page;
1384 g_object_notify (G_OBJECT (op), "use-full-page");
1389 * gtk_print_operation_set_unit:
1390 * @op: a #GtkPrintOperation
1391 * @unit: the unit to use
1393 * Sets up the transformation for the cairo context obtained from
1394 * #GtkPrintContext in such a way that distances are measured in
1400 gtk_print_operation_set_unit (GtkPrintOperation *op,
1403 GtkPrintOperationPrivate *priv;
1405 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1409 if (priv->unit != unit)
1413 g_object_notify (G_OBJECT (op), "unit");
1418 * gtk_print_operation_set_track_print_status:
1419 * @op: a #GtkPrintOperation
1420 * @track_status: %TRUE to track status after printing
1422 * If track_status is %TRUE, the print operation will try to continue report
1423 * on the status of the print job in the printer queues and printer. This
1424 * can allow your application to show things like "out of paper" issues,
1425 * and when the print job actually reaches the printer.
1427 * This function is often implemented using some form of polling, so it should
1428 * not be enabled unless needed.
1433 gtk_print_operation_set_track_print_status (GtkPrintOperation *op,
1434 gboolean track_status)
1436 GtkPrintOperationPrivate *priv;
1438 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1442 if (priv->track_print_status != track_status)
1444 priv->track_print_status = track_status;
1446 g_object_notify (G_OBJECT (op), "track-print-status");
1451 _gtk_print_operation_set_status (GtkPrintOperation *op,
1452 GtkPrintStatus status,
1453 const gchar *string)
1455 GtkPrintOperationPrivate *priv = op->priv;
1456 static const gchar *status_strs[] = {
1457 /* translators, strip the prefix up to and including the first | */
1458 N_("print operation status|Initial state"),
1459 /* translators, strip the prefix up to and including the first | */
1460 N_("print operation status|Preparing to print"),
1461 /* translators, strip the prefix up to and including the first | */
1462 N_("print operation status|Generating data"),
1463 /* translators, strip the prefix up to and including the first | */
1464 N_("print operation status|Sending data"),
1465 /* translators, strip the prefix up to and including the first | */
1466 N_("print operation status|Waiting"),
1467 /* translators, strip the prefix up to and including the first | */
1468 N_("print operation status|Blocking on issue"),
1469 /* translators, strip the prefix up to and including the first | */
1470 N_("print operation status|Printing"),
1471 /* translators, strip the prefix up to and including the first | */
1472 N_("print operation status|Finished"),
1473 /* translators, strip the prefix up to and including the first | */
1474 N_("print operation status|Finished with error")
1477 if (status < 0 || status > GTK_PRINT_STATUS_FINISHED_ABORTED)
1478 status = GTK_PRINT_STATUS_FINISHED_ABORTED;
1481 string = g_strip_context (status_strs[status],
1482 gettext (status_strs[status]));
1484 if (priv->status == status &&
1485 strcmp (string, priv->status_string) == 0)
1488 g_free (priv->status_string);
1489 priv->status_string = g_strdup (string);
1490 priv->status = status;
1492 g_object_notify (G_OBJECT (op), "status");
1493 g_object_notify (G_OBJECT (op), "status-string");
1495 g_signal_emit (op, signals[STATUS_CHANGED], 0);
1500 * gtk_print_operation_get_status:
1501 * @op: a #GtkPrintOperation
1503 * Returns the status of the print operation.
1504 * Also see gtk_print_operation_get_status_string().
1506 * Return value: the status of the print operation
1511 gtk_print_operation_get_status (GtkPrintOperation *op)
1513 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op),
1514 GTK_PRINT_STATUS_FINISHED_ABORTED);
1516 return op->priv->status;
1520 * gtk_print_operation_get_status_string:
1521 * @op: a #GtkPrintOperation
1523 * Returns a string representation of the status of the
1524 * print operation. The string is translated and suitable
1525 * for displaying the print status e.g. in a #GtkStatusbar.
1527 * Use gtk_print_operation_get_status() to obtain a status
1528 * value that is suitable for programmatic use.
1530 * Return value: a string representation of the status
1531 * of the print operation
1535 G_CONST_RETURN gchar *
1536 gtk_print_operation_get_status_string (GtkPrintOperation *op)
1538 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), "");
1540 return op->priv->status_string;
1544 * gtk_print_operation_is_finished:
1545 * @op: a #GtkPrintOperation
1547 * A convenience function to find out if the print operation
1548 * is finished, either successfully (%GTK_PRINT_STATUS_FINISHED)
1549 * or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED).
1551 * Return value: %TRUE, if the print operation is finished.
1556 gtk_print_operation_is_finished (GtkPrintOperation *op)
1558 GtkPrintOperationPrivate *priv;
1560 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op), TRUE);
1564 priv->status == GTK_PRINT_STATUS_FINISHED_ABORTED ||
1565 priv->status == GTK_PRINT_STATUS_FINISHED;
1570 * gtk_print_operation_set_show_dialog:
1571 * @op: a #GtkPrintOperation
1572 * @show_dialog: %TRUE to show the print dialog
1574 * Sets whether calling gtk_print_operation_run() will present
1575 * a print dialog to the user, or just print to the default printer.
1580 gtk_print_operation_set_show_dialog (GtkPrintOperation *op,
1581 gboolean show_dialog)
1583 GtkPrintOperationPrivate *priv;
1585 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1589 show_dialog = show_dialog != FALSE;
1591 if (priv->show_dialog != show_dialog)
1593 priv->show_dialog = show_dialog;
1595 g_object_notify (G_OBJECT (op), "show-dialog");
1600 * gtk_print_operation_set_show_preview:
1601 * @op: a #GtkPrintOperation
1602 * @show_preview: %TRUE to show the print preview
1604 * Sets whether calling gtk_print_operation_run() will present
1605 * the print preview to the user.
1610 gtk_print_operation_set_show_preview (GtkPrintOperation *op,
1611 gboolean show_preview)
1613 GtkPrintOperationPrivate *priv;
1615 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1619 show_preview = show_preview != FALSE;
1621 if (priv->show_preview != show_preview)
1623 priv->show_preview = show_preview;
1625 g_object_notify (G_OBJECT (op), "show-preview");
1630 * gtk_print_operation_set_show_progress:
1631 * @op: a #GtkPrintOperation
1632 * @show_progress: %TRUE to show a progress dialog
1634 * If @show_progress is %TRUE, the print operation will show a
1635 * progress dialog during the print operation.
1640 gtk_print_operation_set_show_progress (GtkPrintOperation *op,
1641 gboolean show_progress)
1643 GtkPrintOperationPrivate *priv;
1645 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1649 show_progress = show_progress != FALSE;
1651 if (priv->show_progress != show_progress)
1653 priv->show_progress = show_progress;
1655 g_object_notify (G_OBJECT (op), "show-progress");
1660 * gtk_print_operation_set_custom_tag_label:
1661 * @op: a #GtkPrintOperation
1662 * @label: the label to use, or %NULL to use the default label
1664 * Sets the label for the tab holding custom widgets.
1669 gtk_print_operation_set_custom_tab_label (GtkPrintOperation *op,
1672 GtkPrintOperationPrivate *priv;
1674 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1678 g_free (priv->custom_tab_label);
1679 priv->custom_tab_label = g_strdup (label);
1681 g_object_notify (G_OBJECT (op), "custom-tab-label");
1686 * gtk_print_operation_set_pdf_target:
1687 * @op: a #GtkPrintOperation
1688 * @filename: the filename for the PDF file
1690 * Sets up the #GtkPrintOperation to generate a PDF file instead
1691 * of showing the print dialog. The indended use of this function
1692 * is for implementing "Export to PDF" actions.
1694 * "Print to PDF" support is independent of this and is done
1695 * by letting the user pick the "Print to PDF" item from the list
1696 * of printers in the print dialog.
1701 gtk_print_operation_set_pdf_target (GtkPrintOperation *op,
1702 const gchar *filename)
1704 GtkPrintOperationPrivate *priv;
1706 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
1710 g_free (priv->pdf_target);
1711 priv->pdf_target = g_strdup (filename);
1713 g_object_notify (G_OBJECT (op), "pdf-target");
1716 /* Creates the initial page setup used for printing unless the
1717 * app overrides this on a per-page basis using request_page_setup.
1719 * Data is taken from, in order, if existing:
1721 * PrintSettings returned from the print dialog
1722 * (initial dialog values are set from default_page_setup
1723 * if unset in app specified print_settings)
1724 * default_page_setup
1725 * per-locale default setup
1727 static GtkPageSetup *
1728 create_page_setup (GtkPrintOperation *op)
1730 GtkPrintOperationPrivate *priv = op->priv;
1731 GtkPageSetup *page_setup;
1732 GtkPrintSettings *settings;
1734 if (priv->default_page_setup)
1735 page_setup = gtk_page_setup_copy (priv->default_page_setup);
1737 page_setup = gtk_page_setup_new ();
1739 settings = priv->print_settings;
1742 GtkPaperSize *paper_size;
1744 if (gtk_print_settings_has_key (settings, GTK_PRINT_SETTINGS_ORIENTATION))
1745 gtk_page_setup_set_orientation (page_setup,
1746 gtk_print_settings_get_orientation (settings));
1749 paper_size = gtk_print_settings_get_paper_size (settings);
1752 gtk_page_setup_set_paper_size (page_setup, paper_size);
1753 gtk_paper_size_free (paper_size);
1756 /* TODO: Margins? */
1763 pdf_start_page (GtkPrintOperation *op,
1764 GtkPrintContext *print_context,
1765 GtkPageSetup *page_setup)
1767 GtkPaperSize *paper_size;
1768 cairo_surface_t *surface = op->priv->platform_data;
1771 paper_size = gtk_page_setup_get_paper_size (page_setup);
1773 w = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
1774 h = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
1776 cairo_pdf_surface_set_size (surface, w, h);
1780 pdf_end_page (GtkPrintOperation *op,
1781 GtkPrintContext *print_context)
1785 cr = gtk_print_context_get_cairo_context (print_context);
1786 cairo_show_page (cr);
1790 pdf_end_run (GtkPrintOperation *op,
1794 GtkPrintOperationPrivate *priv = op->priv;
1795 cairo_surface_t *surface = priv->platform_data;
1797 cairo_surface_finish (surface);
1798 cairo_surface_destroy (surface);
1801 static GtkPrintOperationResult
1802 run_pdf (GtkPrintOperation *op,
1807 GtkPrintOperationPrivate *priv = op->priv;
1808 GtkPageSetup *page_setup;
1809 cairo_surface_t *surface;
1811 double width, height;
1812 /* This will be overwritten later by the non-default size, but
1813 we need to pass some size: */
1815 page_setup = create_page_setup (op);
1816 width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_POINTS);
1817 height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_POINTS);
1818 g_object_unref (page_setup);
1820 surface = cairo_pdf_surface_create (priv->pdf_target,
1822 cairo_pdf_surface_set_dpi (surface, 300, 300);
1824 priv->platform_data = surface;
1825 priv->free_platform_data = (GDestroyNotify) cairo_surface_destroy;
1827 cr = cairo_create (surface);
1828 gtk_print_context_set_cairo_context (op->priv->print_context,
1833 priv->print_pages = GTK_PRINT_PAGES_ALL;
1834 priv->page_ranges = NULL;
1835 priv->num_page_ranges = 0;
1837 priv->manual_num_copies = 1;
1838 priv->manual_collation = FALSE;
1839 priv->manual_reverse = FALSE;
1840 priv->manual_page_set = GTK_PAGE_SET_ALL;
1841 priv->manual_scale = 1.0;
1842 priv->manual_orientation = TRUE;
1846 priv->start_page = pdf_start_page;
1847 priv->end_page = pdf_end_page;
1848 priv->end_run = pdf_end_run;
1850 return GTK_PRINT_OPERATION_RESULT_APPLY;
1855 GtkPrintOperation *op;
1856 gint uncollated_copies;
1857 gint collated_copies;
1858 gint uncollated, collated, total;
1860 gint range, num_ranges;
1861 GtkPageRange *ranges;
1862 GtkPageRange one_range;
1864 gint page, start, end, inc;
1866 gboolean initialized;
1868 GtkWidget *progress;
1870 gboolean is_preview;
1874 find_range (PrintPagesData *data)
1876 GtkPageRange *range;
1878 range = &data->ranges[data->range];
1882 data->start = range->end;
1883 data->end = range->start - 1;
1887 data->start = range->start;
1888 data->end = range->end + 1;
1893 increment_page_sequence (PrintPagesData *data)
1895 GtkPrintOperationPrivate *priv = data->op->priv;
1898 data->page += data->inc;
1899 if (data->page == data->end)
1901 data->range += data->inc;
1902 if (data->range == -1 || data->range == data->num_ranges)
1905 if (data->uncollated == data->uncollated_copies)
1908 data->range = data->inc < 0 ? data->num_ranges - 1 : 0;
1911 data->page = data->start;
1914 while ((priv->manual_page_set == GTK_PAGE_SET_EVEN && data->page % 2 == 0) ||
1915 (priv->manual_page_set == GTK_PAGE_SET_ODD && data->page % 2 == 1));
1921 print_pages_idle_done (gpointer user_data)
1923 PrintPagesData *data;
1924 GtkPrintOperationPrivate *priv;
1926 GDK_THREADS_ENTER ();
1928 data = (PrintPagesData*)user_data;
1929 priv = data->op->priv;
1931 priv->print_pages_idle_id = 0;
1933 if (priv->show_progress_timeout_id > 0)
1935 g_source_remove (priv->show_progress_timeout_id);
1936 priv->show_progress_timeout_id = 0;
1940 gtk_widget_destroy (data->progress);
1942 g_object_unref (data->op);
1944 if (priv->rloop && !data->is_preview)
1945 g_main_loop_quit (priv->rloop);
1949 GDK_THREADS_LEAVE ();
1953 update_progress (PrintPagesData *data)
1955 GtkPrintOperationPrivate *priv;
1958 priv = data->op->priv;
1962 if (priv->status == GTK_PRINT_STATUS_PREPARING)
1964 if (priv->nr_of_pages > 0)
1965 text = g_strdup_printf (_("Preparing %d"), priv->nr_of_pages);
1967 text = g_strdup (_("Preparing"));
1969 else if (priv->status == GTK_PRINT_STATUS_GENERATING_DATA)
1970 text = g_strdup_printf (_("Printing %d"), data->total);
1974 g_object_set (data->progress, "text", text, NULL);
1981 common_render_page (GtkPrintOperation *op,
1984 GtkPrintOperationPrivate *priv = op->priv;
1985 GtkPageSetup *page_setup;
1986 GtkPrintContext *print_context;
1989 print_context = priv->print_context;
1991 page_setup = create_page_setup (op);
1993 g_signal_emit (op, signals[REQUEST_PAGE_SETUP], 0,
1994 print_context, page_nr, page_setup);
1996 _gtk_print_context_set_page_setup (print_context, page_setup);
1998 priv->start_page (op, print_context, page_setup);
2000 cr = gtk_print_context_get_cairo_context (print_context);
2003 if (priv->manual_scale != 1.0)
2006 priv->manual_scale);
2008 if (priv->manual_orientation)
2009 _gtk_print_context_rotate_according_to_orientation (print_context);
2011 if (!priv->use_full_page)
2012 _gtk_print_context_translate_into_margin (print_context);
2014 g_signal_emit (op, signals[DRAW_PAGE], 0,
2015 print_context, page_nr);
2017 priv->end_page (op, print_context);
2021 g_object_unref (page_setup);
2025 print_pages_idle (gpointer user_data)
2027 PrintPagesData *data;
2028 GtkPrintOperationPrivate *priv;
2029 GtkPageSetup *page_setup;
2030 gboolean done = FALSE;
2032 GDK_THREADS_ENTER ();
2034 data = (PrintPagesData*)user_data;
2035 priv = data->op->priv;
2037 if (priv->status == GTK_PRINT_STATUS_PREPARING)
2039 if (!data->initialized)
2041 data->initialized = TRUE;
2042 page_setup = create_page_setup (data->op);
2043 _gtk_print_context_set_page_setup (priv->print_context,
2045 g_object_unref (page_setup);
2047 g_signal_emit (data->op, signals[BEGIN_PRINT], 0, priv->print_context);
2049 if (priv->manual_collation)
2051 data->uncollated_copies = priv->manual_num_copies;
2052 data->collated_copies = 1;
2056 data->uncollated_copies = 1;
2057 data->collated_copies = priv->manual_num_copies;
2063 if (g_signal_has_handler_pending (data->op, signals[PAGINATE], 0, FALSE))
2065 gboolean paginated = FALSE;
2067 g_signal_emit (data->op, signals[PAGINATE], 0, priv->print_context, &paginated);
2072 /* FIXME handle this better */
2073 if (priv->nr_of_pages == 0)
2074 g_warning ("no pages to print");
2076 /* Initialize parts of PrintPagesData that depend on nr_of_pages
2078 if (priv->print_pages == GTK_PRINT_PAGES_RANGES)
2080 data->ranges = priv->page_ranges;
2081 data->num_ranges = priv->num_page_ranges;
2083 else if (priv->print_pages == GTK_PRINT_PAGES_CURRENT &&
2084 priv->current_page != -1)
2086 data->ranges = &data->one_range;
2087 data->num_ranges = 1;
2088 data->ranges[0].start = priv->current_page;
2089 data->ranges[0].end = priv->current_page;
2093 data->ranges = &data->one_range;
2094 data->num_ranges = 1;
2095 data->ranges[0].start = 0;
2096 data->ranges[0].end = priv->nr_of_pages - 1;
2099 if (priv->manual_reverse)
2101 data->range = data->num_ranges - 1;
2111 /* go back one page, since we preincrement below */
2112 data->page = data->start - data->inc;
2113 data->collated = data->collated_copies - 1;
2115 _gtk_print_operation_set_status (data->op,
2116 GTK_PRINT_STATUS_GENERATING_DATA,
2124 if (data->collated == data->collated_copies)
2127 if (!increment_page_sequence (data))
2135 if (data->is_preview)
2139 g_object_ref (data->op);
2141 g_signal_emit_by_name (data->op, "ready", priv->print_context);
2145 common_render_page (data->op, data->page);
2149 if (priv->cancelled)
2151 _gtk_print_operation_set_status (data->op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2156 if (done && !data->is_preview)
2158 g_signal_emit (data->op, signals[END_PRINT], 0, priv->print_context);
2159 priv->end_run (data->op, priv->is_sync, priv->cancelled);
2162 update_progress (data);
2164 GDK_THREADS_LEAVE ();
2170 handle_progress_response (GtkWidget *dialog,
2174 GtkPrintOperation *op = (GtkPrintOperation *)data;
2176 gtk_widget_hide (dialog);
2177 gtk_print_operation_cancel (op);
2181 show_progress_timeout (PrintPagesData *data)
2183 GDK_THREADS_ENTER ();
2185 gtk_window_present (GTK_WINDOW (data->progress));
2187 data->op->priv->show_progress_timeout_id = 0;
2189 GDK_THREADS_LEAVE ();
2195 print_pages (GtkPrintOperation *op,
2197 gboolean is_preview)
2199 GtkPrintOperationPrivate *priv = op->priv;
2200 PrintPagesData *data;
2202 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_PREPARING, NULL);
2204 data = g_new0 (PrintPagesData, 1);
2205 data->op = g_object_ref (op);
2206 data->is_preview = is_preview;
2208 if (priv->show_progress)
2210 GtkWidget *progress;
2212 progress = gtk_message_dialog_new (parent, 0,
2216 g_signal_connect (progress, "response",
2217 G_CALLBACK (handle_progress_response), op);
2219 priv->show_progress_timeout_id =
2220 g_timeout_add (SHOW_PROGRESS_TIME,
2221 (GSourceFunc)show_progress_timeout,
2224 data->progress = progress;
2231 g_signal_emit_by_name (op, "preview",
2232 GTK_PRINT_OPERATION_PREVIEW (op),
2233 op->priv->print_context,
2238 gtk_print_context_get_cairo_context (priv->print_context) == NULL) {
2239 /* Programmer error */
2240 g_error ("You must set a cairo context on the print context");
2243 priv->start_page = preview_start_page;
2244 priv->end_page = preview_end_page;
2245 priv->end_run = preview_end_run;
2247 priv->print_pages = gtk_print_settings_get_print_pages (priv->print_settings);
2248 priv->page_ranges = gtk_print_settings_get_page_ranges (priv->print_settings,
2249 &priv->num_page_ranges);
2250 priv->manual_num_copies = 1;
2251 priv->manual_collation = FALSE;
2252 priv->manual_reverse = FALSE;
2253 priv->manual_page_set = GTK_PAGE_SET_ALL;
2254 priv->manual_scale = 1.0;
2255 priv->manual_orientation = TRUE;
2258 priv->print_pages_idle_id = g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
2261 print_pages_idle_done);
2263 /* Recursive main loop to make sure we don't exit
2264 * on sync operations
2268 priv->rloop = g_main_loop_new (NULL, FALSE);
2270 GDK_THREADS_LEAVE ();
2271 g_main_loop_run (priv->rloop);
2272 GDK_THREADS_ENTER ();
2274 g_main_loop_unref (priv->rloop);
2280 * gtk_print_operation_run:
2281 * @op: a #GtkPrintOperation
2282 * @parent: Transient parent of the dialog, or %NULL
2283 * @error: Return location for errors, or %NULL
2285 * Runs the print operation, by first letting the user modify
2286 * print settings in the print dialog, and then print the
2289 * Note that this function does not return until the rendering of all
2290 * pages is complete. You can connect to the ::status-changed signal on
2291 * @op to obtain some information about the progress of the print operation.
2292 * Furthermore, it may use a recursive mainloop to show the print dialog.
2293 * See gtk_print_operation_run_async() if this is a problem.
2295 * <informalexample><programlisting>
2296 * if (settings != NULL)
2297 * gtk_print_operation_set_print_settings (print, settings);
2299 * if (page_setup != NULL)
2300 * gtk_print_operation_set_default_page_setup (print, page_setup);
2302 * g_signal_connect (print, "begin-print",
2303 * G_CALLBACK (begin_print), &data);
2304 * g_signal_connect (print, "draw-page",
2305 * G_CALLBACK (draw_page), &data);
2307 * res = gtk_print_operation_run (print, parent, &error);
2309 * if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
2311 * error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent),
2312 * GTK_DIALOG_DESTROY_WITH_PARENT,
2313 * GTK_MESSAGE_ERROR,
2314 * GTK_BUTTONS_CLOSE,
2315 * "Error printing file:\n%s",
2317 * g_signal_connect (error_dialog, "response",
2318 * G_CALLBACK (gtk_widget_destroy), NULL);
2319 * gtk_widget_show (error_dialog);
2320 * g_error_free (error);
2322 * else if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
2324 * if (settings != NULL)
2325 * g_object_unref (settings);
2326 * settings = g_object_ref (gtk_print_operation_get_print_settings (print));
2328 * </programlisting></informalexample>
2330 * Return value: the result of the print operation. A return value of
2331 * %GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was
2332 * completed successfully. In this case, it is a good idea to obtain
2333 * the used print settings with gtk_print_operation_get_print_settings()
2334 * and store them for reuse with the next print operation.
2338 GtkPrintOperationResult
2339 gtk_print_operation_run (GtkPrintOperation *op,
2343 GtkPrintOperationPrivate *priv;
2344 GtkPrintOperationResult result;
2347 g_return_val_if_fail (GTK_IS_PRINT_OPERATION (op),
2348 GTK_PRINT_OPERATION_RESULT_ERROR);
2351 priv->is_sync = TRUE;
2353 if (priv->pdf_target != NULL)
2354 result = run_pdf (op, parent, &do_print, error);
2356 result = _gtk_print_operation_platform_backend_run_dialog (op,
2361 print_pages (op, parent, result == GTK_PRINT_OPERATION_RESULT_PREVIEW);
2363 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2369 * gtk_print_operation_run_async:
2370 * @op: a #GtkPrintOperation
2371 * @parent: Transient parent of the dialog, or %NULL
2373 * Runs the print operation, by first letting the user modify
2374 * print settings in the print dialog, and then print the
2377 * In contrast to gtk_print_operation_run(), this function returns after
2378 * showing the print dialog on platforms that support this, and handles
2379 * the printing by connecting a signal handler to the ::response signal
2382 * If you use this function, it is recommended that you store the modified
2383 * #GtkPrintSettings in a ::begin-print or ::end-print signal handler.
2388 gtk_print_operation_run_async (GtkPrintOperation *op,
2391 GtkPrintOperationPrivate *priv;
2394 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
2397 priv->is_sync = FALSE;
2399 if (priv->pdf_target != NULL)
2401 run_pdf (op, parent, &do_print, NULL);
2403 print_pages (op, parent, FALSE);
2405 _gtk_print_operation_set_status (op, GTK_PRINT_STATUS_FINISHED_ABORTED, NULL);
2408 _gtk_print_operation_platform_backend_run_dialog_async (op,
2415 * gtk_print_operation_cancel:
2416 * @op: a #GtkPrintOperation
2418 * Cancels a running print operation. This function may
2419 * be called from a begin-print, paginate or draw-page
2420 * signal handler to stop the currently running print
2426 gtk_print_operation_cancel (GtkPrintOperation *op)
2428 g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
2430 op->priv->cancelled = TRUE;
2435 #define __GTK_PRINT_OPERATION_C__
2436 #include "gtkaliasdef.c"