Move documentation to inline comments: GtkPrintSettings

This commit is contained in:
Javier Jardón 2011-04-18 00:00:27 +01:00
parent 25c2569a5d
commit 14f12a4b1b
5 changed files with 52 additions and 1041 deletions

View File

@ -84,6 +84,7 @@ gtkprintcontext.sgml
gtkprinter.sgml
gtkprintjob.sgml
gtkprintoperation.sgml
gtkprintsettings.sgml
gtkprogressbar.sgml
gtkradioaction.sgml
gtkradiobutton.sgml

File diff suppressed because it is too large Load Diff

View File

@ -703,6 +703,20 @@ typedef enum
GTK_PAGE_SET_ODD
} GtkPageSet;
/**
* GtkNumberUpLayout:
* @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>
*
* 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 >*/

View File

@ -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.
*
* <!-- TODO example of getting, storing and setting settings -->
*
* 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))

View File

@ -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"