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