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