]> Pileus Git - ~andy/gtk/blob - gtk/gtkprintoperation.h
Merge the gtk-printing branch. For more detailed ChangeLog entries, see
[~andy/gtk] / gtk / gtkprintoperation.h
1 /* GTK - The GIMP Toolkit
2  * gtkprintoperation.h: Print Operation
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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 #ifndef __GTK_PRINT_OPERATION_H__
22 #define __GTK_PRINT_OPERATION_H__
23
24 #include <glib-object.h>
25 #include <cairo.h>
26 #include "gtkmain.h"
27 #include "gtkenums.h"
28 #include "gtkwindow.h"
29 #include "gtkpagesetup.h"
30 #include "gtkprintsettings.h"
31 #include "gtkprintcontext.h"
32
33 G_BEGIN_DECLS
34
35 #define GTK_TYPE_PRINT_OPERATION                (gtk_print_operation_get_type ())
36 #define GTK_PRINT_OPERATION(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperation))
37 #define GTK_PRINT_OPERATION_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationClass))
38 #define GTK_IS_PRINT_OPERATION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_OPERATION))
39 #define GTK_IS_PRINT_OPERATION_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_OPERATION))
40 #define GTK_PRINT_OPERATION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_OPERATION, GtkPrintOperationClass))
41
42 typedef struct _GtkPrintOperationClass   GtkPrintOperationClass;
43 typedef struct _GtkPrintOperationPrivate GtkPrintOperationPrivate;
44 typedef struct _GtkPrintOperation        GtkPrintOperation;
45
46 typedef enum {
47   GTK_PRINT_STATUS_INITIAL,
48   GTK_PRINT_STATUS_PREPARING,
49   GTK_PRINT_STATUS_GENERATING_DATA,
50   GTK_PRINT_STATUS_SENDING_DATA,
51   GTK_PRINT_STATUS_PENDING,
52   GTK_PRINT_STATUS_PENDING_ISSUE,
53   GTK_PRINT_STATUS_PRINTING,
54   GTK_PRINT_STATUS_FINISHED,
55   GTK_PRINT_STATUS_FINISHED_ABORTED
56 } GtkPrintStatus;
57
58 struct _GtkPrintOperation
59 {
60   GObject parent_instance;
61   
62   GtkPrintOperationPrivate *priv;
63 };
64
65 struct _GtkPrintOperationClass
66 {
67   GObjectClass parent_class;
68   
69   void (*begin_print)        (GtkPrintOperation *operation, 
70                               GtkPrintContext   *context);
71   void (*request_page_setup) (GtkPrintOperation *operation,
72                               GtkPrintContext   *context,
73                               gint               page_nr,
74                               GtkPageSetup      *setup);
75   void (*draw_page)          (GtkPrintOperation *operation,
76                               GtkPrintContext   *context,
77                               gint               page_nr);
78   void (*end_print)          (GtkPrintOperation *operation,
79                               GtkPrintContext   *context);
80   void (*status_changed)     (GtkPrintOperation *operation);
81   
82   /* Padding for future expansion */
83   void (*_gtk_reserved1) (void);
84   void (*_gtk_reserved2) (void);
85   void (*_gtk_reserved3) (void);
86   void (*_gtk_reserved4) (void);
87   void (*_gtk_reserved5) (void);
88   void (*_gtk_reserved6) (void);
89   void (*_gtk_reserved7) (void);
90 };
91
92 typedef enum {
93   GTK_PRINT_OPERATION_RESULT_ERROR,
94   GTK_PRINT_OPERATION_RESULT_APPLY,
95   GTK_PRINT_OPERATION_RESULT_CANCEL
96 } GtkPrintOperationResult;
97
98 #define GTK_PRINT_ERROR gtk_print_error_quark ()
99
100 typedef enum
101 {
102   GTK_PRINT_ERROR_GENERAL,
103   GTK_PRINT_ERROR_INTERNAL_ERROR,
104   GTK_PRINT_ERROR_NOMEM
105 } GtkPrintError;
106
107 GQuark gtk_print_error_quark (void);
108
109 GType                   gtk_print_operation_get_type               (void) G_GNUC_CONST;
110 GtkPrintOperation *     gtk_print_operation_new                    (void);
111 void                    gtk_print_operation_set_default_page_setup (GtkPrintOperation  *op,
112                                                                     GtkPageSetup       *default_page_setup);
113 GtkPageSetup *          gtk_print_operation_get_default_page_setup (GtkPrintOperation  *op);
114 void                    gtk_print_operation_set_print_settings     (GtkPrintOperation  *op,
115                                                                     GtkPrintSettings   *print_settings);
116 GtkPrintSettings *      gtk_print_operation_get_print_settings     (GtkPrintOperation  *op);
117 void                    gtk_print_operation_set_job_name           (GtkPrintOperation  *op,
118                                                                     const gchar        *job_name);
119 void                    gtk_print_operation_set_nr_of_pages        (GtkPrintOperation  *op,
120                                                                     gint                n_pages);
121 void                    gtk_print_operation_set_current_page       (GtkPrintOperation  *op,
122                                                                     gint                current_page);
123 void                    gtk_print_operation_set_use_full_page      (GtkPrintOperation  *op,
124                                                                     gboolean            full_page);
125 void                    gtk_print_operation_set_unit               (GtkPrintOperation  *op,
126                                                                     GtkUnit             unit);
127 void                    gtk_print_operation_set_show_dialog        (GtkPrintOperation  *op,
128                                                                     gboolean            show_dialog);
129 void                    gtk_print_operation_set_pdf_target         (GtkPrintOperation  *op,
130                                                                     const gchar        *filename);
131 GtkPrintOperationResult gtk_print_operation_run                    (GtkPrintOperation  *op,
132                                                                     GtkWindow          *parent,
133                                                                     GError            **error);
134 GtkPrintStatus          gtk_print_operation_get_status             (GtkPrintOperation  *op);
135 G_CONST_RETURN gchar *  gtk_print_operation_get_status_string      (GtkPrintOperation  *op);
136 gboolean                gtk_print_operation_is_finished            (GtkPrintOperation  *op);
137
138 GtkPageSetup           *gtk_print_run_page_setup_dialog            (GtkWindow          *parent,
139                                                                     GtkPageSetup       *page_setup,
140                                                                     GtkPrintSettings   *settings);
141
142 G_END_DECLS
143
144 #endif /* __GTK_PRINT_OPERATION_H__ */