1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.PaperSize</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkpaned.html" title="gtk.Paned"><link rel="next" href="class-gtkplug.html" title="gtk.Plug"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.PaperSize</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkpaned.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkplug.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkpapersize"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.PaperSize</h2><p>gtk.PaperSize — an object providing support for named paper sizes (new in
2
PyGTK 2.10)</p></div><div class="refsect1" lang="en"><a name="id3588751"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.PaperSize</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
2
PyGTK 2.10)</p></div><div class="refsect1" lang="en"><a name="id3789557"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.PaperSize</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
3
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkpapersize.html#constructor-gtkpapersize" title="gtk.PaperSize">gtk.PaperSize</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--copy" title="gtk.PaperSize.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--is-equal" title="gtk.PaperSize.is_equal">is_equal</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size2</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-name" title="gtk.PaperSize.get_name">get_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-display-name" title="gtk.PaperSize.get_display_name">get_display_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-ppd-name" title="gtk.PaperSize.get_ppd_name">get_ppd_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-width" title="gtk.PaperSize.get_width">get_width</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-height" title="gtk.PaperSize.get_height">get_height</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--is-custom" title="gtk.PaperSize.is_custom">is_custom</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--set-size" title="gtk.PaperSize.set_size">set_size</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-default-top-margin" title="gtk.PaperSize.get_default_top_margin">get_default_top_margin</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-default-bottom-margin" title="gtk.PaperSize.get_default_bottom_margin">get_default_bottom_margin</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-default-left-margin" title="gtk.PaperSize.get_default_left_margin">get_default_left_margin</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#method-gtkpapersize--get-default-right-margin" title="gtk.PaperSize.get_default_right_margin">get_default_right_margin</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#function-gtk--paper-size-new-from-ppd" title="gtk.paper_size_new_from_ppd">gtk.paper_size_new_from_ppd</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ppd_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>ppd_display_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#function-gtk--paper-size-new-custom" title="gtk.paper_size_new_custom">gtk.paper_size_new_cutom</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>display_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#function-gtk--paper-size-get-default" title="gtk.paper_size_get_default">gtk.paper_size_get_default</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3589345"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This class is available in PyGTK 2.10 and above.</p></div><p>A <a class="link" href="class-gtkpapersize.html" title="gtk.PaperSize"><code class="classname">gtk.PaperSize</code></a>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#function-gtk--paper-size-new-from-ppd" title="gtk.paper_size_new_from_ppd">gtk.paper_size_new_from_ppd</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ppd_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>ppd_display_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#function-gtk--paper-size-new-custom" title="gtk.paper_size_new_custom">gtk.paper_size_new_cutom</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>display_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>unit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkpapersize.html#function-gtk--paper-size-get-default" title="gtk.paper_size_get_default">gtk.paper_size_get_default</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3790150"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This class is available in PyGTK 2.10 and above.</p></div><p>A <a class="link" href="class-gtkpapersize.html" title="gtk.PaperSize"><code class="classname">gtk.PaperSize</code></a>
7
7
handles paper sizes. It uses the standard called "PWG 5101.1-2002 PWG:
8
8
Standard for Media Standardized Names" to name the paper sizes (and to
9
9
get the data for the page sizes). The common standard paper sizes are