path: root/docs/reference/pygtk-gtkpapersize.xml

<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkpapersize">

  <refnamediv>
    <refname>gtk.PaperSize</refname>
      <refpurpose>an object providing support for named paper sizes (new in
      PyGTK 2.10)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.PaperSize</classname></ooclass>
      <ooclass><classname>gobject.GBoxed</classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkpapersize">gtk.PaperSize</link></methodname>
        <methodparam><parameter role="keyword">name</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--copy">copy</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--is-equal">is_equal</link></methodname>
        <methodparam><parameter role="keyword">size2</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-name">get_name</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-display-name">get_display_name</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-ppd-name">get_ppd_name</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-width">get_width</link></methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-height">get_height</link></methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--is-custom">is_custom</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--set-size">set_size</link></methodname>
        <methodparam><parameter role="keyword">width</parameter></methodparam>
        <methodparam><parameter role="keyword">height</parameter></methodparam>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-default-top-margin">get_default_top_margin</link></methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-default-bottom-margin">get_default_bottom_margin</link></methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-default-left-margin">get_default_left_margin</link></methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkpapersize--get-default-right-margin">get_default_right_margin</link></methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis>

</classsynopsis>

<programlisting>
<emphasis role="bold">Functions</emphasis>

<methodsynopsis language="python">
    <methodname><link linkend="function-gtk--paper-size-new-from-ppd">gtk.paper_size_new_from_ppd</link></methodname>
    <methodparam><parameter role="keyword">ppd_name</parameter></methodparam>
    <methodparam><parameter role="keyword">ppd_display_name</parameter></methodparam>
    <methodparam><parameter role="keyword">width</parameter></methodparam>
    <methodparam><parameter role="keyword">height</parameter></methodparam>
  </methodsynopsis><methodsynopsis language="python">
    <methodname><link linkend="function-gtk--paper-size-new-custom">gtk.paper_size_new_cutom</link></methodname>
    <methodparam><parameter role="keyword">name</parameter></methodparam>
    <methodparam><parameter role="keyword">display_name</parameter></methodparam>
    <methodparam><parameter role="keyword">width</parameter></methodparam>
    <methodparam><parameter role="keyword">height</parameter></methodparam>
    <methodparam><parameter role="keyword">unit</parameter></methodparam>
  </methodsynopsis><methodsynopsis language="python">
    <methodname><link linkend="function-gtk--paper-size-get-default">gtk.paper_size_get_default</link></methodname>
    <methodparam><parameter role="keyword"></parameter></methodparam>
  </methodsynopsis></programlisting>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This class is available in PyGTK 2.10 and above.</para>
    </note>

    <para>A <link
    linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
    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). The common standard paper sizes are
    named by the <xref linkend="gtk-paper-name-constants"
    endterm="gtk-paper-name-constants-title"></xref>. In addition to
    standard paper sizes, <link
    linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
    allows to construct custom paper sizes with arbitrary dimensions.</para>

    <para>The <link
    linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
    object stores not only the dimensions (width and height) of a paper size
    and its name, it also provides default print margins. </para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkpapersize">
      <title>gtk.PaperSize</title>

      <programlisting><constructorsynopsis language="python">
        <methodname>gtk.PaperSize</methodname>
        <methodparam><parameter role="keyword">name</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">name</parameter>&nbsp;:</term>
          <listitem><simpara>a paper size name, or <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This constructor is available in PyGTK 2.10 and above.</para>
      </note>

      <para>Creates a new <link
      linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
      object by parsing a PWG 5101.1-2002 PWG paper name. </para>
      
      <para>If <parameter>name</parameter> is <literal>None</literal>, the
      default paper size is returned, see
      <function>paper_size_get_default</function>().</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkpapersize--copy">
      <title>gtk.PaperSize.copy</title>

      <programlisting><methodsynopsis language="python">
        <methodname>copy</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a copy of <parameter>other</parameter></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>copy</methodname>() method copies an existing <link linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--is-equal">
      <title>gtk.PaperSize.is_equal</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_equal</methodname>
        <methodparam><parameter role="keyword">size2</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">size2</parameter>&nbsp;:</term>
          <listitem><simpara>another <link
          linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
          object</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal>, if this paper size and
          <parameter>size2</parameter> represent the same paper
          size</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>is_equal</methodname>() method returns the
      result of comparing this paper size to the <link
      linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
      specified by <parameter>size2</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-name">
      <title>gtk.PaperSize.get_name</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_name</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the name of the paper size</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_name</methodname>() method returns the name
      of the paper size.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-display-name">
      <title>gtk.PaperSize.get_display_name</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_display_name</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the human-readable name of the paper
          size.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_display_name</methodname>() method returns
      the human-readable name of the paper size.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-ppd-name">
      <title>gtk.PaperSize.get_ppd_name</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_ppd_name</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the PPD name of the paper
          size or <literal>None</literal></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_ppd_name</methodname>() method returns the
      PPD name of the paper size, which may be
      <literal>None</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-width">
      <title>gtk.PaperSize.get_width</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_width</methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for the return value - one of the
          <xref linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the paper width</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_width</methodname>() method returns the
      paper width of the paper size, in units of
      <parameter>unit</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-height">
      <title>gtk.PaperSize.get_height</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_height</methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for the return value - one of the
          <xref linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the paper height</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_height</methodname>() method returns the
      paper height of the paper size, in units of
      <parameter>unit</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--is-custom">
      <title>gtk.PaperSize.is_custom</title>

      <programlisting><methodsynopsis language="python">
        <methodname>is_custom</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the paper size is a
          custom paper size.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The <methodname>is_custom</methodname>() method returns
      <literal>True</literal> if paper size is not a standard paper
      size.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--set-size">
      <title>gtk.PaperSize.set_size</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_size</methodname>
        <methodparam><parameter role="keyword">width</parameter></methodparam>
        <methodparam><parameter role="keyword">height</parameter></methodparam>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">width</parameter>&nbsp;:</term>
          <listitem><simpara>the new width in units of
          <parameter>unit</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">height</parameter>&nbsp;:</term>
          <listitem><simpara>the new height in units of
          <parameter>unit</parameter></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for <parameter>width</parameter> and
          <parameter>height</parameter> - one of the <xref
          linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>set_size</methodname>() method changes the
      dimensions of the paper size to <parameter>width</parameter> x
      <parameter>height</parameter> in the units specified by
      <literal>unit</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-default-top-margin">
      <title>gtk.PaperSize.get_default_top_margin</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_default_top_margin</methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for the return value - one of the
          <xref linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the default top margin</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_default_top_margin</methodname>() method
      returns the default top margin for the <link
      linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-default-bottom-margin">
      <title>gtk.PaperSize.get_default_bottom_margin</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_default_bottom_margin</methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for the return value - one of the
          <xref linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the default bottom margin</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_default_bottom_margin</methodname>() method
      gets the default bottom margin for the paper size.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-default-left-margin">
      <title>gtk.PaperSize.get_default_left_margin</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_default_left_margin</methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for the return value - one of the
          <xref linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the default left margin</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_default_left_margin</methodname>() method
      gets the default left margin for the paper size.</para>

    </refsect2>

    <refsect2 id="method-gtkpapersize--get-default-right-margin">
      <title>gtk.PaperSize.get_default_right_margin</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_default_right_margin</methodname>
        <methodparam><parameter role="keyword">unit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
          <listitem><simpara>the unit for the return value - one of the
          <xref linkend="gtk-unit-constants"
          endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the default right margin</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>get_default_right_margin</methodname>() method
      gets the default right margin for the paper size.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-gtk--paper-size-new-from-ppd">
      <title>gtk.paper_size_new_from_ppd</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.paper_size_new_from_ppd</methodname>
          <methodparam><parameter role="keyword">ppd_name</parameter></methodparam>
          <methodparam><parameter role="keyword">ppd_display_name</parameter></methodparam>
          <methodparam><parameter role="keyword">width</parameter></methodparam>
          <methodparam><parameter role="keyword">height</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">>ppd_name</parameter>&nbsp;:</term>
	  <listitem><simpara>a PPD paper name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">ppd_display_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the corresponding human-readable
	  name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">width</parameter>&nbsp;:</term>
	  <listitem><simpara>the paper width, in points</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">height</parameter>&nbsp;:</term>
	  <listitem><simpara>the paper height in points</simpara></listitem>
	</varlistentry>
	<varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a new <link
	  linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This function is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <function>paper_size new__from_ppd</function>() function
      creates a new <link
      linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
      object by using PPD information.  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="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
      object.</para>

    </refsect2>

    <refsect2 id="function-gtk--paper-size-new-custom">
      <title>gtk.paper_size_new_custom</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.paper_size_new_custom</methodname>
          <methodparam><parameter role="keyword">name</parameter></methodparam>
          <methodparam><parameter role="keyword">display_name</parameter></methodparam>
          <methodparam><parameter role="keyword">width</parameter></methodparam>
          <methodparam><parameter role="keyword">height</parameter></methodparam>
          <methodparam><parameter role="keyword">unit</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">>name</parameter>&nbsp;:</term>
	  <listitem><simpara>the paper name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">display_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the corresponding human-readable
	  name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">width</parameter>&nbsp;:</term>
	  <listitem><simpara>the paper width, in units of
	  <parameter>unit</parameter></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">height</parameter>&nbsp;:</term>
	  <listitem><simpara>the paper height in units of
	  <parameter>unit</parameter></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">unit</parameter>&nbsp;:</term>
	  <listitem><simpara>the units - one of the <xref
	  linkend="gtk-unit-constants"
	  endterm="gtk-unit-constants-title"></xref>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a new <link
	  linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This function is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <function>paper_size_new_custom</function>() function
      creates a new <link
      linkend="class-gtkpapersize"><classname>gtk.PaperSize</classname></link>
      object with the given parameters.</para>

    </refsect2>

    <refsect2 id="function-gtk--paper-size-get-default">
      <title>gtk.paper_size_get_default</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.paper_size_get_default</methodname>
	  <methodparam><parameter
			 role="keyword"></parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the name of the default paper
	  size.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This function is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <function>paper_size_get_default</function>() function
      returns the name of the default paper size, which depends on the
      current locale.</para>

    </refsect2>

  </refsect1>

</refentry>