summaryrefslogtreecommitdiff
path: root/doc/gutenprint/html/paper_8h.html
blob: 93339578734d076a4ed51802e994b6924dafbe3e (plain)
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
<!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.6"/>
<title>libgutenprint API Reference: include/gutenprint/paper.h File Reference</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 style="padding-left: 0.5em;">
   <div id="projectname">libgutenprint API Reference
   &#160;<span id="projectnumber">5.2.10-pre2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1aca62f7c2d1ca2bd7aa79274e259f3c.html">gutenprint</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">paper.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Paper size functions.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="vars_8h.html">gutenprint/vars.h</a>&gt;</code><br/>
</div><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 &#160;</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">&#160;</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">&#160;</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 &#160;</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 class="memdesc:ga72e4619e373e38dc02dc452813b7b958"><td class="mdescLeft">&#160;</td><td class="mdescRight">Units of measurement.  <a href="group__papersize.html#ga72e4619e373e38dc02dc452813b7b958">More...</a><br/></td></tr>
<tr class="separator:ga72e4619e373e38dc02dc452813b7b958"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31255c4eebfaaf5cd319e5638a6a3069"><td class="memItemLeft" align="right" valign="top">enum &#160;</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 class="separator:ga31255c4eebfaaf5cd319e5638a6a3069"><td class="memSeparator" colspan="2">&#160;</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&#160;</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">&#160;</td><td class="mdescRight">Get the number of available papersizes.  <a href="group__papersize.html#ga84fd0bad33b134217f54fa8c1e6c8b99">More...</a><br/></td></tr>
<tr class="separator:ga84fd0bad33b134217f54fa8c1e6c8b99"><td class="memSeparator" colspan="2">&#160;</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> *&#160;</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">&#160;</td><td class="mdescRight">Get a papersize by name.  <a href="group__papersize.html#ga60f3dee8f26cac05d8d6fcaff1e39630">More...</a><br/></td></tr>
<tr class="separator:ga60f3dee8f26cac05d8d6fcaff1e39630"><td class="memSeparator" colspan="2">&#160;</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> *&#160;</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">&#160;</td><td class="mdescRight">Get a papersize by size.  <a href="group__papersize.html#ga1484a5e75a2b2921bbe0c9e17deb0b77">More...</a><br/></td></tr>
<tr class="separator:ga1484a5e75a2b2921bbe0c9e17deb0b77"><td class="memSeparator" colspan="2">&#160;</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> *&#160;</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">&#160;</td><td class="mdescRight">Get a papersize by size if an exact match is found.  <a href="group__papersize.html#ga879cd515ca2eb5fd8cd76ae62f4bfa4e">More...</a><br/></td></tr>
<tr class="separator:ga879cd515ca2eb5fd8cd76ae62f4bfa4e"><td class="memSeparator" colspan="2">&#160;</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> *&#160;</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">&#160;</td><td class="mdescRight">Get a papersize by its index number.  <a href="group__papersize.html#gab2e9f694a3b90aeaaa14d6af3b5fe75a">More...</a><br/></td></tr>
<tr class="separator:gab2e9f694a3b90aeaaa14d6af3b5fe75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33c0be56646361b1ce85a9d338336dd3"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Get the default paper dimensions for the current configuration.  <a href="group__papersize.html#ga33c0be56646361b1ce85a9d338336dd3">More...</a><br/></td></tr>
<tr class="separator:ga33c0be56646361b1ce85a9d338336dd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Paper size functions. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>