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;
212 gtk_print_job_constructor (GType type,
213 guint n_construct_properties,
214 GObjectConstructParam *construct_params)
217 GtkPrintJobPrivate *priv;
221 G_OBJECT_CLASS (gtk_print_job_parent_class)->constructor (type,
222 n_construct_properties,
225 job = GTK_PRINT_JOB (object);
228 g_assert (priv->printer_set &&
229 priv->settings_set &&
230 priv->page_setup_set);
232 _gtk_printer_prepare_for_print (priv->printer,
242 gtk_print_job_finalize (GObject *object)
244 GtkPrintJob *job = GTK_PRINT_JOB (object);
245 GtkPrintJobPrivate *priv = job->priv;
247 if (priv->spool_io != NULL)
249 g_io_channel_unref (priv->spool_io);
250 priv->spool_io = NULL;
254 g_object_unref (priv->backend);
257 g_object_unref (priv->printer);
260 cairo_surface_destroy (priv->surface);
263 g_object_unref (priv->settings);
265 if (priv->page_setup)
266 g_object_unref (priv->page_setup);
268 g_free (job->page_ranges);
269 job->page_ranges = NULL;
271 g_free (priv->title);
274 G_OBJECT_CLASS (gtk_print_job_parent_class)->finalize (object);
279 * @title: the job title
280 * @printer: a #GtkPrinter
281 * @settings: a #GtkPrintSettings
282 * @page_setup: a #GtkPageSetup
284 * Creates a new #GtkPrintJob.
286 * Return value: a new #GtkPrintJob
291 gtk_print_job_new (const gchar *title,
293 GtkPrintSettings *settings,
294 GtkPageSetup *page_setup)
297 result = g_object_new (GTK_TYPE_PRINT_JOB,
300 "settings", settings,
301 "page-setup", page_setup,
303 return (GtkPrintJob *) result;
307 * gtk_print_job_get_settings:
308 * @job: a #GtkPrintJob
310 * Gets the #GtkPrintSettings of the print job.
312 * Return value: the settings of @job
317 gtk_print_job_get_settings (GtkPrintJob *job)
319 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
321 return job->priv->settings;
325 * gtk_print_job_get_printer:
326 * @job: a #GtkPrintJob
328 * Gets the #GtkPrinter of the print job.
330 * Return value: the printer of @job
335 gtk_print_job_get_printer (GtkPrintJob *job)
337 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
339 return job->priv->printer;
343 * gtk_print_job_get_title:
344 * @job: a #GtkPrintJob
346 * Gets the job title.
348 * Return value: the title of @job
352 G_CONST_RETURN gchar *
353 gtk_print_job_get_title (GtkPrintJob *job)
355 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
357 return job->priv->title;
361 * gtk_print_job_get_status:
362 * @job: a #GtkPrintJob
364 * Gets the status of the print job.
366 * Return value: the status of @job
371 gtk_print_job_get_status (GtkPrintJob *job)
373 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), GTK_PRINT_STATUS_FINISHED);
375 return job->priv->status;
379 gtk_print_job_set_status (GtkPrintJob *job,
380 GtkPrintStatus status)
382 GtkPrintJobPrivate *priv;
384 g_return_if_fail (GTK_IS_PRINT_JOB (job));
388 if (priv->status == status)
391 priv->status = status;
392 g_signal_emit (job, signals[STATUS_CHANGED], 0);
396 * gtk_print_job_set_source_file:
397 * @job: a #GtkPrintJob
398 * @filename: the file to be printed
399 * @error: return location for errors
401 * Make the #GtkPrintJob send an existing document to the
402 * printing system. The file can be in any format understood
403 * by the platforms printing system (typically PostScript,
404 * but on many platforms PDF may work too). See
405 * gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
407 * Returns: %FALSE if an error occurred
412 gtk_print_job_set_source_file (GtkPrintJob *job,
413 const gchar *filename,
416 GtkPrintJobPrivate *priv;
421 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
425 priv->spool_io = g_io_channel_new_file (filename, "r", &tmp_error);
427 if (tmp_error == NULL)
428 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
430 if (tmp_error != NULL)
432 g_propagate_error (error, tmp_error);
440 * gtk_print_job_get_surface:
441 * @job: a #GtkPrintJob
442 * @error: return location for errors, or %NULL
444 * Gets a cairo surface onto which the pages of
445 * the print job should be rendered.
447 * Return value: the cairo surface of @job
452 gtk_print_job_get_surface (GtkPrintJob *job,
455 GtkPrintJobPrivate *priv;
457 gdouble width, height;
458 GtkPaperSize *paper_size;
464 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
469 return priv->surface;
471 g_return_val_if_fail (priv->spool_io == NULL, NULL);
473 fd = g_file_open_tmp ("gtkprint_XXXXXX",
479 g_propagate_error (error, tmp_error);
483 fchmod (fd, S_IRUSR | S_IWUSR);
485 #ifdef G_ENABLE_DEBUG
486 /* If we are debugging printing don't delete the tmp files */
487 if (!(gtk_debug_flags & GTK_DEBUG_PRINTING))
488 #endif /* G_ENABLE_DEBUG */
492 paper_size = gtk_page_setup_get_paper_size (priv->page_setup);
493 width = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
494 height = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
496 priv->spool_io = g_io_channel_unix_new (fd);
497 g_io_channel_set_close_on_unref (priv->spool_io, TRUE);
498 g_io_channel_set_encoding (priv->spool_io, NULL, &tmp_error);
500 if (tmp_error != NULL)
502 g_io_channel_unref (priv->spool_io);
503 priv->spool_io = NULL;
504 g_propagate_error (error, tmp_error);
508 priv->surface = _gtk_printer_create_cairo_surface (priv->printer,
513 return priv->surface;
517 * gtk_print_job_set_track_print_status:
518 * @job: a #GtkPrintJob
519 * @track_status: %TRUE to track status after printing
521 * If track_status is %TRUE, the print job will try to continue report
522 * on the status of the print job in the printer queues and printer. This
523 * can allow your application to show things like "out of paper" issues,
524 * and when the print job actually reaches the printer.
526 * This function is often implemented using some form of polling, so it should
527 * not be enabled unless needed.
532 gtk_print_job_set_track_print_status (GtkPrintJob *job,
533 gboolean track_status)
535 GtkPrintJobPrivate *priv;
537 g_return_if_fail (GTK_IS_PRINT_JOB (job));
541 track_status = track_status != FALSE;
543 if (priv->track_print_status != track_status)
545 priv->track_print_status = track_status;
547 g_object_notify (G_OBJECT (job), "track-print-status");
552 * gtk_print_job_get_track_print_status:
553 * @job: a #GtkPrintJob
555 * Returns wheter jobs will be tracked after printing.
556 * For details, see gtk_print_job_set_track_print_status().
558 * Return value: %TRUE if print job status will be reported after printing
563 gtk_print_job_get_track_print_status (GtkPrintJob *job)
565 GtkPrintJobPrivate *priv;
567 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
571 return priv->track_print_status;
575 gtk_print_job_set_property (GObject *object,
581 GtkPrintJob *job = GTK_PRINT_JOB (object);
582 GtkPrintJobPrivate *priv = job->priv;
583 GtkPrintSettings *settings;
588 g_free (priv->title);
589 priv->title = g_value_dup_string (value);
593 priv->printer = GTK_PRINTER (g_value_dup_object (value));
594 priv->printer_set = TRUE;
595 priv->backend = g_object_ref (gtk_printer_get_backend (priv->printer));
598 case PROP_PAGE_SETUP:
599 priv->page_setup = GTK_PAGE_SETUP (g_value_dup_object (value));
600 priv->page_setup_set = TRUE;
604 /* We save a copy of the settings since we modify
605 * if when preparing the printer job. */
606 settings = GTK_PRINT_SETTINGS (g_value_get_object (value));
607 priv->settings = gtk_print_settings_copy (settings);
608 priv->settings_set = TRUE;
611 case PROP_TRACK_PRINT_STATUS:
612 gtk_print_job_set_track_print_status (job, g_value_get_boolean (value));
616 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
622 gtk_print_job_get_property (GObject *object,
627 GtkPrintJob *job = GTK_PRINT_JOB (object);
628 GtkPrintJobPrivate *priv = job->priv;
633 g_value_set_string (value, priv->title);
636 g_value_set_object (value, priv->printer);
639 g_value_set_object (value, priv->settings);
641 case PROP_PAGE_SETUP:
642 g_value_set_object (value, priv->page_setup);
644 case PROP_TRACK_PRINT_STATUS:
645 g_value_set_boolean (value, priv->track_print_status);
648 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
654 * gtk_print_job_send:
655 * @job: a GtkPrintJob
656 * @callback: function to call when the job completes or an error occurs
657 * @user_data: user data that gets passed to @callback
658 * @dnotify: destroy notify for @user_data
660 * Sends the print job off to the printer.
665 gtk_print_job_send (GtkPrintJob *job,
666 GtkPrintJobCompleteFunc callback,
668 GDestroyNotify dnotify)
670 GtkPrintJobPrivate *priv;
672 g_return_if_fail (GTK_IS_PRINT_JOB (job));
675 g_return_if_fail (priv->spool_io != NULL);
677 gtk_print_job_set_status (job, GTK_PRINT_STATUS_SENDING_DATA);
679 g_io_channel_seek_position (priv->spool_io, 0, G_SEEK_SET, NULL);
681 gtk_print_backend_print_stream (priv->backend, job,
683 callback, user_data, dnotify);
687 #define __GTK_PRINT_JOB_C__
688 #include "gtkaliasdef.c"