<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libgutenprint API Reference: papersize</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libgutenprint API Reference <span id="projectnumber">5.2.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">papersize</div> </div>
</div>
<div class="contents">
<p>The papersize describes the dimensions of a paper.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__papersize__t.html">stp_papersize_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The papersize data type. <a href="structstp__papersize__t.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga72e4619e373e38dc02dc452813b7b958">stp_papersize_unit_t</a> { <a class="el" href="group__papersize.html#gga72e4619e373e38dc02dc452813b7b958adb394159413ade42022509cd3280fef3">PAPERSIZE_ENGLISH_STANDARD</a>,
<a class="el" href="group__papersize.html#gga72e4619e373e38dc02dc452813b7b958a6d5868bc6707f8801ce4d584428c2ae8">PAPERSIZE_METRIC_STANDARD</a>,
<a class="el" href="group__papersize.html#gga72e4619e373e38dc02dc452813b7b958a00b7e9a18afc172872861b26dbcc8cb8">PAPERSIZE_ENGLISH_EXTENDED</a>,
<a class="el" href="group__papersize.html#gga72e4619e373e38dc02dc452813b7b958a62e2906a87fa4bcf32913943fd5b225a">PAPERSIZE_METRIC_EXTENDED</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Units of measurement. <a href="group__papersize.html#ga72e4619e373e38dc02dc452813b7b958">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga31255c4eebfaaf5cd319e5638a6a3069">stp_papersize_type_t</a> { <a class="el" href="group__papersize.html#gga31255c4eebfaaf5cd319e5638a6a3069a99d27f84f91d583c3e465e56c83fff2f">PAPERSIZE_TYPE_STANDARD</a> = 0,
<a class="el" href="group__papersize.html#gga31255c4eebfaaf5cd319e5638a6a3069a660290248a563e7590202afd3ba68fb4">PAPERSIZE_TYPE_ENVELOPE</a>
}</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga84fd0bad33b134217f54fa8c1e6c8b99">stp_known_papersizes</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available papersizes. <a href="#ga84fd0bad33b134217f54fa8c1e6c8b99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga60f3dee8f26cac05d8d6fcaff1e39630">stp_get_papersize_by_name</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by name. <a href="#ga60f3dee8f26cac05d8d6fcaff1e39630"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga1484a5e75a2b2921bbe0c9e17deb0b77">stp_get_papersize_by_size</a> (int length, int width)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by size. <a href="#ga1484a5e75a2b2921bbe0c9e17deb0b77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga879cd515ca2eb5fd8cd76ae62f4bfa4e">stp_get_papersize_by_size_exact</a> (int length, int width)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by size if an exact match is found. <a href="#ga879cd515ca2eb5fd8cd76ae62f4bfa4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#gab2e9f694a3b90aeaaa14d6af3b5fe75a">stp_get_papersize_by_index</a> (int idx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by its index number. <a href="#gab2e9f694a3b90aeaaa14d6af3b5fe75a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga33c0be56646361b1ce85a9d338336dd3">stp_default_media_size</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, int *width, int *height)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default paper dimensions for the current configuration. <a href="#ga33c0be56646361b1ce85a9d338336dd3"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>The papersize describes the dimensions of a paper. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga31255c4eebfaaf5cd319e5638a6a3069"></a><!-- doxytag: member="paper.h::stp_papersize_type_t" ref="ga31255c4eebfaaf5cd319e5638a6a3069" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__papersize.html#ga31255c4eebfaaf5cd319e5638a6a3069">stp_papersize_type_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga31255c4eebfaaf5cd319e5638a6a3069a99d27f84f91d583c3e465e56c83fff2f"></a><!-- doxytag: member="PAPERSIZE_TYPE_STANDARD" ref="gga31255c4eebfaaf5cd319e5638a6a3069a99d27f84f91d583c3e465e56c83fff2f" args="" -->PAPERSIZE_TYPE_STANDARD</em> </td><td>
<p>Standard paper size. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga31255c4eebfaaf5cd319e5638a6a3069a660290248a563e7590202afd3ba68fb4"></a><!-- doxytag: member="PAPERSIZE_TYPE_ENVELOPE" ref="gga31255c4eebfaaf5cd319e5638a6a3069a660290248a563e7590202afd3ba68fb4" args="" -->PAPERSIZE_TYPE_ENVELOPE</em> </td><td>
<p>Envelope. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga72e4619e373e38dc02dc452813b7b958"></a><!-- doxytag: member="paper.h::stp_papersize_unit_t" ref="ga72e4619e373e38dc02dc452813b7b958" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__papersize.html#ga72e4619e373e38dc02dc452813b7b958">stp_papersize_unit_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Units of measurement. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga72e4619e373e38dc02dc452813b7b958adb394159413ade42022509cd3280fef3"></a><!-- doxytag: member="PAPERSIZE_ENGLISH_STANDARD" ref="gga72e4619e373e38dc02dc452813b7b958adb394159413ade42022509cd3280fef3" args="" -->PAPERSIZE_ENGLISH_STANDARD</em> </td><td>
<p>English/Imperial units. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga72e4619e373e38dc02dc452813b7b958a6d5868bc6707f8801ce4d584428c2ae8"></a><!-- doxytag: member="PAPERSIZE_METRIC_STANDARD" ref="gga72e4619e373e38dc02dc452813b7b958a6d5868bc6707f8801ce4d584428c2ae8" args="" -->PAPERSIZE_METRIC_STANDARD</em> </td><td>
<p>Metric units. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga72e4619e373e38dc02dc452813b7b958a00b7e9a18afc172872861b26dbcc8cb8"></a><!-- doxytag: member="PAPERSIZE_ENGLISH_EXTENDED" ref="gga72e4619e373e38dc02dc452813b7b958a00b7e9a18afc172872861b26dbcc8cb8" args="" -->PAPERSIZE_ENGLISH_EXTENDED</em> </td><td>
<p>English/Imperial units (optional paper, not displayed by default). </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga72e4619e373e38dc02dc452813b7b958a62e2906a87fa4bcf32913943fd5b225a"></a><!-- doxytag: member="PAPERSIZE_METRIC_EXTENDED" ref="gga72e4619e373e38dc02dc452813b7b958a62e2906a87fa4bcf32913943fd5b225a" args="" -->PAPERSIZE_METRIC_EXTENDED</em> </td><td>
<p>Metric units (optional paper, not displayed by default). </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga33c0be56646361b1ce85a9d338336dd3"></a><!-- doxytag: member="paper.h::stp_default_media_size" ref="ga33c0be56646361b1ce85a9d338336dd3" args="(const stp_vars_t *v, int *width, int *height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void stp_default_media_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> * </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>height</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the default paper dimensions for the current configuration. </p>
<p>The default is derived from the PageSize parameter if set, otherwise the default page size for the printer is used. If no value can be determined, 1x1 will be returned. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the Gutenprint vars object </td></tr>
<tr><td class="paramname">width</td><td>pointer to storage that the width will be returned in. </td></tr>
<tr><td class="paramname">height</td><td>pointer to storage that the height will be returned in. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab2e9f694a3b90aeaaa14d6af3b5fe75a"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_index" ref="gab2e9f694a3b90aeaaa14d6af3b5fe75a" args="(int idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_index </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a papersize by its index number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>the index number. This must not be greater than (total number of papers - 1). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga60f3dee8f26cac05d8d6fcaff1e39630"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_name" ref="ga60f3dee8f26cac05d8d6fcaff1e39630" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_name </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a papersize by name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the short unique name of the paper. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga1484a5e75a2b2921bbe0c9e17deb0b77"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_size" ref="ga1484a5e75a2b2921bbe0c9e17deb0b77" args="(int length, int width)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_size </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a papersize by size. </p>
<p>The nearest available size to the size requested will be found. Only paper sizes within 5 points of width and height will be considered. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>the length of the paper. </td></tr>
<tr><td class="paramname">width</td><td>the width of the paper </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga879cd515ca2eb5fd8cd76ae62f4bfa4e"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_size_exact" ref="ga879cd515ca2eb5fd8cd76ae62f4bfa4e" args="(int length, int width)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_size_exact </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a papersize by size if an exact match is found. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>the length of the paper. </td></tr>
<tr><td class="paramname">width</td><td>the width of the paper </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ga84fd0bad33b134217f54fa8c1e6c8b99"></a><!-- doxytag: member="paper.h::stp_known_papersizes" ref="ga84fd0bad33b134217f54fa8c1e6c8b99" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stp_known_papersizes </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of available papersizes. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of papersizes. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
