Pileus Git - ~andy/gtk/blob - gtk/gtkprintjob.h

   1 /* GtkPrintJob
   2  * Copyright (C) 2006 Red Hat,Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GTK_PRINT_JOB_H__
  19 #define __GTK_PRINT_JOB_H__
  20
  21 #if !defined (__GTK_UNIX_PRINT_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtkunixprint.h> can be included directly."
  23 #endif
  24
  25 #include <cairo.h>
  26
  27 #include <gtk/gtk.h>
  28 #include <gtk/gtkprinter.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_PRINT_JOB                  (gtk_print_job_get_type ())
  33 #define GTK_PRINT_JOB(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_JOB, GtkPrintJob))
  34 #define GTK_PRINT_JOB_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_JOB, GtkPrintJobClass))
  35 #define GTK_IS_PRINT_JOB(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_JOB))
  36 #define GTK_IS_PRINT_JOB_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_JOB))
  37 #define GTK_PRINT_JOB_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_JOB, GtkPrintJobClass))
  38
  39 typedef struct _GtkPrintJob          GtkPrintJob;
  40 typedef struct _GtkPrintJobClass     GtkPrintJobClass;
  41 typedef struct _GtkPrintJobPrivate   GtkPrintJobPrivate;
  42
  43 /**
  44  * GtkPrintJobCompleteFunc:
  45  * @print_job: the #GtkPrintJob
  46  * @user_data: user data that has been passed to gtk_print_job_send()
  47  * @error: a #GError that contains error information if the sending
  48  *     of the print job failed, otherwise %NULL
  49  *
  50  * The type of callback that is passed to gtk_print_job_send().
  51  * It is called when the print job has been completely sent.
  52  */
  53 typedef void (*GtkPrintJobCompleteFunc) (GtkPrintJob  *print_job,
  54                                          gpointer      user_data,
  55                                          const GError *error);
  56
  57 struct _GtkPrinter;
  58
  59 struct _GtkPrintJob
  60 {
  61   GObject parent_instance;
  62
  63   GtkPrintJobPrivate *priv;
  64 };
  65
  66 struct _GtkPrintJobClass
  67 {
  68   GObjectClass parent_class;
  69
  70   void (*status_changed) (GtkPrintJob *job);
  71
  72   /* Padding for future expansion */
  73   void (*_gtk_reserved1) (void);
  74   void (*_gtk_reserved2) (void);
  75   void (*_gtk_reserved3) (void);
  76   void (*_gtk_reserved4) (void);
  77 };
  78
  79 GType                    gtk_print_job_get_type               (void) G_GNUC_CONST;
  80 GtkPrintJob             *gtk_print_job_new                    (const gchar              *title,
  81                                                                GtkPrinter               *printer,
  82                                                                GtkPrintSettings         *settings,
  83                                                                GtkPageSetup             *page_setup);
  84 GtkPrintSettings        *gtk_print_job_get_settings           (GtkPrintJob              *job);
  85 GtkPrinter              *gtk_print_job_get_printer            (GtkPrintJob              *job);
  86 const gchar *            gtk_print_job_get_title              (GtkPrintJob              *job);
  87 GtkPrintStatus           gtk_print_job_get_status             (GtkPrintJob              *job);
  88 gboolean                 gtk_print_job_set_source_file        (GtkPrintJob              *job,
  89                                                                const gchar              *filename,
  90                                                                GError                  **error);
  91 cairo_surface_t         *gtk_print_job_get_surface            (GtkPrintJob              *job,
  92                                                                GError                  **error);
  93 void                     gtk_print_job_set_track_print_status (GtkPrintJob              *job,
  94                                                                gboolean                  track_status);
  95 gboolean                 gtk_print_job_get_track_print_status (GtkPrintJob              *job);
  96 void                     gtk_print_job_send                   (GtkPrintJob              *job,
  97                                                                GtkPrintJobCompleteFunc   callback,
  98                                                                gpointer                  user_data,
  99                                                                GDestroyNotify            dnotify);
 100
 101 GtkPrintPages     gtk_print_job_get_pages       (GtkPrintJob       *job);
 102 void              gtk_print_job_set_pages       (GtkPrintJob       *job,
 103                                                  GtkPrintPages      pages);
 104 GtkPageRange *    gtk_print_job_get_page_ranges (GtkPrintJob       *job,
 105                                                  gint              *n_ranges);
 106 void              gtk_print_job_set_page_ranges (GtkPrintJob       *job,
 107                                                  GtkPageRange      *ranges,
 108                                                  gint               n_ranges);
 109 GtkPageSet        gtk_print_job_get_page_set    (GtkPrintJob       *job);
 110 void              gtk_print_job_set_page_set    (GtkPrintJob       *job,
 111                                                  GtkPageSet         page_set);
 112 gint              gtk_print_job_get_num_copies  (GtkPrintJob       *job);
 113 void              gtk_print_job_set_num_copies  (GtkPrintJob       *job,
 114                                                  gint               num_copies);
 115 gdouble           gtk_print_job_get_scale       (GtkPrintJob       *job);
 116 void              gtk_print_job_set_scale       (GtkPrintJob       *job,
 117                                                  gdouble            scale);
 118 guint             gtk_print_job_get_n_up        (GtkPrintJob       *job);
 119 void              gtk_print_job_set_n_up        (GtkPrintJob       *job,
 120                                                  guint              n_up);
 121 GtkNumberUpLayout gtk_print_job_get_n_up_layout (GtkPrintJob       *job);
 122 void              gtk_print_job_set_n_up_layout (GtkPrintJob       *job,
 123                                                  GtkNumberUpLayout  layout);
 124 gboolean          gtk_print_job_get_rotate      (GtkPrintJob       *job);
 125 void              gtk_print_job_set_rotate      (GtkPrintJob       *job,
 126                                                  gboolean           rotate);
 127 gboolean          gtk_print_job_get_collate     (GtkPrintJob       *job);
 128 void              gtk_print_job_set_collate     (GtkPrintJob       *job,
 129                                                  gboolean           collate);
 130 gboolean          gtk_print_job_get_reverse     (GtkPrintJob       *job);
 131 void              gtk_print_job_set_reverse     (GtkPrintJob       *job,
 132                                                  gboolean           reverse);
 133
 134 G_END_DECLS
 135
 136 #endif /* __GTK_PRINT_JOB_H__ */