<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkPaperSize: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="Printing.html" title="Printing">
<link rel="prev" href="GtkPageSetup.html" title="GtkPageSetup">
<link rel="next" href="GtkPrinter.html" title="GtkPrinter">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkPaperSize.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkPaperSize.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Printing.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkPageSetup.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkPrinter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkPaperSize"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkPaperSize.top_of_page"></a>GtkPaperSize</span></h2>
<p>GtkPaperSize — Support for named paper sizes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkPaperSize.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-new" title="gtk_paper_size_new ()">gtk_paper_size_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-new-from-ppd" title="gtk_paper_size_new_from_ppd ()">gtk_paper_size_new_from_ppd</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-new-from-ipp" title="gtk_paper_size_new_from_ipp ()">gtk_paper_size_new_from_ipp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-new-custom" title="gtk_paper_size_new_custom ()">gtk_paper_size_new_custom</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-copy" title="gtk_paper_size_copy ()">gtk_paper_size_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-free" title="gtk_paper_size_free ()">gtk_paper_size_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-is-equal" title="gtk_paper_size_is_equal ()">gtk_paper_size_is_equal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-paper-sizes" title="gtk_paper_size_get_paper_sizes ()">gtk_paper_size_get_paper_sizes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-name" title="gtk_paper_size_get_name ()">gtk_paper_size_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-display-name" title="gtk_paper_size_get_display_name ()">gtk_paper_size_get_display_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-ppd-name" title="gtk_paper_size_get_ppd_name ()">gtk_paper_size_get_ppd_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-width" title="gtk_paper_size_get_width ()">gtk_paper_size_get_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-height" title="gtk_paper_size_get_height ()">gtk_paper_size_get_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-is-ipp" title="gtk_paper_size_is_ipp ()">gtk_paper_size_is_ipp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-is-custom" title="gtk_paper_size_is_custom ()">gtk_paper_size_is_custom</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-set-size" title="gtk_paper_size_set_size ()">gtk_paper_size_set_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-default-top-margin" title="gtk_paper_size_get_default_top_margin ()">gtk_paper_size_get_default_top_margin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-default-bottom-margin" title="gtk_paper_size_get_default_bottom_margin ()">gtk_paper_size_get_default_bottom_margin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-default-left-margin" title="gtk_paper_size_get_default_left_margin ()">gtk_paper_size_get_default_left_margin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-default-right-margin" title="gtk_paper_size_get_default_right_margin ()">gtk_paper_size_get_default_right_margin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-get-default" title="gtk_paper_size_get_default ()">gtk_paper_size_get_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-new-from-key-file" title="gtk_paper_size_new_from_key_file ()">gtk_paper_size_new_from_key_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPaperSize.html#gtk-paper-size-to-key-file" title="gtk_paper_size_to_key_file ()">gtk_paper_size_to_key_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPaperSize.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GtkPaperSize-struct" title="GtkPaperSize">GtkPaperSize</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit">GtkUnit</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-UNIT-PIXEL:CAPS" title="GTK_UNIT_PIXEL">GTK_UNIT_PIXEL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-A3:CAPS" title="GTK_PAPER_NAME_A3">GTK_PAPER_NAME_A3</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-A4:CAPS" title="GTK_PAPER_NAME_A4">GTK_PAPER_NAME_A4</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-A5:CAPS" title="GTK_PAPER_NAME_A5">GTK_PAPER_NAME_A5</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-B5:CAPS" title="GTK_PAPER_NAME_B5">GTK_PAPER_NAME_B5</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-LETTER:CAPS" title="GTK_PAPER_NAME_LETTER">GTK_PAPER_NAME_LETTER</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-EXECUTIVE:CAPS" title="GTK_PAPER_NAME_EXECUTIVE">GTK_PAPER_NAME_EXECUTIVE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkPaperSize.html#GTK-PAPER-NAME-LEGAL:CAPS" title="GTK_PAPER_NAME_LEGAL">GTK_PAPER_NAME_LEGAL</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPaperSize.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
<span class="lineart">╰──</span> GtkPaperSize
</pre>
</div>
<div class="refsect1">
<a name="GtkPaperSize.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkPaperSize.description"></a><h2>Description</h2>
<p>GtkPaperSize handles paper sizes. It uses the standard called
<a class="ulink" href="http://www.pwg.org/standards.html" target="_top">PWG 5101.1-2002 PWG: Standard for Media Standardized Names</a>
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.</p>
<p>The <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object stores not only the dimensions (width
and height) of a paper size and its name, it also provides
default <a class="link" href="GtkPageSetup.html#print-margins" title="Margins">print margins</a>.</p>
<p>Printing support has been added in GTK+ 2.10.</p>
</div>
<div class="refsect1">
<a name="GtkPaperSize.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-paper-size-new"></a><h3>gtk_paper_size_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
gtk_paper_size_new (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Creates a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object by parsing a
<a class="ulink" href="ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf" target="_top">PWG 5101.1-2002</a>
paper name.</p>
<p>If <em class="parameter"><code>name</code></em>
is <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default paper size is returned,
see <a class="link" href="GtkPaperSize.html#gtk-paper-size-get-default" title="gtk_paper_size_get_default ()"><code class="function">gtk_paper_size_get_default()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p> a paper size name, or <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.2.7"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>, use <a class="link" href="GtkPaperSize.html#gtk-paper-size-free" title="gtk_paper_size_free ()"><code class="function">gtk_paper_size_free()</code></a>
to free it</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-new-from-ppd"></a><h3>gtk_paper_size_new_from_ppd ()</h3>
<pre class="programlisting"><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
gtk_paper_size_new_from_ppd (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ppd_name</code></em>,
<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ppd_display_name</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>);</pre>
<p>Creates a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object by using
PPD information.</p>
<p>If <em class="parameter"><code>ppd_name</code></em>
is not a recognized PPD paper name,
<em class="parameter"><code>ppd_display_name</code></em>
, <em class="parameter"><code>width</code></em>
and <em class="parameter"><code>height</code></em>
are used to
construct a custom <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ppd_name</p></td>
<td class="parameter_description"><p>a PPD paper name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ppd_display_name</p></td>
<td class="parameter_description"><p>the corresponding human-readable name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the paper width, in points</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the paper height in points</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.3.7"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>, use <a class="link" href="GtkPaperSize.html#gtk-paper-size-free" title="gtk_paper_size_free ()"><code class="function">gtk_paper_size_free()</code></a>
to free it</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-new-from-ipp"></a><h3>gtk_paper_size_new_from_ipp ()</h3>
<pre class="programlisting"><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
gtk_paper_size_new_from_ipp (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ipp_name</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>);</pre>
<p>Creates a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object by using
IPP information.</p>
<p>If <em class="parameter"><code>ipp_name</code></em>
is not a recognized paper name,
<em class="parameter"><code>width</code></em>
and <em class="parameter"><code>height</code></em>
are used to
construct a custom <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>ipp_name</p></td>
<td class="parameter_description"><p>an IPP paper name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the paper width, in points</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the paper height in points</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.4.7"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>, use <a class="link" href="GtkPaperSize.html#gtk-paper-size-free" title="gtk_paper_size_free ()"><code class="function">gtk_paper_size_free()</code></a>
to free it</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-new-custom"></a><h3>gtk_paper_size_new_custom ()</h3>
<pre class="programlisting"><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
gtk_paper_size_new_custom (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *display_name</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Creates a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object with the
given parameters.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the paper name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>display_name</p></td>
<td class="parameter_description"><p>the human-readable name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the paper width, in units of <em class="parameter"><code>unit</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the paper height, in units of <em class="parameter"><code>unit</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for <em class="parameter"><code>width</code></em>
and <em class="parameter"><code>height</code></em>
. not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.5.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object, use <a class="link" href="GtkPaperSize.html#gtk-paper-size-free" title="gtk_paper_size_free ()"><code class="function">gtk_paper_size_free()</code></a>
to free it</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-copy"></a><h3>gtk_paper_size_copy ()</h3>
<pre class="programlisting"><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
gtk_paper_size_copy (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *other</code></em>);</pre>
<p>Copies an existing <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>other</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.6.6"></a><h4>Returns</h4>
<p> a copy of <em class="parameter"><code>other</code></em>
</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-free"></a><h3>gtk_paper_size_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_paper_size_free (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>);</pre>
<p>Free the given <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-is-equal"></a><h3>gtk_paper_size_is_equal ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_paper_size_is_equal (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size1</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size2</code></em>);</pre>
<p>Compares two <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> objects.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size1</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size2</p></td>
<td class="parameter_description"><p>another <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.8.6"></a><h4>Returns</h4>
<p> <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if <em class="parameter"><code>size1</code></em>
and <em class="parameter"><code>size2</code></em>
represent the same paper size</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-paper-sizes"></a><h3>gtk_paper_size_get_paper_sizes ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gtk_paper_size_get_paper_sizes (<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> include_custom</code></em>);</pre>
<p>Creates a list of known paper sizes.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>include_custom</p></td>
<td class="parameter_description"><p>whether to include custom paper sizes
as defined in the page setup dialog</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.9.6"></a><h4>Returns</h4>
<p> a newly allocated list of newly
allocated <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> objects. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkPaperSize][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-name"></a><h3>gtk_paper_size_get_name ()</h3>
<pre class="programlisting">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_paper_size_get_name (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>);</pre>
<p>Gets the name of the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.10.6"></a><h4>Returns</h4>
<p> the name of <em class="parameter"><code>size</code></em>
</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-display-name"></a><h3>gtk_paper_size_get_display_name ()</h3>
<pre class="programlisting">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_paper_size_get_display_name (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>);</pre>
<p>Gets the human-readable name of the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.11.6"></a><h4>Returns</h4>
<p> the human-readable name of <em class="parameter"><code>size</code></em>
</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-ppd-name"></a><h3>gtk_paper_size_get_ppd_name ()</h3>
<pre class="programlisting">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_paper_size_get_ppd_name (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>);</pre>
<p>Gets the PPD name of the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>, which
may be <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.12.6"></a><h4>Returns</h4>
<p> the PPD name of <em class="parameter"><code>size</code></em>
</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-width"></a><h3>gtk_paper_size_get_width ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_paper_size_get_width (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Gets the paper width of the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>, in
units of <em class="parameter"><code>unit</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for the return value, not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.13.6"></a><h4>Returns</h4>
<p> the paper width</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-height"></a><h3>gtk_paper_size_get_height ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_paper_size_get_height (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Gets the paper height of the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>, in
units of <em class="parameter"><code>unit</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for the return value, not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.14.6"></a><h4>Returns</h4>
<p> the paper height</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-is-ipp"></a><h3>gtk_paper_size_is_ipp ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_paper_size_is_ipp (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>);</pre>
<p>Returns <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>size</code></em>
is an IPP standard paper size.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.15.6"></a><h4>Returns</h4>
<p> whether <em class="parameter"><code>size</code></em>
is not an IPP custom paper size.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-is-custom"></a><h3>gtk_paper_size_is_custom ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_paper_size_is_custom (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>);</pre>
<p>Returns <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>size</code></em>
is not a standard paper size.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.16.6"></a><h4>Returns</h4>
<p> whether <em class="parameter"><code>size</code></em>
is a custom paper size.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-set-size"></a><h3>gtk_paper_size_set_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_paper_size_set_size (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Changes the dimensions of a <em class="parameter"><code>size</code></em>
to <em class="parameter"><code>width</code></em>
x <em class="parameter"><code>height</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.17.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a custom <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the new width in units of <em class="parameter"><code>unit</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the new height in units of <em class="parameter"><code>unit</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for <em class="parameter"><code>width</code></em>
and <em class="parameter"><code>height</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-default-top-margin"></a><h3>gtk_paper_size_get_default_top_margin ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_paper_size_get_default_top_margin (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Gets the default top margin for the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for the return value, not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.18.6"></a><h4>Returns</h4>
<p> the default top margin</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-default-bottom-margin"></a><h3>gtk_paper_size_get_default_bottom_margin ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_paper_size_get_default_bottom_margin
(<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Gets the default bottom margin for the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.19.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for the return value, not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.19.6"></a><h4>Returns</h4>
<p> the default bottom margin</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-default-left-margin"></a><h3>gtk_paper_size_get_default_left_margin ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_paper_size_get_default_left_margin
(<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Gets the default left margin for the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.20.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for the return value, not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.20.6"></a><h4>Returns</h4>
<p> the default left margin</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-default-right-margin"></a><h3>gtk_paper_size_get_default_right_margin ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
gtk_paper_size_get_default_right_margin
(<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a class="link" href="GtkPaperSize.html#GtkUnit" title="enum GtkUnit"><span class="type">GtkUnit</span></a> unit</code></em>);</pre>
<p>Gets the default right margin for the <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.21.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the unit for the return value, not <a class="link" href="GtkPaperSize.html#GTK-UNIT-NONE:CAPS"><code class="literal">GTK_UNIT_NONE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.21.6"></a><h4>Returns</h4>
<p> the default right margin</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-get-default"></a><h3>gtk_paper_size_get_default ()</h3>
<pre class="programlisting">const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_paper_size_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the name of the default paper size, which
depends on the current locale.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.22.5"></a><h4>Returns</h4>
<p> the name of the default paper size. The string
is owned by GTK+ and should not be modified.</p>
</div>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-new-from-key-file"></a><h3>gtk_paper_size_new_from_key_file ()</h3>
<pre class="programlisting"><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="returnvalue">GtkPaperSize</span></a> *
gtk_paper_size_new_from_key_file (<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> *key_file</code></em>,
<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group_name</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Reads a paper size from the group <em class="parameter"><code>group_name</code></em>
in the key file
<em class="parameter"><code>key_file</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.23.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>key_file</p></td>
<td class="parameter_description"><p>the <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> to retrieve the papersize from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group_name</p></td>
<td class="parameter_description"><p>the name ofthe group in the key file to read,
or <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to read the first group</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for an error, or <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.17.6.8.23.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> object with the restored
paper size, or <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred</p>
</div>
<p class="since">Since: 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-paper-size-to-key-file"></a><h3>gtk_paper_size_to_key_file ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_paper_size_to_key_file (<em class="parameter"><code><a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a> *size</code></em>,
<em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> *key_file</code></em>,
<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *group_name</code></em>);</pre>
<p>This function adds the paper size from <em class="parameter"><code>size</code></em>
to <em class="parameter"><code>key_file</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.17.6.8.24.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPaperSize.html" title="GtkPaperSize"><span class="type">GtkPaperSize</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_file</p></td>
<td class="parameter_description"><p>the <a href="/home/vagrant/ruby-gnome2.win64/glib2/vendor/local/share/gtk-doc/html/glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> to save the paper size to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group_name</p></td>
<td class="parameter_description"><p>the group to add the settings to in <em class="parameter"><code>key_file</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.12</p>
</div>
</div>
<div class="refsect1">
<a name="GtkPaperSize.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkPaperSize-struct"></a><h3>GtkPaperSize</h3>
<pre class="programlisting">typedef struct _GtkPaperSize GtkPaperSize;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkUnit"></a><h3>enum GtkUnit</h3>
<p>See also <a class="link" href="GtkPrintSettings.html#gtk-print-settings-set-paper-width" title="gtk_print_settings_set_paper_width ()"><code class="function">gtk_print_settings_set_paper_width()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.17.6.9.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-UNIT-NONE:CAPS"></a>GTK_UNIT_NONE</p></td>
<td class="enum_member_description">
<p>No units.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-UNIT-POINTS:CAPS"></a>GTK_UNIT_POINTS</p></td>
<td class="enum_member_description">
<p>Dimensions in points.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-UNIT-INCH:CAPS"></a>GTK_UNIT_INCH</p></td>
<td class="enum_member_description">
<p>Dimensions in inches.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-UNIT-MM:CAPS"></a>GTK_UNIT_MM</p></td>
<td class="enum_member_description">
<p>Dimensions in millimeters</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GTK-UNIT-PIXEL:CAPS"></a><h3>GTK_UNIT_PIXEL</h3>
<pre class="programlisting">#define GTK_UNIT_PIXEL GTK_UNIT_NONE
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-A3:CAPS"></a><h3>GTK_PAPER_NAME_A3</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_A3 "iso_a3"
</pre>
<p>Name for the A3 paper size.</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-A4:CAPS"></a><h3>GTK_PAPER_NAME_A4</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_A4 "iso_a4"
</pre>
<p>Name for the A4 paper size.</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-A5:CAPS"></a><h3>GTK_PAPER_NAME_A5</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_A5 "iso_a5"
</pre>
<p>Name for the A5 paper size.</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-B5:CAPS"></a><h3>GTK_PAPER_NAME_B5</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_B5 "iso_b5"
</pre>
<p>Name for the B5 paper size.</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-LETTER:CAPS"></a><h3>GTK_PAPER_NAME_LETTER</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_LETTER "na_letter"
</pre>
<p>Name for the Letter paper size.</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-EXECUTIVE:CAPS"></a><h3>GTK_PAPER_NAME_EXECUTIVE</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_EXECUTIVE "na_executive"
</pre>
<p>Name for the Executive paper size.</p>
</div>
<hr>
<div class="refsect2">
<a name="GTK-PAPER-NAME-LEGAL:CAPS"></a><h3>GTK_PAPER_NAME_LEGAL</h3>
<pre class="programlisting">#define GTK_PAPER_NAME_LEGAL "na_legal"
</pre>
<p>Name for the Legal paper size.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkPaperSize.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkPageSetup.html" title="GtkPageSetup"><span class="type">GtkPageSetup</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>