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);
89 GTK_PRINT_JOB_PROP_TITLE,
90 GTK_PRINT_JOB_PROP_PRINTER,
91 GTK_PRINT_JOB_PROP_PAGE_SETUP,
92 GTK_PRINT_JOB_PROP_SETTINGS
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 (G_OBJECT_CLASS (class),
113 GTK_PRINT_JOB_PROP_TITLE,
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 (G_OBJECT_CLASS (class),
122 GTK_PRINT_JOB_PROP_PRINTER,
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 (G_OBJECT_CLASS (class),
131 GTK_PRINT_JOB_PROP_SETTINGS,
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 (G_OBJECT_CLASS (class),
140 GTK_PRINT_JOB_PROP_PAGE_SETUP,
141 g_param_spec_object ("page-setup",
145 GTK_PARAM_READWRITE |
146 G_PARAM_CONSTRUCT_ONLY));
149 * GtkPrintJob::status-changed:
150 * @job: the #GtkPrintJob object on which the signal was emitted
152 * Gets emitted when the status of a job changes. The signal handler
153 * can use gtk_print_job_get_status() to obtain the new status.
157 signals[STATUS_CHANGED] =
158 g_signal_new (I_("status-changed"),
159 G_TYPE_FROM_CLASS (class),
161 G_STRUCT_OFFSET (GtkPrintJobClass, status_changed),
163 g_cclosure_marshal_VOID__VOID,
168 gtk_print_job_init (GtkPrintJob *job)
170 GtkPrintJobPrivate *priv;
172 priv = job->priv = GTK_PRINT_JOB_GET_PRIVATE (job);
174 priv->spool_file_fd = -1;
176 priv->title = g_strdup ("");
177 priv->surface = NULL;
178 priv->backend = NULL;
179 priv->printer = NULL;
181 priv->printer_set = FALSE;
182 priv->settings_set = FALSE;
183 priv->page_setup_set = FALSE;
184 priv->status = GTK_PRINT_STATUS_INITIAL;
185 priv->track_print_status = FALSE;
187 job->print_pages = GTK_PRINT_PAGES_ALL;
188 job->page_ranges = NULL;
189 job->num_page_ranges = 0;
190 job->collate = FALSE;
191 job->reverse = FALSE;
194 job->page_set = GTK_PAGE_SET_ALL;
195 job->rotate_to_orientation = FALSE;
200 gtk_print_job_constructor (GType type,
201 guint n_construct_properties,
202 GObjectConstructParam *construct_params)
205 GtkPrintJobPrivate *priv;
209 G_OBJECT_CLASS (gtk_print_job_parent_class)->constructor (type,
210 n_construct_properties,
213 job = GTK_PRINT_JOB (object);
216 g_assert (priv->printer_set &&
217 priv->settings_set &&
218 priv->page_setup_set);
220 _gtk_printer_prepare_for_print (priv->printer,
230 gtk_print_job_finalize (GObject *object)
232 GtkPrintJob *job = GTK_PRINT_JOB (object);
233 GtkPrintJobPrivate *priv = job->priv;
235 if (priv->spool_file_fd >= 0)
237 close (priv->spool_file_fd);
238 priv->spool_file_fd = -1;
242 g_object_unref (priv->backend);
245 g_object_unref (priv->printer);
248 cairo_surface_destroy (priv->surface);
251 g_object_unref (priv->settings);
253 if (priv->page_setup)
254 g_object_unref (priv->page_setup);
256 g_free (job->page_ranges);
257 job->page_ranges = NULL;
259 g_free (priv->title);
262 G_OBJECT_CLASS (gtk_print_job_parent_class)->finalize (object);
267 * @title: the job title
268 * @printer: a #GtkPrinter
269 * @settings: a #GtkPrintSettings
270 * @page_setup: a #GtkPageSetup
272 * Creates a new #GtkPrintJob.
274 * Return value: a new #GtkPrintJob
279 gtk_print_job_new (const gchar *title,
281 GtkPrintSettings *settings,
282 GtkPageSetup *page_setup)
285 result = g_object_new (GTK_TYPE_PRINT_JOB,
288 "settings", settings,
289 "page-setup", page_setup,
291 return (GtkPrintJob *) result;
295 * gtk_print_job_get_settings:
296 * @job: a #GtkPrintJob
298 * Gets the #GtkPrintSettings of the print job.
300 * Return value: the settings of @job
305 gtk_print_job_get_settings (GtkPrintJob *job)
307 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
309 return job->priv->settings;
313 * gtk_print_job_get_printer:
314 * @job: a #GtkPrintJob
316 * Gets the #GtkPrinter of the print job.
318 * Return value: the printer of @job
323 gtk_print_job_get_printer (GtkPrintJob *job)
325 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
327 return job->priv->printer;
331 * gtk_print_job_get_title:
332 * @job: a #GtkPrintJob
334 * Gets the job title.
336 * Return value: the title of @job
340 G_CONST_RETURN gchar *
341 gtk_print_job_get_title (GtkPrintJob *job)
343 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
345 return job->priv->title;
349 * gtk_print_job_get_status:
350 * @job: a #GtkPrintJob
352 * Gets the status of the print job.
354 * Return value: the status of @job
359 gtk_print_job_get_status (GtkPrintJob *job)
361 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), GTK_PRINT_STATUS_FINISHED);
363 return job->priv->status;
367 gtk_print_job_set_status (GtkPrintJob *job,
368 GtkPrintStatus status)
370 GtkPrintJobPrivate *priv;
372 g_return_if_fail (GTK_IS_PRINT_JOB (job));
376 if (priv->status == status)
379 priv->status = status;
380 g_signal_emit (job, signals[STATUS_CHANGED], 0);
384 * gtk_print_job_set_source_file:
385 * @job: a #GtkPrintJob
386 * @filename: the file to be printed
387 * @error: return location for errors
389 * Make the #GtkPrintJob send an existing document to the
390 * printing system. The file can be in any format understood
391 * by the platforms printing system (typically PostScript,
392 * but on many platforms PDF may work too).
394 * Returns: %FALSE if an error occurred
399 gtk_print_job_set_source_file (GtkPrintJob *job,
400 const gchar *filename,
403 GtkPrintJobPrivate *priv;
405 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
409 priv->spool_file_fd = g_open (filename, O_RDONLY|O_BINARY);
410 if (priv->spool_file_fd < 0)
412 gchar *display_filename = g_filename_display_name (filename);
413 int save_errno = errno;
417 g_file_error_from_errno (save_errno),
418 _("Failed to open file '%s': %s"),
420 g_strerror (save_errno));
422 g_free (display_filename);
430 * gtk_print_job_get_surface:
431 * @job: a #GtkPrintJob
432 * @error: return location for errors, or %NULL
434 * Gets a cairo surface onto which the pages of
435 * the print job should be rendered.
437 * Return value: the cairo surface of @job
442 gtk_print_job_get_surface (GtkPrintJob *job,
445 GtkPrintJobPrivate *priv;
447 gdouble width, height;
448 GtkPaperSize *paper_size;
450 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), NULL);
455 return priv->surface;
457 g_return_val_if_fail (priv->spool_file_fd == -1, NULL);
459 priv->spool_file_fd = g_file_open_tmp ("gtkprint_XXXXXX",
462 if (priv->spool_file_fd == -1)
465 fchmod (priv->spool_file_fd, S_IRUSR | S_IWUSR);
468 paper_size = gtk_page_setup_get_paper_size (priv->page_setup);
469 width = gtk_paper_size_get_width (paper_size, GTK_UNIT_POINTS);
470 height = gtk_paper_size_get_height (paper_size, GTK_UNIT_POINTS);
472 priv->surface = _gtk_printer_create_cairo_surface (priv->printer,
474 priv->spool_file_fd);
476 return priv->surface;
480 * gtk_print_job_set_track_print_status:
481 * @job: a #GtkPrintJob
482 * @track_status: %TRUE to track status after printing
484 * If track_status is %TRUE, the print job will try to continue report
485 * on the status of the print job in the printer queues and printer. This
486 * can allow your application to show things like "out of paper" issues,
487 * and when the print job actually reaches the printer.
489 * This function is often implemented using some form of polling, so it should
490 * not be enabled unless needed.
495 gtk_print_job_set_track_print_status (GtkPrintJob *job,
496 gboolean track_status)
498 GtkPrintJobPrivate *priv;
500 g_return_if_fail (GTK_IS_PRINT_JOB (job));
504 track_status = track_status != FALSE;
506 if (priv->track_print_status != track_status)
508 priv->track_print_status = track_status;
510 g_object_notify (job, "track-status");
515 * gtk_print_job_get_track_print_status:
516 * @job: a #GtkPrintJob
518 * Returns wheter jobs will be tracked after printing.
519 * For details, see gtk_print_job_set_track_print_status().
521 * Return value: %TRUE if print job status will be reported after printing
526 gtk_print_job_get_track_print_status (GtkPrintJob *job)
528 GtkPrintJobPrivate *priv;
530 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
534 return priv->track_print_status;
538 gtk_print_job_set_property (GObject *object,
544 GtkPrintJob *job = GTK_PRINT_JOB (object);
545 GtkPrintJobPrivate *priv = job->priv;
546 GtkPrintSettings *settings;
550 case GTK_PRINT_JOB_PROP_TITLE:
551 priv->title = g_value_dup_string (value);
554 case GTK_PRINT_JOB_PROP_PRINTER:
555 priv->printer = GTK_PRINTER (g_value_dup_object (value));
556 priv->printer_set = TRUE;
557 priv->backend = g_object_ref (gtk_printer_get_backend (priv->printer));
560 case GTK_PRINT_JOB_PROP_PAGE_SETUP:
561 priv->page_setup = GTK_PAGE_SETUP (g_value_dup_object (value));
562 priv->page_setup_set = TRUE;
565 case GTK_PRINT_JOB_PROP_SETTINGS:
566 /* We save a copy of the settings since we modify
567 * if when preparing the printer job. */
568 settings = GTK_PRINT_SETTINGS (g_value_get_object (value));
569 priv->settings = gtk_print_settings_copy (settings);
570 priv->settings_set = TRUE;
574 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
580 gtk_print_job_get_property (GObject *object,
585 GtkPrintJob *job = GTK_PRINT_JOB (object);
586 GtkPrintJobPrivate *priv = job->priv;
590 case GTK_PRINT_JOB_PROP_TITLE:
591 g_value_set_string (value, priv->title);
593 case GTK_PRINT_JOB_PROP_PRINTER:
594 g_value_set_object (value, priv->printer);
596 case GTK_PRINT_JOB_PROP_SETTINGS:
597 g_value_set_object (value, priv->settings);
599 case GTK_PRINT_JOB_PROP_PAGE_SETUP:
600 g_value_set_object (value, priv->page_setup);
603 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
609 * gtk_print_job_send:
610 * @job: a GtkPrintJob
611 * @callback: function to call when the job completes
612 * @user_data: user data that gets passed to @callback
613 * @dnotify: destroy notify for @user_data
614 * @error: return location for errors, or %NULL
616 * Sends the print job off to the printer.
618 * Return value: %FALSE if an error occurred
623 gtk_print_job_send (GtkPrintJob *job,
624 GtkPrintJobCompleteFunc callback,
626 GDestroyNotify dnotify,
629 GtkPrintJobPrivate *priv;
631 g_return_val_if_fail (GTK_IS_PRINT_JOB (job), FALSE);
634 g_return_val_if_fail (priv->spool_file_fd > 0, FALSE);
636 gtk_print_job_set_status (job, GTK_PRINT_STATUS_SENDING_DATA);
637 lseek (priv->spool_file_fd, 0, SEEK_SET);
638 gtk_print_backend_print_stream (priv->backend,
649 gtk_print_capabilities_get_type (void)
651 static GType etype = 0;
655 static const GFlagsValue values[] = {
656 { GTK_PRINT_CAPABILITY_PAGE_SET, "GTK_PRINT_CAPABILITY_PAGE_SET", "page-set" },
657 { GTK_PRINT_CAPABILITY_COPIES, "GTK_PRINT_CAPABILITY_COPIES", "copies" },
658 { GTK_PRINT_CAPABILITY_COLLATE, "GTK_PRINT_CAPABILITY_COLLATE", "collate" },
659 { GTK_PRINT_CAPABILITY_REVERSE, "GTK_PRINT_CAPABILITY_REVERSE", "reverse" },
660 { GTK_PRINT_CAPABILITY_SCALE, "GTK_PRINT_CAPABILITY_SCALE", "scale" },
664 etype = g_flags_register_static (I_("GtkPrintCapabilities"), values);
671 #define __GTK_PRINT_JOB_C__
672 #include "gtkaliasdef.c"