git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-units.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>Units: 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="ch03.html" title="Miscellaneous">
   9 <link rel="prev" href="ch03.html" title="Miscellaneous">
  10 <link rel="next" href="libglabels-3.0-str.html" title="String Utility Functions">
  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-units.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="libglabels-3.0-str.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-units"></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-units.top_of_page"></a>Units</span></h2>
  30 <p>Units — Type to represent units of distance supported by libglabels</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-units.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">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  44 </td>
  45 <td class="function_name">
  46 <a class="link" href="libglabels-3.0-units.html#lgl-units-get-id" title="lgl_units_get_id ()">lgl_units_get_id</a> <span class="c_punctuation">()</span>
  47 </td>
  48 </tr>
  49 <tr>
  50 <td class="function_type">
  51 <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>
  52 </td>
  53 <td class="function_name">
  54 <a class="link" href="libglabels-3.0-units.html#lgl-units-from-id" title="lgl_units_from_id ()">lgl_units_from_id</a> <span class="c_punctuation">()</span>
  55 </td>
  56 </tr>
  57 <tr>
  58 <td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  59 </td>
  60 <td class="function_name">
  61 <a class="link" href="libglabels-3.0-units.html#lgl-units-get-name" title="lgl_units_get_name ()">lgl_units_get_name</a> <span class="c_punctuation">()</span>
  62 </td>
  63 </tr>
  64 <tr>
  65 <td class="function_type">
  66 <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>
  67 </td>
  68 <td class="function_name">
  69 <a class="link" href="libglabels-3.0-units.html#lgl-units-from-name" title="lgl_units_from_name ()">lgl_units_from_name</a> <span class="c_punctuation">()</span>
  70 </td>
  71 </tr>
  72 <tr>
  73 <td class="function_type">
  74 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
  75 </td>
  76 <td class="function_name">
  77 <a class="link" href="libglabels-3.0-units.html#lgl-units-get-points-per-unit" title="lgl_units_get_points_per_unit ()">lgl_units_get_points_per_unit</a> <span class="c_punctuation">()</span>
  78 </td>
  79 </tr>
  80 <tr>
  81 <td class="function_type">
  82 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
  83 </td>
  84 <td class="function_name">
  85 <a class="link" href="libglabels-3.0-units.html#lgl-units-get-units-per-point" title="lgl_units_get_units_per_point ()">lgl_units_get_units_per_point</a> <span class="c_punctuation">()</span>
  86 </td>
  87 </tr>
  88 </tbody>
  89 </table></div>
  90 </div>
  91 <div class="refsect1">
  92 <a name="libglabels-3.0-units.other"></a><h2>Types and Values</h2>
  93 <div class="informaltable"><table width="100%" border="0">
  94 <colgroup>
  95 <col width="150px" class="name">
  96 <col class="description">
  97 </colgroup>
  98 <tbody><tr>
  99 <td class="datatype_keyword">enum</td>
 100 <td class="function_name"><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits">lglUnits</a></td>
 101 </tr></tbody>
 102 </table></div>
 103 </div>
 104 <div class="refsect1">
 105 <a name="libglabels-3.0-units.includes"></a><h2>Includes</h2>
 106 <pre class="synopsis">#include &lt;libglabels/lgl-units.h&gt;
 107 </pre>
 108 </div>
 109 <div class="refsect1">
 110 <a name="libglabels-3.0-units.description"></a><h2>Description</h2>
 111 <p>
 112 This section defines a type to represent the various units of distance
 113 supported by libglabels.  It also defines a set of related functions.
 114 </p>
 115 </div>
 116 <div class="refsect1">
 117 <a name="libglabels-3.0-units.functions_details"></a><h2>Functions</h2>
 118 <div class="refsect2">
 119 <a name="lgl-units-get-id"></a><h3>lgl_units_get_id ()</h3>
 120 <pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 121 lgl_units_get_id (<em class="parameter"><code><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a> units</code></em>);</pre>
 122 <p>Return a unique ID string for the given units.  This ID is how units
 123 are encoded in libglabels XML files and will remain constant across
 124 all locales.  IDs are identical to the absolute length units supported
 125 in the CSS2 Specification (Section 4.3.2).</p>
 126 <div class="refsect3">
 127 <a name="id-1.4.2.7.2.5"></a><h4>Parameters</h4>
 128 <div class="informaltable"><table width="100%" border="0">
 129 <colgroup>
 130 <col width="150px" class="parameters_name">
 131 <col class="parameters_description">
 132 <col width="200px" class="parameters_annotations">
 133 </colgroup>
 134 <tbody><tr>
 135 <td class="parameter_name"><p>units</p></td>
 136 <td class="parameter_description"><p>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</p></td>
 137 <td class="parameter_annotations"> </td>
 138 </tr></tbody>
 139 </table></div>
 140 </div>
 141 <div class="refsect3">
 142 <a name="id-1.4.2.7.2.6"></a><h4>Returns</h4>
 143 <p> ID string.</p>
 144 </div>
 145 </div>
 146 <hr>
 147 <div class="refsect2">
 148 <a name="lgl-units-from-id"></a><h3>lgl_units_from_id ()</h3>
 149 <pre class="programlisting"><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>
 150 lgl_units_from_id (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
 151 <p>Return the unique <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a> for the given ID string.
 152 This ID is how units are encoded in libglabels XML files and will remain
 153 constant across all locales.  IDs are identical to the absolute length
 154 units supported in the CSS2 Specification (Section 4.3.2).</p>
 155 <div class="refsect3">
 156 <a name="id-1.4.2.7.3.5"></a><h4>Parameters</h4>
 157 <div class="informaltable"><table width="100%" border="0">
 158 <colgroup>
 159 <col width="150px" class="parameters_name">
 160 <col class="parameters_description">
 161 <col width="200px" class="parameters_annotations">
 162 </colgroup>
 163 <tbody><tr>
 164 <td class="parameter_name"><p>id</p></td>
 165 <td class="parameter_description"><p>ID string</p></td>
 166 <td class="parameter_annotations"> </td>
 167 </tr></tbody>
 168 </table></div>
 169 </div>
 170 <div class="refsect3">
 171 <a name="id-1.4.2.7.3.6"></a><h4>Returns</h4>
 172 <p> units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>).</p>
 173 </div>
 174 </div>
 175 <hr>
 176 <div class="refsect2">
 177 <a name="lgl-units-get-name"></a><h3>lgl_units_get_name ()</h3>
 178 <pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 179 lgl_units_get_name (<em class="parameter"><code><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a> units</code></em>);</pre>
 180 <p>Return a unique name string for the given units.  This name is human
 181 readable and will be translated to the current locale.</p>
 182 <div class="refsect3">
 183 <a name="id-1.4.2.7.4.5"></a><h4>Parameters</h4>
 184 <div class="informaltable"><table width="100%" border="0">
 185 <colgroup>
 186 <col width="150px" class="parameters_name">
 187 <col class="parameters_description">
 188 <col width="200px" class="parameters_annotations">
 189 </colgroup>
 190 <tbody><tr>
 191 <td class="parameter_name"><p>units</p></td>
 192 <td class="parameter_description"><p>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</p></td>
 193 <td class="parameter_annotations"> </td>
 194 </tr></tbody>
 195 </table></div>
 196 </div>
 197 <div class="refsect3">
 198 <a name="id-1.4.2.7.4.6"></a><h4>Returns</h4>
 199 <p> name string.</p>
 200 </div>
 201 </div>
 202 <hr>
 203 <div class="refsect2">
 204 <a name="lgl-units-from-name"></a><h3>lgl_units_from_name ()</h3>
 205 <pre class="programlisting"><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>
 206 lgl_units_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 207 <p>Return the unique <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a> for the given name string.  This name is
 208 human readable and is expected to be translated to the current locale.</p>
 209 <div class="refsect3">
 210 <a name="id-1.4.2.7.5.5"></a><h4>Parameters</h4>
 211 <div class="informaltable"><table width="100%" border="0">
 212 <colgroup>
 213 <col width="150px" class="parameters_name">
 214 <col class="parameters_description">
 215 <col width="200px" class="parameters_annotations">
 216 </colgroup>
 217 <tbody><tr>
 218 <td class="parameter_name"><p>name</p></td>
 219 <td class="parameter_description"><p>NAME string</p></td>
 220 <td class="parameter_annotations"> </td>
 221 </tr></tbody>
 222 </table></div>
 223 </div>
 224 <div class="refsect3">
 225 <a name="id-1.4.2.7.5.6"></a><h4>Returns</h4>
 226 <p> units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>).</p>
 227 </div>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="lgl-units-get-points-per-unit"></a><h3>lgl_units_get_points_per_unit ()</h3>
 232 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
 233 lgl_units_get_points_per_unit (<em class="parameter"><code><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a> units</code></em>);</pre>
 234 <p>Return a scale factor for the given units in points/unit.</p>
 235 <div class="refsect3">
 236 <a name="id-1.4.2.7.6.5"></a><h4>Parameters</h4>
 237 <div class="informaltable"><table width="100%" border="0">
 238 <colgroup>
 239 <col width="150px" class="parameters_name">
 240 <col class="parameters_description">
 241 <col width="200px" class="parameters_annotations">
 242 </colgroup>
 243 <tbody><tr>
 244 <td class="parameter_name"><p>units</p></td>
 245 <td class="parameter_description"><p>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</p></td>
 246 <td class="parameter_annotations"> </td>
 247 </tr></tbody>
 248 </table></div>
 249 </div>
 250 <div class="refsect3">
 251 <a name="id-1.4.2.7.6.6"></a><h4>Returns</h4>
 252 <p> scale factor.</p>
 253 </div>
 254 </div>
 255 <hr>
 256 <div class="refsect2">
 257 <a name="lgl-units-get-units-per-point"></a><h3>lgl_units_get_units_per_point ()</h3>
 258 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>
 259 lgl_units_get_units_per_point (<em class="parameter"><code><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a> units</code></em>);</pre>
 260 <p>Return a scale factor for the given units in units/point.</p>
 261 <div class="refsect3">
 262 <a name="id-1.4.2.7.7.5"></a><h4>Parameters</h4>
 263 <div class="informaltable"><table width="100%" border="0">
 264 <colgroup>
 265 <col width="150px" class="parameters_name">
 266 <col class="parameters_description">
 267 <col width="200px" class="parameters_annotations">
 268 </colgroup>
 269 <tbody><tr>
 270 <td class="parameter_name"><p>units</p></td>
 271 <td class="parameter_description"><p>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</p></td>
 272 <td class="parameter_annotations"> </td>
 273 </tr></tbody>
 274 </table></div>
 275 </div>
 276 <div class="refsect3">
 277 <a name="id-1.4.2.7.7.6"></a><h4>Returns</h4>
 278 <p> scale factor.</p>
 279 </div>
 280 </div>
 281 </div>
 282 <div class="refsect1">
 283 <a name="libglabels-3.0-units.other_details"></a><h2>Types and Values</h2>
 284 <div class="refsect2">
 285 <a name="lglUnits"></a><h3>enum lglUnits</h3>
 286 <p>
 287 This enumeration defines supported units of distance.
 288 </p>
 289 <div class="refsect3">
 290 <a name="id-1.4.2.8.2.4"></a><h4>Members</h4>
 291 <div class="informaltable"><table width="100%" border="0">
 292 <colgroup>
 293 <col width="300px" class="enum_members_name">
 294 <col class="enum_members_description">
 295 <col width="200px" class="enum_members_annotations">
 296 </colgroup>
 297 <tbody>
 298 <tr>
 299 <td class="enum_member_name"><p><a name="LGL-UNITS-POINT:CAPS"></a>LGL_UNITS_POINT</p></td>
 300 <td class="enum_member_description">
 301 <p>Points.</p>
 302 </td>
 303 <td class="enum_member_annotations"> </td>
 304 </tr>
 305 <tr>
 306 <td class="enum_member_name"><p><a name="LGL-UNITS-INCH:CAPS"></a>LGL_UNITS_INCH</p></td>
 307 <td class="enum_member_description">
 308 <p>Inches.</p>
 309 </td>
 310 <td class="enum_member_annotations"> </td>
 311 </tr>
 312 <tr>
 313 <td class="enum_member_name"><p><a name="LGL-UNITS-MM:CAPS"></a>LGL_UNITS_MM</p></td>
 314 <td class="enum_member_description">
 315 <p>Millimeters</p>
 316 </td>
 317 <td class="enum_member_annotations"> </td>
 318 </tr>
 319 <tr>
 320 <td class="enum_member_name"><p><a name="LGL-UNITS-CM:CAPS"></a>LGL_UNITS_CM</p></td>
 321 <td class="enum_member_description">
 322 <p>Centimeters</p>
 323 </td>
 324 <td class="enum_member_annotations"> </td>
 325 </tr>
 326 <tr>
 327 <td class="enum_member_name"><p><a name="LGL-UNITS-PICA:CAPS"></a>LGL_UNITS_PICA</p></td>
 328 <td class="enum_member_description">
 329 <p>Picas</p>
 330 </td>
 331 <td class="enum_member_annotations"> </td>
 332 </tr>
 333 <tr>
 334 <td class="enum_member_name"><p><a name="LGL-UNITS-FIRST:CAPS"></a>LGL_UNITS_FIRST</p></td>
 335 <td class="enum_member_description">
 336 <p>First supported unit.  (Used for bounds checking and iteration through supported units.)</p>
 337 </td>
 338 <td class="enum_member_annotations"> </td>
 339 </tr>
 340 <tr>
 341 <td class="enum_member_name"><p><a name="LGL-UNITS-LAST:CAPS"></a>LGL_UNITS_LAST</p></td>
 342 <td class="enum_member_description">
 343 <p>Last supported unit.  (Used for bounds checking and iteration through supported units.)</p>
 344 </td>
 345 <td class="enum_member_annotations"> </td>
 346 </tr>
 347 <tr>
 348 <td class="enum_member_name"><p><a name="LGL-UNITS-INVALID:CAPS"></a>LGL_UNITS_INVALID</p></td>
 349 <td class="enum_member_description">
 350 <p>Invalid unit.  (Returned by libglabels units functions when a supported unit cannot be determined.)</p>
 351 </td>
 352 <td class="enum_member_annotations"> </td>
 353 </tr>
 354 </tbody>
 355 </table></div>
 356 </div>
 357 </div>
 358 </div>
 359 </div>
 360 <div class="footer">
 361 <hr>Generated by GTK-Doc V1.24</div>
 362 </body>
 363 </html>