Commit 945e97e5 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkPaperSize

parent d947178e
......@@ -17,6 +17,7 @@ gtkmessagedialog.sgml
gtkobject.sgml
gtkorientable.sgml
gtkpagesetupunixdialog.sgml
gtkpapersize.sgml
gtkprinter.sgml
gtkradioaction.sgml
gtkradiobutton.sgml
......
<!-- ##### SECTION Title ##### -->
GtkPaperSize
<!-- ##### SECTION Short_Description ##### -->
Support for named paper sizes
<!-- ##### SECTION Long_Description ##### -->
<para>
GtkPaperSize handles paper sizes. It uses the standard called
"PWG 5101.1-2002 PWG: Standard for Media Standardized Names"
<!-- FIXME link here -->
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.
</para>
<para>
The #GtkPaperSize object stores not only the dimensions (width
and height) of a paper size and its name, it also provides
default <link linkend="print-margins">print margins</link>.
</para>
<para>
Printing support has been added in GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkPageSetup
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkPaperSize ##### -->
<para>
</para>
<!-- ##### ENUM GtkUnit ##### -->
<para>
</para>
@GTK_UNIT_PIXEL:
@GTK_UNIT_POINTS:
@GTK_UNIT_INCH:
@GTK_UNIT_MM:
<!-- ##### MACRO GTK_PAPER_NAME_A3 ##### -->
<para>
Name for the A4 paper size.
</para>
<!-- ##### MACRO GTK_PAPER_NAME_A4 ##### -->
<para>
Name for the A4 paper size.
</para>
<!-- ##### MACRO GTK_PAPER_NAME_A5 ##### -->
<para>
Name for the A5 paper size.
</para>
<!-- ##### MACRO GTK_PAPER_NAME_B5 ##### -->
<para>
Name for the B5 paper size.
</para>
<!-- ##### MACRO GTK_PAPER_NAME_LETTER ##### -->
<para>
Name for the Letter paper size.
</para>
<!-- ##### MACRO GTK_PAPER_NAME_EXECUTIVE ##### -->
<para>
Name for the Executive paper size.
</para>
<!-- ##### MACRO GTK_PAPER_NAME_LEGAL ##### -->
<para>
Name for the Legal paper size.
</para>
<!-- ##### FUNCTION gtk_paper_size_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_new_from_ppd ##### -->
<para>
</para>
@ppd_name:
@ppd_display_name:
@width:
@height:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_new_custom ##### -->
<para>
</para>
@name:
@display_name:
@width:
@height:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_copy ##### -->
<para>
</para>
@other:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_free ##### -->
<para>
</para>
@size:
<!-- ##### FUNCTION gtk_paper_size_is_equal ##### -->
<para>
</para>
@size1:
@size2:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_paper_sizes ##### -->
<para>
</para>
@include_custom:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_name ##### -->
<para>
</para>
@size:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_display_name ##### -->
<para>
</para>
@size:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_ppd_name ##### -->
<para>
</para>
@size:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_width ##### -->
<para>
</para>
@size:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_height ##### -->
<para>
</para>
@size:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_is_custom ##### -->
<para>
</para>
@size:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_set_size ##### -->
<para>
</para>
@size:
@width:
@height:
@unit:
<!-- ##### FUNCTION gtk_paper_size_get_default_top_margin ##### -->
<para>
</para>
@size:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_default_bottom_margin ##### -->
<para>
</para>
@size:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_default_left_margin ##### -->
<para>
</para>
@size:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_default_right_margin ##### -->
<para>
</para>
@size:
@unit:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_get_default ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_new_from_key_file ##### -->
<para>
</para>
@key_file:
@group_name:
@error:
@Returns:
<!-- ##### FUNCTION gtk_paper_size_to_key_file ##### -->
<para>
</para>
@size:
@key_file:
@group_name:
......@@ -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
* <ulink url="http://www.pwg.org/standards.html">"PWG 5101.1-2002 PWG: Standard for Media Standardized Names"</ulink>
* 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 <link linkend="print-margins">print margins</link>.
*
* Printing support has been added in GTK+ 2.10.
*/
struct _GtkPaperSize
{
const PaperInfo *info;
......
......@@ -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;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment