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