1 /* GTK - The GIMP Toolkit
2 * gtkprintbackend.h: Abstract printer backend interfaces
3 * Copyright (C) 2006, Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 #ifndef __GTK_PRINT_BACKEND_H__
22 #define __GTK_PRINT_BACKEND_H__
24 /* This is a "semi-private" header; it is meant only for
25 * alternate GtkPrintDialog backend modules; no stability guarantees
26 * are made at this point
28 #ifndef GTK_PRINT_BACKEND_ENABLE_UNSUPPORTED
29 #error "GtkPrintBackend is not supported API for general use"
33 #include <gtk/gtkunixprint.h>
34 #include <gtk/gtkprinteroptionset.h>
38 typedef struct _GtkPrintBackendClass GtkPrintBackendClass;
39 typedef struct _GtkPrintBackendPrivate GtkPrintBackendPrivate;
41 #define GTK_PRINT_BACKEND_ERROR (gtk_print_backend_error_quark ())
45 /* TODO: add specific errors */
46 GTK_PRINT_BACKEND_ERROR_GENERIC
47 } GtkPrintBackendError;
49 GQuark gtk_print_backend_error_quark (void);
51 #define GTK_TYPE_PRINT_BACKEND (gtk_print_backend_get_type ())
52 #define GTK_PRINT_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackend))
53 #define GTK_PRINT_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendClass))
54 #define GTK_IS_PRINT_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_BACKEND))
55 #define GTK_IS_PRINT_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND))
56 #define GTK_PRINT_BACKEND_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendClass))
60 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
61 GTK_PRINT_BACKEND_STATUS_OK,
62 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE
63 } GtkPrintBackendStatus;
65 struct _GtkPrintBackend
67 GObject parent_instance;
69 GtkPrintBackendPrivate *priv;
72 struct _GtkPrintBackendClass
74 GObjectClass parent_class;
76 /* Global backend methods: */
77 void (*request_printer_list) (GtkPrintBackend *backend);
78 void (*print_stream) (GtkPrintBackend *backend,
81 GtkPrintJobCompleteFunc callback,
83 GDestroyNotify dnotify);
85 /* Printer methods: */
86 void (*printer_request_details) (GtkPrinter *printer);
87 cairo_surface_t * (*printer_create_cairo_surface) (GtkPrinter *printer,
88 GtkPrintSettings *settings,
91 GIOChannel *cache_io);
92 GtkPrinterOptionSet * (*printer_get_options) (GtkPrinter *printer,
93 GtkPrintSettings *settings,
94 GtkPageSetup *page_setup,
95 GtkPrintCapabilities capabilities);
96 gboolean (*printer_mark_conflicts) (GtkPrinter *printer,
97 GtkPrinterOptionSet *options);
98 void (*printer_get_settings_from_options) (GtkPrinter *printer,
99 GtkPrinterOptionSet *options,
100 GtkPrintSettings *settings);
101 void (*printer_prepare_for_print) (GtkPrinter *printer,
102 GtkPrintJob *print_job,
103 GtkPrintSettings *settings,
104 GtkPageSetup *page_setup);
105 GList * (*printer_list_papers) (GtkPrinter *printer);
106 GtkPageSetup * (*printer_get_default_page_size) (GtkPrinter *printer);
107 gboolean (*printer_get_hard_margins) (GtkPrinter *printer,
112 GtkPrintCapabilities (*printer_get_capabilities) (GtkPrinter *printer);
115 void (*printer_list_changed) (GtkPrintBackend *backend);
116 void (*printer_list_done) (GtkPrintBackend *backend);
117 void (*printer_added) (GtkPrintBackend *backend,
118 GtkPrinter *printer);
119 void (*printer_removed) (GtkPrintBackend *backend,
120 GtkPrinter *printer);
121 void (*printer_status_changed) (GtkPrintBackend *backend,
122 GtkPrinter *printer);
123 void (*request_password) (GtkPrintBackend *backend,
124 gpointer auth_info_required,
125 gpointer auth_info_default,
126 gpointer auth_info_display,
127 gpointer auth_info_visible,
128 const gchar *prompt);
131 void (*set_password) (GtkPrintBackend *backend,
132 gchar **auth_info_required,
135 /* Padding for future expansion */
136 void (*_gtk_reserved1) (void);
137 void (*_gtk_reserved2) (void);
138 void (*_gtk_reserved3) (void);
139 void (*_gtk_reserved4) (void);
142 GType gtk_print_backend_get_type (void) G_GNUC_CONST;
144 GList *gtk_print_backend_get_printer_list (GtkPrintBackend *print_backend);
145 gboolean gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend);
146 GtkPrinter *gtk_print_backend_find_printer (GtkPrintBackend *print_backend,
147 const gchar *printer_name);
148 void gtk_print_backend_print_stream (GtkPrintBackend *print_backend,
151 GtkPrintJobCompleteFunc callback,
153 GDestroyNotify dnotify);
154 GList * gtk_print_backend_load_modules (void);
155 void gtk_print_backend_destroy (GtkPrintBackend *print_backend);
156 void gtk_print_backend_set_password (GtkPrintBackend *backend,
157 gchar **auth_info_required,
160 /* Backend-only functions for GtkPrintBackend */
162 void gtk_print_backend_add_printer (GtkPrintBackend *print_backend,
163 GtkPrinter *printer);
164 void gtk_print_backend_remove_printer (GtkPrintBackend *print_backend,
165 GtkPrinter *printer);
166 void gtk_print_backend_set_list_done (GtkPrintBackend *backend);
169 /* Backend-only functions for GtkPrinter */
171 GtkPrinter *gtk_printer_new (const char *name,
172 GtkPrintBackend *backend,
173 gboolean is_virtual);
174 gboolean gtk_printer_is_new (GtkPrinter *printer);
175 void gtk_printer_set_is_new (GtkPrinter *printer,
177 void gtk_printer_set_is_active (GtkPrinter *printer,
179 gboolean gtk_printer_set_is_paused (GtkPrinter *printer,
181 gboolean gtk_printer_set_is_accepting_jobs (GtkPrinter *printer,
183 void gtk_printer_set_has_details (GtkPrinter *printer,
185 void gtk_printer_set_is_default (GtkPrinter *printer,
187 void gtk_printer_set_icon_name (GtkPrinter *printer,
189 gboolean gtk_printer_set_job_count (GtkPrinter *printer,
191 gboolean gtk_printer_set_location (GtkPrinter *printer,
192 const gchar *location);
193 gboolean gtk_printer_set_description (GtkPrinter *printer,
194 const gchar *description);
195 gboolean gtk_printer_set_state_message (GtkPrinter *printer,
196 const gchar *message);
201 #endif /* __GTK_PRINT_BACKEND_H__ */