2006-04-21 15:09:32 +00:00
|
|
|
<!-- ##### 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 ##### -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### 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>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the A4 paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PAPER_NAME_A4 ##### -->
|
|
|
|
<para>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the A4 paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PAPER_NAME_A5 ##### -->
|
|
|
|
<para>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the A5 paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PAPER_NAME_B5 ##### -->
|
|
|
|
<para>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the B5 paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PAPER_NAME_LETTER ##### -->
|
|
|
|
<para>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the Letter paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PAPER_NAME_EXECUTIVE ##### -->
|
|
|
|
<para>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the Executive paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO GTK_PAPER_NAME_LEGAL ##### -->
|
|
|
|
<para>
|
2006-04-24 17:53:32 +00:00
|
|
|
Name for the Legal paper size.
|
2006-04-21 15:09:32 +00:00
|
|
|
</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:
|
|
|
|
|
|
|
|
|
2007-05-24 05:51:56 +00:00
|
|
|
<!-- ##### FUNCTION gtk_paper_size_get_paper_sizes ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@include_custom:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2006-04-21 15:09:32 +00:00
|
|
|
<!-- ##### 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>
|
|
|
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2007-05-24 05:51:56 +00:00
|
|
|
<!-- ##### 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:
|
|
|
|
|
|
|
|
|