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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if !defined (__GTK_UNIX_PRINT_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtkunixprint.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_PRINT_JOB_H__
  25 #define __GTK_PRINT_JOB_H__
  26
  27 #include <cairo.h>
  28
  29 #include <gtk/gtk.h>
  30 #include <gtk/gtkprinter.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GTK_TYPE_PRINT_JOB                  (gtk_print_job_get_type ())
  35 #define GTK_PRINT_JOB(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_JOB, GtkPrintJob))
  36 #define GTK_PRINT_JOB_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PRINT_JOB, GtkPrintJobClass))
  37 #define GTK_IS_PRINT_JOB(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_JOB))
  38 #define GTK_IS_PRINT_JOB_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_JOB))
  39 #define GTK_PRINT_JOB_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PRINT_JOB, GtkPrintJobClass))
  40
  41 typedef struct _GtkPrintJob          GtkPrintJob;
  42 typedef struct _GtkPrintJobClass     GtkPrintJobClass;
  43 typedef struct _GtkPrintJobPrivate   GtkPrintJobPrivate;
  44
  45 /**
  46  * GtkPrintJobCompleteFunc:
  47  * @print_job: the #GtkPrintJob
  48  * @user_data: user data that has been passed to gtk_print_job_send()
  49  * @error: a #GError that contains error information if the sending
  50  *     of the print job failed, otherwise %NULL
  51  *
  52  * The type of callback that is passed to gtk_print_job_send().
  53  * It is called when the print job has been completely sent.
  54  */
  55 typedef void (*GtkPrintJobCompleteFunc) (GtkPrintJob  *print_job,
  56                                          gpointer      user_data,
  57                                          const GError *error);
  58
  59 struct _GtkPrinter;
  60
  61 struct _GtkPrintJob
  62 {
  63   GObject parent_instance;
  64
  65   GtkPrintJobPrivate *priv;
  66 };
  67
  68 struct _GtkPrintJobClass
  69 {
  70   GObjectClass parent_class;
  71
  72   void (*status_changed) (GtkPrintJob *job);
  73
  74   /* Padding for future expansion */
  75   void (*_gtk_reserved1) (void);
  76   void (*_gtk_reserved2) (void);
  77   void (*_gtk_reserved3) (void);
  78   void (*_gtk_reserved4) (void);
  79 };
  80
  81 GType                    gtk_print_job_get_type               (void) G_GNUC_CONST;
  82 GtkPrintJob             *gtk_print_job_new                    (const gchar              *title,
  83                                                                GtkPrinter               *printer,
  84                                                                GtkPrintSettings         *settings,
  85                                                                GtkPageSetup             *page_setup);
  86 GtkPrintSettings        *gtk_print_job_get_settings           (GtkPrintJob              *job);
  87 GtkPrinter              *gtk_print_job_get_printer            (GtkPrintJob              *job);
  88 G_CONST_RETURN gchar    *gtk_print_job_get_title              (GtkPrintJob              *job);
  89 GtkPrintStatus           gtk_print_job_get_status             (GtkPrintJob              *job);
  90 gboolean                 gtk_print_job_set_source_file        (GtkPrintJob              *job,
  91                                                                const gchar              *filename,
  92                                                                GError                  **error);
  93 cairo_surface_t         *gtk_print_job_get_surface            (GtkPrintJob              *job,
  94                                                                GError                  **error);
  95 void                     gtk_print_job_set_track_print_status (GtkPrintJob              *job,
  96                                                                gboolean                  track_status);
  97 gboolean                 gtk_print_job_get_track_print_status (GtkPrintJob              *job);
  98 void                     gtk_print_job_send                   (GtkPrintJob              *job,
  99                                                                GtkPrintJobCompleteFunc   callback,
 100                                                                gpointer                  user_data,
 101                                                                GDestroyNotify            dnotify);
 102
 103 GtkPrintPages     gtk_print_job_get_pages       (GtkPrintJob       *job);
 104 void              gtk_print_job_set_pages       (GtkPrintJob       *job,
 105                                                  GtkPrintPages      pages);
 106 GtkPageRange *    gtk_print_job_get_page_ranges (GtkPrintJob       *job,
 107                                                  gint              *n_ranges);
 108 void              gtk_print_job_set_page_ranges (GtkPrintJob       *job,
 109                                                  GtkPageRange      *ranges,
 110                                                  gint               n_ranges);
 111 GtkPageSet        gtk_print_job_get_page_set    (GtkPrintJob       *job);
 112 void              gtk_print_job_set_page_set    (GtkPrintJob       *job,
 113                                                  GtkPageSet         page_set);
 114 gint              gtk_print_job_get_num_copies  (GtkPrintJob       *job);
 115 void              gtk_print_job_set_num_copies  (GtkPrintJob       *job,
 116                                                  gint               num_copies);
 117 gdouble           gtk_print_job_get_scale       (GtkPrintJob       *job);
 118 void              gtk_print_job_set_scale       (GtkPrintJob       *job,
 119                                                  gdouble            scale);
 120 guint             gtk_print_job_get_n_up        (GtkPrintJob       *job);
 121 void              gtk_print_job_set_n_up        (GtkPrintJob       *job,
 122                                                  guint              n_up);
 123 GtkNumberUpLayout gtk_print_job_get_n_up_layout (GtkPrintJob       *job);
 124 void              gtk_print_job_set_n_up_layout (GtkPrintJob       *job,
 125                                                  GtkNumberUpLayout  layout);
 126 gboolean          gtk_print_job_get_rotate      (GtkPrintJob       *job);
 127 void              gtk_print_job_set_rotate      (GtkPrintJob       *job,
 128                                                  gboolean           rotate);
 129 gboolean          gtk_print_job_get_collate     (GtkPrintJob       *job);
 130 void              gtk_print_job_set_collate     (GtkPrintJob       *job,
 131                                                  gboolean           collate);
 132 gboolean          gtk_print_job_get_reverse     (GtkPrintJob       *job);
 133 void              gtk_print_job_set_reverse     (GtkPrintJob       *job,
 134                                                  gboolean           reverse);
 135
 136 G_END_DECLS
 137
 138 #endif /* __GTK_PRINT_JOB_H__ */