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

   1 /* GTK - The GIMP Toolkit
   2  * gtkprintsettings.h: Print Settings
   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 #ifndef __GTK_PRINT_SETTINGS_H__
  21 #define __GTK_PRINT_SETTINGS_H__
  22
  23 #include <glib-object.h>
  24 #include "gtkpapersize.h"
  25
  26 G_BEGIN_DECLS
  27
  28 typedef struct _GtkPrintSettings GtkPrintSettings;
  29
  30 #define GTK_TYPE_PRINT_SETTINGS    (gtk_print_settings_get_type ())
  31 #define GTK_PRINT_SETTINGS(obj)    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PRINT_SETTINGS, GtkPrintSettings))
  32 #define GTK_IS_PRINT_SETTINGS(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PRINT_SETTINGS))
  33
  34 typedef void  (*GtkPrintSettingsFunc)  (const gchar *key,
  35                                         const gchar *value,
  36                                         gpointer     user_data);
  37
  38 typedef struct _GtkPageRange GtkPageRange;
  39 struct _GtkPageRange
  40 {
  41   gint start;
  42   gint end;
  43 };
  44
  45 GType             gtk_print_settings_get_type (void) G_GNUC_CONST;
  46 GtkPrintSettings *gtk_print_settings_new      (void);
  47
  48 GtkPrintSettings *gtk_print_settings_copy                    (GtkPrintSettings     *other);
  49 gboolean          gtk_print_settings_has_key                 (GtkPrintSettings     *settings,
  50                                                               const gchar          *key);
  51 G_CONST_RETURN gchar *gtk_print_settings_get                (GtkPrintSettings     *settings,
  52                                                               const gchar          *key);
  53 void              gtk_print_settings_set                     (GtkPrintSettings     *settings,
  54                                                               const gchar          *key,
  55                                                               const gchar          *value);
  56 void              gtk_print_settings_unset                   (GtkPrintSettings     *settings,
  57                                                               const gchar          *key);
  58 void              gtk_print_settings_foreach                 (GtkPrintSettings     *settings,
  59                                                               GtkPrintSettingsFunc  func,
  60                                                               gpointer              user_data);
  61 gboolean          gtk_print_settings_get_bool                (GtkPrintSettings     *settings,
  62                                                               const gchar          *key);
  63 void              gtk_print_settings_set_bool                (GtkPrintSettings     *settings,
  64                                                               const gchar          *key,
  65                                                               gboolean              value);
  66 gdouble           gtk_print_settings_get_double              (GtkPrintSettings     *settings,
  67                                                               const gchar          *key);
  68 gdouble           gtk_print_settings_get_double_with_default (GtkPrintSettings     *settings,
  69                                                               const gchar          *key,
  70                                                               gdouble               def);
  71 void              gtk_print_settings_set_double              (GtkPrintSettings     *settings,
  72                                                               const gchar          *key,
  73                                                               gdouble               value);
  74 gdouble           gtk_print_settings_get_length              (GtkPrintSettings     *settings,
  75                                                               const gchar          *key,
  76                                                               GtkUnit               unit);
  77 void              gtk_print_settings_set_length              (GtkPrintSettings     *settings,
  78                                                               const gchar          *key,
  79                                                               gdouble               value,
  80                                                               GtkUnit               unit);
  81 gint              gtk_print_settings_get_int                 (GtkPrintSettings     *settings,
  82                                                               const gchar          *key);
  83 gint              gtk_print_settings_get_int_with_default    (GtkPrintSettings     *settings,
  84                                                               const gchar          *key,
  85                                                               gint                  def);
  86 void              gtk_print_settings_set_int                 (GtkPrintSettings     *settings,
  87                                                               const gchar          *key,
  88                                                               gint                  value);
  89
  90 #define GTK_PRINT_SETTINGS_PRINTER        "printer"
  91 #define GTK_PRINT_SETTINGS_ORIENTATION    "orientation"
  92 #define GTK_PRINT_SETTINGS_PAPER_FORMAT   "paper-format"
  93 #define GTK_PRINT_SETTINGS_PAPER_WIDTH    "paper-width"
  94 #define GTK_PRINT_SETTINGS_PAPER_HEIGHT   "paper-height"
  95 #define GTK_PRINT_SETTINGS_NUM_COPIES     "num-copies"
  96 #define GTK_PRINT_SETTINGS_DEFAULT_SOURCE "default-source"
  97 #define GTK_PRINT_SETTINGS_QUALITY        "quality"
  98 #define GTK_PRINT_SETTINGS_RESOLUTION     "resolution"
  99 #define GTK_PRINT_SETTINGS_USE_COLOR      "use-color"
 100 #define GTK_PRINT_SETTINGS_DUPLEX         "duplex"
 101 #define GTK_PRINT_SETTINGS_COLLATE        "collate"
 102 #define GTK_PRINT_SETTINGS_REVERSE        "reverse"
 103 #define GTK_PRINT_SETTINGS_MEDIA_TYPE     "media-type"
 104 #define GTK_PRINT_SETTINGS_DITHER         "dither"
 105 #define GTK_PRINT_SETTINGS_SCALE          "scale"
 106 #define GTK_PRINT_SETTINGS_PRINT_PAGES    "print-pages"
 107 #define GTK_PRINT_SETTINGS_PAGE_RANGES    "page-ranges"
 108 #define GTK_PRINT_SETTINGS_PAGE_SET       "page-set"
 109 #define GTK_PRINT_SETTINGS_PRINT_TO_FILE  "print-to-file"
 110 #define GTK_PRINT_SETTINGS_FINISHINGS     "finishings"
 111 #define GTK_PRINT_SETTINGS_NUMBER_UP      "number-up"
 112 #define GTK_PRINT_SETTINGS_OUTPUT_BIN     "output-bin"
 113
 114 #define GTK_PRINT_SETTINGS_WIN32_DRIVER_VERSION "win32-driver-version"
 115 #define GTK_PRINT_SETTINGS_WIN32_DRIVER_EXTRA   "win32-driver-extra"
 116
 117 /* Helpers: */
 118
 119 G_CONST_RETURN gchar *gtk_print_settings_get_printer     (GtkPrintSettings   *settings);
 120 void               gtk_print_settings_set_printer        (GtkPrintSettings   *settings,
 121                                                           const gchar        *printer);
 122 GtkPageOrientation gtk_print_settings_get_orientation    (GtkPrintSettings   *settings);
 123 void               gtk_print_settings_set_orientation    (GtkPrintSettings   *settings,
 124                                                           GtkPageOrientation  orientation);
 125 GtkPaperSize *     gtk_print_settings_get_paper_size     (GtkPrintSettings   *settings);
 126 void               gtk_print_settings_set_paper_size     (GtkPrintSettings   *settings,
 127                                                           GtkPaperSize       *paper_size);
 128 gdouble            gtk_print_settings_get_paper_width    (GtkPrintSettings   *settings,
 129                                                           GtkUnit             unit);
 130 void               gtk_print_settings_set_paper_width    (GtkPrintSettings   *settings,
 131                                                           gdouble             width,
 132                                                           GtkUnit             unit);
 133 gdouble            gtk_print_settings_get_paper_height   (GtkPrintSettings   *settings,
 134                                                           GtkUnit             unit);
 135 void               gtk_print_settings_set_paper_height   (GtkPrintSettings   *settings,
 136                                                           gdouble             height,
 137                                                           GtkUnit             unit);
 138 gboolean           gtk_print_settings_get_use_color      (GtkPrintSettings   *settings);
 139 void               gtk_print_settings_set_use_color      (GtkPrintSettings   *settings,
 140                                                           gboolean            use_color);
 141 gboolean           gtk_print_settings_get_collate        (GtkPrintSettings   *settings);
 142 void               gtk_print_settings_set_collate        (GtkPrintSettings   *settings,
 143                                                           gboolean            collate);
 144 gboolean           gtk_print_settings_get_reverse        (GtkPrintSettings   *settings);
 145 void               gtk_print_settings_set_reverse        (GtkPrintSettings   *settings,
 146                                                           gboolean            reverse);
 147 GtkPrintDuplex     gtk_print_settings_get_duplex         (GtkPrintSettings   *settings);
 148 void               gtk_print_settings_set_duplex         (GtkPrintSettings   *settings,
 149                                                           GtkPrintDuplex      duplex);
 150 GtkPrintQuality    gtk_print_settings_get_quality        (GtkPrintSettings   *settings);
 151 void               gtk_print_settings_set_quality        (GtkPrintSettings   *settings,
 152                                                           GtkPrintQuality     quality);
 153 gint               gtk_print_settings_get_num_copies     (GtkPrintSettings   *settings);
 154 void               gtk_print_settings_set_num_copies     (GtkPrintSettings   *settings,
 155                                                           gint                num_copies);
 156 gint               gtk_print_settings_get_number_up      (GtkPrintSettings   *settings);
 157 void               gtk_print_settings_set_number_up      (GtkPrintSettings   *settings,
 158                                                           gint                number_up);
 159 gint               gtk_print_settings_get_resolution     (GtkPrintSettings   *settings);
 160 void               gtk_print_settings_set_resolution     (GtkPrintSettings   *settings,
 161                                                           gint                resolution);
 162 gdouble            gtk_print_settings_get_scale          (GtkPrintSettings   *settings);
 163 void               gtk_print_settings_set_scale          (GtkPrintSettings   *settings,
 164                                                           gdouble             scale);
 165 gboolean           gtk_print_settings_get_print_to_file  (GtkPrintSettings   *settings);
 166 void               gtk_print_settings_set_print_to_file  (GtkPrintSettings   *settings,
 167                                                           gboolean            print_to_file);
 168 GtkPrintPages      gtk_print_settings_get_print_pages    (GtkPrintSettings   *settings);
 169 void               gtk_print_settings_set_print_pages    (GtkPrintSettings   *settings,
 170                                                           GtkPrintPages       pages);
 171 GtkPageRange *     gtk_print_settings_get_page_ranges    (GtkPrintSettings   *settings,
 172                                                           gint               *num_ranges);
 173 void               gtk_print_settings_set_page_ranges    (GtkPrintSettings   *settings,
 174                                                           GtkPageRange       *page_ranges,
 175                                                           gint                num_ranges);
 176 GtkPageSet         gtk_print_settings_get_page_set       (GtkPrintSettings   *settings);
 177 void               gtk_print_settings_set_page_set       (GtkPrintSettings   *settings,
 178                                                           GtkPageSet          page_set);
 179 G_CONST_RETURN gchar *gtk_print_settings_get_default_source (GtkPrintSettings   *settings);
 180 void               gtk_print_settings_set_default_source (GtkPrintSettings   *settings,
 181                                                           const gchar        *default_source);
 182 G_CONST_RETURN gchar *gtk_print_settings_get_media_type  (GtkPrintSettings   *settings);
 183 void               gtk_print_settings_set_media_type     (GtkPrintSettings   *settings,
 184                                                           const gchar        *media_type);
 185 G_CONST_RETURN gchar *gtk_print_settings_get_dither      (GtkPrintSettings   *settings);
 186 void               gtk_print_settings_set_dither         (GtkPrintSettings   *settings,
 187                                                           const gchar        *dither);
 188 G_CONST_RETURN gchar *gtk_print_settings_get_finishings  (GtkPrintSettings   *settings);
 189 void               gtk_print_settings_set_finishings     (GtkPrintSettings   *settings,
 190                                                           const gchar        *finishings);
 191 G_CONST_RETURN gchar *gtk_print_settings_get_output_bin  (GtkPrintSettings   *settings);
 192 void               gtk_print_settings_set_output_bin     (GtkPrintSettings   *settings,
 193                                                           const gchar        *output_bin);
 194
 195 G_END_DECLS
 196
 197 #endif /* __GTK_PRINT_SETTINGS_H__ */