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