GtkPrintSettings

typedef struct _GtkPrintSettings GtkPrintSettings;

GtkPrintSettingsFunc ()

void                (*GtkPrintSettingsFunc)             (const gchar *key,
                                                         const gchar *value,
                                                         gpointer user_data);

gtk_print_settings_new ()

GtkPrintSettings*   gtk_print_settings_new              (void);

Creates a new GtkPrintSettings object.

Since 2.10

gtk_print_settings_copy ()

GtkPrintSettings*   gtk_print_settings_copy             (GtkPrintSettings *other);

Copies a GtkPrintSettings object.

Since 2.10

gtk_print_settings_has_key ()

gboolean            gtk_print_settings_has_key          (GtkPrintSettings *settings,
                                                         const gchar *key);

Returns TRUE, if a value is associated with key.

Since 2.10

gtk_print_settings_get ()

const gchar*        gtk_print_settings_get              (GtkPrintSettings *settings,
                                                         const gchar *key);

Looks up the string value associated with key.

Since 2.10

gtk_print_settings_set ()

void                gtk_print_settings_set              (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         const gchar *value);

Associates value with key.

Since 2.10

gtk_print_settings_unset ()

void                gtk_print_settings_unset            (GtkPrintSettings *settings,
                                                         const gchar *key);

Removes any value associated with key. This has the same effect as setting the value to NULL.

Since 2.10

gtk_print_settings_foreach ()

void                gtk_print_settings_foreach          (GtkPrintSettings *settings,
                                                         GtkPrintSettingsFunc func,
                                                         gpointer user_data);

Calls func for each key-value pair of settings.

Since 2.10

gtk_print_settings_get_bool ()

gboolean            gtk_print_settings_get_bool         (GtkPrintSettings *settings,
                                                         const gchar *key);

Returns the boolean represented by the value that is associated with key.

The string "true" represents TRUE, any other string FALSE.

Since 2.10

gtk_print_settings_set_bool ()

void                gtk_print_settings_set_bool         (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         gboolean value);

Sets key to a boolean value.

Since 2.10

gtk_print_settings_get_double ()

gdouble             gtk_print_settings_get_double       (GtkPrintSettings *settings,
                                                         const gchar *key);

Returns the double value associated with key, or 0.

Since 2.10

gtk_print_settings_get_double_with_default ()

gdouble             gtk_print_settings_get_double_with_default
                                                        (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         gdouble def);

Returns the floating point number represented by the value that is associated with key, or default_val if the value does not represent a floating point number.

Floating point numbers are parsed with g_ascii_strtod().

Since 2.10

gtk_print_settings_set_double ()

void                gtk_print_settings_set_double       (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         gdouble value);

Sets key to a double value.

Since 2.10

gtk_print_settings_get_length ()

gdouble             gtk_print_settings_get_length       (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         GtkUnit unit);

Returns the value associated with key, interpreted as a length. The returned value is converted to units.

Since 2.10

gtk_print_settings_set_length ()

void                gtk_print_settings_set_length       (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         gdouble value,
                                                         GtkUnit unit);

Associates a length in units of unit with key.

Since 2.10

gtk_print_settings_get_int ()

gint                gtk_print_settings_get_int          (GtkPrintSettings *settings,
                                                         const gchar *key);

Returns the integer value of key, or 0.

Since 2.10

gtk_print_settings_get_int_with_default ()

gint                gtk_print_settings_get_int_with_default
                                                        (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         gint def);

Returns the value of key, interpreted as an integer, or the default value.

Since 2.10

gtk_print_settings_set_int ()

void                gtk_print_settings_set_int          (GtkPrintSettings *settings,
                                                         const gchar *key,
                                                         gint value);

Sets key to an integer value.

Since 2.10

GTK_PRINT_SETTINGS_PRINTER

#define GTK_PRINT_SETTINGS_PRINTER          "printer"

gtk_print_settings_get_printer ()

const gchar*        gtk_print_settings_get_printer      (GtkPrintSettings *settings);

Convenience function to obtain the value of GTK_PRINT_SETTINGS_PRINTER.

Since 2.10

gtk_print_settings_set_printer ()

void                gtk_print_settings_set_printer      (GtkPrintSettings *settings,
                                                         const gchar *printer);

