<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkPaperSize">
<refmeta>
<refentrytitle role="top_of_page" id="GtkPaperSize.top_of_page">GtkPaperSize</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkPaperSize</refname>
<refpurpose>Support for named paper sizes</refpurpose>
</refnamediv>

<refsect1 id="GtkPaperSize.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-new">gtk_paper_size_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-new-from-ppd">gtk_paper_size_new_from_ppd</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-new-from-ipp">gtk_paper_size_new_from_ipp</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-new-custom">gtk_paper_size_new_custom</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-copy">gtk_paper_size_copy</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-free">gtk_paper_size_free</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-is-equal">gtk_paper_size_is_equal</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-paper-sizes">gtk_paper_size_get_paper_sizes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-name">gtk_paper_size_get_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-display-name">gtk_paper_size_get_display_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-ppd-name">gtk_paper_size_get_ppd_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-width">gtk_paper_size_get_width</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-height">gtk_paper_size_get_height</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-is-ipp">gtk_paper_size_is_ipp</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-is-custom">gtk_paper_size_is_custom</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-set-size">gtk_paper_size_set_size</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-default-top-margin">gtk_paper_size_get_default_top_margin</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-default-bottom-margin">gtk_paper_size_get_default_bottom_margin</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-default-left-margin">gtk_paper_size_get_default_left_margin</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-default-right-margin">gtk_paper_size_get_default_right_margin</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-get-default">gtk_paper_size_get_default</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-new-from-key-file">gtk_paper_size_new_from_key_file</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-new-from-gvariant">gtk_paper_size_new_from_gvariant</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-paper-size-to-key-file">gtk_paper_size_to_key_file</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GVariant"><returnvalue>GVariant</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-paper-size-to-gvariant">gtk_paper_size_to_gvariant</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkPaperSize.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkPaperSize-struct">GtkPaperSize</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="GtkUnit">GtkUnit</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-UNIT-PIXEL:CAPS">GTK_UNIT_PIXEL</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-A3:CAPS">GTK_PAPER_NAME_A3</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-A4:CAPS">GTK_PAPER_NAME_A4</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-A5:CAPS">GTK_PAPER_NAME_A5</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-B5:CAPS">GTK_PAPER_NAME_B5</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-LETTER:CAPS">GTK_PAPER_NAME_LETTER</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-EXECUTIVE:CAPS">GTK_PAPER_NAME_EXECUTIVE</link></entry></row>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="GTK-PAPER-NAME-LEGAL:CAPS">GTK_PAPER_NAME_LEGAL</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkPaperSize.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GBoxed">GBoxed</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkPaperSize
</screen>
</refsect1>

<refsect1 id="GtkPaperSize.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkPaperSize.description" role="desc">
<title role="desc.title">Description</title>
<para>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.</para>
<para>The <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> 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>

</refsect1>
<refsect1 id="GtkPaperSize.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-paper-size-new" role="function">
<title>gtk_paper_size_new&#160;()</title>
<indexterm zone="gtk-paper-size-new"><primary>gtk_paper_size_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object by parsing a
<ulink url="ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf">PWG 5101.1-2002</ulink>
paper name.</para>
<para>If <parameter>name</parameter>
 is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the default paper size is returned,
