forked from AuroraMiddleware/gtk
906 lines
11 KiB
Plaintext
906 lines
11 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GtkPrintSettings
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Stores print settings
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
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.
|
|
</para>
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
<!-- TODO example of getting, storing and setting settings -->
|
|
|
|
<para>
|
|
Printing support was added in GTK+ 2.10.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### STRUCT GtkPrintSettings ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### USER_FUNCTION GtkPrintSettingsFunc ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@key:
|
|
@value:
|
|
@user_data:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@other:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_has_key ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@value:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_unset ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_foreach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@func:
|
|
@user_data:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_bool ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_bool ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@value:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_double ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_double_with_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@def:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_double ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@value:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_length ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@unit:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_length ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@value:
|
|
@unit:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_int ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_int_with_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@def:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_int ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key:
|
|
@value:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PRINTER ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_printer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_printer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@printer:
|
|
|
|
|
|
<!-- ##### ENUM GtkPageOrientation ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GTK_PAGE_ORIENTATION_PORTRAIT:
|
|
@GTK_PAGE_ORIENTATION_LANDSCAPE:
|
|
@GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT:
|
|
@GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE:
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_ORIENTATION ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_orientation ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_orientation ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@orientation:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PAPER_FORMAT ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_paper_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_paper_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@paper_size:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PAPER_WIDTH ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_paper_width ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@unit:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_paper_width ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@width:
|
|
@unit:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PAPER_HEIGHT ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_paper_height ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@unit:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_paper_height ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@height:
|
|
@unit:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_USE_COLOR ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_use_color ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_use_color ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@use_color:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_COLLATE ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_collate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_collate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@collate:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_REVERSE ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_reverse ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_reverse ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@reverse:
|
|
|
|
|
|
<!-- ##### ENUM GtkPrintDuplex ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GTK_PRINT_DUPLEX_SIMPLEX:
|
|
@GTK_PRINT_DUPLEX_HORIZONTAL:
|
|
@GTK_PRINT_DUPLEX_VERTICAL:
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_DUPLEX ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_duplex ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_duplex ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@duplex:
|
|
|
|
|
|
<!-- ##### ENUM GtkPrintQuality ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GTK_PRINT_QUALITY_LOW:
|
|
@GTK_PRINT_QUALITY_NORMAL:
|
|
@GTK_PRINT_QUALITY_HIGH:
|
|
@GTK_PRINT_QUALITY_DRAFT:
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_QUALITY ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_quality ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_quality ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@quality:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_N_COPIES ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_n_copies ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_n_copies ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@num_copies:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_NUMBER_UP ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_number_up ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_number_up ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@number_up:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_RESOLUTION ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_resolution ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_resolution ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@resolution:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_SCALE ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_scale ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_scale ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@scale:
|
|
|
|
|
|
<!-- ##### ENUM GtkPrintPages ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GTK_PRINT_PAGES_ALL:
|
|
@GTK_PRINT_PAGES_CURRENT:
|
|
@GTK_PRINT_PAGES_RANGES:
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PRINT_PAGES ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_print_pages ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_print_pages ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@pages:
|
|
|
|
|
|
<!-- ##### STRUCT GtkPageRange ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@start:
|
|
@end:
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PAGE_RANGES ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_page_ranges ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@num_ranges:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_page_ranges ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@page_ranges:
|
|
@num_ranges:
|
|
|
|
|
|
<!-- ##### ENUM GtkPageSet ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GTK_PAGE_SET_ALL:
|
|
@GTK_PAGE_SET_EVEN:
|
|
@GTK_PAGE_SET_ODD:
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_PAGE_SET ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_page_set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_page_set ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@page_set:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_DEFAULT_SOURCE ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_default_source ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_default_source ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@default_source:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_MEDIA_TYPE ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_media_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_media_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@media_type:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_DITHER ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_dither ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_dither ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@dither:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_FINISHINGS ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_finishings ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_finishings ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@finishings:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_OUTPUT_BIN ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_get_output_bin ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_set_output_bin ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@output_bin:
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_OUTPUT_FILE_FORMAT ##### -->
|
|
<para>
|
|
The key used by the "Print to file" printer to store the format
|
|
of the output. The supported values are "PS" and "PDF".
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_OUTPUT_URI ##### -->
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_WIN32_DRIVER_EXTRA ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PRINT_SETTINGS_WIN32_DRIVER_VERSION ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_new_from_file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@file_name:
|
|
@error:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_new_from_key_file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@key_file:
|
|
@group_name:
|
|
@error:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_to_file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@file_name:
|
|
@error:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_print_settings_to_key_file ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@settings:
|
|
@key_file:
|
|
@group_name:
|
|
|
|
|