2 * Copyright (C) 2006 John (J5) Palmieri <johnp@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
21 * @Short_description: Represents a print job
23 * A #GtkPrintJob object represents a job that is sent to a
24 * printer. You only need to deal directly with print jobs if
25 * you use the non-portable #GtkPrintUnixDialog API.
27 * Use gtk_print_job_get_surface() to obtain the cairo surface
28 * onto which the pages must be drawn. Use gtk_print_job_send()
29 * to send the finished job to the printer. If you don't use cairo
30 * #GtkPrintJob also supports printing of manually generated postscript,
31 * via gtk_print_job_set_source_file().
42 #include <sys/types.h>
45 #include <glib/gstdio.h>
47 #include "gtkprivate.h"
49 #include "gtkprintjob.h"
50 #include "gtkprinter.h"
51 #include "gtkprinter-private.h"
52 #include "gtkprintbackend.h"
58 struct _GtkPrintJobPrivate
63 cairo_surface_t *surface;
65 GtkPrintStatus status;
66 GtkPrintBackend *backend;
68 GtkPrintSettings *settings;
69 GtkPageSetup *page_setup;
71 GtkPrintPages print_pages;
72 GtkPageRange *page_ranges;
78 GtkNumberUpLayout number_up_layout;
80 guint printer_set : 1;
81 guint page_setup_set : 1;
82 guint settings_set : 1;
83 guint track_print_status : 1;
84 guint rotate_to_orientation : 1;
89 #define GTK_PRINT_JOB_GET_PRIVATE(o) \
90 (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINT_JOB, GtkPrintJobPrivate))
92 static void gtk_print_job_finalize (GObject *object);
93 static void gtk_print_job_set_property (GObject *object,
97 static void gtk_print_job_get_property (GObject *object,
101 static GObject* gtk_print_job_constructor (GType type,
102 guint n_construct_properties,
103 GObjectConstructParam *construct_params);
116 PROP_TRACK_PRINT_STATUS
119 static guint signals[LAST_SIGNAL] = { 0 };
121 G_DEFINE_TYPE (GtkPrintJob, gtk_print_job, G_TYPE_OBJECT)
124 gtk_print_job_class_init (GtkPrintJobClass *class)
126 GObjectClass *object_class;
127 object_class = (GObjectClass *) class;
129 object_class->finalize = gtk_print_job_finalize;
130 object_class->constructor = gtk_print_job_constructor;
131 object_class->set_property = gtk_print_job_set_property;
132 object_class->get_property = gtk_print_job_get_property;
134 g_type_class_add_private (class, sizeof (GtkPrintJobPrivate));
136 g_object_class_install_property (object_class,
138 g_param_spec_string ("title",
140 P_("Title of the print job"),
142 GTK_PARAM_READWRITE |
143 G_PARAM_CONSTRUCT_ONLY));
145 g_object_class_install_property (object_class,
147 g_param_spec_object ("printer",
149 P_("Printer to print the job to"),
151 GTK_PARAM_READWRITE |
152 G_PARAM_CONSTRUCT_ONLY));
154 g_object_class_install_property (object_class,
156 g_param_spec_object ("settings",
158 P_("Printer settings"),
159 GTK_TYPE_PRINT_SETTINGS,
160 GTK_PARAM_READWRITE |
161 G_PARAM_CONSTRUCT_ONLY));
163 g_object_class_install_property (object_class,
165 g_param_spec_object ("page-setup",
169 GTK_PARAM_READWRITE |
170 G_PARAM_CONSTRUCT_ONLY));
172 g_object_class_install_property (object_class,
173 PROP_TRACK_PRINT_STATUS,
174 g_param_spec_boolean ("track-print-status",
175 P_("Track Print Status"),
176 P_("TRUE if the print job will continue to emit "
177 "status-changed signals after the print data "
178 "has been sent to the printer or print server."),
180 GTK_PARAM_READWRITE));
184 * GtkPrintJob::status-changed:
185 * @job: the #GtkPrintJob object on which the signal was emitted
187 * Gets emitted when the status of a job changes. The signal handler
188 * can use gtk_print_job_get_status() to obtain the new status.
192 signals[STATUS_CHANGED] =
193 g_signal_new (I_("status-changed"),
194 G_TYPE_FROM_CLASS (class),
196 G_STRUCT_OFFSET (GtkPrintJobClass, status_changed),
198 g_cclosure_marshal_VOID__VOID,
203 gtk_print_job_init (GtkPrintJob *job)
205 GtkPrintJobPrivate *priv;
207 priv = job->priv = GTK_PRINT_JOB_GET_PRIVATE (job);
209 priv->spool_io = NULL;
211 priv->title = g_strdup ("");
212 priv->surface = NULL;
213 priv->backend = NULL;
214 priv->printer = NULL;
216 priv->printer_set = FALSE;
217 priv->settings_set = FALSE;
218 priv->page_setup_set = FALSE;
219 priv->status = GTK_PRINT_STATUS_INITIAL;
220 priv->track_print_status = FALSE;
222 priv->print_pages = GTK_PRINT_PAGES_ALL;
223 priv->page_ranges = NULL;
224 priv->num_page_ranges = 0;
225 priv->collate = FALSE;
226 priv->reverse = FALSE;
227 priv->num_copies = 1;
229 priv->page_set = GTK_PAGE_SET_ALL;
230 priv->rotate_to_orientation = FALSE;
232 priv->number_up_layout = GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM;
237 gtk_print_job_constructor (GType type,
238 guint n_construct_properties,
239 GObjectConstructParam *construct_params)
242 GtkPrintJobPrivate *priv;
246 G_OBJECT_CLASS (gtk_print_job_parent_class)->constructor (type,
247 n_construct_properties,
250 job = GTK_PRINT_JOB (object);
253 g_assert (priv->printer_set &&
254 priv->settings_set &&
255 priv->page_setup_set);
257 _gtk_printer_prepare_for_print (priv->printer,
267 gtk_print_job_finalize (GObject *object)
269 GtkPrintJob *job = GTK_PRINT_JOB (object);
270 GtkPrintJobPrivate *priv = job->priv;
272 if (priv->spool_io != NULL)
274 g_io_channel_unref (priv->spool_io);
275 priv->spool_io = NULL;
279 g_object_unref (priv->backend);
282 g_object_unref (priv->printer);
285 cairo_surface_destroy (priv->surface);
288 g_object_unref (priv->settings);
290 if (priv->page_setup)
291 g_object_unref (priv->page_setup);
293 g_free (priv->page_ranges);
294 priv->page_ranges = NULL;
296 g_free (priv->title);
299 G_OBJECT_CLASS (gtk_print_job_parent_class)->finalize (object);
304 * @title: the job title
305 * @printer: a #GtkPrinter
306 * @settings: a #GtkPrintSettings
307 * @page_setup: a #GtkPageSetup
309 * Creates a new #GtkPrintJob.
311 * Return value: a new #GtkPrintJob
316 gtk_print_job_new (const gchar *title,
318 GtkPrintSettings *settings,
319 GtkPageSetup *page_setup)
322 result = g_object_new (GTK_TYPE_PRINT_JOB,
325 "settings", settings,
326 "page-setup", page_setup,
328 return (GtkPrintJob *) result;
332 * gtk_print_job_get_settings:
333 * @job: a #GtkPrintJob
335 * Gets the #GtkPrintSettings of the print job.
337 * Return value: (transfer none): the settings of @job
342 gtk_print_job_get_settings (GtkPrintJob *job)
344 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
346 return job->priv->settings;
350 * gtk_print_job_get_printer:
351 * @job: a #GtkPrintJob
353 * Gets the #GtkPrinter of the print job.
355 * Return value: (transfer none): the printer of @job
360 gtk_print_job_get_printer (GtkPrintJob *job)
362 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
364 return job->priv->printer;
368 * gtk_print_job_get_title:
369 * @job: a #GtkPrintJob
371 * Gets the job title.
373 * Return value: the title of @job
378 gtk_print_job_get_title (GtkPrintJob *job)
380 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
382 return job->priv->title;
386 * gtk_print_job_get_status:
387 * @job: a #GtkPrintJob
389 * Gets the status of the print job.
391 * Return value: the status of @job
396 gtk_print_job_get_status (GtkPrintJob *job)
398 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), GTK_PRINT_STATUS_FINISHED);
400 return job->priv->status;
404 gtk_print_job_set_status (GtkPrintJob *job,
405 GtkPrintStatus status)
407 GtkPrintJobPrivate *priv;
409 g_return_if_fail (GTK_IS_PRINT_JOB (job));
413 if (priv->status == status)
416 priv->status = status;
417 g_signal_emit (job, signals[STATUS_CHANGED], 0);
421 * gtk_print_job_set_source_file:
422 * @job: a #GtkPrintJob
423 * @filename: (type filename): the file to be printed
424 * @error: return location for errors
426 * Make the #GtkPrintJob send an existing document to the
427 * printing system. The file can be in any format understood
428 * by the platforms printing system (typically PostScript,
429 * but on many platforms PDF may work too). See
430 * gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
432 * Returns: %FALSE if an error occurred
437 gtk_print_job_set_source_file (GtkPrintJob *job,
438 const gchar *filename,
441 GtkPrintJobPrivate *priv;
446 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
450 priv->spool_io = g_io_channel_new_file (filename, "r", &tmp_error);
452 if (tmp_error == NULL)
453 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
455 if (tmp_error != NULL)
457 g_propagate_error (error, tmp_error);
465 * gtk_print_job_get_surface:
466 * @job: a #GtkPrintJob
467 * @error: (allow-none): return location for errors, or %NULL
469 * Gets a cairo surface onto which the pages of
470 * the print job should be rendered.
472 * Return value: (transfer none): the cairo surface of @job
477 gtk_print_job_get_surface (GtkPrintJob *job,
480 GtkPrintJobPrivate *priv;
482 gdouble width, height;
483 GtkPaperSize *paper_size;
489 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
494 return priv->surface;
496 g_return_val_if_fail (priv->spool_io == NULL, NULL);
498 fd = g_file_open_tmp ("gtkprint_XXXXXX",
504 g_propagate_error (error, tmp_error);
508 fchmod (fd, S_IRUSR | S_IWUSR);
510 #ifdef G_ENABLE_DEBUG
511 /* If we are debugging printing don't delete the tmp files */
512 if (!(gtk_get_debug_flags () & GTK_DEBUG_PRINTING))
513 #endif /* G_ENABLE_DEBUG */
517 paper_size = gtk_page_setup_get_paper_size (priv->page_setup);
518 width = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
519 height = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
521 priv->spool_io = g_io_channel_unix_new (fd);
522 g_io_channel_set_close_on_unref (priv->spool_io, TRUE);
523 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
525 if (tmp_error != NULL)
527 g_io_channel_unref (priv->spool_io);
528 priv->spool_io = NULL;
529 g_propagate_error (error, tmp_error);
533 priv->surface = _gtk_printer_create_cairo_surface (priv->printer,
538 return priv->surface;
542 * gtk_print_job_set_track_print_status:
543 * @job: a #GtkPrintJob
544 * @track_status: %TRUE to track status after printing
546 * If track_status is %TRUE, the print job will try to continue report
547 * on the status of the print job in the printer queues and printer. This
548 * can allow your application to show things like "out of paper" issues,
549 * and when the print job actually reaches the printer.
551 * This function is often implemented using some form of polling, so it should
552 * not be enabled unless needed.
557 gtk_print_job_set_track_print_status (GtkPrintJob *job,
558 gboolean track_status)
560 GtkPrintJobPrivate *priv;
562 g_return_if_fail (GTK_IS_PRINT_JOB (job));
566 track_status = track_status != FALSE;
568 if (priv->track_print_status != track_status)
570 priv->track_print_status = track_status;
572 g_object_notify (G_OBJECT (job), "track-print-status");
577 * gtk_print_job_get_track_print_status:
578 * @job: a #GtkPrintJob
580 * Returns wheter jobs will be tracked after printing.
581 * For details, see gtk_print_job_set_track_print_status().
583 * Return value: %TRUE if print job status will be reported after printing
588 gtk_print_job_get_track_print_status (GtkPrintJob *job)
590 GtkPrintJobPrivate *priv;
592 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
596 return priv->track_print_status;
600 gtk_print_job_set_property (GObject *object,
606 GtkPrintJob *job = GTK_PRINT_JOB (object);
607 GtkPrintJobPrivate *priv = job->priv;
608 GtkPrintSettings *settings;
613 g_free (priv->title);
614 priv->title = g_value_dup_string (value);
618 priv->printer = GTK_PRINTER (g_value_dup_object (value));
619 priv->printer_set = TRUE;
620 priv->backend = g_object_ref (gtk_printer_get_backend (priv->printer));
623 case PROP_PAGE_SETUP:
624 priv->page_setup = GTK_PAGE_SETUP (g_value_dup_object (value));
625 priv->page_setup_set = TRUE;
629 /* We save a copy of the settings since we modify
630 * if when preparing the printer job. */
631 settings = GTK_PRINT_SETTINGS (g_value_get_object (value));
632 priv->settings = gtk_print_settings_copy (settings);
633 priv->settings_set = TRUE;
636 case PROP_TRACK_PRINT_STATUS:
637 gtk_print_job_set_track_print_status (job, g_value_get_boolean (value));
641 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
647 gtk_print_job_get_property (GObject *object,
652 GtkPrintJob *job = GTK_PRINT_JOB (object);
653 GtkPrintJobPrivate *priv = job->priv;
658 g_value_set_string (value, priv->title);
661 g_value_set_object (value, priv->printer);
664 g_value_set_object (value, priv->settings);
666 case PROP_PAGE_SETUP:
667 g_value_set_object (value, priv->page_setup);
669 case PROP_TRACK_PRINT_STATUS:
670 g_value_set_boolean (value, priv->track_print_status);
673 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
679 * gtk_print_job_send:
680 * @job: a GtkPrintJob
681 * @callback: function to call when the job completes or an error occurs
682 * @user_data: user data that gets passed to @callback
683 * @dnotify: destroy notify for @user_data
685 * Sends the print job off to the printer.
690 gtk_print_job_send (GtkPrintJob *job,
691 GtkPrintJobCompleteFunc callback,
693 GDestroyNotify dnotify)
695 GtkPrintJobPrivate *priv;
697 g_return_if_fail (GTK_IS_PRINT_JOB (job));
700 g_return_if_fail (priv->spool_io != NULL);
702 gtk_print_job_set_status (job, GTK_PRINT_STATUS_SENDING_DATA);
704 g_io_channel_seek_position (priv->spool_io, 0, G_SEEK_SET, NULL);
706 gtk_print_backend_print_stream (priv->backend, job,
708 callback, user_data, dnotify);
712 * gtk_print_job_get_pages:
713 * @job: a #GtkPrintJob
715 * Gets the #GtkPrintPages setting for this job.
717 * Returns: the #GtkPrintPages setting
722 gtk_print_job_get_pages (GtkPrintJob *job)
724 return job->priv->print_pages;
728 * gtk_print_job_set_pages:
729 * @job: a #GtkPrintJob
730 * @pages: the #GtkPrintPages setting
732 * Sets the #GtkPrintPages setting for this job.
737 gtk_print_job_set_pages (GtkPrintJob *job,
740 job->priv->print_pages = pages;
744 * gtk_print_job_get_page_ranges:
745 * @job: a #GtkPrintJob
746 * @n_ranges: (out): return location for the number of ranges
748 * Gets the page ranges for this job.
750 * Returns: (array length=n_ranges) (transfer none): a pointer to an
751 * array of #GtkPageRange structs
756 gtk_print_job_get_page_ranges (GtkPrintJob *job,
759 *n_ranges = job->priv->num_page_ranges;
760 return job->priv->page_ranges;
764 * gtk_print_job_set_page_ranges:
765 * @job: a #GtkPrintJob
766 * @ranges: (array length=n_ranges): pointer to an array of
767 * #GtkPageRange structs
768 * @n_ranges: the length of the @ranges array
770 * Sets the page ranges for this job.
775 gtk_print_job_set_page_ranges (GtkPrintJob *job,
776 GtkPageRange *ranges,
779 job->priv->page_ranges = ranges;
780 job->priv->num_page_ranges = n_ranges;
784 * gtk_print_job_get_page_set:
785 * @job: a #GtkPrintJob
787 * Gets the #GtkPageSet setting for this job.
789 * Returns: the #GtkPageSet setting
794 gtk_print_job_get_page_set (GtkPrintJob *job)
796 return job->priv->page_set;
800 * gtk_print_job_set_page_set:
801 * @job: a #GtkPrintJob
802 * @page_set: a #GtkPageSet setting
804 * Sets the #GtkPageSet setting for this job.
809 gtk_print_job_set_page_set (GtkPrintJob *job,
812 job->priv->page_set = page_set;
816 * gtk_print_job_get_num_copies:
817 * @job: a #GtkPrintJob
819 * Gets the number of copies of this job.
821 * Returns: the number of copies
826 gtk_print_job_get_num_copies (GtkPrintJob *job)
828 return job->priv->num_copies;
832 * gtk_print_job_set_num_copies:
833 * @job: a #GtkPrintJob
834 * @num_copies: the number of copies
836 * Sets the number of copies for this job.
841 gtk_print_job_set_num_copies (GtkPrintJob *job,
844 job->priv->num_copies = num_copies;
848 * gtk_print_job_get_scale:
849 * @job: a #GtkPrintJob
851 * Gets the scale for this job (where 1.0 means unscaled).
858 gtk_print_job_get_scale (GtkPrintJob *job)
861 return job->priv->scale;
865 * gtk_print_job_set_scale:
866 * @job: a #GtkPrintJob
869 * Sets the scale for this job (where 1.0 means unscaled).
874 gtk_print_job_set_scale (GtkPrintJob *job,
877 job->priv->scale = scale;
881 * gtk_print_job_get_n_up:
882 * @job: a #GtkPrintJob
884 * Gets the n-up setting for this job.
886 * Returns: the n-up setting
891 gtk_print_job_get_n_up (GtkPrintJob *job)
893 return job->priv->number_up;
897 * gtk_print_job_set_n_up:
898 * @job: a #GtkPrintJob
899 * @n_up: the n-up value
901 * Sets the n-up setting for this job.
906 gtk_print_job_set_n_up (GtkPrintJob *job,
909 job->priv->number_up = n_up;
913 * gtk_print_job_get_n_up_layout:
914 * @job: a #GtkPrintJob
916 * Gets the n-up layout setting for this job.
918 * Returns: the n-up layout
923 gtk_print_job_get_n_up_layout (GtkPrintJob *job)
925 return job->priv->number_up_layout;
929 * gtk_print_job_set_n_up_layout:
930 * @job: a #GtkPrintJob
931 * @layout: the n-up layout setting
933 * Sets the n-up layout setting for this job.
938 gtk_print_job_set_n_up_layout (GtkPrintJob *job,
939 GtkNumberUpLayout layout)
941 job->priv->number_up_layout = layout;
945 * gtk_print_job_get_rotate:
946 * @job: a #GtkPrintJob
948 * Gets whether the job is printed rotated.
950 * Returns: whether the job is printed rotated
955 gtk_print_job_get_rotate (GtkPrintJob *job)
957 return job->priv->rotate_to_orientation;
961 * gtk_print_job_set_rotate:
962 * @job: a #GtkPrintJob
963 * @rotate: whether to print rotated
965 * Sets whether this job is printed rotated.
970 gtk_print_job_set_rotate (GtkPrintJob *job,
973 job->priv->rotate_to_orientation = rotate;
977 * gtk_print_job_get_collate:
978 * @job: a #GtkPrintJob
980 * Gets whether this job is printed collated.
982 * Returns: whether the job is printed collated
987 gtk_print_job_get_collate (GtkPrintJob *job)
989 return job->priv->collate;
993 * gtk_print_job_set_collate:
994 * @job: a #GtkPrintJob
995 * @collate: whether the job is printed collated
997 * Sets whether this job is printed collated.
1002 gtk_print_job_set_collate (GtkPrintJob *job,
1005 job->priv->collate = collate;
1009 * gtk_print_job_get_reverse:
1010 * @job: a #GtkPrintJob
1012 * Gets whether this job is printed reversed.
1014 * Returns: whether the job is printed reversed.
1019 gtk_print_job_get_reverse (GtkPrintJob *job)
1021 return job->priv->reverse;
1025 * gtk_print_job_set_reverse:
1026 * @job: a #GtkPrintJob
1027 * @reverse: whether the job is printed reversed
1029 * Sets whether this job is printed reversed.
1034 gtk_print_job_set_reverse (GtkPrintJob *job,
1037 job->priv->reverse = reverse;