diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 45d4c04391..9a71d2d04f 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -17,6 +17,7 @@ gtkmessagedialog.sgml gtkobject.sgml gtkorientable.sgml gtkpagesetupunixdialog.sgml +gtkpapersize.sgml gtkprinter.sgml gtkradioaction.sgml gtkradiobutton.sgml diff --git a/docs/reference/gtk/tmpl/gtkpapersize.sgml b/docs/reference/gtk/tmpl/gtkpapersize.sgml deleted file mode 100644 index abc19fd132..0000000000 --- a/docs/reference/gtk/tmpl/gtkpapersize.sgml +++ /dev/null @@ -1,308 +0,0 @@ - -GtkPaperSize - - -Support for named paper sizes - - - -GtkPaperSize handles paper sizes. It uses the standard called -"PWG 5101.1-2002 PWG: Standard for Media Standardized Names" - -to name the paper sizes (and to get the data for the page sizes). -In addition to standard paper sizes, GtkPaperSize allows to -construct custom paper sizes with arbitrary dimensions. - - -The #GtkPaperSize object stores not only the dimensions (width -and height) of a paper size and its name, it also provides -default print margins. - - - -Printing support has been added in GTK+ 2.10. - - - - -#GtkPageSetup - - - - - - - - - - - - - - - - - - - -@GTK_UNIT_PIXEL: -@GTK_UNIT_POINTS: -@GTK_UNIT_INCH: -@GTK_UNIT_MM: - - - -Name for the A4 paper size. - - - - - - -Name for the A4 paper size. - - - - - - -Name for the A5 paper size. - - - - - - -Name for the B5 paper size. - - - - - - -Name for the Letter paper size. - - - - - - -Name for the Executive paper size. - - - - - - -Name for the Legal paper size. - - - - - - - - - -@name: -@Returns: - - - - - - - -@ppd_name: -@ppd_display_name: -@width: -@height: -@Returns: - - - - - - - -@name: -@display_name: -@width: -@height: -@unit: -@Returns: - - - - - - - -@other: -@Returns: - - - - - - - -@size: - - - - - - - -@size1: -@size2: -@Returns: - - - - - - - -@include_custom: -@Returns: - - - - - - - -@size: -@Returns: - - - - - - - -@size: -@Returns: - - - - - - - -@size: -@Returns: - - - - - - - -@size: -@unit: -@Returns: - - - - - - - -@size: -@unit: -@Returns: - - - - - - - -@size: -@Returns: - - - - - - - -@size: -@width: -@height: -@unit: - - - - - - - -@size: -@unit: -@Returns: - - - - - - - -@size: -@unit: -@Returns: - - - - - - - -@size: -@unit: -@Returns: - - - - - - - -@size: -@unit: -@Returns: - - - - - - - -@void: -@Returns: - - - - - - - -@key_file: -@group_name: -@error: -@Returns: - - - - - - - -@size: -@key_file: -@group_name: - - diff --git a/gtk/gtkpapersize.c b/gtk/gtkpapersize.c index 3d81fd9f35..7601aba552 100644 --- a/gtk/gtkpapersize.c +++ b/gtk/gtkpapersize.c @@ -34,6 +34,27 @@ #include "paper_names_offsets.c" + +/** + * SECTION:gtkpapersize + * @Short_description: Support for named paper sizes + * @Title: GtkPaperSize + * @See_also:#GtkPageSetup + * + * GtkPaperSize handles paper sizes. It uses the standard called + * "PWG 5101.1-2002 PWG: Standard for Media Standardized Names" + * to name the paper sizes (and to get the data for the page sizes). + * In addition to standard paper sizes, GtkPaperSize allows to + * construct custom paper sizes with arbitrary dimensions. + * + * The #GtkPaperSize object stores not only the dimensions (width + * and height) of a paper size and its name, it also provides + * default print margins. + * + * Printing support has been added in GTK+ 2.10. + */ + + struct _GtkPaperSize { const PaperInfo *info; diff --git a/gtk/gtkpapersize.h b/gtk/gtkpapersize.h index a3ef2f1067..864eb3818e 100644 --- a/gtk/gtkpapersize.h +++ b/gtk/gtkpapersize.h @@ -36,12 +36,53 @@ typedef struct _GtkPaperSize GtkPaperSize; #define GTK_TYPE_PAPER_SIZE (gtk_paper_size_get_type ()) /* Common names, from PWG 5101.1-2002 PWG: Standard for Media Standardized Names */ +/** + * GTK_PAPER_NAME_A3: + * + * Name for the A4 paper size. + */ #define GTK_PAPER_NAME_A3 "iso_a3" + +/** + * GTK_PAPER_NAME_A4: + * + * Name for the A4 paper size. + */ #define GTK_PAPER_NAME_A4 "iso_a4" + +/** + * GTK_PAPER_NAME_A5: + * + * Name for the A5 paper size. + */ #define GTK_PAPER_NAME_A5 "iso_a5" + +/** + * GTK_PAPER_NAME_B5: + * + * Name for the B5 paper size. + */ #define GTK_PAPER_NAME_B5 "iso_b5" + +/** + * GTK_PAPER_NAME_LETTER: + * + * Name for the Letter paper size. + */ #define GTK_PAPER_NAME_LETTER "na_letter" + +/** + * GTK_PAPER_NAME_EXECUTIVE: + * + * Name for the Executive paper size. + */ #define GTK_PAPER_NAME_EXECUTIVE "na_executive" + +/** + * GTK_PAPER_NAME_LEGAL: + * + * Name for the Legal paper size. + */ #define GTK_PAPER_NAME_LEGAL "na_legal" GType gtk_paper_size_get_type (void) G_GNUC_CONST;