Convenience function to set GTK_PRINT_SETTINGS_PRINTER to printer.

Since 2.10

enum GtkPageOrientation

typedef enum
{
  GTK_PAGE_ORIENTATION_PORTRAIT,
  GTK_PAGE_ORIENTATION_LANDSCAPE,
  GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
  GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
} GtkPageOrientation;

GTK_PRINT_SETTINGS_ORIENTATION

#define GTK_PRINT_SETTINGS_ORIENTATION      "orientation"

gtk_print_settings_get_orientation ()

GtkPageOrientation  gtk_print_settings_get_orientation  (GtkPrintSettings *settings);

Get the value of GTK_PRINT_SETTINGS_ORIENTATION, converted to a GtkPageOrientation.

Since 2.10

gtk_print_settings_set_orientation ()

void                gtk_print_settings_set_orientation  (GtkPrintSettings *settings,
                                                         GtkPageOrientation orientation);

Sets the value of GTK_PRINT_SETTINGS_ORIENTATION.

Since 2.10

GTK_PRINT_SETTINGS_PAPER_FORMAT

#define GTK_PRINT_SETTINGS_PAPER_FORMAT     "paper-format"

gtk_print_settings_get_paper_size ()

GtkPaperSize*       gtk_print_settings_get_paper_size   (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, converted to a GtkPaperSize.

Since 2.10

gtk_print_settings_set_paper_size ()

void                gtk_print_settings_set_paper_size   (GtkPrintSettings *settings,
                                                         GtkPaperSize *paper_size);

Sets the value of GTK_PRINT_SETTINGS_PAPER_FORMAT, GTK_PRINT_SETTINGS_PAPER_WIDTH and GTK_PRINT_SETTINGS_PAPER_HEIGHT.

Since 2.10

GTK_PRINT_SETTINGS_PAPER_WIDTH

#define GTK_PRINT_SETTINGS_PAPER_WIDTH      "paper-width"

gtk_print_settings_get_paper_width ()

gdouble             gtk_print_settings_get_paper_width  (GtkPrintSettings *settings,
                                                         GtkUnit unit);

Gets the value of GTK_PRINT_SETTINGS_PAPER_WIDTH, converted to unit.

Since 2.10

gtk_print_settings_set_paper_width ()

void                gtk_print_settings_set_paper_width  (GtkPrintSettings *settings,
                                                         gdouble width,
                                                         GtkUnit unit);

Sets the value of GTK_PRINT_SETTINGS_PAPER_WIDTH.

Since 2.10

GTK_PRINT_SETTINGS_PAPER_HEIGHT

#define GTK_PRINT_SETTINGS_PAPER_HEIGHT     "paper-height"

gtk_print_settings_get_paper_height ()

gdouble             gtk_print_settings_get_paper_height (GtkPrintSettings *settings,
                                                         GtkUnit unit);

Gets the value of GTK_PRINT_SETTINGS_PAPER_HEIGHT, converted to unit.

Since 2.10

gtk_print_settings_set_paper_height ()

void                gtk_print_settings_set_paper_height (GtkPrintSettings *settings,
                                                         gdouble height,
                                                         GtkUnit unit);

Sets the value of GTK_PRINT_SETTINGS_PAPER_HEIGHT.

Since 2.10

GTK_PRINT_SETTINGS_USE_COLOR

#define GTK_PRINT_SETTINGS_USE_COLOR        "use-color"

gtk_print_settings_get_use_color ()

gboolean            gtk_print_settings_get_use_color    (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_USE_COLOR.

Since 2.10

gtk_print_settings_set_use_color ()

void                gtk_print_settings_set_use_color    (GtkPrintSettings *settings,
                                                         gboolean use_color);

Sets the value of GTK_PRINT_SETTINGS_USE_COLOR.

Since 2.10

GTK_PRINT_SETTINGS_COLLATE

#define GTK_PRINT_SETTINGS_COLLATE          "collate"

gtk_print_settings_get_collate ()

gboolean            gtk_print_settings_get_collate      (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_COLLATE.

Since 2.10

gtk_print_settings_set_collate ()

void                gtk_print_settings_set_collate      (GtkPrintSettings *settings,
                                                         gboolean collate);

Sets the value of GTK_PRINT_SETTINGS_COLLATE.

Since 2.10

GTK_PRINT_SETTINGS_REVERSE

#define GTK_PRINT_SETTINGS_REVERSE          "reverse"

gtk_print_settings_get_reverse ()

gboolean            gtk_print_settings_get_reverse      (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_REVERSE.

Since 2.10

gtk_print_settings_set_reverse ()

void                gtk_print_settings_set_reverse      (GtkPrintSettings *settings,
                                                         gboolean reverse);

Sets the value of GTK_PRINT_SETTINGS_REVERSE.

Since 2.10

enum GtkPrintDuplex

typedef enum
{
  GTK_PRINT_DUPLEX_SIMPLEX,
  GTK_PRINT_DUPLEX_HORIZONTAL,
  GTK_PRINT_DUPLEX_VERTICAL
} GtkPrintDuplex;

GTK_PRINT_SETTINGS_DUPLEX

#define GTK_PRINT_SETTINGS_DUPLEX           "duplex"

gtk_print_settings_get_duplex ()

GtkPrintDuplex      gtk_print_settings_get_duplex       (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_DUPLEX.

Since 2.10

gtk_print_settings_set_duplex ()

void                gtk_print_settings_set_duplex       (GtkPrintSettings *settings,
                                                         GtkPrintDuplex duplex);

Sets the value of GTK_PRINT_SETTINGS_DUPLEX.

Since 2.10

enum GtkPrintQuality

typedef enum
{
  GTK_PRINT_QUALITY_LOW,
  GTK_PRINT_QUALITY_NORMAL,
  GTK_PRINT_QUALITY_HIGH,
  GTK_PRINT_QUALITY_DRAFT
} GtkPrintQuality;

GTK_PRINT_SETTINGS_QUALITY

#define GTK_PRINT_SETTINGS_QUALITY          "quality"

gtk_print_settings_get_quality ()

GtkPrintQuality     gtk_print_settings_get_quality      (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_QUALITY.

Since 2.10

gtk_print_settings_set_quality ()

void                gtk_print_settings_set_quality      (GtkPrintSettings *settings,
                                                         GtkPrintQuality quality);

Sets the value of GTK_PRINT_SETTINGS_QUALITY.

Since 2.10

GTK_PRINT_SETTINGS_N_COPIES

#define GTK_PRINT_SETTINGS_N_COPIES         "n-copies"

gtk_print_settings_get_n_copies ()

gint                gtk_print_settings_get_n_copies     (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_N_COPIES.

Since 2.10

gtk_print_settings_set_n_copies ()

void                gtk_print_settings_set_n_copies     (GtkPrintSettings *settings,
                                                         gint num_copies);

Sets the value of GTK_PRINT_SETTINGS_N_COPIES.

Since 2.10

GTK_PRINT_SETTINGS_NUMBER_UP

#define GTK_PRINT_SETTINGS_NUMBER_UP        "number-up"

gtk_print_settings_get_number_up ()

gint                gtk_print_settings_get_number_up    (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_NUMBER_UP.

Since 2.10

gtk_print_settings_set_number_up ()

void                gtk_print_settings_set_number_up    (GtkPrintSettings *settings,
                                                         gint number_up);

Sets the value of GTK_PRINT_SETTINGS_NUMBER_UP.

Since 2.10

GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT

#define GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT "number-up-layout"

gtk_print_settings_get_number_up_layout ()

GtkNumberUpLayout   gtk_print_settings_get_number_up_layout
                                                        (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

Since 2.14

gtk_print_settings_set_number_up_layout ()

void                gtk_print_settings_set_number_up_layout
                                                        (GtkPrintSettings *settings,
                                                         GtkNumberUpLayout number_up_layout);

Sets the value of GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.

Since 2.14

GTK_PRINT_SETTINGS_RESOLUTION

#define GTK_PRINT_SETTINGS_RESOLUTION       "resolution"

gtk_print_settings_get_resolution ()

gint                gtk_print_settings_get_resolution   (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_RESOLUTION.

Since 2.10

gtk_print_settings_set_resolution ()

void                gtk_print_settings_set_resolution   (GtkPrintSettings *settings,
                                                         gint resolution);

Sets the value of GTK_PRINT_SETTINGS_RESOLUTION.

Since 2.10

GTK_PRINT_SETTINGS_SCALE

#define GTK_PRINT_SETTINGS_SCALE            "scale"

gtk_print_settings_get_scale ()

gdouble             gtk_print_settings_get_scale        (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_SCALE.

Since 2.10

gtk_print_settings_set_scale ()

void                gtk_print_settings_set_scale        (GtkPrintSettings *settings,
                                                         gdouble scale);

Sets the value of GTK_PRINT_SETTINGS_SCALE.

Since 2.10

enum GtkPrintPages

typedef enum
{
  GTK_PRINT_PAGES_ALL,
  GTK_PRINT_PAGES_CURRENT,
  GTK_PRINT_PAGES_RANGES
} GtkPrintPages;

GTK_PRINT_SETTINGS_PRINT_PAGES

#define GTK_PRINT_SETTINGS_PRINT_PAGES      "print-pages"

gtk_print_settings_get_print_pages ()

GtkPrintPages       gtk_print_settings_get_print_pages  (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_PRINT_PAGES.

Since 2.10

gtk_print_settings_set_print_pages ()

void                gtk_print_settings_set_print_pages  (GtkPrintSettings *settings,
                                                         GtkPrintPages pages);

Sets the value of GTK_PRINT_SETTINGS_PRINT_PAGES.

Since 2.10

GtkPageRange

typedef struct {
  gint start;
  gint end;
} GtkPageRange;

GTK_PRINT_SETTINGS_PAGE_RANGES

#define GTK_PRINT_SETTINGS_PAGE_RANGES      "page-ranges"

gtk_print_settings_get_page_ranges ()

GtkPageRange*       gtk_print_settings_get_page_ranges  (GtkPrintSettings *settings,
                                                         gint *num_ranges);

Gets the value of GTK_PRINT_SETTINGS_PAGE_RANGES.

Since 2.10

gtk_print_settings_set_page_ranges ()

void                gtk_print_settings_set_page_ranges  (GtkPrintSettings *settings,
                                                         GtkPageRange *page_ranges,
                                                         gint num_ranges);

Sets the value of GTK_PRINT_SETTINGS_PAGE_RANGES.

Since 2.10

enum GtkPageSet

typedef enum
{
  GTK_PAGE_SET_ALL,
  GTK_PAGE_SET_EVEN,
  GTK_PAGE_SET_ODD
} GtkPageSet;

GTK_PRINT_SETTINGS_PAGE_SET

#define GTK_PRINT_SETTINGS_PAGE_SET         "page-set"

gtk_print_settings_get_page_set ()

GtkPageSet          gtk_print_settings_get_page_set     (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_PAGE_SET.

Since 2.10

gtk_print_settings_set_page_set ()

void                gtk_print_settings_set_page_set     (GtkPrintSettings *settings,
                                                         GtkPageSet page_set);

Sets the value of GTK_PRINT_SETTINGS_PAGE_SET.

Since 2.10

GTK_PRINT_SETTINGS_DEFAULT_SOURCE

#define GTK_PRINT_SETTINGS_DEFAULT_SOURCE   "default-source"

gtk_print_settings_get_default_source ()

const gchar*        gtk_print_settings_get_default_source
                                                        (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

Since 2.10

gtk_print_settings_set_default_source ()

void                gtk_print_settings_set_default_source
                                                        (GtkPrintSettings *settings,
                                                         const gchar *default_source);

Sets the value of GTK_PRINT_SETTINGS_DEFAULT_SOURCE.

Since 2.10

GTK_PRINT_SETTINGS_MEDIA_TYPE

#define GTK_PRINT_SETTINGS_MEDIA_TYPE       "media-type"

gtk_print_settings_get_media_type ()

const gchar*        gtk_print_settings_get_media_type   (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

Since 2.10

gtk_print_settings_set_media_type ()

void                gtk_print_settings_set_media_type   (GtkPrintSettings *settings,
                                                         const gchar *media_type);

Sets the value of GTK_PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

Since 2.10

GTK_PRINT_SETTINGS_DITHER

#define GTK_PRINT_SETTINGS_DITHER           "dither"

gtk_print_settings_get_dither ()

const gchar*        gtk_print_settings_get_dither       (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_DITHER.

Since 2.10

gtk_print_settings_set_dither ()

void                gtk_print_settings_set_dither       (GtkPrintSettings *settings,
                                                         const gchar *dither);

Sets the value of GTK_PRINT_SETTINGS_DITHER.

Since 2.10

GTK_PRINT_SETTINGS_FINISHINGS

#define GTK_PRINT_SETTINGS_FINISHINGS       "finishings"

gtk_print_settings_get_finishings ()

const gchar*        gtk_print_settings_get_finishings   (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_FINISHINGS.

Since 2.10

gtk_print_settings_set_finishings ()

void                gtk_print_settings_set_finishings   (GtkPrintSettings *settings,
                                                         const gchar *finishings);

Sets the value of GTK_PRINT_SETTINGS_FINISHINGS.

Since 2.10

GTK_PRINT_SETTINGS_OUTPUT_BIN

#define GTK_PRINT_SETTINGS_OUTPUT_BIN       "output-bin"

gtk_print_settings_get_output_bin ()

const gchar*        gtk_print_settings_get_output_bin   (GtkPrintSettings *settings);

Gets the value of GTK_PRINT_SETTINGS_OUTPUT_BIN.

Since 2.10

gtk_print_settings_set_output_bin ()

void                gtk_print_settings_set_output_bin   (GtkPrintSettings *settings,
                                                         const gchar *output_bin);

Sets the value of GTK_PRINT_SETTINGS_OUTPUT_BIN.

Since 2.10

GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT

#define GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT  "output-file-format"

The key used by the "Print to file" printer to store the format of the output. The supported values are "PS" and "PDF".

GTK_PRINT_SETTINGS_OUTPUT_URI

#define GTK_PRINT_SETTINGS_OUTPUT_URI          "output-uri"

The key used by the "Print to file" printer to store the URI to which the output should be written. GTK+ itself supports only "file://" URIs.

GTK_PRINT_SETTINGS_WIN32_DRIVER_EXTRA

#define GTK_PRINT_SETTINGS_WIN32_DRIVER_EXTRA   "win32-driver-extra"

GTK_PRINT_SETTINGS_WIN32_DRIVER_VERSION

#define GTK_PRINT_SETTINGS_WIN32_DRIVER_VERSION "win32-driver-version"

gtk_print_settings_new_from_file ()

GtkPrintSettings*   gtk_print_settings_new_from_file    (const gchar *file_name,
                                                         GError **error);

Reads the print settings from file_name. Returns a new GtkPrintSettings object with the restored settings, or NULL if an error occurred. See gtk_print_settings_to_file().

Since 2.12

gtk_print_settings_new_from_key_file ()

GtkPrintSettings*   gtk_print_settings_new_from_key_file
                                                        (GKeyFile *key_file,
                                                         const gchar *group_name,
                                                         GError **error);

Reads the print settings from the group group_name in key_file. Returns a new GtkPrintSettings object with the restored settings, or NULL if an error occurred.

Since 2.12

gtk_print_settings_load_file ()

gboolean            gtk_print_settings_load_file        (GtkPrintSettings *settings,
                                                         const gchar *file_name,
                                                         GError **error);

Reads the print settings from file_name. See gtk_print_settings_to_file().

Since 2.14

gtk_print_settings_load_key_file ()

gboolean            gtk_print_settings_load_key_file    (GtkPrintSettings *settings,
                                                         GKeyFile *key_file,
                                                         const gchar *group_name,
                                                         GError **error);

Reads the print settings from the group group_name in key_file.

Since 2.14

gtk_print_settings_to_file ()

gboolean            gtk_print_settings_to_file          (GtkPrintSettings *settings,
                                                         const gchar *file_name,
                                                         GError **error);

This function saves the print settings from settings to file_name.

Since 2.12

gtk_print_settings_to_key_file ()

void                gtk_print_settings_to_key_file      (GtkPrintSettings *settings,
                                                         GKeyFile *key_file,
                                                         const gchar *group_name);

This function adds the print settings from settings to key_file.

Since 2.12