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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
29 #include <sys/types.h>
32 #include <glib/gstdio.h>
34 #include "gtkprivate.h"
36 #include "gtkprintjob.h"
37 #include "gtkprinter.h"
38 #include "gtkprinter-private.h"
39 #include "gtkprintbackend.h"
45 struct _GtkPrintJobPrivate
50 cairo_surface_t *surface;
52 GtkPrintStatus status;
53 GtkPrintBackend *backend;
55 GtkPrintSettings *settings;
56 GtkPageSetup *page_setup;
58 guint printer_set : 1;
59 guint page_setup_set : 1;
60 guint settings_set : 1;
61 guint track_print_status : 1;
65 #define GTK_PRINT_JOB_GET_PRIVATE(o) \
66 (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINT_JOB, GtkPrintJobPrivate))
68 static void gtk_print_job_finalize (GObject *object);
69 static void gtk_print_job_set_property (GObject *object,
73 static void gtk_print_job_get_property (GObject *object,
77 static GObject* gtk_print_job_constructor (GType type,
78 guint n_construct_properties,
79 GObjectConstructParam *construct_params);
92 PROP_TRACK_PRINT_STATUS
95 static guint signals[LAST_SIGNAL] = { 0 };
97 G_DEFINE_TYPE (GtkPrintJob, gtk_print_job, G_TYPE_OBJECT)
100 gtk_print_job_class_init (GtkPrintJobClass *class)
102 GObjectClass *object_class;
103 object_class = (GObjectClass *) class;
105 object_class->finalize = gtk_print_job_finalize;
106 object_class->constructor = gtk_print_job_constructor;
107 object_class->set_property = gtk_print_job_set_property;
108 object_class->get_property = gtk_print_job_get_property;
110 g_type_class_add_private (class, sizeof (GtkPrintJobPrivate));
112 g_object_class_install_property (object_class,
114 g_param_spec_string ("title",
116 P_("Title of the print job"),
118 GTK_PARAM_READWRITE |
119 G_PARAM_CONSTRUCT_ONLY));
121 g_object_class_install_property (object_class,
123 g_param_spec_object ("printer",
125 P_("Printer to print the job to"),
127 GTK_PARAM_READWRITE |
128 G_PARAM_CONSTRUCT_ONLY));
130 g_object_class_install_property (object_class,
132 g_param_spec_object ("settings",
134 P_("Printer settings"),
135 GTK_TYPE_PRINT_SETTINGS,
136 GTK_PARAM_READWRITE |
137 G_PARAM_CONSTRUCT_ONLY));
139 g_object_class_install_property (object_class,
141 g_param_spec_object ("page-setup",
145 GTK_PARAM_READWRITE |
146 G_PARAM_CONSTRUCT_ONLY));
148 g_object_class_install_property (object_class,
149 PROP_TRACK_PRINT_STATUS,
150 g_param_spec_boolean ("track-print-status",
151 P_("Track Print Status"),
152 P_("TRUE if the print job will continue to emit "
153 "status-changed signals after the print data "
154 "has been sent to the printer or print server."),
156 GTK_PARAM_READWRITE));
160 * GtkPrintJob::status-changed:
161 * @job: the #GtkPrintJob object on which the signal was emitted
163 * Gets emitted when the status of a job changes. The signal handler
164 * can use gtk_print_job_get_status() to obtain the new status.
168 signals[STATUS_CHANGED] =
169 g_signal_new (I_("status-changed"),
170 G_TYPE_FROM_CLASS (class),
172 G_STRUCT_OFFSET (GtkPrintJobClass, status_changed),
174 g_cclosure_marshal_VOID__VOID,
179 gtk_print_job_init (GtkPrintJob *job)
181 GtkPrintJobPrivate *priv;
183 priv = job->priv = GTK_PRINT_JOB_GET_PRIVATE (job);
185 priv->spool_io = NULL;
187 priv->title = g_strdup ("");
188 priv->surface = NULL;
189 priv->backend = NULL;
190 priv->printer = NULL;
192 priv->printer_set = FALSE;
193 priv->settings_set = FALSE;
194 priv->page_setup_set = FALSE;
195 priv->status = GTK_PRINT_STATUS_INITIAL;
196 priv->track_print_status = FALSE;
198 job->print_pages = GTK_PRINT_PAGES_ALL;
199 job->page_ranges = NULL;
200 job->num_page_ranges = 0;
201 job->collate = FALSE;
202 job->reverse = FALSE;
205 job->page_set = GTK_PAGE_SET_ALL;
206 job->rotate_to_orientation = FALSE;
208 job->number_up_layout = GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM;
213 gtk_print_job_constructor (GType type,
214 guint n_construct_properties,
215 GObjectConstructParam *construct_params)
218 GtkPrintJobPrivate *priv;
222 G_OBJECT_CLASS (gtk_print_job_parent_class)->constructor (type,
223 n_construct_properties,
226 job = GTK_PRINT_JOB (object);
229 g_assert (priv->printer_set &&
230 priv->settings_set &&
231 priv->page_setup_set);
233 _gtk_printer_prepare_for_print (priv->printer,
243 gtk_print_job_finalize (GObject *object)
245 GtkPrintJob *job = GTK_PRINT_JOB (object);
246 GtkPrintJobPrivate *priv = job->priv;
248 if (priv->spool_io != NULL)
250 g_io_channel_unref (priv->spool_io);
251 priv->spool_io = NULL;
255 g_object_unref (priv->backend);
258 g_object_unref (priv->printer);
261 cairo_surface_destroy (priv->surface);
264 g_object_unref (priv->settings);
266 if (priv->page_setup)
267 g_object_unref (priv->page_setup);
269 g_free (job->page_ranges);
270 job->page_ranges = NULL;
272 g_free (priv->title);
275 G_OBJECT_CLASS (gtk_print_job_parent_class)->finalize (object);
280 * @title: the job title
281 * @printer: a #GtkPrinter
282 * @settings: a #GtkPrintSettings
283 * @page_setup: a #GtkPageSetup
285 * Creates a new #GtkPrintJob.
287 * Return value: a new #GtkPrintJob
292 gtk_print_job_new (const gchar *title,
294 GtkPrintSettings *settings,
295 GtkPageSetup *page_setup)
298 result = g_object_new (GTK_TYPE_PRINT_JOB,
301 "settings", settings,
302 "page-setup", page_setup,
304 return (GtkPrintJob *) result;
308 * gtk_print_job_get_settings:
309 * @job: a #GtkPrintJob
311 * Gets the #GtkPrintSettings of the print job.
313 * Return value: the settings of @job
318 gtk_print_job_get_settings (GtkPrintJob *job)
320 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
322 return job->priv->settings;
326 * gtk_print_job_get_printer:
327 * @job: a #GtkPrintJob
329 * Gets the #GtkPrinter of the print job.
331 * Return value: the printer of @job
336 gtk_print_job_get_printer (GtkPrintJob *job)
338 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
340 return job->priv->printer;
344 * gtk_print_job_get_title:
345 * @job: a #GtkPrintJob
347 * Gets the job title.
349 * Return value: the title of @job
353 G_CONST_RETURN gchar *
354 gtk_print_job_get_title (GtkPrintJob *job)
356 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
358 return job->priv->title;
362 * gtk_print_job_get_status:
363 * @job: a #GtkPrintJob
365 * Gets the status of the print job.
367 * Return value: the status of @job
372 gtk_print_job_get_status (GtkPrintJob *job)
374 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), GTK_PRINT_STATUS_FINISHED);
376 return job->priv->status;
380 gtk_print_job_set_status (GtkPrintJob *job,
381 GtkPrintStatus status)
383 GtkPrintJobPrivate *priv;
385 g_return_if_fail (GTK_IS_PRINT_JOB (job));
389 if (priv->status == status)
392 priv->status = status;
393 g_signal_emit (job, signals[STATUS_CHANGED], 0);
397 * gtk_print_job_set_source_file:
398 * @job: a #GtkPrintJob
399 * @filename: the file to be printed
400 * @error: return location for errors
402 * Make the #GtkPrintJob send an existing document to the
403 * printing system. The file can be in any format understood
404 * by the platforms printing system (typically PostScript,
405 * but on many platforms PDF may work too). See
406 * gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
408 * Returns: %FALSE if an error occurred
413 gtk_print_job_set_source_file (GtkPrintJob *job,
414 const gchar *filename,
417 GtkPrintJobPrivate *priv;
422 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
426 priv->spool_io = g_io_channel_new_file (filename, "r", &tmp_error);
428 if (tmp_error == NULL)
429 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
431 if (tmp_error != NULL)
433 g_propagate_error (error, tmp_error);
441 * gtk_print_job_get_surface:
442 * @job: a #GtkPrintJob
443 * @error: (allow-none): return location for errors, or %NULL
445 * Gets a cairo surface onto which the pages of
446 * the print job should be rendered.
448 * Return value: the cairo surface of @job
453 gtk_print_job_get_surface (GtkPrintJob *job,
456 GtkPrintJobPrivate *priv;
458 gdouble width, height;
459 GtkPaperSize *paper_size;
465 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
470 return priv->surface;
472 g_return_val_if_fail (priv->spool_io == NULL, NULL);
474 fd = g_file_open_tmp ("gtkprint_XXXXXX",
480 g_propagate_error (error, tmp_error);
484 fchmod (fd, S_IRUSR | S_IWUSR);
486 #ifdef G_ENABLE_DEBUG
487 /* If we are debugging printing don't delete the tmp files */
488 if (!(gtk_debug_flags & GTK_DEBUG_PRINTING))
489 #endif /* G_ENABLE_DEBUG */
493 paper_size = gtk_page_setup_get_paper_size (priv->page_setup);
494 width = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
495 height = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
497 priv->spool_io = g_io_channel_unix_new (fd);
498 g_io_channel_set_close_on_unref (priv->spool_io, TRUE);
499 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
501 if (tmp_error != NULL)
503 g_io_channel_unref (priv->spool_io);
504 priv->spool_io = NULL;
505 g_propagate_error (error, tmp_error);
509 priv->surface = _gtk_printer_create_cairo_surface (priv->printer,
514 return priv->surface;
518 * gtk_print_job_set_track_print_status:
519 * @job: a #GtkPrintJob
520 * @track_status: %TRUE to track status after printing
522 * If track_status is %TRUE, the print job will try to continue report
523 * on the status of the print job in the printer queues and printer. This
524 * can allow your application to show things like "out of paper" issues,
525 * and when the print job actually reaches the printer.
527 * This function is often implemented using some form of polling, so it should
528 * not be enabled unless needed.
533 gtk_print_job_set_track_print_status (GtkPrintJob *job,
534 gboolean track_status)
536 GtkPrintJobPrivate *priv;
538 g_return_if_fail (GTK_IS_PRINT_JOB (job));
542 track_status = track_status != FALSE;
544 if (priv->track_print_status != track_status)
546 priv->track_print_status = track_status;
548 g_object_notify (G_OBJECT (job), "track-print-status");
553 * gtk_print_job_get_track_print_status:
554 * @job: a #GtkPrintJob
556 * Returns wheter jobs will be tracked after printing.
557 * For details, see gtk_print_job_set_track_print_status().
559 * Return value: %TRUE if print job status will be reported after printing
564 gtk_print_job_get_track_print_status (GtkPrintJob *job)
566 GtkPrintJobPrivate *priv;
568 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
572 return priv->track_print_status;
576 gtk_print_job_set_property (GObject *object,
582 GtkPrintJob *job = GTK_PRINT_JOB (object);
583 GtkPrintJobPrivate *priv = job->priv;
584 GtkPrintSettings *settings;
589 g_free (priv->title);
590 priv->title = g_value_dup_string (value);
594 priv->printer = GTK_PRINTER (g_value_dup_object (value));
595 priv->printer_set = TRUE;
596 priv->backend = g_object_ref (gtk_printer_get_backend (priv->printer));
599 case PROP_PAGE_SETUP:
600 priv->page_setup = GTK_PAGE_SETUP (g_value_dup_object (value));
601 priv->page_setup_set = TRUE;
605 /* We save a copy of the settings since we modify
606 * if when preparing the printer job. */
607 settings = GTK_PRINT_SETTINGS (g_value_get_object (value));
608 priv->settings = gtk_print_settings_copy (settings);
609 priv->settings_set = TRUE;
612 case PROP_TRACK_PRINT_STATUS:
613 gtk_print_job_set_track_print_status (job, g_value_get_boolean (value));
617 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
623 gtk_print_job_get_property (GObject *object,
628 GtkPrintJob *job = GTK_PRINT_JOB (object);
629 GtkPrintJobPrivate *priv = job->priv;
634 g_value_set_string (value, priv->title);
637 g_value_set_object (value, priv->printer);
640 g_value_set_object (value, priv->settings);
642 case PROP_PAGE_SETUP:
643 g_value_set_object (value, priv->page_setup);
645 case PROP_TRACK_PRINT_STATUS:
646 g_value_set_boolean (value, priv->track_print_status);
649 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
655 * gtk_print_job_send:
656 * @job: a GtkPrintJob
657 * @callback: function to call when the job completes or an error occurs
658 * @user_data: user data that gets passed to @callback
659 * @dnotify: destroy notify for @user_data
661 * Sends the print job off to the printer.
666 gtk_print_job_send (GtkPrintJob *job,
667 GtkPrintJobCompleteFunc callback,
669 GDestroyNotify dnotify)
671 GtkPrintJobPrivate *priv;
673 g_return_if_fail (GTK_IS_PRINT_JOB (job));
676 g_return_if_fail (priv->spool_io != NULL);
678 gtk_print_job_set_status (job, GTK_PRINT_STATUS_SENDING_DATA);
680 g_io_channel_seek_position (priv->spool_io, 0, G_SEEK_SET, NULL);
682 gtk_print_backend_print_stream (priv->backend, job,
684 callback, user_data, dnotify);