git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-paper.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>The lglPaper Structure</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="LibGlabels 3.0 Reference Manual">
   8 <link rel="up" href="ch01.html" title="Basic LibGlabels Usage">
   9 <link rel="prev" href="libglabels-3.0-template.html" title="The lglTemplate Structure">
  10 <link rel="next" href="libglabels-3.0-category.html" title="The lglCategory Structure">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libglabels-3.0-template.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">LibGlabels 3.0 Reference Manual</th>
  21 <td><a accesskey="n" href="libglabels-3.0-category.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libglabels-3.0-paper.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-paper.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-paper"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libglabels-3.0-paper.top_of_page"></a>The lglPaper Structure</span></h2>
  34 <p>The lglPaper Structure — Paper size definitions</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglabels-3.0-paper.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-paper.h&gt;
  42
  43 struct              <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper">lglPaper</a>;
  44 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *          <a class="link" href="libglabels-3.0-paper.html#lgl-paper-new" title="lgl_paper_new ()">lgl_paper_new</a>                       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
  45                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
  46                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
  47                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
  48                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pwg_size</code></em>);
  49 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *          <a class="link" href="libglabels-3.0-paper.html#lgl-paper-dup" title="lgl_paper_dup ()">lgl_paper_dup</a>                       (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> *orig</code></em>);
  50 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-paper.html#lgl-paper-free" title="lgl_paper_free ()">lgl_paper_free</a>                      (<em class="parameter"><code><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> *paper</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="libglabels-3.0-paper.description"></a><h2>Description</h2>
  55 <p>
  56 This section describes a structure for representing a paper size definition
  57 and related functions.
  58 </p>
  59 </div>
  60 <div class="refsect1">
  61 <a name="libglabels-3.0-paper.details"></a><h2>Details</h2>
  62 <div class="refsect2">
  63 <a name="lglPaper"></a><h3>struct lglPaper</h3>
  64 <pre class="programlisting">struct lglPaper {
  65         gchar               *id;       /* Unique ID of paper definition */
  66         gchar               *name;     /* Localized name of paper */
  67         gdouble              width;    /* Width (in points) */
  68         gdouble              height;   /* Height (in points) */
  69         gchar               *pwg_size; /* PWG 5101.1-2002 size name */
  70 };
  71 </pre>
  72 <p>
  73 This structure defines a paper (page) size.
  74 </p>
  75 <div class="variablelist"><table border="0">
  76 <col align="left" valign="top">
  77 <tbody>
  78 <tr>
  79 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglPaper.id"></a>id</code></em>;</span></p></td>
  80 <td>Paper size ID.</td>
  81 </tr>
  82 <tr>
  83 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglPaper.name"></a>name</code></em>;</span></p></td>
  84 <td>Localized paper size name.</td>
  85 </tr>
  86 <tr>
  87 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> <em class="structfield"><code><a name="lglPaper.width"></a>width</code></em>;</span></p></td>
  88 <td>Width of paper in points.</td>
  89 </tr>
  90 <tr>
  91 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> <em class="structfield"><code><a name="lglPaper.height"></a>height</code></em>;</span></p></td>
  92 <td>Height of paper in points.</td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglPaper.pwg-size"></a>pwg_size</code></em>;</span></p></td>
  96 <td>Paper size string as defined in PWG 5101.1-2002.</td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="lgl-paper-new"></a><h3>lgl_paper_new ()</h3>
 104 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *          lgl_paper_new                       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
 105                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 106                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
 107                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
 108                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pwg_size</code></em>);</pre>
 109 <p>
 110 Allocates and constructs a new <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.
 111 </p>
 112 <div class="variablelist"><table border="0">
 113 <col align="left" valign="top">
 114 <tbody>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 117 <td>Id of paper definition. (E.g. US-Letter, A4, etc.)  Should be
 118 unique.</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 122 <td>Localized name of paper.</td>
 123 </tr>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 126 <td>Width of paper in points.</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 130 <td>Height of paper in points.</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>pwg_size</code></em> :</span></p></td>
 134 <td>PWG 5101.1-2002 size name.</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 138 <td>a pointer to a newly allocated <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.</td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="lgl-paper-dup"></a><h3>lgl_paper_dup ()</h3>
 146 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *          lgl_paper_dup                       (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> *orig</code></em>);</pre>
 147 <p>
 148 Duplicates an existing <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.
 149 </p>
 150 <div class="variablelist"><table border="0">
 151 <col align="left" valign="top">
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>orig</code></em> :</span></p></td>
 155 <td>
 156 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure to be duplicated.</td>
 157 </tr>
 158 <tr>
 159 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 160 <td>a pointer to a newly allocated <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.</td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 <hr>
 166 <div class="refsect2">
 167 <a name="lgl-paper-free"></a><h3>lgl_paper_free ()</h3>
 168 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_paper_free                      (<em class="parameter"><code><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> *paper</code></em>);</pre>
 169 <p>
 170 Free all memory associated with an existing <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.
 171 </p>
 172 <div class="variablelist"><table border="0">
 173 <col align="left" valign="top">
 174 <tbody><tr>
 175 <td><p><span class="term"><em class="parameter"><code>paper</code></em> :</span></p></td>
 176 <td>pointer to <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure to be freed.</td>
 177 </tr></tbody>
 178 </table></div>
 179 </div>
 180 </div>
 181 </div>
 182 <div class="footer">
 183 <hr>
 184           Generated by GTK-Doc V1.17</div>
 185 </body>
 186 </html>