Commit 14f12a4b authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkPrintSettings

parent 25c2569a
......@@ -84,6 +84,7 @@ gtkprintcontext.sgml
gtkprinter.sgml
gtkprintjob.sgml
gtkprintoperation.sgml
gtkprintsettings.sgml
gtkprogressbar.sgml
gtkradioaction.sgml
gtkradiobutton.sgml
......
<!-- ##### 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 ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkPrintSettings ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GtkPrintSettingsFunc ##### -->
<para>
</para>
@key:
@value:
@user_data:
<!-- ##### FUNCTION gtk_print_settings_new ##### -->
<para>
</para>
@void:
@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:
<!-- ##### ENUM GtkNumberUpLayout ##### -->
<para>
Used to determine the layout of pages on a sheet when printing
multiple pages per sheet.
</para>
@GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-lrtb.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-lrbt.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-rltb.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-rlbt.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-tblr.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-tbrl.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-btlr.png" format="PNG"></inlinegraphic>
@GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-btrl.png" format="PNG"></inlinegraphic>
<!-- ##### MACRO GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_print_settings_get_number_up_layout ##### -->
<para>
</para>
@settings:
@Returns:
<!-- ##### FUNCTION gtk_print_settings_set_number_up_layout ##### -->
<para>
</para>
@settings:
@number_up_layout:
<!-- ##### 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:
<!-- ##### FUNCTION gtk_print_settings_set_resolution_xy ##### -->
<para>
</para>
@settings:
@resolution_x:
@resolution_y:
<!-- ##### MACRO GTK_PRINT_SETTINGS_RESOLUTION_X ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_print_settings_get_resolution_x ##### -->
<para>
</para>
@settings:
@Returns:
<!-- ##### MACRO GTK_PRINT_SETTINGS_RESOLUTION_Y ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_print_settings_get_resolution_y ##### -->
<para>
</para>
@settings:
@Returns:
<!-- ##### MACRO GTK_PRINT_SETTINGS_PRINTER_LPI ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_print_settings_get_printer_lpi ##### -->
<para>
</para>
@settings:
@Returns:
<!-- ##### FUNCTION gtk_print_settings_set_printer_lpi ##### -->
<para>
</para>
@settings:
@lpi:
<!-- ##### 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:
@GTK_PRINT_PAGES_SELECTION:
<!-- ##### 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>