1/* GTK - The GIMP Toolkit
2 * gtkprintbackend.h: Abstract printer backend interfaces
3 * Copyright (C) 2006, Red Hat, Inc.
4 *
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.
9 *
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.
14 *
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/>.
17 */
18
19#ifndef __GTK_PRINT_BACKEND_PRIVATE_H__
20#define __GTK_PRINT_BACKEND_PRIVATE_H__
21
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
25 */
26#ifndef GTK_PRINT_BACKEND_ENABLE_UNSUPPORTED
27#error "GtkPrintBackend is not supported API for general use"
28#endif
29
30#include <gtk/gtk.h>
31#include <gtk/gtkunixprint.h>
32#include <gtk/gtkprinteroptionset.h>
33
34G_BEGIN_DECLS
35
36typedef struct _GtkPrintBackendClass GtkPrintBackendClass;
37typedef struct _GtkPrintBackendPrivate GtkPrintBackendPrivate;
38
39#define GTK_PRINT_BACKEND_ERROR (gtk_print_backend_error_quark ())
40
41typedef enum
42{
43 /* TODO: add specific errors */
44 GTK_PRINT_BACKEND_ERROR_GENERIC
45} GtkPrintBackendError;
46
47GDK_AVAILABLE_IN_ALL
48GQuark gtk_print_backend_error_quark (void);
49
50#define GTK_TYPE_PRINT_BACKEND (gtk_print_backend_get_type ())
51#define GTK_PRINT_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackend))
52#define GTK_PRINT_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendClass))
53#define GTK_IS_PRINT_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_BACKEND))
54#define GTK_IS_PRINT_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_BACKEND))
55#define GTK_PRINT_BACKEND_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendClass))
56
57typedef enum
58{
59 GTK_PRINT_BACKEND_STATUS_UNKNOWN,
60 GTK_PRINT_BACKEND_STATUS_OK,
61 GTK_PRINT_BACKEND_STATUS_UNAVAILABLE
62} GtkPrintBackendStatus;
63
64struct _GtkPrintBackend
65{
66 GObject parent_instance;
67
68 GtkPrintBackendPrivate *priv;
69};
70
71struct _GtkPrintBackendClass
72{
73 GObjectClass parent_class;
74
75 /* Global backend methods: */
76 void (*request_printer_list) (GtkPrintBackend *backend);
77 void (*print_stream) (GtkPrintBackend *backend,
78 GtkPrintJob *job,
79 GIOChannel *data_io,
80 GtkPrintJobCompleteFunc callback,
81 gpointer user_data,
82 GDestroyNotify dnotify);
83
84 /* Printer methods: */
85 void (*printer_request_details) (GtkPrinter *printer);
86 cairo_surface_t * (*printer_create_cairo_surface) (GtkPrinter *printer,
87 GtkPrintSettings *settings,
88 double height,
89 double width,
90 GIOChannel *cache_io);
91 GtkPrinterOptionSet * (*printer_get_options) (GtkPrinter *printer,
92 GtkPrintSettings *settings,
93 GtkPageSetup *page_setup,
94 GtkPrintCapabilities capabilities);
95 gboolean (*printer_mark_conflicts) (GtkPrinter *printer,
96 GtkPrinterOptionSet *options);
97 void (*printer_get_settings_from_options) (GtkPrinter *printer,
98 GtkPrinterOptionSet *options,
99 GtkPrintSettings *settings);
100 void (*printer_prepare_for_print) (GtkPrinter *printer,
101 GtkPrintJob *print_job,
102 GtkPrintSettings *settings,
103 GtkPageSetup *page_setup);
104 GList * (*printer_list_papers) (GtkPrinter *printer);
105 GtkPageSetup * (*printer_get_default_page_size) (GtkPrinter *printer);
106 gboolean (*printer_get_hard_margins) (GtkPrinter *printer,
107 double *top,
108 double *bottom,
109 double *left,
110 double *right);
111 GtkPrintCapabilities (*printer_get_capabilities) (GtkPrinter *printer);
112
113 /* Signals */
114 void (*printer_list_changed) (GtkPrintBackend *backend);
115 void (*printer_list_done) (GtkPrintBackend *backend);
116 void (*printer_added) (GtkPrintBackend *backend,
117 GtkPrinter *printer);
118 void (*printer_removed) (GtkPrintBackend *backend,
119 GtkPrinter *printer);
120 void (*printer_status_changed) (GtkPrintBackend *backend,
121 GtkPrinter *printer);
122 void (*request_password) (GtkPrintBackend *backend,
123 gpointer auth_info_required,
124 gpointer auth_info_default,
125 gpointer auth_info_display,
126 gpointer auth_info_visible,
127 const char *prompt,
128 gboolean can_store_auth_info);
129
130 /* not a signal */
131 void (*set_password) (GtkPrintBackend *backend,
132 char **auth_info_required,
133 char **auth_info,
134 gboolean store_auth_info);
135
136 gboolean (*printer_get_hard_margins_for_paper_size) (GtkPrinter *printer,
137 GtkPaperSize *paper_size,
138 double *top,
139 double *bottom,
140 double *left,
141 double *right);
142};
143
144#define GTK_PRINT_BACKEND_EXTENSION_POINT_NAME "gtk-print-backend"
145
146GDK_AVAILABLE_IN_ALL
147GType gtk_print_backend_get_type (void) G_GNUC_CONST;
148
149GDK_AVAILABLE_IN_ALL
150GList *gtk_print_backend_get_printer_list (GtkPrintBackend *print_backend);
151GDK_AVAILABLE_IN_ALL
152GListModel *gtk_print_backend_get_printers (GtkPrintBackend *print_backend);
153GDK_AVAILABLE_IN_ALL
154gboolean gtk_print_backend_printer_list_is_done (GtkPrintBackend *print_backend);
155GDK_AVAILABLE_IN_ALL
156GtkPrinter *gtk_print_backend_find_printer (GtkPrintBackend *print_backend,
157 const char *printer_name);
158GDK_AVAILABLE_IN_ALL
159void gtk_print_backend_print_stream (GtkPrintBackend *print_backend,
160 GtkPrintJob *job,
161 GIOChannel *data_io,
162 GtkPrintJobCompleteFunc callback,
163 gpointer user_data,
164 GDestroyNotify dnotify);
165GDK_AVAILABLE_IN_ALL
166GList * gtk_print_backend_load_modules (void);
167GDK_AVAILABLE_IN_ALL
168void gtk_print_backend_destroy (GtkPrintBackend *print_backend);
169GDK_AVAILABLE_IN_ALL
170void gtk_print_backend_set_password (GtkPrintBackend *backend,
171 char **auth_info_required,
172 char **auth_info,
173 gboolean can_store_auth_info);
174
175/* Backend-only functions for GtkPrintBackend */
176
177GDK_AVAILABLE_IN_ALL
178void gtk_print_backend_add_printer (GtkPrintBackend *print_backend,
179 GtkPrinter *printer);
180GDK_AVAILABLE_IN_ALL
181void gtk_print_backend_remove_printer (GtkPrintBackend *print_backend,
182 GtkPrinter *printer);
183GDK_AVAILABLE_IN_ALL
184void gtk_print_backend_set_list_done (GtkPrintBackend *backend);
185
186
187/* Backend-only functions for GtkPrinter */
188GDK_AVAILABLE_IN_ALL
189gboolean gtk_printer_is_new (GtkPrinter *printer);
190GDK_AVAILABLE_IN_ALL
191void gtk_printer_set_accepts_pdf (GtkPrinter *printer,
192 gboolean val);
193GDK_AVAILABLE_IN_ALL
194void gtk_printer_set_accepts_ps (GtkPrinter *printer,
195 gboolean val);
196GDK_AVAILABLE_IN_ALL
197void gtk_printer_set_is_new (GtkPrinter *printer,
198 gboolean val);
199GDK_AVAILABLE_IN_ALL
200void gtk_printer_set_is_active (GtkPrinter *printer,
201 gboolean val);
202GDK_AVAILABLE_IN_ALL
203gboolean gtk_printer_set_is_paused (GtkPrinter *printer,
204 gboolean val);
205GDK_AVAILABLE_IN_ALL
206gboolean gtk_printer_set_is_accepting_jobs (GtkPrinter *printer,
207 gboolean val);
208GDK_AVAILABLE_IN_ALL
209void gtk_printer_set_has_details (GtkPrinter *printer,
210 gboolean val);
211GDK_AVAILABLE_IN_ALL
212void gtk_printer_set_is_default (GtkPrinter *printer,
213 gboolean val);
214GDK_AVAILABLE_IN_ALL
215void gtk_printer_set_icon_name (GtkPrinter *printer,
216 const char *icon);
217GDK_AVAILABLE_IN_ALL
218gboolean gtk_printer_set_job_count (GtkPrinter *printer,
219 int count);
220GDK_AVAILABLE_IN_ALL
221gboolean gtk_printer_set_location (GtkPrinter *printer,
222 const char *location);
223GDK_AVAILABLE_IN_ALL
224gboolean gtk_printer_set_description (GtkPrinter *printer,
225 const char *description);
226GDK_AVAILABLE_IN_ALL
227gboolean gtk_printer_set_state_message (GtkPrinter *printer,
228 const char *message);
229
230void gtk_print_backends_init (void);
231
232
233G_END_DECLS
234
235#endif /* __GTK_PRINT_BACKEND_PRIVATE_H__ */
236

source code of gtk/gtk/gtkprintbackendprivate.h