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