diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index ee7efc7037..8bd6d8cea4 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -84,6 +84,7 @@ gtkprintcontext.sgml gtkprinter.sgml gtkprintjob.sgml gtkprintoperation.sgml +gtkprintsettings.sgml gtkprogressbar.sgml gtkradioaction.sgml gtkradiobutton.sgml diff --git a/docs/reference/gtk/tmpl/gtkprintsettings.sgml b/docs/reference/gtk/tmpl/gtkprintsettings.sgml deleted file mode 100644 index 4a1ee3bf16..0000000000 --- a/docs/reference/gtk/tmpl/gtkprintsettings.sgml +++ /dev/null @@ -1,1040 +0,0 @@ - -GtkPrintSettings - - -Stores print settings - - - -A GtkPrintSettings object represents the settings of a print dialog in -a system-independent way. The main use for this object is that once -you've printed you can get a settings object that represents the settings -the user chose, and the next time you print you can pass that object in so -that the user doesn't have to re-set all his settings. - - -Its also possible to enumerate the settings so that you can easily save -the settings for the next time your app runs, or even store them in a -document. The predefined keys try to use shared values as much as possible -so that moving such a document between systems still works. - - - - - -Printing support was added in GTK+ 2.10. - - - - - - - - - - - - - - - - - - - - - - - - -@key: -@value: -@user_data: - - - - - - - -@void: -@Returns: - - - - - - - -@other: -@Returns: - - - - - - - -@settings: -@key: -@Returns: - - - - - - - -@settings: -@key: -@Returns: - - - - - - - -@settings: -@key: -@value: - - - - - - - -@settings: -@key: - - - - - - - -@settings: -@func: -@user_data: - - - - - - - -@settings: -@key: -@Returns: - - - - - - - -@settings: -@key: -@value: - - - - - - - -@settings: -@key: -@Returns: - - - - - - - -@settings: -@key: -@def: -@Returns: - - - - - - - -@settings: -@key: -@value: - - - - - - - -@settings: -@key: -@unit: -@Returns: - - - - - - - -@settings: -@key: -@value: -@unit: - - - - - - - -@settings: -@key: -@Returns: - - - - - - - -@settings: -@key: -@def: -@Returns: - - - - - - - -@settings: -@key: -@value: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@printer: - - - - - - - -@GTK_PAGE_ORIENTATION_PORTRAIT: -@GTK_PAGE_ORIENTATION_LANDSCAPE: -@GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT: -@GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE: - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@orientation: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@paper_size: - - - - - - - - - - - - - - -@settings: -@unit: -@Returns: - - - - - - - -@settings: -@width: -@unit: - - - - - - - - - - - - - - -@settings: -@unit: -@Returns: - - - - - - - -@settings: -@height: -@unit: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@use_color: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@collate: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@reverse: - - - - - - - -@GTK_PRINT_DUPLEX_SIMPLEX: -@GTK_PRINT_DUPLEX_HORIZONTAL: -@GTK_PRINT_DUPLEX_VERTICAL: - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@duplex: - - - - - - - -@GTK_PRINT_QUALITY_LOW: -@GTK_PRINT_QUALITY_NORMAL: -@GTK_PRINT_QUALITY_HIGH: -@GTK_PRINT_QUALITY_DRAFT: - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@quality: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@num_copies: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@number_up: - - - - -Used to determine the layout of pages on a sheet when printing -multiple pages per sheet. - - -@GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: -@GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: -@GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: -@GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: -@GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: -@GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: -@GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: -@GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@number_up_layout: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@resolution: - - - - - - - -@settings: -@resolution_x: -@resolution_y: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@lpi: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@scale: - - - - - - - -@GTK_PRINT_PAGES_ALL: -@GTK_PRINT_PAGES_CURRENT: -@GTK_PRINT_PAGES_RANGES: -@GTK_PRINT_PAGES_SELECTION: - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@pages: - - - - - - - -@start: -@end: - - - - - - - - - - - - - -@settings: -@num_ranges: -@Returns: - - - - - - - -@settings: -@page_ranges: -@num_ranges: - - - - - - - -@GTK_PAGE_SET_ALL: -@GTK_PAGE_SET_EVEN: -@GTK_PAGE_SET_ODD: - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@page_set: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@default_source: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@media_type: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@dither: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@finishings: - - - - - - - - - - - - - - -@settings: -@Returns: - - - - - - - -@settings: -@output_bin: - - - - -The key used by the "Print to file" printer to store the format -of the output. The supported values are "PS" and "PDF". - - - - - - -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. - - - - - - - - - - - - - - - - - - - - - - - -@file_name: -@error: -@Returns: - - - - - - - -@key_file: -@group_name: -@error: -@Returns: - - - - - - - -@settings: -@file_name: -@error: -@Returns: - - - - - - - -@settings: -@key_file: -@group_name: -@error: -@Returns: - - - - - - - -@settings: -@file_name: -@error: -@Returns: - - - - - - - -@settings: -@key_file: -@group_name: - - diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h index 95cfb299ba..33e3aea02b 100644 --- a/gtk/gtkenums.h +++ b/gtk/gtkenums.h @@ -703,6 +703,20 @@ typedef enum GTK_PAGE_SET_ODD } GtkPageSet; +/** + * GtkNumberUpLayout: + * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: + * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: + * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: + * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: + * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: + * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: + * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: + * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: + * + * Used to determine the layout of pages on a sheet when printing + * multiple pages per sheet. + */ typedef enum { GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/ diff --git a/gtk/gtkprintsettings.c b/gtk/gtkprintsettings.c index 64c8e518a2..cf60c9329d 100644 --- a/gtk/gtkprintsettings.c +++ b/gtk/gtkprintsettings.c @@ -31,6 +31,28 @@ #include "gtkwidget.h" +/** + * SECTION:gtkprintsettings + * @Short_description: Stores print settings + * @Title: GtkPrintSettings + * + * A GtkPrintSettings object represents the settings of a print dialog in + * a system-independent way. The main use for this object is that once + * you've printed you can get a settings object that represents the settings + * the user chose, and the next time you print you can pass that object in so + * that the user doesn't have to re-set all his settings. + * + * Its also possible to enumerate the settings so that you can easily save + * the settings for the next time your app runs, or even store them in a + * document. The predefined keys try to use shared values as much as possible + * so that moving such a document between systems still works. + * + * + * + * Printing support was added in GTK+ 2.10. + */ + + typedef struct _GtkPrintSettingsClass GtkPrintSettingsClass; #define GTK_IS_PRINT_SETTINGS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PRINT_SETTINGS)) @@ -40,7 +62,7 @@ typedef struct _GtkPrintSettingsClass GtkPrintSettingsClass; struct _GtkPrintSettings { GObject parent_instance; - + GHashTable *hash; }; diff --git a/gtk/gtkprintsettings.h b/gtk/gtkprintsettings.h index 102c6c497a..02b6073466 100644 --- a/gtk/gtkprintsettings.h +++ b/gtk/gtkprintsettings.h @@ -137,7 +137,21 @@ void gtk_print_settings_set_int (GtkPrintSettings #define GTK_PRINT_SETTINGS_RESOLUTION_Y "resolution-y" #define GTK_PRINT_SETTINGS_PRINTER_LPI "printer-lpi" +/** + * GTK_PRINT_SETTINGS_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". + */ #define GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT "output-file-format" + +/** + * GTK_PRINT_SETTINGS_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. + */ #define GTK_PRINT_SETTINGS_OUTPUT_URI "output-uri" #define GTK_PRINT_SETTINGS_WIN32_DRIVER_VERSION "win32-driver-version"