git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-xml.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>XML Helper Functions</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="ch02.html" title="Working Directly With LibGlabels XML">
   9 <link rel="prev" href="libglabels-3.0-xml-vendor.html" title="XML Vendor Functions">
  10 <link rel="next" href="ch03.html" title="Miscellaneous">
  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="libglabels-3.0-xml-vendor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.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="ch03.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-xml.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-xml.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-xml"></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-xml.top_of_page"></a>XML Helper Functions</span></h2>
  34 <p>XML Helper Functions — Functions to help format and parse glabels XML properties</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglabels-3.0-xml.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-xml.h&gt;
  42
  43 #define             <a class="link" href="libglabels-3.0-xml.html#LGL-XML-NAME-SPACE:CAPS" title="LGL_XML_NAME_SPACE">LGL_XML_NAME_SPACE</a>
  44
  45 <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-xml.html#lgl-xml-get-prop-string" title="lgl_xml_get_prop_string ()">lgl_xml_get_prop_string</a>             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  46                                                          <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> *property</code></em>,
  47                                                          <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> *default_val</code></em>);
  48 <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-xml.html#lgl-xml-get-prop-i18n-string" title="lgl_xml_get_prop_i18n_string ()">lgl_xml_get_prop_i18n_string</a>        (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  49                                                          <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> *property</code></em>,
  50                                                          <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> *default_val</code></em>);
  51 <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-xml.html#lgl-xml-get-prop-double" title="lgl_xml_get_prop_double ()">lgl_xml_get_prop_double</a>             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  52                                                          <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> *property</code></em>,
  53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> default_val</code></em>);
  54 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libglabels-3.0-xml.html#lgl-xml-get-prop-boolean" title="lgl_xml_get_prop_boolean ()">lgl_xml_get_prop_boolean</a>            (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  55                                                          <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> *property</code></em>,
  56                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> default_val</code></em>);
  57 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-get-prop-int" title="lgl_xml_get_prop_int ()">lgl_xml_get_prop_int</a>                (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  58                                                          <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> *property</code></em>,
  59                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> default_val</code></em>);
  60 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libglabels-3.0-xml.html#lgl-xml-get-prop-uint" title="lgl_xml_get_prop_uint ()">lgl_xml_get_prop_uint</a>               (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  61                                                          <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> *property</code></em>,
  62                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> default_val</code></em>);
  63 <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-xml.html#lgl-xml-get-prop-length" title="lgl_xml_get_prop_length ()">lgl_xml_get_prop_length</a>             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  64                                                          <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> *property</code></em>,
  65                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> default_val</code></em>);
  66
  67 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-string" title="lgl_xml_set_prop_string ()">lgl_xml_set_prop_string</a>             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  68                                                          <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> *property</code></em>,
  69                                                          <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> *val</code></em>);
  70 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-double" title="lgl_xml_set_prop_double ()">lgl_xml_set_prop_double</a>             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  71                                                          <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> *property</code></em>,
  72                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> val</code></em>);
  73 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-boolean" title="lgl_xml_set_prop_boolean ()">lgl_xml_set_prop_boolean</a>            (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  74                                                          <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> *property</code></em>,
  75                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> val</code></em>);
  76 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-int" title="lgl_xml_set_prop_int ()">lgl_xml_set_prop_int</a>                (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  77                                                          <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> *property</code></em>,
  78                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> val</code></em>);
  79 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-uint-hex" title="lgl_xml_set_prop_uint_hex ()">lgl_xml_set_prop_uint_hex</a>           (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  80                                                          <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> *property</code></em>,
  81                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> val</code></em>);
  82 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-length" title="lgl_xml_set_prop_length ()">lgl_xml_set_prop_length</a>             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  83                                                          <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> *property</code></em>,
  84                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> val</code></em>);
  85
  86 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libglabels-3.0-xml.html#lgl-xml-is-node" title="lgl_xml_is_node ()">lgl_xml_is_node</a>                     (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
  87                                                          <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>);
  88 <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-xml.html#lgl-xml-get-node-content" title="lgl_xml_get_node_content ()">lgl_xml_get_node_content</a>            (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);
  89
  90 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-default-units" title="lgl_xml_set_default_units ()">lgl_xml_set_default_units</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>);
  91 </pre>
  92 </div>
  93 <div class="refsect1">
  94 <a name="libglabels-3.0-xml.description"></a><h2>Description</h2>
  95 <p>
  96 This section describes a number of "helper" functions for formatting and
  97 parsing various types of properties for tags in glabels XML file formats.
  98 </p>
  99 <p>
 100 These functions are basically wrappers to functions from libxml2.
 101 </p>
 102 </div>
 103 <div class="refsect1">
 104 <a name="libglabels-3.0-xml.details"></a><h2>Details</h2>
 105 <div class="refsect2">
 106 <a name="LGL-XML-NAME-SPACE:CAPS"></a><h3>LGL_XML_NAME_SPACE</h3>
 107 <pre class="programlisting">#define LGL_XML_NAME_SPACE "http://glabels.org/xmlns/3.0/"
 108 </pre>
 109 <p>
 110 </p>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="lgl-xml-get-prop-string"></a><h3>lgl_xml_get_prop_string ()</h3>
 115 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             lgl_xml_get_prop_string             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 116                                                          <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> *property</code></em>,
 117                                                          <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> *default_val</code></em>);</pre>
 118 <p>
 119 Return value of property as a string.
 120 </p>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 126 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 130 <td>the property name</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 134 <td>a default value to return if property not found</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 138 <td>the property as a pointer to a gchar string.  This string should
 139 be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="lgl-xml-get-prop-i18n-string"></a><h3>lgl_xml_get_prop_i18n_string ()</h3>
 147 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             lgl_xml_get_prop_i18n_string        (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 148                                                          <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> *property</code></em>,
 149                                                          <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> *default_val</code></em>);</pre>
 150 <p>
 151 Return value of a translatable property as a string.
 152 </p>
 153 <div class="variablelist"><table border="0">
 154 <col align="left" valign="top">
 155 <tbody>
 156 <tr>
 157 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 158 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 162 <td>the property name</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 166 <td>a default value to return if property not found</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 170 <td>the property as a pointer to a gchar string.  This string should
 171 be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</td>
 172 </tr>
 173 </tbody>
 174 </table></div>
 175 </div>
 176 <hr>
 177 <div class="refsect2">
 178 <a name="lgl-xml-get-prop-double"></a><h3>lgl_xml_get_prop_double ()</h3>
 179 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             lgl_xml_get_prop_double             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 180                                                          <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> *property</code></em>,
 181                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> default_val</code></em>);</pre>
 182 <p>
 183 Return value of property as a double.
 184 </p>
 185 <div class="variablelist"><table border="0">
 186 <col align="left" valign="top">
 187 <tbody>
 188 <tr>
 189 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 190 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 191 </tr>
 192 <tr>
 193 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 194 <td>the property name</td>
 195 </tr>
 196 <tr>
 197 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 198 <td>a default value to return if property not found</td>
 199 </tr>
 200 <tr>
 201 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 202 <td>the property as a double.</td>
 203 </tr>
 204 </tbody>
 205 </table></div>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="lgl-xml-get-prop-boolean"></a><h3>lgl_xml_get_prop_boolean ()</h3>
 210 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            lgl_xml_get_prop_boolean            (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 211                                                          <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> *property</code></em>,
 212                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> default_val</code></em>);</pre>
 213 <p>
 214 Return value of property as a boolean.
 215 </p>
 216 <div class="variablelist"><table border="0">
 217 <col align="left" valign="top">
 218 <tbody>
 219 <tr>
 220 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 221 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 222 </tr>
 223 <tr>
 224 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 225 <td>the property name</td>
 226 </tr>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 229 <td>a default value to return if property not found</td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 233 <td>the property as a boolean.</td>
 234 </tr>
 235 </tbody>
 236 </table></div>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="lgl-xml-get-prop-int"></a><h3>lgl_xml_get_prop_int ()</h3>
 241 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_xml_get_prop_int                (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 242                                                          <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> *property</code></em>,
 243                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> default_val</code></em>);</pre>
 244 <p>
 245 Return value of property as an integer.
 246 </p>
 247 <div class="variablelist"><table border="0">
 248 <col align="left" valign="top">
 249 <tbody>
 250 <tr>
 251 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 252 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 253 </tr>
 254 <tr>
 255 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 256 <td>the property name</td>
 257 </tr>
 258 <tr>
 259 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 260 <td>a default value to return if property not found</td>
 261 </tr>
 262 <tr>
 263 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 264 <td>the property as an integer.</td>
 265 </tr>
 266 </tbody>
 267 </table></div>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="lgl-xml-get-prop-uint"></a><h3>lgl_xml_get_prop_uint ()</h3>
 272 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               lgl_xml_get_prop_uint               (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 273                                                          <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> *property</code></em>,
 274                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> default_val</code></em>);</pre>
 275 <p>
 276 Return value of property (usually formatted in hex) as an unsigned integer.
 277 </p>
 278 <div class="variablelist"><table border="0">
 279 <col align="left" valign="top">
 280 <tbody>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 283 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 284 </tr>
 285 <tr>
 286 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 287 <td>the property name</td>
 288 </tr>
 289 <tr>
 290 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 291 <td>a default value to return if property not found</td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 295 <td>the property as an unsigned integer.</td>
 296 </tr>
 297 </tbody>
 298 </table></div>
 299 </div>
 300 <hr>
 301 <div class="refsect2">
 302 <a name="lgl-xml-get-prop-length"></a><h3>lgl_xml_get_prop_length ()</h3>
 303 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             lgl_xml_get_prop_length             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 304                                                          <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> *property</code></em>,
 305                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> default_val</code></em>);</pre>
 306 <p>
 307 Return value of a length property as a double, converting to internal
 308 units (points).  The property is expected to be formatted as a number
 309 followed by a units string.  If there is no units string, the length
 310 is assumed to be in points.  Valid units strings are "pt" for points,
 311 "in" for inches, "mm" for millimeters, "cm" for centimeters, and
 312 "pc" for picas.
 313 </p>
 314 <div class="variablelist"><table border="0">
 315 <col align="left" valign="top">
 316 <tbody>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 319 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 320 </tr>
 321 <tr>
 322 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 323 <td>the property name</td>
 324 </tr>
 325 <tr>
 326 <td><p><span class="term"><em class="parameter"><code>default_val</code></em> :</span></p></td>
 327 <td>a default value to return if property not found</td>
 328 </tr>
 329 <tr>
 330 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 331 <td>the length in points.</td>
 332 </tr>
 333 </tbody>
 334 </table></div>
 335 </div>
 336 <hr>
 337 <div class="refsect2">
 338 <a name="lgl-xml-set-prop-string"></a><h3>lgl_xml_set_prop_string ()</h3>
 339 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_prop_string             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 340                                                          <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> *property</code></em>,
 341                                                          <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> *val</code></em>);</pre>
 342 <p>
 343 Set a property from a string.
 344 </p>
 345 <div class="variablelist"><table border="0">
 346 <col align="left" valign="top">
 347 <tbody>
 348 <tr>
 349 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 350 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 351 </tr>
 352 <tr>
 353 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 354 <td>the property name</td>
 355 </tr>
 356 <tr>
 357 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 358 <td>the value to set</td>
 359 </tr>
 360 </tbody>
 361 </table></div>
 362 </div>
 363 <hr>
 364 <div class="refsect2">
 365 <a name="lgl-xml-set-prop-double"></a><h3>lgl_xml_set_prop_double ()</h3>
 366 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_prop_double             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 367                                                          <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> *property</code></em>,
 368                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> val</code></em>);</pre>
 369 <p>
 370 Set a property from a double.
 371 </p>
 372 <div class="variablelist"><table border="0">
 373 <col align="left" valign="top">
 374 <tbody>
 375 <tr>
 376 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 377 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 378 </tr>
 379 <tr>
 380 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 381 <td>the property name</td>
 382 </tr>
 383 <tr>
 384 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 385 <td>the value to set</td>
 386 </tr>
 387 </tbody>
 388 </table></div>
 389 </div>
 390 <hr>
 391 <div class="refsect2">
 392 <a name="lgl-xml-set-prop-boolean"></a><h3>lgl_xml_set_prop_boolean ()</h3>
 393 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_prop_boolean            (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 394                                                          <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> *property</code></em>,
 395                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> val</code></em>);</pre>
 396 <p>
 397 Set a property from a boolean.
 398 </p>
 399 <div class="variablelist"><table border="0">
 400 <col align="left" valign="top">
 401 <tbody>
 402 <tr>
 403 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 404 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 405 </tr>
 406 <tr>
 407 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 408 <td>the property name</td>
 409 </tr>
 410 <tr>
 411 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 412 <td>the value to set</td>
 413 </tr>
 414 </tbody>
 415 </table></div>
 416 </div>
 417 <hr>
 418 <div class="refsect2">
 419 <a name="lgl-xml-set-prop-int"></a><h3>lgl_xml_set_prop_int ()</h3>
 420 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_prop_int                (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 421                                                          <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> *property</code></em>,
 422                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> val</code></em>);</pre>
 423 <p>
 424 Set a property from an integer.
 425 </p>
 426 <div class="variablelist"><table border="0">
 427 <col align="left" valign="top">
 428 <tbody>
 429 <tr>
 430 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 431 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 432 </tr>
 433 <tr>
 434 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 435 <td>the property name</td>
 436 </tr>
 437 <tr>
 438 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 439 <td>the value to set</td>
 440 </tr>
 441 </tbody>
 442 </table></div>
 443 </div>
 444 <hr>
 445 <div class="refsect2">
 446 <a name="lgl-xml-set-prop-uint-hex"></a><h3>lgl_xml_set_prop_uint_hex ()</h3>
 447 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_prop_uint_hex           (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 448                                                          <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> *property</code></em>,
 449                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> val</code></em>);</pre>
 450 <p>
 451 Set a property from an unsigned integer and format in hex.
 452 </p>
 453 <div class="variablelist"><table border="0">
 454 <col align="left" valign="top">
 455 <tbody>
 456 <tr>
 457 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 458 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 459 </tr>
 460 <tr>
 461 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 462 <td>the property name</td>
 463 </tr>
 464 <tr>
 465 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 466 <td>the value to set</td>
 467 </tr>
 468 </tbody>
 469 </table></div>
 470 </div>
 471 <hr>
 472 <div class="refsect2">
 473 <a name="lgl-xml-set-prop-length"></a><h3>lgl_xml_set_prop_length ()</h3>
 474 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_prop_length             (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 475                                                          <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> *property</code></em>,
 476                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> val</code></em>);</pre>
 477 <p>
 478 Set a property from a length, performing any necessary conversion.
 479 Length properties are formatted as a number followed by a units string.
 480 The units of the formatted property is determined by the most recent call to
 481 <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-default-units" title="lgl_xml_set_default_units ()"><code class="function">lgl_xml_set_default_units()</code></a>.
 482 </p>
 483 <div class="variablelist"><table border="0">
 484 <col align="left" valign="top">
 485 <tbody>
 486 <tr>
 487 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 488 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 489 </tr>
 490 <tr>
 491 <td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
 492 <td>the property name</td>
 493 </tr>
 494 <tr>
 495 <td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 496 <td>the length to set in internal units (points)</td>
 497 </tr>
 498 </tbody>
 499 </table></div>
 500 </div>
 501 <hr>
 502 <div class="refsect2">
 503 <a name="lgl-xml-is-node"></a><h3>lgl_xml_is_node ()</h3>
 504 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            lgl_xml_is_node                     (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>,
 505                                                          <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>
 506 <p>
 507 Test if a node name matches given name.
 508 </p>
 509 <div class="variablelist"><table border="0">
 510 <col align="left" valign="top">
 511 <tbody>
 512 <tr>
 513 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 514 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 515 </tr>
 516 <tr>
 517 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 518 <td>the node name</td>
 519 </tr>
 520 <tr>
 521 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 522 <td>TRUE if the name of the node matches.  Otherwise FALSE.</td>
 523 </tr>
 524 </tbody>
 525 </table></div>
 526 </div>
 527 <hr>
 528 <div class="refsect2">
 529 <a name="lgl-xml-get-node-content"></a><h3>lgl_xml_get_node_content ()</h3>
 530 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             lgl_xml_get_node_content            (<em class="parameter"><code><span class="type">xmlNodePtr</span> node</code></em>);</pre>
 531 <p>
 532 Get the content of a node.
 533 </p>
 534 <div class="variablelist"><table border="0">
 535 <col align="left" valign="top">
 536 <tbody>
 537 <tr>
 538 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
 539 <td>the libxml2 <span class="type">xmlNodePtr</span> of the node</td>
 540 </tr>
 541 <tr>
 542 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 543 <td>the property as a pointer to a gchar string.  This string should
 544 be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</td>
 545 </tr>
 546 </tbody>
 547 </table></div>
 548 </div>
 549 <hr>
 550 <div class="refsect2">
 551 <a name="lgl-xml-set-default-units"></a><h3>lgl_xml_set_default_units ()</h3>
 552 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_set_default_units           (<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>
 553 <p>
 554 Set the default units when formatting lengths.  See
 555 <a class="link" href="libglabels-3.0-xml.html#lgl-xml-set-prop-length" title="lgl_xml_set_prop_length ()"><code class="function">lgl_xml_set_prop_length()</code></a>.
 556 </p>
 557 <div class="variablelist"><table border="0">
 558 <col align="left" valign="top">
 559 <tbody><tr>
 560 <td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 561 <td>default units selection (<a class="link" href="libglabels-3.0-units.html#lglUnits" title="enum lglUnits"><span class="type">lglUnits</span></a>)</td>
 562 </tr></tbody>
 563 </table></div>
 564 </div>
 565 </div>
 566 </div>
 567 <div class="footer">
 568 <hr>
 569           Generated by GTK-Doc V1.17</div>
 570 </body>
 571 </html>