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

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