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, see <http://www.gnu.org/licenses/>.
19 #ifndef __GTK_PRINT_BACKEND_H__
20 #define __GTK_PRINT_BACKEND_H__
22 /* This is a "semi-private" header; it is meant only for
23 * alternate GtkPrintDialog backend modules; no stability guarantees
24 * are made at this point
26 #ifndef GTK_PRINT_BACKEND_ENABLE_UNSUPPORTED
27 #error "GtkPrintBackend is not supported API for general use"
31 #include <gtk/gtkunixprint.h>
32 #include <gtk/gtkprinteroptionset.h>
36 typedef struct _GtkPrintBackendClass GtkPrintBackendClass;
37 typedef struct _GtkPrintBackendPrivate GtkPrintBackendPrivate;
39 #define GTK_PRINT_BACKEND_ERROR (gtk_print_backend_error_quark ())
43 /* TODO: add specific errors */
44 GTK_PRINT_BACKEND_ERROR_GENERIC
45 } GtkPrintBackendError;
47 GQuark gtk_print_backend_error_quark (void);
49 #define GTK_TYPE_PRINT_BACKEND (gtk_print_backend_get_type ())
50 #define GTK_PRINT_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackend))
51 #define GTK_PRINT_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendClass))
52 #define GTK_IS_PRINT_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_BACKEND))
53 #define GTK_IS_PRINT_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND))
54 #define GTK_PRINT_BACKEND_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendClass))
58 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
59 GTK_PRINT_BACKEND_STATUS_OK,
60 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE
61 } GtkPrintBackendStatus;
63 struct _GtkPrintBackend
65 GObject parent_instance;
67 GtkPrintBackendPrivate *priv;
70 struct _GtkPrintBackendClass
72 GObjectClass parent_class;
74 /* Global backend methods: */
75 void (*request_printer_list) (GtkPrintBackend *backend);
76 void (*print_stream) (GtkPrintBackend *backend,
79 GtkPrintJobCompleteFunc callback,
81 GDestroyNotify dnotify);
83 /* Printer methods: */
84 void (*printer_request_details) (GtkPrinter *printer);
85 cairo_surface_t * (*printer_create_cairo_surface) (GtkPrinter *printer,
86 GtkPrintSettings *settings,
89 GIOChannel *cache_io);
90 GtkPrinterOptionSet * (*printer_get_options) (GtkPrinter *printer,
91 GtkPrintSettings *settings,
92 GtkPageSetup *page_setup,
93 GtkPrintCapabilities capabilities);
94 gboolean (*printer_mark_conflicts) (GtkPrinter *printer,
95 GtkPrinterOptionSet *options);
96 void (*printer_get_settings_from_options) (GtkPrinter *printer,
97 GtkPrinterOptionSet *options,
98 GtkPrintSettings *settings);
99 void (*printer_prepare_for_print) (GtkPrinter *printer,
100 GtkPrintJob *print_job,
101 GtkPrintSettings *settings,
102 GtkPageSetup *page_setup);
103 GList * (*printer_list_papers) (GtkPrinter *printer);
104 GtkPageSetup * (*printer_get_default_page_size) (GtkPrinter *printer);
105 gboolean (*printer_get_hard_margins) (GtkPrinter *printer,
110 GtkPrintCapabilities (*printer_get_capabilities) (GtkPrinter *printer);
113 void (*printer_list_changed) (GtkPrintBackend *backend);
114 void (*printer_list_done) (GtkPrintBackend *backend);
115 void (*printer_added) (GtkPrintBackend *backend,
116 GtkPrinter *printer);
117 void (*printer_removed) (GtkPrintBackend *backend,
118 GtkPrinter *printer);
119 void (*printer_status_changed) (GtkPrintBackend *backend,
120 GtkPrinter *printer);
121 void (*request_password) (GtkPrintBackend *backend,
122 gpointer auth_info_required,
123 gpointer auth_info_default,
124 gpointer auth_info_display,
125 gpointer auth_info_visible,
126 const gchar *prompt);
129 void (*set_password) (GtkPrintBackend *backend,
130 gchar **auth_info_required,
133 /* Padding for future expansion */
134 void (*_gtk_reserved1) (void);
135 void (*_gtk_reserved2) (void);
136 void (*_gtk_reserved3) (void);
137 void (*_gtk_reserved4) (void);
140 GType gtk_print_backend_get_type (void) G_GNUC_CONST;
142 GList *gtk_print_backend_get_printer_list (GtkPrintBackend *print_backend);
143 gboolean gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend);
144 GtkPrinter *gtk_print_backend_find_printer (GtkPrintBackend *print_backend,
145 const gchar *printer_name);
146 void gtk_print_backend_print_stream (GtkPrintBackend *print_backend,
149 GtkPrintJobCompleteFunc callback,
151 GDestroyNotify dnotify);
152 GList * gtk_print_backend_load_modules (void);
153 void gtk_print_backend_destroy (GtkPrintBackend *print_backend);
154 void gtk_print_backend_set_password (GtkPrintBackend *backend,
155 gchar **auth_info_required,
158 /* Backend-only functions for GtkPrintBackend */
160 void gtk_print_backend_add_printer (GtkPrintBackend *print_backend,
161 GtkPrinter *printer);
162 void gtk_print_backend_remove_printer (GtkPrintBackend *print_backend,
163 GtkPrinter *printer);
164 void gtk_print_backend_set_list_done (GtkPrintBackend *backend);
167 /* Backend-only functions for GtkPrinter */
168 gboolean gtk_printer_is_new (GtkPrinter *printer);
169 void gtk_printer_set_accepts_pdf (GtkPrinter *printer,
171 void gtk_printer_set_accepts_ps (GtkPrinter *printer,
173 void gtk_printer_set_is_new (GtkPrinter *printer,
175 void gtk_printer_set_is_active (GtkPrinter *printer,
177 gboolean gtk_printer_set_is_paused (GtkPrinter *printer,
179 gboolean gtk_printer_set_is_accepting_jobs (GtkPrinter *printer,
181 void gtk_printer_set_has_details (GtkPrinter *printer,
183 void gtk_printer_set_is_default (GtkPrinter *printer,
185 void gtk_printer_set_icon_name (GtkPrinter *printer,
187 gboolean gtk_printer_set_job_count (GtkPrinter *printer,
189 gboolean gtk_printer_set_location (GtkPrinter *printer,
190 const gchar *location);
191 gboolean gtk_printer_set_description (GtkPrinter *printer,
192 const gchar *description);
193 gboolean gtk_printer_set_state_message (GtkPrinter *printer,
194 const gchar *message);
199 #endif /* __GTK_PRINT_BACKEND_H__ */