diff options
Diffstat (limited to 'doc/gutenprint/html/group__papersize.html')
| -rw-r--r-- | doc/gutenprint/html/group__papersize.html | 171 |
1 files changed, 22 insertions, 149 deletions
diff --git a/doc/gutenprint/html/group__papersize.html b/doc/gutenprint/html/group__papersize.html index b344257..3fea87b 100644 --- a/doc/gutenprint/html/group__papersize.html +++ b/doc/gutenprint/html/group__papersize.html @@ -3,7 +3,7 @@ <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="generator" content="Doxygen 1.8.14"/> <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"/> @@ -19,7 +19,7 @@ <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libgutenprint API Reference -  <span id="projectnumber">5.3.0-pre1</span> +  <span id="projectnumber">5.3.1</span> </div> </td> </tr> @@ -27,14 +27,15 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> @@ -62,32 +63,19 @@ Enumerations</h2></td></tr> <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> + }</td></tr> +<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> <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> +<a class="el" href="group__papersize.html#gga31255c4eebfaaf5cd319e5638a6a3069a660290248a563e7590202afd3ba68fb4">PAPERSIZE_TYPE_ENVELOPE</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:ga0b6ed5fa9f761c85d7992d33af5dcdce"><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#ga0b6ed5fa9f761c85d7992d33af5dcdce">stp_get_papersize_by_size</a> (<a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> length, <a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> width)</td></tr> -<tr class="memdesc:ga0b6ed5fa9f761c85d7992d33af5dcdce"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by size. <a href="#ga0b6ed5fa9f761c85d7992d33af5dcdce">More...</a><br /></td></tr> -<tr class="separator:ga0b6ed5fa9f761c85d7992d33af5dcdce"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaa80ec891bdc954c6ee3db8f703f83d71"><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#gaa80ec891bdc954c6ee3db8f703f83d71">stp_get_papersize_by_size_exact</a> (<a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> length, <a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> width)</td></tr> -<tr class="memdesc:gaa80ec891bdc954c6ee3db8f703f83d71"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by size if an exact match is found. <a href="#gaa80ec891bdc954c6ee3db8f703f83d71">More...</a><br /></td></tr> -<tr class="separator:gaa80ec891bdc954c6ee3db8f703f83d71"><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:gaa1030bc16945705116695eedf09ecd17"><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#gaa1030bc16945705116695eedf09ecd17">stp_describe_papersize</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, const char *name)</td></tr> +<tr class="memdesc:gaa1030bc16945705116695eedf09ecd17"><td class="mdescLeft"> </td><td class="mdescRight">Get a papersize by name. <a href="#gaa1030bc16945705116695eedf09ecd17">More...</a><br /></td></tr> +<tr class="separator:gaa1030bc16945705116695eedf09ecd17"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa6e3d956dcc13c8aa2e489164aacf442"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#gaa6e3d956dcc13c8aa2e489164aacf442">stp_default_media_size</a> (const <a class="el" href="group__vars.html#ga2d49c94847d18d8b62a214995b14680f">stp_vars_t</a> *v, <a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> *width, <a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> *height)</td></tr> <tr class="memdesc:gaa6e3d956dcc13c8aa2e489164aacf442"><td class="mdescLeft"> </td><td class="mdescRight">Get the default paper dimensions for the current configuration. <a href="#gaa6e3d956dcc13c8aa2e489164aacf442">More...</a><br /></td></tr> <tr class="separator:gaa6e3d956dcc13c8aa2e489164aacf442"><td class="memSeparator" colspan="2"> </td></tr> @@ -111,8 +99,6 @@ Functions</h2></td></tr> </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> @@ -188,115 +174,23 @@ Functions</h2></td></tr> </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> +<a id="gaa1030bc16945705116695eedf09ecd17"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa1030bc16945705116695eedf09ecd17">◆ </a></span>stp_describe_papersize()</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 class="memname">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_describe_papersize </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="ga0b6ed5fa9f761c85d7992d33af5dcdce"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga0b6ed5fa9f761c85d7992d33af5dcdce">◆ </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"><a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> </td> - <td class="paramname"><em>length</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> </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="gaa80ec891bdc954c6ee3db8f703f83d71"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaa80ec891bdc954c6ee3db8f703f83d71">◆ </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"><a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> </td> - <td class="paramname"><em>length</em>, </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"><a class="el" href="types_8h.html#a28331211ca816787023d0444a79585ac">stp_dimension_t</a> </td> - <td class="paramname"><em>width</em> </td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> </tr> <tr> <td></td> @@ -306,11 +200,11 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Get a papersize by size if an exact match is found. </p> +<p>Get a papersize by name. </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> + <tr><td class="paramname">v</td><td>the Gutenprint vars object </td></tr> + <tr><td class="paramname">name</td><td>the short unique name of the paper. </td></tr> </table> </dd> </dl> @@ -318,33 +212,12 @@ Functions</h2></td></tr> </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 +</a> 1.8.14 </small></address> </body> </html> |