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: LibGlabels 3.0 Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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.24 (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="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#libglabels-3.0-paper.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="libglabels-3.0-template.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="libglabels-3.0-category.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="libglabels-3.0-paper"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="libglabels-3.0-paper.top_of_page"></a>The lglPaper Structure</span></h2>
  30 <p>The lglPaper Structure — Paper size definitions</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="libglabels-3.0-paper.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table width="100%" border="0">
  37 <colgroup>
  38 <col width="150px" class="functions_return">
  39 <col class="functions_name">
  40 </colgroup>
  41 <tbody>
  42 <tr>
  43 <td class="function_type">
  44 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="libglabels-3.0-paper.html#lgl-paper-new" title="lgl_paper_new ()">lgl_paper_new</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="libglabels-3.0-paper.html#lgl-paper-dup" title="lgl_paper_dup ()">lgl_paper_dup</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <span class="returnvalue">void</span>
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="libglabels-3.0-paper.html#lgl-paper-free" title="lgl_paper_free ()">lgl_paper_free</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 </tbody>
  67 </table></div>
  68 </div>
  69 <div class="refsect1">
  70 <a name="libglabels-3.0-paper.other"></a><h2>Types and Values</h2>
  71 <div class="informaltable"><table width="100%" border="0">
  72 <colgroup>
  73 <col width="150px" class="name">
  74 <col class="description">
  75 </colgroup>
  76 <tbody><tr>
  77 <td class="datatype_keyword">struct</td>
  78 <td class="function_name"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper">lglPaper</a></td>
  79 </tr></tbody>
  80 </table></div>
  81 </div>
  82 <div class="refsect1">
  83 <a name="libglabels-3.0-paper.includes"></a><h2>Includes</h2>
  84 <pre class="synopsis">#include &lt;libglabels/lgl-paper.h&gt;
  85 </pre>
  86 </div>
  87 <div class="refsect1">
  88 <a name="libglabels-3.0-paper.description"></a><h2>Description</h2>
  89 <p>
  90 This section describes a structure for representing a paper size definition
  91 and related functions.
  92 </p>
  93 </div>
  94 <div class="refsect1">
  95 <a name="libglabels-3.0-paper.functions_details"></a><h2>Functions</h2>
  96 <div class="refsect2">
  97 <a name="lgl-paper-new"></a><h3>lgl_paper_new ()</h3>
  98 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
  99 lgl_paper_new (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
 100                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 101                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
 102                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
 103                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pwg_size</code></em>);</pre>
 104 <p>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.</p>
 105 <div class="refsect3">
 106 <a name="id-1.2.4.7.2.5"></a><h4>Parameters</h4>
 107 <div class="informaltable"><table width="100%" border="0">
 108 <colgroup>
 109 <col width="150px" class="parameters_name">
 110 <col class="parameters_description">
 111 <col width="200px" class="parameters_annotations">
 112 </colgroup>
 113 <tbody>
 114 <tr>
 115 <td class="parameter_name"><p>id</p></td>
 116 <td class="parameter_description"><p>Id of paper definition. (E.g. US-Letter, A4, etc.)  Should be
 117 unique.</p></td>
 118 <td class="parameter_annotations"> </td>
 119 </tr>
 120 <tr>
 121 <td class="parameter_name"><p>name</p></td>
 122 <td class="parameter_description"><p>Localized name of paper.</p></td>
 123 <td class="parameter_annotations"> </td>
 124 </tr>
 125 <tr>
 126 <td class="parameter_name"><p>width</p></td>
 127 <td class="parameter_description"><p>Width of paper in points.</p></td>
 128 <td class="parameter_annotations"> </td>
 129 </tr>
 130 <tr>
 131 <td class="parameter_name"><p>height</p></td>
 132 <td class="parameter_description"><p>Height of paper in points.</p></td>
 133 <td class="parameter_annotations"> </td>
 134 </tr>
 135 <tr>
 136 <td class="parameter_name"><p>pwg_size</p></td>
 137 <td class="parameter_description"><p>PWG 5101.1-2002 size name.</p></td>
 138 <td class="parameter_annotations"> </td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <div class="refsect3">
 144 <a name="id-1.2.4.7.2.6"></a><h4>Returns</h4>
 145 <p> 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.</p>
 146 </div>
 147 </div>
 148 <hr>
 149 <div class="refsect2">
 150 <a name="lgl-paper-dup"></a><h3>lgl_paper_dup ()</h3>
 151 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
 152 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>
 153 <p>Duplicates an existing <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.</p>
 154 <div class="refsect3">
 155 <a name="id-1.2.4.7.3.5"></a><h4>Parameters</h4>
 156 <div class="informaltable"><table width="100%" border="0">
 157 <colgroup>
 158 <col width="150px" class="parameters_name">
 159 <col class="parameters_description">
 160 <col width="200px" class="parameters_annotations">
 161 </colgroup>
 162 <tbody><tr>
 163 <td class="parameter_name"><p>orig</p></td>
 164 <td class="parameter_description"><p><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure to be duplicated.</p></td>
 165 <td class="parameter_annotations"> </td>
 166 </tr></tbody>
 167 </table></div>
 168 </div>
 169 <div class="refsect3">
 170 <a name="id-1.2.4.7.3.6"></a><h4>Returns</h4>
 171 <p> 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.</p>
 172 </div>
 173 </div>
 174 <hr>
 175 <div class="refsect2">
 176 <a name="lgl-paper-free"></a><h3>lgl_paper_free ()</h3>
 177 <pre class="programlisting"><span class="returnvalue">void</span>
 178 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>
 179 <p>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.</p>
 180 <div class="refsect3">
 181 <a name="id-1.2.4.7.4.5"></a><h4>Parameters</h4>
 182 <div class="informaltable"><table width="100%" border="0">
 183 <colgroup>
 184 <col width="150px" class="parameters_name">
 185 <col class="parameters_description">
 186 <col width="200px" class="parameters_annotations">
 187 </colgroup>
 188 <tbody><tr>
 189 <td class="parameter_name"><p>paper</p></td>
 190 <td class="parameter_description"><p>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.</p></td>
 191 <td class="parameter_annotations"> </td>
 192 </tr></tbody>
 193 </table></div>
 194 </div>
 195 </div>
 196 </div>
 197 <div class="refsect1">
 198 <a name="libglabels-3.0-paper.other_details"></a><h2>Types and Values</h2>
 199 <div class="refsect2">
 200 <a name="lglPaper"></a><h3>struct lglPaper</h3>
 201 <pre class="programlisting">struct lglPaper {
 202         gchar               *id;       /* Unique ID of paper definition */
 203         gchar               *name;     /* Localized name of paper */
 204         gdouble              width;    /* Width (in points) */
 205         gdouble              height;   /* Height (in points) */
 206         gchar               *pwg_size; /* PWG 5101.1-2002 size name */
 207 };
 208 </pre>
 209 <p>
 210 This structure defines a paper (page) size.
 211 </p>
 212 <div class="refsect3">
 213 <a name="id-1.2.4.8.2.5"></a><h4>Members</h4>
 214 <div class="informaltable"><table width="100%" border="0">
 215 <colgroup>
 216 <col width="300px" class="struct_members_name">
 217 <col class="struct_members_description">
 218 <col width="200px" class="struct_members_annotations">
 219 </colgroup>
 220 <tbody>
 221 <tr>
 222 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 223 <td class="struct_member_description"><p>Paper size ID.</p></td>
 224 <td class="struct_member_annotations"> </td>
 225 </tr>
 226 <tr>
 227 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 228 <td class="struct_member_description"><p>Localized paper size name.</p></td>
 229 <td class="struct_member_annotations"> </td>
 230 </tr>
 231 <tr>
 232 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 233 <td class="struct_member_description"><p>Width of paper in points.</p></td>
 234 <td class="struct_member_annotations"> </td>
 235 </tr>
 236 <tr>
 237 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 238 <td class="struct_member_description"><p>Height of paper in points.</p></td>
 239 <td class="struct_member_annotations"> </td>
 240 </tr>
 241 <tr>
 242 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 243 <td class="struct_member_description"><p>Paper size string as defined in PWG 5101.1-2002.</p></td>
 244 <td class="struct_member_annotations"> </td>
 245 </tr>
 246 </tbody>
 247 </table></div>
 248 </div>
 249 </div>
 250 </div>
 251 </div>
 252 <div class="footer">
 253 <hr>Generated by GTK-Doc V1.24</div>
 254 </body>
 255 </html>