summaryrefslogtreecommitdiff
path: root/gtk/gtkprintbackend.h
blob: de225f9e3a3e6436153bed39f9e06fc4bedb3c50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/* GTK - The GIMP Toolkit
 * gtkprintbackend.h: Abstract printer backend interfaces
 * Copyright (C) 2006, Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GTK_PRINT_BACKEND_H__
#define __GTK_PRINT_BACKEND_H__

/* This is a "semi-private" header; it is meant only for
 * alternate GtkPrintDialog backend modules; no stability guarantees 
 * are made at this point
 */
#ifndef GTK_PRINT_BACKEND_ENABLE_UNSUPPORTED
#error "GtkPrintBackend is not supported API for general use"
#endif

#include <glib-object.h>
#include <cairo.h>

#include "gtkprinter-private.h"
#include "gtkprintsettings.h"
#include "gtkprinteroption.h"
#include "gtkprintjob.h"

G_BEGIN_DECLS

typedef struct _GtkPrintBackendIface  GtkPrintBackendIface;

#define GTK_PRINT_BACKEND_ERROR (gtk_print_backend_error_quark ())

typedef enum
{
  /* TODO: add specific errors */
  GTK_PRINT_BACKEND_ERROR_GENERIC
} GtkPrintBackendError;

GQuark     gtk_print_backend_error_quark      (void);

#define GTK_TYPE_PRINT_BACKEND             (gtk_print_backend_get_type ())
#define GTK_PRINT_BACKEND(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_BACKEND, GtkPrintBackend))
#define GTK_IS_PRINT_BACKEND(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_BACKEND))
#define GTK_PRINT_BACKEND_GET_IFACE(inst)  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_PRINT_BACKEND, GtkPrintBackendIface))

struct _GtkPrintBackendIface
{
  GTypeInterface base_iface;

  /* Global backend methods: */
  GList      * (*get_printer_list) (GtkPrintBackend *printer_backend);

  GtkPrinter * (*find_printer) (GtkPrintBackend *print_backend,
                                const gchar *printer_name);
  void         (*print_stream) (GtkPrintBackend *print_backend,
                                GtkPrintJob *job,
				gint data_fd,
				GtkPrintJobCompleteFunc callback,
				gpointer user_data,
				GDestroyNotify dnotify);

  /* Printer methods: */
  void                  (*printer_request_details)           (GtkPrinter *printer);
  cairo_surface_t *     (*printer_create_cairo_surface)      (GtkPrinter *printer,
							      gdouble height,
							      gdouble width,
							      gint cache_fd);
  GtkPrinterOptionSet * (*printer_get_options)               (GtkPrinter *printer,
							      GtkPrintSettings *settings,
							      GtkPageSetup *page_setup);
  gboolean              (*printer_mark_conflicts)            (GtkPrinter *printer,
							      GtkPrinterOptionSet *options);
  void                  (*printer_get_settings_from_options) (GtkPrinter *printer,
							      GtkPrinterOptionSet *options,
							      GtkPrintSettings *settings);
  void                  (*printer_prepare_for_print)         (GtkPrinter *printer,
							      GtkPrintJob *print_job,
							      GtkPrintSettings *settings,
							      GtkPageSetup *page_setup);
  GList  *              (*printer_list_papers)               (GtkPrinter *printer);
  void                  (*printer_get_hard_margins)          (GtkPrinter *printer,
							      double     *top,
							      double     *bottom,
							      double     *left,
							      double     *right);

  /* Signals 
   */
  void (*printer_list_changed)   (void);
  void (*printer_added)          (GtkPrinter *printer);
  void (*printer_removed)        (GtkPrinter *printer);
  void (*printer_status_changed) (GtkPrinter *printer);
};

GType   gtk_print_backend_get_type       (void) G_GNUC_CONST;

GList      *gtk_print_backend_get_printer_list (GtkPrintBackend         *print_backend);
GtkPrinter *gtk_print_backend_find_printer     (GtkPrintBackend         *print_backend,
						const gchar             *printer_name);
void        gtk_print_backend_print_stream     (GtkPrintBackend         *print_backend,
						GtkPrintJob             *job,
						gint                     data_fd,
						GtkPrintJobCompleteFunc  callback,
						gpointer                 user_data,
						GDestroyNotify           dnotify);
GList *     gtk_print_backend_load_modules     (void);


/* Backend-only functions for GtkPrinter */

GtkPrinter *gtk_printer_new               (const char      *name,
					   GtkPrintBackend *backend,
					   gboolean         is_virtual);
gboolean    gtk_printer_is_new            (GtkPrinter      *printer);
void        gtk_printer_set_is_new        (GtkPrinter      *printer,
					   gboolean         val);
void        gtk_printer_set_is_active     (GtkPrinter      *printer,
					   gboolean         val);
void        gtk_printer_set_has_details   (GtkPrinter      *printer,
					   gboolean         val);
void        gtk_printer_set_is_default    (GtkPrinter      *printer,
					   gboolean         val);
void        gtk_printer_set_icon_name     (GtkPrinter      *printer,
					   const gchar     *icon);
gboolean    gtk_printer_set_job_count     (GtkPrinter      *printer,
					   gint             count);
gboolean    gtk_printer_set_location      (GtkPrinter      *printer,
					   const gchar     *location);
gboolean    gtk_printer_set_description   (GtkPrinter      *printer,
					   const gchar     *description);
gboolean    gtk_printer_set_state_message (GtkPrinter      *printer,
					   const gchar     *message);
void        gtk_printer_set_is_active     (GtkPrinter      *printer,
					   gboolean         active);


G_END_DECLS

#endif /* __GTK_PRINT_BACKEND_H__ */