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"
46 struct _GtkPrintJobPrivate
51 cairo_surface_t *surface;
53 GtkPrintStatus status;
54 GtkPrintBackend *backend;
56 GtkPrintSettings *settings;
57 GtkPageSetup *page_setup;
59 guint printer_set : 1;
60 guint page_setup_set : 1;
61 guint settings_set : 1;
62 guint track_print_status : 1;
66 #define GTK_PRINT_JOB_GET_PRIVATE(o) \
67 (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_PRINT_JOB, GtkPrintJobPrivate))
69 static void gtk_print_job_finalize (GObject *object);
70 static void gtk_print_job_set_property (GObject *object,
74 static void gtk_print_job_get_property (GObject *object,
78 static GObject* gtk_print_job_constructor (GType type,
79 guint n_construct_properties,
80 GObjectConstructParam *construct_params);
93 PROP_TRACK_PRINT_STATUS
96 static guint signals[LAST_SIGNAL] = { 0 };
98 G_DEFINE_TYPE (GtkPrintJob, gtk_print_job, G_TYPE_OBJECT)
101 gtk_print_job_class_init (GtkPrintJobClass *class)
103 GObjectClass *object_class;
104 object_class = (GObjectClass *) class;
106 object_class->finalize = gtk_print_job_finalize;
107 object_class->constructor = gtk_print_job_constructor;
108 object_class->set_property = gtk_print_job_set_property;
109 object_class->get_property = gtk_print_job_get_property;
111 g_type_class_add_private (class, sizeof (GtkPrintJobPrivate));
113 g_object_class_install_property (object_class,
115 g_param_spec_string ("title",
117 P_("Title of the print job"),
119 GTK_PARAM_READWRITE |
120 G_PARAM_CONSTRUCT_ONLY));
122 g_object_class_install_property (object_class,
124 g_param_spec_object ("printer",
126 P_("Printer to print the job to"),
128 GTK_PARAM_READWRITE |
129 G_PARAM_CONSTRUCT_ONLY));
131 g_object_class_install_property (object_class,
133 g_param_spec_object ("settings",
135 P_("Printer settings"),
136 GTK_TYPE_PRINT_SETTINGS,
137 GTK_PARAM_READWRITE |
138 G_PARAM_CONSTRUCT_ONLY));
140 g_object_class_install_property (object_class,
142 g_param_spec_object ("page-setup",
146 GTK_PARAM_READWRITE |
147 G_PARAM_CONSTRUCT_ONLY));
149 g_object_class_install_property (object_class,
150 PROP_TRACK_PRINT_STATUS,
151 g_param_spec_boolean ("track-print-status",
152 P_("Track Print Status"),
153 P_("TRUE if the print job will continue to emit "
154 "status-changed signals after the print data "
155 "has been sent to the printer or print server."),
157 GTK_PARAM_READWRITE));
161 * GtkPrintJob::status-changed:
162 * @job: the #GtkPrintJob object on which the signal was emitted
164 * Gets emitted when the status of a job changes. The signal handler
165 * can use gtk_print_job_get_status() to obtain the new status.
169 signals[STATUS_CHANGED] =
170 g_signal_new (I_("status-changed"),
171 G_TYPE_FROM_CLASS (class),
173 G_STRUCT_OFFSET (GtkPrintJobClass, status_changed),
175 g_cclosure_marshal_VOID__VOID,
180 gtk_print_job_init (GtkPrintJob *job)
182 GtkPrintJobPrivate *priv;
184 priv = job->priv = GTK_PRINT_JOB_GET_PRIVATE (job);
186 priv->spool_io = NULL;
188 priv->title = g_strdup ("");
189 priv->surface = NULL;
190 priv->backend = NULL;
191 priv->printer = NULL;
193 priv->printer_set = FALSE;
194 priv->settings_set = FALSE;
195 priv->page_setup_set = FALSE;
196 priv->status = GTK_PRINT_STATUS_INITIAL;
197 priv->track_print_status = FALSE;
199 job->print_pages = GTK_PRINT_PAGES_ALL;
200 job->page_ranges = NULL;
201 job->num_page_ranges = 0;
202 job->collate = FALSE;
203 job->reverse = FALSE;
206 job->page_set = GTK_PAGE_SET_ALL;
207 job->rotate_to_orientation = FALSE;
209 job->number_up_layout = GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM;
214 gtk_print_job_constructor (GType type,
215 guint n_construct_properties,
216 GObjectConstructParam *construct_params)
219 GtkPrintJobPrivate *priv;
223 G_OBJECT_CLASS (gtk_print_job_parent_class)->constructor (type,
224 n_construct_properties,
227 job = GTK_PRINT_JOB (object);
230 g_assert (priv->printer_set &&
231 priv->settings_set &&
232 priv->page_setup_set);
234 _gtk_printer_prepare_for_print (priv->printer,
244 gtk_print_job_finalize (GObject *object)
246 GtkPrintJob *job = GTK_PRINT_JOB (object);
247 GtkPrintJobPrivate *priv = job->priv;
249 if (priv->spool_io != NULL)
251 g_io_channel_unref (priv->spool_io);
252 priv->spool_io = NULL;
256 g_object_unref (priv->backend);
259 g_object_unref (priv->printer);
262 cairo_surface_destroy (priv->surface);
265 g_object_unref (priv->settings);
267 if (priv->page_setup)
268 g_object_unref (priv->page_setup);
270 g_free (job->page_ranges);
271 job->page_ranges = NULL;
273 g_free (priv->title);
276 G_OBJECT_CLASS (gtk_print_job_parent_class)->finalize (object);
281 * @title: the job title
282 * @printer: a #GtkPrinter
283 * @settings: a #GtkPrintSettings
284 * @page_setup: a #GtkPageSetup
286 * Creates a new #GtkPrintJob.
288 * Return value: a new #GtkPrintJob
293 gtk_print_job_new (const gchar *title,
295 GtkPrintSettings *settings,
296 GtkPageSetup *page_setup)
299 result = g_object_new (GTK_TYPE_PRINT_JOB,
302 "settings", settings,
303 "page-setup", page_setup,
305 return (GtkPrintJob *) result;
309 * gtk_print_job_get_settings:
310 * @job: a #GtkPrintJob
312 * Gets the #GtkPrintSettings of the print job.
314 * Return value: the settings of @job
319 gtk_print_job_get_settings (GtkPrintJob *job)
321 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
323 return job->priv->settings;
327 * gtk_print_job_get_printer:
328 * @job: a #GtkPrintJob
330 * Gets the #GtkPrinter of the print job.
332 * Return value: the printer of @job
337 gtk_print_job_get_printer (GtkPrintJob *job)
339 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
341 return job->priv->printer;
345 * gtk_print_job_get_title:
346 * @job: a #GtkPrintJob
348 * Gets the job title.
350 * Return value: the title of @job
354 G_CONST_RETURN gchar *
355 gtk_print_job_get_title (GtkPrintJob *job)
357 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
359 return job->priv->title;
363 * gtk_print_job_get_status:
364 * @job: a #GtkPrintJob
366 * Gets the status of the print job.
368 * Return value: the status of @job
373 gtk_print_job_get_status (GtkPrintJob *job)
375 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), GTK_PRINT_STATUS_FINISHED);
377 return job->priv->status;
381 gtk_print_job_set_status (GtkPrintJob *job,
382 GtkPrintStatus status)
384 GtkPrintJobPrivate *priv;
386 g_return_if_fail (GTK_IS_PRINT_JOB (job));
390 if (priv->status == status)
393 priv->status = status;
394 g_signal_emit (job, signals[STATUS_CHANGED], 0);
398 * gtk_print_job_set_source_file:
399 * @job: a #GtkPrintJob
400 * @filename: the file to be printed
401 * @error: return location for errors
403 * Make the #GtkPrintJob send an existing document to the
404 * printing system. The file can be in any format understood
405 * by the platforms printing system (typically PostScript,
406 * but on many platforms PDF may work too). See
407 * gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
409 * Returns: %FALSE if an error occurred
414 gtk_print_job_set_source_file (GtkPrintJob *job,
415 const gchar *filename,
418 GtkPrintJobPrivate *priv;
423 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
427 priv->spool_io = g_io_channel_new_file (filename, "r", &tmp_error);
429 if (tmp_error == NULL)
430 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
432 if (tmp_error != NULL)
434 g_propagate_error (error, tmp_error);
442 * gtk_print_job_get_surface:
443 * @job: a #GtkPrintJob
444 * @error: return location for errors, or %NULL
446 * Gets a cairo surface onto which the pages of
447 * the print job should be rendered.
449 * Return value: the cairo surface of @job
454 gtk_print_job_get_surface (GtkPrintJob *job,
457 GtkPrintJobPrivate *priv;
459 gdouble width, height;
460 GtkPaperSize *paper_size;
466 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
471 return priv->surface;
473 g_return_val_if_fail (priv->spool_io == NULL, NULL);
475 fd = g_file_open_tmp ("gtkprint_XXXXXX",
481 g_propagate_error (error, tmp_error);
485 fchmod (fd, S_IRUSR | S_IWUSR);
487 #ifdef G_ENABLE_DEBUG
488 /* If we are debugging printing don't delete the tmp files */
489 if (!(gtk_debug_flags & GTK_DEBUG_PRINTING))
490 #endif /* G_ENABLE_DEBUG */
494 paper_size = gtk_page_setup_get_paper_size (priv->page_setup);
495 width = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
496 height = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
498 priv->spool_io = g_io_channel_unix_new (fd);
499 g_io_channel_set_close_on_unref (priv->spool_io, TRUE);
500 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
502 if (tmp_error != NULL)
504 g_io_channel_unref (priv->spool_io);
505 priv->spool_io = NULL;
506 g_propagate_error (error, tmp_error);
510 priv->surface = _gtk_printer_create_cairo_surface (priv->printer,
515 return priv->surface;
519 * gtk_print_job_set_track_print_status:
520 * @job: a #GtkPrintJob
521 * @track_status: %TRUE to track status after printing
523 * If track_status is %TRUE, the print job will try to continue report
524 * on the status of the print job in the printer queues and printer. This
525 * can allow your application to show things like "out of paper" issues,
526 * and when the print job actually reaches the printer.
528 * This function is often implemented using some form of polling, so it should
529 * not be enabled unless needed.
534 gtk_print_job_set_track_print_status (GtkPrintJob *job,
535 gboolean track_status)
537 GtkPrintJobPrivate *priv;
539 g_return_if_fail (GTK_IS_PRINT_JOB (job));
543 track_status = track_status != FALSE;
545 if (priv->track_print_status != track_status)
547 priv->track_print_status = track_status;
549 g_object_notify (G_OBJECT (job), "track-print-status");
554 * gtk_print_job_get_track_print_status:
555 * @job: a #GtkPrintJob
557 * Returns wheter jobs will be tracked after printing.
558 * For details, see gtk_print_job_set_track_print_status().
560 * Return value: %TRUE if print job status will be reported after printing
565 gtk_print_job_get_track_print_status (GtkPrintJob *job)
567 GtkPrintJobPrivate *priv;
569 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
573 return priv->track_print_status;
577 gtk_print_job_set_property (GObject *object,
583 GtkPrintJob *job = GTK_PRINT_JOB (object);
584 GtkPrintJobPrivate *priv = job->priv;
585 GtkPrintSettings *settings;
590 g_free (priv->title);
591 priv->title = g_value_dup_string (value);
595 priv->printer = GTK_PRINTER (g_value_dup_object (value));
596 priv->printer_set = TRUE;
597 priv->backend = g_object_ref (gtk_printer_get_backend (priv->printer));
600 case PROP_PAGE_SETUP:
601 priv->page_setup = GTK_PAGE_SETUP (g_value_dup_object (value));
602 priv->page_setup_set = TRUE;
606 /* We save a copy of the settings since we modify
607 * if when preparing the printer job. */
608 settings = GTK_PRINT_SETTINGS (g_value_get_object (value));
609 priv->settings = gtk_print_settings_copy (settings);
610 priv->settings_set = TRUE;
613 case PROP_TRACK_PRINT_STATUS:
614 gtk_print_job_set_track_print_status (job, g_value_get_boolean (value));
618 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
624 gtk_print_job_get_property (GObject *object,
629 GtkPrintJob *job = GTK_PRINT_JOB (object);
630 GtkPrintJobPrivate *priv = job->priv;
635 g_value_set_string (value, priv->title);
638 g_value_set_object (value, priv->printer);
641 g_value_set_object (value, priv->settings);
643 case PROP_PAGE_SETUP:
644 g_value_set_object (value, priv->page_setup);
646 case PROP_TRACK_PRINT_STATUS:
647 g_value_set_boolean (value, priv->track_print_status);
650 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
656 * gtk_print_job_send:
657 * @job: a GtkPrintJob
658 * @callback: function to call when the job completes or an error occurs
659 * @user_data: user data that gets passed to @callback
660 * @dnotify: destroy notify for @user_data
662 * Sends the print job off to the printer.
667 gtk_print_job_send (GtkPrintJob *job,
668 GtkPrintJobCompleteFunc callback,
670 GDestroyNotify dnotify)
672 GtkPrintJobPrivate *priv;
674 g_return_if_fail (GTK_IS_PRINT_JOB (job));
677 g_return_if_fail (priv->spool_io != NULL);
679 gtk_print_job_set_status (job, GTK_PRINT_STATUS_SENDING_DATA);
681 g_io_channel_seek_position (priv->spool_io, 0, G_SEEK_SET, NULL);
683 gtk_print_backend_print_stream (priv->backend, job,
685 callback, user_data, dnotify);
689 #define __GTK_PRINT_JOB_C__
690 #include "gtkaliasdef.c"