see <link linkend="gtk-paper-size-get-default"><function>gtk_paper_size_get_default()</function></link>.</para>
<refsect3 id="gtk-paper-size-new.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>name</para></entry>
<entry role="parameter_description"><para>a paper size name, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>, use <link linkend="gtk-paper-size-free"><function>gtk_paper_size_free()</function></link>
to free it</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-new-from-ppd" role="function">
<title>gtk_paper_size_new_from_ppd&#160;()</title>
<indexterm zone="gtk-paper-size-new-from-ppd"><primary>gtk_paper_size_new_from_ppd</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_new_from_ppd (<parameter>const <link linkend="gchar"><type>gchar</type></link> *ppd_name</parameter>,
                             <parameter>const <link linkend="gchar"><type>gchar</type></link> *ppd_display_name</parameter>,
                             <parameter><link linkend="gdouble"><type>gdouble</type></link> width</parameter>,
                             <parameter><link linkend="gdouble"><type>gdouble</type></link> height</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object by using
PPD information.</para>
<para>If <parameter>ppd_name</parameter>
 is not a recognized PPD paper name,
<parameter>ppd_display_name</parameter>
, <parameter>width</parameter>
 and <parameter>height</parameter>
 are used to
construct a custom <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object.</para>
<refsect3 id="gtk-paper-size-new-from-ppd.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>ppd_name</para></entry>
<entry role="parameter_description"><para>a PPD paper name</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ppd_display_name</para></entry>
<entry role="parameter_description"><para>the corresponding human-readable name</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>the paper width, in points</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>the paper height in points</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-new-from-ppd.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>, use <link linkend="gtk-paper-size-free"><function>gtk_paper_size_free()</function></link>
to free it</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-new-from-ipp" role="function">
<title>gtk_paper_size_new_from_ipp&#160;()</title>
<indexterm zone="gtk-paper-size-new-from-ipp"><primary>gtk_paper_size_new_from_ipp</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_new_from_ipp (<parameter>const <link linkend="gchar"><type>gchar</type></link> *ipp_name</parameter>,
                             <parameter><link linkend="gdouble"><type>gdouble</type></link> width</parameter>,
                             <parameter><link linkend="gdouble"><type>gdouble</type></link> height</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object by using
IPP information.</para>
<para>If <parameter>ipp_name</parameter>
 is not a recognized paper name,
<parameter>width</parameter>
 and <parameter>height</parameter>
 are used to
construct a custom <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object.</para>
<refsect3 id="gtk-paper-size-new-from-ipp.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>ipp_name</para></entry>
<entry role="parameter_description"><para>an IPP paper name</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>the paper width, in points</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>the paper height in points</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-new-from-ipp.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>, use <link linkend="gtk-paper-size-free"><function>gtk_paper_size_free()</function></link>
to free it</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-new-custom" role="function">
<title>gtk_paper_size_new_custom&#160;()</title>
<indexterm zone="gtk-paper-size-new-custom"><primary>gtk_paper_size_new_custom</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_new_custom (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
                           <parameter>const <link linkend="gchar"><type>gchar</type></link> *display_name</parameter>,
                           <parameter><link linkend="gdouble"><type>gdouble</type></link> width</parameter>,
                           <parameter><link linkend="gdouble"><type>gdouble</type></link> height</parameter>,
                           <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object with the
given parameters.</para>
<refsect3 id="gtk-paper-size-new-custom.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>name</para></entry>
<entry role="parameter_description"><para>the paper name</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>display_name</para></entry>
<entry role="parameter_description"><para>the human-readable name</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>the paper width, in units of <parameter>unit</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>the paper height, in units of <parameter>unit</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for <parameter>width</parameter>
and <parameter>height</parameter>
. not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-new-custom.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object, use <link linkend="gtk-paper-size-free"><function>gtk_paper_size_free()</function></link>
to free it</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-copy" role="function">
<title>gtk_paper_size_copy&#160;()</title>
<indexterm zone="gtk-paper-size-copy"><primary>gtk_paper_size_copy</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_copy (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *other</parameter>);</programlisting>
<para>Copies an existing <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-copy.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>other</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-copy.returns" role="returns">
<title>Returns</title>
<para> a copy of <parameter>other</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-free" role="function">
<title>gtk_paper_size_free&#160;()</title>
<indexterm zone="gtk-paper-size-free"><primary>gtk_paper_size_free</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_paper_size_free (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>);</programlisting>
<para>Free the given <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object.</para>
<refsect3 id="gtk-paper-size-free.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-is-equal" role="function">
<title>gtk_paper_size_is_equal&#160;()</title>
<indexterm zone="gtk-paper-size-is-equal"><primary>gtk_paper_size_is_equal</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_paper_size_is_equal (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size1</parameter>,
                         <parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size2</parameter>);</programlisting>
<para>Compares two <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> objects.</para>
<refsect3 id="gtk-paper-size-is-equal.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size1</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>size2</para></entry>
<entry role="parameter_description"><para>another <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-is-equal.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, if <parameter>size1</parameter>
and <parameter>size2</parameter>
represent the same paper size</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-paper-sizes" role="function">
<title>gtk_paper_size_get_paper_sizes&#160;()</title>
<indexterm zone="gtk-paper-size-get-paper-sizes"><primary>gtk_paper_size_get_paper_sizes</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link>&#160;*
gtk_paper_size_get_paper_sizes (<parameter><link linkend="gboolean"><type>gboolean</type></link> include_custom</parameter>);</programlisting>
<para>Creates a list of known paper sizes.</para>
<refsect3 id="gtk-paper-size-get-paper-sizes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>include_custom</para></entry>
<entry role="parameter_description"><para>whether to include custom paper sizes
as defined in the page setup dialog</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-paper-sizes.returns" role="returns">
<title>Returns</title>
<para>a newly allocated list of newly
allocated <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> objects. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> GtkPaperSize][<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-name" role="function">
<title>gtk_paper_size_get_name&#160;()</title>
<indexterm zone="gtk-paper-size-get-name"><primary>gtk_paper_size_get_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_paper_size_get_name (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>);</programlisting>
<para>Gets the name of the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-get-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-name.returns" role="returns">
<title>Returns</title>
<para> the name of <parameter>size</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-display-name" role="function">
<title>gtk_paper_size_get_display_name&#160;()</title>
<indexterm zone="gtk-paper-size-get-display-name"><primary>gtk_paper_size_get_display_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_paper_size_get_display_name (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>);</programlisting>
<para>Gets the human-readable name of the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-get-display-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-display-name.returns" role="returns">
<title>Returns</title>
<para> the human-readable name of <parameter>size</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-ppd-name" role="function">
<title>gtk_paper_size_get_ppd_name&#160;()</title>
<indexterm zone="gtk-paper-size-get-ppd-name"><primary>gtk_paper_size_get_ppd_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_paper_size_get_ppd_name (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>);</programlisting>
<para>Gets the PPD name of the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>, which
may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<refsect3 id="gtk-paper-size-get-ppd-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-ppd-name.returns" role="returns">
<title>Returns</title>
<para> the PPD name of <parameter>size</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-width" role="function">
<title>gtk_paper_size_get_width&#160;()</title>
<indexterm zone="gtk-paper-size-get-width"><primary>gtk_paper_size_get_width</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
gtk_paper_size_get_width (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                          <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Gets the paper width of the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>, in
units of <parameter>unit</parameter>
.</para>
<refsect3 id="gtk-paper-size-get-width.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for the return value, not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-width.returns" role="returns">
<title>Returns</title>
<para> the paper width</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-height" role="function">
<title>gtk_paper_size_get_height&#160;()</title>
<indexterm zone="gtk-paper-size-get-height"><primary>gtk_paper_size_get_height</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
gtk_paper_size_get_height (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                           <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Gets the paper height of the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>, in
units of <parameter>unit</parameter>
.</para>
<refsect3 id="gtk-paper-size-get-height.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for the return value, not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-height.returns" role="returns">
<title>Returns</title>
<para> the paper height</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-is-ipp" role="function">
<title>gtk_paper_size_is_ipp&#160;()</title>
<indexterm zone="gtk-paper-size-is-ipp"><primary>gtk_paper_size_is_ipp</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_paper_size_is_ipp (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>size</parameter>
 is an IPP standard paper size.</para>
<refsect3 id="gtk-paper-size-is-ipp.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-is-ipp.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>size</parameter>
is not an IPP custom paper size.</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-is-custom" role="function">
<title>gtk_paper_size_is_custom&#160;()</title>
<indexterm zone="gtk-paper-size-is-custom"><primary>gtk_paper_size_is_custom</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_paper_size_is_custom (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>size</parameter>
 is not a standard paper size.</para>
<refsect3 id="gtk-paper-size-is-custom.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-is-custom.returns" role="returns">
<title>Returns</title>
<para> whether <parameter>size</parameter>
is a custom paper size.</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-set-size" role="function">
<title>gtk_paper_size_set_size&#160;()</title>
<indexterm zone="gtk-paper-size-set-size"><primary>gtk_paper_size_set_size</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_paper_size_set_size (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                         <parameter><link linkend="gdouble"><type>gdouble</type></link> width</parameter>,
                         <parameter><link linkend="gdouble"><type>gdouble</type></link> height</parameter>,
                         <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Changes the dimensions of a <parameter>size</parameter>
 to <parameter>width</parameter>
 x <parameter>height</parameter>
.</para>
<refsect3 id="gtk-paper-size-set-size.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a custom <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>the new width in units of <parameter>unit</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>the new height in units of <parameter>unit</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for <parameter>width</parameter>
and <parameter>height</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-default-top-margin" role="function">
<title>gtk_paper_size_get_default_top_margin&#160;()</title>
<indexterm zone="gtk-paper-size-get-default-top-margin"><primary>gtk_paper_size_get_default_top_margin</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
gtk_paper_size_get_default_top_margin (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                                       <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Gets the default top margin for the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-get-default-top-margin.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for the return value, not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-default-top-margin.returns" role="returns">
<title>Returns</title>
<para> the default top margin</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-default-bottom-margin" role="function">
<title>gtk_paper_size_get_default_bottom_margin&#160;()</title>
<indexterm zone="gtk-paper-size-get-default-bottom-margin"><primary>gtk_paper_size_get_default_bottom_margin</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
gtk_paper_size_get_default_bottom_margin
                               (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                                <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Gets the default bottom margin for the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-get-default-bottom-margin.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for the return value, not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-default-bottom-margin.returns" role="returns">
<title>Returns</title>
<para> the default bottom margin</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-default-left-margin" role="function">
<title>gtk_paper_size_get_default_left_margin&#160;()</title>
<indexterm zone="gtk-paper-size-get-default-left-margin"><primary>gtk_paper_size_get_default_left_margin</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
gtk_paper_size_get_default_left_margin
                               (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                                <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Gets the default left margin for the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-get-default-left-margin.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for the return value, not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-default-left-margin.returns" role="returns">
<title>Returns</title>
<para> the default left margin</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-default-right-margin" role="function">
<title>gtk_paper_size_get_default_right_margin&#160;()</title>
<indexterm zone="gtk-paper-size-get-default-right-margin"><primary>gtk_paper_size_get_default_right_margin</primary></indexterm>
<programlisting language="C"><link linkend="gdouble"><returnvalue>gdouble</returnvalue></link>
gtk_paper_size_get_default_right_margin
                               (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                                <parameter><link linkend="GtkUnit"><type>GtkUnit</type></link> unit</parameter>);</programlisting>
<para>Gets the default right margin for the <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link>.</para>
<refsect3 id="gtk-paper-size-get-default-right-margin.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>unit</para></entry>
<entry role="parameter_description"><para>the unit for the return value, not <link linkend="GTK-UNIT-NONE:CAPS"><literal>GTK_UNIT_NONE</literal></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-get-default-right-margin.returns" role="returns">
<title>Returns</title>
<para> the default right margin</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-get-default" role="function">
<title>gtk_paper_size_get_default&#160;()</title>
<indexterm zone="gtk-paper-size-get-default"><primary>gtk_paper_size_get_default</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gtk_paper_size_get_default (<parameter><type>void</type></parameter>);</programlisting>
<para>Returns the name of the default paper size, which
depends on the current locale.</para>
<refsect3 id="gtk-paper-size-get-default.returns" role="returns">
<title>Returns</title>
<para> the name of the default paper size. The string
is owned by GTK and should not be modified.</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-new-from-key-file" role="function">
<title>gtk_paper_size_new_from_key_file&#160;()</title>
<indexterm zone="gtk-paper-size-new-from-key-file"><primary>gtk_paper_size_new_from_key_file</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_new_from_key_file (<parameter><link linkend="GKeyFile"><type>GKeyFile</type></link> *key_file</parameter>,
                                  <parameter>const <link linkend="gchar"><type>gchar</type></link> *group_name</parameter>,
                                  <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
<para>Reads a paper size from the group <parameter>group_name</parameter>
 in the key file
<parameter>key_file</parameter>
.</para>
<refsect3 id="gtk-paper-size-new-from-key-file.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>key_file</para></entry>
<entry role="parameter_description"><para>the <link linkend="GKeyFile"><type>GKeyFile</type></link> to retrieve the papersize from</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>group_name</para></entry>
<entry role="parameter_description"><para>the name of the group in the key file to read,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to read the first group. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>error</para></entry>
<entry role="parameter_description"><para>return location for an error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-new-from-key-file.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object with the restored
paper size, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if an error occurred</para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-new-from-gvariant" role="function">
<title>gtk_paper_size_new_from_gvariant&#160;()</title>
<indexterm zone="gtk-paper-size-new-from-gvariant"><primary>gtk_paper_size_new_from_gvariant</primary></indexterm>
<programlisting language="C"><link linkend="GtkPaperSize"><returnvalue>GtkPaperSize</returnvalue></link>&#160;*
gtk_paper_size_new_from_gvariant (<parameter><link linkend="GVariant"><type>GVariant</type></link> *variant</parameter>);</programlisting>
<para>Deserialize a paper size from an a{sv} variant in
the format produced by <link linkend="gtk-paper-size-to-gvariant"><function>gtk_paper_size_to_gvariant()</function></link>.</para>
<refsect3 id="gtk-paper-size-new-from-gvariant.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>variant</para></entry>
<entry role="parameter_description"><para>an a{sv} <link linkend="GVariant"><type>GVariant</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-new-from-gvariant.returns" role="returns">
<title>Returns</title>
<para>a new <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> object. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-to-key-file" role="function">
<title>gtk_paper_size_to_key_file&#160;()</title>
<indexterm zone="gtk-paper-size-to-key-file"><primary>gtk_paper_size_to_key_file</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_paper_size_to_key_file (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *size</parameter>,
                            <parameter><link linkend="GKeyFile"><type>GKeyFile</type></link> *key_file</parameter>,
                            <parameter>const <link linkend="gchar"><type>gchar</type></link> *group_name</parameter>);</programlisting>
<para>This function adds the paper size from <parameter>size</parameter>
 to <parameter>key_file</parameter>
.</para>
<refsect3 id="gtk-paper-size-to-key-file.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>key_file</para></entry>
<entry role="parameter_description"><para>the <link linkend="GKeyFile"><type>GKeyFile</type></link> to save the paper size to</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>group_name</para></entry>
<entry role="parameter_description"><para>the group to add the settings to in <parameter>key_file</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-paper-size-to-gvariant" role="function">
<title>gtk_paper_size_to_gvariant&#160;()</title>
<indexterm zone="gtk-paper-size-to-gvariant"><primary>gtk_paper_size_to_gvariant</primary></indexterm>
<programlisting language="C"><link linkend="GVariant"><returnvalue>GVariant</returnvalue></link>&#160;*
gtk_paper_size_to_gvariant (<parameter><link linkend="GtkPaperSize"><type>GtkPaperSize</type></link> *paper_size</parameter>);</programlisting>
<para>Serialize a paper size to an a{sv} variant.</para>
<refsect3 id="gtk-paper-size-to-gvariant.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>paper_size</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkPaperSize"><type>GtkPaperSize</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-paper-size-to-gvariant.returns" role="returns">
<title>Returns</title>
<para>a new, floating, <link linkend="GVariant"><type>GVariant</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkPaperSize.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkPaperSize-struct" role="struct">
<title>GtkPaperSize</title>
<indexterm zone="GtkPaperSize-struct"><primary>GtkPaperSize</primary></indexterm>
<programlisting language="C">typedef struct _GtkPaperSize GtkPaperSize;</programlisting>
</refsect2>
<refsect2 id="GtkUnit" role="enum">
<title>enum GtkUnit</title>
<indexterm zone="GtkUnit"><primary>GtkUnit</primary></indexterm>
<para>See also <link linkend="gtk-print-settings-set-paper-width"><function>gtk_print_settings_set_paper_width()</function></link>.</para>
<refsect3 id="GtkUnit.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="GTK-UNIT-NONE:CAPS">GTK_UNIT_NONE</para></entry>
<entry role="enum_member_description"><para>No units.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GTK-UNIT-POINTS:CAPS">GTK_UNIT_POINTS</para></entry>
<entry role="enum_member_description"><para>Dimensions in points.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GTK-UNIT-INCH:CAPS">GTK_UNIT_INCH</para></entry>
<entry role="enum_member_description"><para>Dimensions in inches.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="GTK-UNIT-MM:CAPS">GTK_UNIT_MM</para></entry>
<entry role="enum_member_description"><para>Dimensions in millimeters</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="GTK-UNIT-PIXEL:CAPS" role="macro">
<title>GTK_UNIT_PIXEL</title>
<indexterm zone="GTK-UNIT-PIXEL:CAPS"><primary>GTK_UNIT_PIXEL</primary></indexterm>
<programlisting language="C">#define GTK_UNIT_PIXEL GTK_UNIT_NONE
</programlisting>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-A3:CAPS" role="macro">
<title>GTK_PAPER_NAME_A3</title>
<indexterm zone="GTK-PAPER-NAME-A3:CAPS"><primary>GTK_PAPER_NAME_A3</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_A3 "iso_a3"
</programlisting>
<para>Name for the A3 paper size.</para>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-A4:CAPS" role="macro">
<title>GTK_PAPER_NAME_A4</title>
<indexterm zone="GTK-PAPER-NAME-A4:CAPS"><primary>GTK_PAPER_NAME_A4</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_A4 "iso_a4"
</programlisting>
<para>Name for the A4 paper size.</para>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-A5:CAPS" role="macro">
<title>GTK_PAPER_NAME_A5</title>
<indexterm zone="GTK-PAPER-NAME-A5:CAPS"><primary>GTK_PAPER_NAME_A5</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_A5 "iso_a5"
</programlisting>
<para>Name for the A5 paper size.</para>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-B5:CAPS" role="macro">
<title>GTK_PAPER_NAME_B5</title>
<indexterm zone="GTK-PAPER-NAME-B5:CAPS"><primary>GTK_PAPER_NAME_B5</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_B5 "iso_b5"
</programlisting>
<para>Name for the B5 paper size.</para>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-LETTER:CAPS" role="macro">
<title>GTK_PAPER_NAME_LETTER</title>
<indexterm zone="GTK-PAPER-NAME-LETTER:CAPS"><primary>GTK_PAPER_NAME_LETTER</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_LETTER "na_letter"
</programlisting>
<para>Name for the Letter paper size.</para>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-EXECUTIVE:CAPS" role="macro">
<title>GTK_PAPER_NAME_EXECUTIVE</title>
<indexterm zone="GTK-PAPER-NAME-EXECUTIVE:CAPS"><primary>GTK_PAPER_NAME_EXECUTIVE</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_EXECUTIVE "na_executive"
</programlisting>
<para>Name for the Executive paper size.</para>
</refsect2>
<refsect2 id="GTK-PAPER-NAME-LEGAL:CAPS" role="macro">
<title>GTK_PAPER_NAME_LEGAL</title>
<indexterm zone="GTK-PAPER-NAME-LEGAL:CAPS"><primary>GTK_PAPER_NAME_LEGAL</primary></indexterm>
<programlisting language="C">#define GTK_PAPER_NAME_LEGAL "na_legal"
</programlisting>
<para>Name for the Legal paper size.</para>
</refsect2>

</refsect1>
<refsect1 id="GtkPaperSize.see-also">
<title>See Also</title>
<para><link linkend="GtkPageSetup"><type>GtkPageSetup</type></link></para>

</refsect1>

</refentry>
