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</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="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.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="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch03.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-str.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-units.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-units.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-units"></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-units.top_of_page"></a>Units</span></h2>
  34 <p>Units — Type to represent units of distance supported by libglabels</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglabels-3.0-units.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-units.h&gt;
  42
  43 enum                <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits">lglUnits</a>;
  44 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libglabels-3.0-units.html#lgl-units-get-id" title="lgl_units_get_id ()">lgl_units_get_id</a>                    (<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>);
  45 <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>            <a class="link" href="libglabels-3.0-units.html#lgl-units-from-id" title="lgl_units_from_id ()">lgl_units_from_id</a>                   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);
  46 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libglabels-3.0-units.html#lgl-units-get-name" title="lgl_units_get_name ()">lgl_units_get_name</a>                  (<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>);
  47 <a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>            <a class="link" href="libglabels-3.0-units.html#lgl-units-from-name" title="lgl_units_from_name ()">lgl_units_from_name</a>                 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
  48 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <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>       (<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>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <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>       (<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>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="libglabels-3.0-units.description"></a><h2>Description</h2>
  54 <p>
  55 This section defines a type to represent the various units of distance
  56 supported by libglabels.  It also defines a set of related functions.
  57 </p>
  58 </div>
  59 <div class="refsect1">
  60 <a name="libglabels-3.0-units.details"></a><h2>Details</h2>
  61 <div class="refsect2">
  62 <a name="lglUnits"></a><h3>enum lglUnits</h3>
  63 <pre class="programlisting">typedef enum {
  64         LGL_UNITS_POINT, /* encoded as "pt" */
  65         LGL_UNITS_INCH,  /* encoded as "in" */
  66         LGL_UNITS_MM,    /* encoded as "mm" */
  67         LGL_UNITS_CM,    /* encoded as "cm" */
  68         LGL_UNITS_PICA,  /* encoded as "pc" */
  69
  70         LGL_UNITS_FIRST = LGL_UNITS_POINT,
  71         LGL_UNITS_LAST  = LGL_UNITS_PICA,
  72
  73         LGL_UNITS_INVALID = -1
  74 } lglUnits;
  75 </pre>
  76 <p>
  77 This enumeration defines supported units of distance.
  78 </p>
  79 <div class="variablelist"><table border="0">
  80 <col align="left" valign="top">
  81 <tbody>
  82 <tr>
  83 <td><p><a name="LGL-UNITS-POINT:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_POINT</code></span></p></td>
  84 <td>Points.
  85 </td>
  86 </tr>
  87 <tr>
  88 <td><p><a name="LGL-UNITS-INCH:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_INCH</code></span></p></td>
  89 <td>Inches.
  90 </td>
  91 </tr>
  92 <tr>
  93 <td><p><a name="LGL-UNITS-MM:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_MM</code></span></p></td>
  94 <td>Millimeters
  95 </td>
  96 </tr>
  97 <tr>
  98 <td><p><a name="LGL-UNITS-CM:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_CM</code></span></p></td>
  99 <td>Centimeters
 100 </td>
 101 </tr>
 102 <tr>
 103 <td><p><a name="LGL-UNITS-PICA:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_PICA</code></span></p></td>
 104 <td>Picas
 105 </td>
 106 </tr>
 107 <tr>
 108 <td><p><a name="LGL-UNITS-FIRST:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_FIRST</code></span></p></td>
 109 <td>First supported unit.  (Used for bounds checking and iteration through supported units.)
 110 </td>
 111 </tr>
 112 <tr>
 113 <td><p><a name="LGL-UNITS-LAST:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_LAST</code></span></p></td>
 114 <td>Last supported unit.  (Used for bounds checking and iteration through supported units.)
 115 </td>
 116 </tr>
 117 <tr>
 118 <td><p><a name="LGL-UNITS-INVALID:CAPS"></a><span class="term"><code class="literal">LGL_UNITS_INVALID</code></span></p></td>
 119 <td>Invalid unit.  (Returned by libglabels units functions when a supported unit cannot be determined.)
 120 </td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="lgl-units-get-id"></a><h3>lgl_units_get_id ()</h3>
 128 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
 129 <p>
 130 Return a unique ID string for the given units.  This ID is how units
 131 are encoded in libglabels XML files and will remain constant across
 132 all locales.  IDs are identical to the absolute length units supported
 133 in the CSS2 Specification (Section 4.3.2).
 134 </p>
 135 <div class="variablelist"><table border="0">
 136 <col align="left" valign="top">
 137 <tbody>
 138 <tr>
 139 <td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 140 <td>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 144 <td>ID string.</td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="lgl-units-from-id"></a><h3>lgl_units_from_id ()</h3>
 152 <pre class="programlisting"><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>            lgl_units_from_id                   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
 153 <p>
 154 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.
 155 This ID is how units are encoded in libglabels XML files and will remain
 156 constant across all locales.  IDs are identical to the absolute length
 157 units supported in the CSS2 Specification (Section 4.3.2).
 158 </p>
 159 <div class="variablelist"><table border="0">
 160 <col align="left" valign="top">
 161 <tbody>
 162 <tr>
 163 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 164 <td>ID string</td>
 165 </tr>
 166 <tr>
 167 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 168 <td>units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>).</td>
 169 </tr>
 170 </tbody>
 171 </table></div>
 172 </div>
 173 <hr>
 174 <div class="refsect2">
 175 <a name="lgl-units-get-name"></a><h3>lgl_units_get_name ()</h3>
 176 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
 177 <p>
 178 Return a unique name string for the given units.  This name is human
 179 readable and will be translated to the current locale.
 180 </p>
 181 <div class="variablelist"><table border="0">
 182 <col align="left" valign="top">
 183 <tbody>
 184 <tr>
 185 <td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 186 <td>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</td>
 187 </tr>
 188 <tr>
 189 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 190 <td>name string.</td>
 191 </tr>
 192 </tbody>
 193 </table></div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="lgl-units-from-name"></a><h3>lgl_units_from_name ()</h3>
 198 <pre class="programlisting"><a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="returnvalue">lglUnits</span></a>            lgl_units_from_name                 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 199 <p>
 200 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
 201 human readable and is expected to be translated to the current locale.
 202 </p>
 203 <div class="variablelist"><table border="0">
 204 <col align="left" valign="top">
 205 <tbody>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 208 <td>NAME string</td>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 212 <td>units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>).</td>
 213 </tr>
 214 </tbody>
 215 </table></div>
 216 </div>
 217 <hr>
 218 <div class="refsect2">
 219 <a name="lgl-units-get-points-per-unit"></a><h3>lgl_units_get_points_per_unit ()</h3>
 220 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             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>
 221 <p>
 222 Return a scale factor for the given units in points/unit.
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 229 <td>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 233 <td>scale factor.</td>
 234 </tr>
 235 </tbody>
 236 </table></div>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="lgl-units-get-units-per-point"></a><h3>lgl_units_get_units_per_point ()</h3>
 241 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             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>
 242 <p>
 243 Return a scale factor for the given units in units/point.
 244 </p>
 245 <div class="variablelist"><table border="0">
 246 <col align="left" valign="top">
 247 <tbody>
 248 <tr>
 249 <td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 250 <td>Units (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</td>
 251 </tr>
 252 <tr>
 253 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 254 <td>scale factor.</td>
 255 </tr>
 256 </tbody>
 257 </table></div>
 258 </div>
 259 </div>
 260 </div>
 261 <div class="footer">
 262 <hr>
 263           Generated by GTK-Doc V1.17</div>
 264 </body>
 265 </html>