/usr/share/doc/libgutenprint-doc/reference/html/group__papersize.html is in libgutenprint-doc 5.2.13-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libgutenprint API Reference: papersize</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libgutenprint API Reference
 <span id="projectnumber">5.2.13</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<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><!--header-->
<div class="contents">
<p>The papersize describes the dimensions of a paper.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The papersize data type. <a href="structstp__papersize__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga72e4619e373e38dc02dc452813b7b958"><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>
}<tr class="memdesc:ga72e4619e373e38dc02dc452813b7b958"><td class="mdescLeft"> </td><td class="mdescRight">Units of measurement. <a href="group__papersize.html#ga72e4619e373e38dc02dc452813b7b958">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga72e4619e373e38dc02dc452813b7b958"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga31255c4eebfaaf5cd319e5638a6a3069"><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>,
<a class="el" href="group__papersize.html#gga31255c4eebfaaf5cd319e5638a6a3069a7f5ebb4b034dda5137ff6296d9dc67ac">PAPERSIZE_TYPE_SPECIAL</a>
}</td></tr>
<tr class="separator:ga31255c4eebfaaf5cd319e5638a6a3069"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga84fd0bad33b134217f54fa8c1e6c8b99"><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 class="memdesc:ga84fd0bad33b134217f54fa8c1e6c8b99"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available papersizes. <a href="#ga84fd0bad33b134217f54fa8c1e6c8b99">More...</a><br /></td></tr>
<tr class="separator:ga84fd0bad33b134217f54fa8c1e6c8b99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60f3dee8f26cac05d8d6fcaff1e39630"><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 class="memdesc:ga60f3dee8f26cac05d8d6fcaff1e39630"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by name. <a href="#ga60f3dee8f26cac05d8d6fcaff1e39630">More...</a><br /></td></tr>
<tr class="separator:ga60f3dee8f26cac05d8d6fcaff1e39630"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1484a5e75a2b2921bbe0c9e17deb0b77"><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 class="memdesc:ga1484a5e75a2b2921bbe0c9e17deb0b77"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by size. <a href="#ga1484a5e75a2b2921bbe0c9e17deb0b77">More...</a><br /></td></tr>
<tr class="separator:ga1484a5e75a2b2921bbe0c9e17deb0b77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga879cd515ca2eb5fd8cd76ae62f4bfa4e"><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 class="memdesc:ga879cd515ca2eb5fd8cd76ae62f4bfa4e"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by size if an exact match is found. <a href="#ga879cd515ca2eb5fd8cd76ae62f4bfa4e">More...</a><br /></td></tr>
<tr class="separator:ga879cd515ca2eb5fd8cd76ae62f4bfa4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab2e9f694a3b90aeaaa14d6af3b5fe75a"><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 class="memdesc:gab2e9f694a3b90aeaaa14d6af3b5fe75a"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by its index number. <a href="#gab2e9f694a3b90aeaaa14d6af3b5fe75a">More...</a><br /></td></tr>
<tr class="separator:gab2e9f694a3b90aeaaa14d6af3b5fe75a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga33c0be56646361b1ce85a9d338336dd3"><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 class="memdesc:ga33c0be56646361b1ce85a9d338336dd3"><td class="mdescLeft"> </td><td class="mdescRight">Get the default paper dimensions for the current configuration. <a href="#ga33c0be56646361b1ce85a9d338336dd3">More...</a><br /></td></tr>
<tr class="separator:ga33c0be56646361b1ce85a9d338336dd3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The papersize describes the dimensions of a paper. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga31255c4eebfaaf5cd319e5638a6a3069"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31255c4eebfaaf5cd319e5638a6a3069">◆ </a></span>stp_papersize_type_t</h2>
<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">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga31255c4eebfaaf5cd319e5638a6a3069a99d27f84f91d583c3e465e56c83fff2f"></a>PAPERSIZE_TYPE_STANDARD </td><td class="fielddoc"><p>Standard paper size. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga31255c4eebfaaf5cd319e5638a6a3069a660290248a563e7590202afd3ba68fb4"></a>PAPERSIZE_TYPE_ENVELOPE </td><td class="fielddoc"><p>Envelope. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga31255c4eebfaaf5cd319e5638a6a3069a7f5ebb4b034dda5137ff6296d9dc67ac"></a>PAPERSIZE_TYPE_SPECIAL </td><td class="fielddoc"><p>Special (not normally displayed) </p>
</td></tr>
</table>
</div>
</div>
<a id="ga72e4619e373e38dc02dc452813b7b958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga72e4619e373e38dc02dc452813b7b958">◆ </a></span>stp_papersize_unit_t</h2>
<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>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga72e4619e373e38dc02dc452813b7b958adb394159413ade42022509cd3280fef3"></a>PAPERSIZE_ENGLISH_STANDARD </td><td class="fielddoc"><p>English/Imperial units. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga72e4619e373e38dc02dc452813b7b958a6d5868bc6707f8801ce4d584428c2ae8"></a>PAPERSIZE_METRIC_STANDARD </td><td class="fielddoc"><p>Metric units. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga72e4619e373e38dc02dc452813b7b958a00b7e9a18afc172872861b26dbcc8cb8"></a>PAPERSIZE_ENGLISH_EXTENDED </td><td class="fielddoc"><p>English/Imperial units (optional paper, not displayed by default). </p>
</td></tr>
<tr><td class="fieldname"><a id="gga72e4619e373e38dc02dc452813b7b958a62e2906a87fa4bcf32913943fd5b225a"></a>PAPERSIZE_METRIC_EXTENDED </td><td class="fielddoc"><p>Metric units (optional paper, not displayed by default). </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga33c0be56646361b1ce85a9d338336dd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga33c0be56646361b1ce85a9d338336dd3">◆ </a></span>stp_default_media_size()</h2>
<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 class="params"><dt>Parameters</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 id="gab2e9f694a3b90aeaaa14d6af3b5fe75a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab2e9f694a3b90aeaaa14d6af3b5fe75a">◆ </a></span>stp_get_papersize_by_index()</h2>
<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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a id="ga60f3dee8f26cac05d8d6fcaff1e39630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60f3dee8f26cac05d8d6fcaff1e39630">◆ </a></span>stp_get_papersize_by_name()</h2>
<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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a id="ga1484a5e75a2b2921bbe0c9e17deb0b77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1484a5e75a2b2921bbe0c9e17deb0b77">◆ </a></span>stp_get_papersize_by_size()</h2>
<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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a id="ga879cd515ca2eb5fd8cd76ae62f4bfa4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga879cd515ca2eb5fd8cd76ae62f4bfa4e">◆ </a></span>stp_get_papersize_by_size_exact()</h2>
<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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>a static pointer to the papersize, or NULL on failure. </dd></dl>
</div>
</div>
<a id="ga84fd0bad33b134217f54fa8c1e6c8b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga84fd0bad33b134217f54fa8c1e6c8b99">◆ </a></span>stp_known_papersizes()</h2>
<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="section return"><dt>Returns</dt><dd>the number of papersizes. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<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.8.13
</small></address>
</body>
</html>
|