diff options
Diffstat (limited to 'doc/gutenprint/html/group__papersize.html')
| -rw-r--r-- | doc/gutenprint/html/group__papersize.html | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/doc/gutenprint/html/group__papersize.html b/doc/gutenprint/html/group__papersize.html new file mode 100644 index 0000000..f8c424f --- /dev/null +++ b/doc/gutenprint/html/group__papersize.html @@ -0,0 +1,277 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>libgutenprint API Reference: papersize</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.3-20050530 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> +<h1>papersize</h1>The papersize describes the dimensions of a paper. +<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap 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"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga5">stp_papersize_unit_t</a> { <a class="el" href="group__papersize.html#gga5a0">PAPERSIZE_ENGLISH_STANDARD</a>, +<a class="el" href="group__papersize.html#gga5a1">PAPERSIZE_METRIC_STANDARD</a>, +<a class="el" href="group__papersize.html#gga5a2">PAPERSIZE_ENGLISH_EXTENDED</a>, +<a class="el" href="group__papersize.html#gga5a3">PAPERSIZE_METRIC_EXTENDED</a> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Units of measurement. <a href="group__papersize.html#ga5">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga0">stp_known_papersizes</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of available papersizes. <a href="#ga0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap 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#ga1">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="#ga1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap 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#ga2">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="#ga2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap 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#ga3">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="#ga3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__papersize.html#ga4">stp_default_media_size</a> (const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> *v, int *width, int *height)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The papersize describes the dimensions of a paper. +<p> +<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="ga5"></a><!-- doxytag: member="paper.h::stp_papersize_unit_t" ref="ga5" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">enum <a class="el" href="group__papersize.html#ga5">stp_papersize_unit_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Units of measurement. +<p> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="gga5a0"></a><!-- doxytag: member="PAPERSIZE_ENGLISH_STANDARD" ref="gga5a0" args="" -->PAPERSIZE_ENGLISH_STANDARD</em> </td><td> +English/Imperial units. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga5a1"></a><!-- doxytag: member="PAPERSIZE_METRIC_STANDARD" ref="gga5a1" args="" -->PAPERSIZE_METRIC_STANDARD</em> </td><td> +Metric units. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga5a2"></a><!-- doxytag: member="PAPERSIZE_ENGLISH_EXTENDED" ref="gga5a2" args="" -->PAPERSIZE_ENGLISH_EXTENDED</em> </td><td> +English/Imperial units (optional paper, not displayed by default). </td></tr> +<tr><td valign="top"><em><a class="anchor" name="gga5a3"></a><!-- doxytag: member="PAPERSIZE_METRIC_EXTENDED" ref="gga5a3" args="" -->PAPERSIZE_METRIC_EXTENDED</em> </td><td> +Metric units (optional paper, not displayed by default). </td></tr> +</table> +</dl> + </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="ga4"></a><!-- doxytag: member="paper.h::stp_default_media_size" ref="ga4" args="(const stp_vars_t *v, int *width, int *height)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void stp_default_media_size </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="group__vars.html#ga0">stp_vars_t</a> * </td> + <td class="mdname" nowrap> <em>v</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>width</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int * </td> + <td class="mdname" nowrap> <em>height</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a class="anchor" name="ga3"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_index" ref="ga3" args="(int idx)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_index </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>idx</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a papersize by its index number. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>idx</em> </td><td>the index number. This must not be greater than (total number of papers - 1). </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the papersize, or NULL on failure. The pointer should not be freed.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga1"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_name" ref="ga1" args="(const char *name)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_name </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname1" valign="top" nowrap> <em>name</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a papersize by name. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the short unique name of the paper. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the papersize, or NULL on failure. The pointer should not be freed.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga2"></a><!-- doxytag: member="paper.h::stp_get_papersize_by_size" ref="ga2" args="(int length, int width)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">const <a class="el" href="structstp__papersize__t.html">stp_papersize_t</a>* stp_get_papersize_by_size </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname" nowrap> <em>length</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>width</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get a papersize by size. +<p> +The nearest available size to the size requested will be found. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the paper. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>the width of the paper </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a pointer to the papersize, or NULL on failure. The pointer should not be freed.</dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="ga0"></a><!-- doxytag: member="paper.h::stp_known_papersizes" ref="ga0" args="(void)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">int stp_known_papersizes </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Get the number of available papersizes. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>the number of papersizes.</dd></dl> + </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Jul 2 09:45:10 2005 for libgutenprint API Reference by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.3-20050530 </small></address> +</body> +</html> |