]> git.sur5r.net Git - glabels/blob - docs/libglabels/xml/xml.xml
Imported Upstream version 2.2.8
[glabels] / docs / libglabels / xml / xml.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
5 <refentry id="libglabels-xml">
6 <refmeta>
7 <refentrytitle role="top_of_page" id="libglabels-xml.top_of_page">XML Helper Functions</refentrytitle>
8 <manvolnum>3</manvolnum>
9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
10 </refmeta>
11
12 <refnamediv>
13 <refname>XML Helper Functions</refname>
14 <refpurpose>Functions to help format and parse glabels XML properties</refpurpose>
15 </refnamediv>
16
17 <refsynopsisdiv id="libglabels-xml.synopsis" role="synopsis">
18 <title role="synopsis.title">Synopsis</title>
19
20 <synopsis>
21
22 #include &lt;libglabels/xml.h&gt;
23
24 #define             <link linkend="LGL-XML-NAME-SPACE--CAPS">LGL_XML_NAME_SPACE</link>
25
26 <link linkend="gchar">gchar</link> *             <link linkend="lgl-xml-get-prop-string">lgl_xml_get_prop_string</link>             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
27                                                          const <link linkend="gchar">gchar</link> *property,
28                                                          const <link linkend="gchar">gchar</link> *default_val);
29 <link linkend="gchar">gchar</link> *             <link linkend="lgl-xml-get-prop-i18n-string">lgl_xml_get_prop_i18n_string</link>        (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
30                                                          const <link linkend="gchar">gchar</link> *property,
31                                                          const <link linkend="gchar">gchar</link> *default_val);
32 <link linkend="gdouble">gdouble</link>             <link linkend="lgl-xml-get-prop-double">lgl_xml_get_prop_double</link>             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
33                                                          const <link linkend="gchar">gchar</link> *property,
34                                                          <link linkend="gdouble">gdouble</link> default_val);
35 <link linkend="gboolean">gboolean</link>            <link linkend="lgl-xml-get-prop-boolean">lgl_xml_get_prop_boolean</link>            (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
36                                                          const <link linkend="gchar">gchar</link> *property,
37                                                          <link linkend="gboolean">gboolean</link> default_val);
38 <link linkend="gint">gint</link>                <link linkend="lgl-xml-get-prop-int">lgl_xml_get_prop_int</link>                (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
39                                                          const <link linkend="gchar">gchar</link> *property,
40                                                          <link linkend="gint">gint</link> default_val);
41 <link linkend="guint">guint</link>               <link linkend="lgl-xml-get-prop-uint">lgl_xml_get_prop_uint</link>               (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
42                                                          const <link linkend="gchar">gchar</link> *property,
43                                                          <link linkend="guint">guint</link> default_val);
44 <link linkend="gdouble">gdouble</link>             <link linkend="lgl-xml-get-prop-length">lgl_xml_get_prop_length</link>             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
45                                                          const <link linkend="gchar">gchar</link> *property,
46                                                          <link linkend="gdouble">gdouble</link> default_val);
47
48 <link linkend="void">void</link>                <link linkend="lgl-xml-set-prop-string">lgl_xml_set_prop_string</link>             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
49                                                          const <link linkend="gchar">gchar</link> *property,
50                                                          const <link linkend="gchar">gchar</link> *val);
51 <link linkend="void">void</link>                <link linkend="lgl-xml-set-prop-double">lgl_xml_set_prop_double</link>             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
52                                                          const <link linkend="gchar">gchar</link> *property,
53                                                          <link linkend="gdouble">gdouble</link> val);
54 <link linkend="void">void</link>                <link linkend="lgl-xml-set-prop-boolean">lgl_xml_set_prop_boolean</link>            (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
55                                                          const <link linkend="gchar">gchar</link> *property,
56                                                          <link linkend="gboolean">gboolean</link> val);
57 <link linkend="void">void</link>                <link linkend="lgl-xml-set-prop-int">lgl_xml_set_prop_int</link>                (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
58                                                          const <link linkend="gchar">gchar</link> *property,
59                                                          <link linkend="gint">gint</link> val);
60 <link linkend="void">void</link>                <link linkend="lgl-xml-set-prop-uint-hex">lgl_xml_set_prop_uint_hex</link>           (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
61                                                          const <link linkend="gchar">gchar</link> *property,
62                                                          <link linkend="guint">guint</link> val);
63 <link linkend="void">void</link>                <link linkend="lgl-xml-set-prop-length">lgl_xml_set_prop_length</link>             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
64                                                          const <link linkend="gchar">gchar</link> *property,
65                                                          <link linkend="gdouble">gdouble</link> val);
66
67 <link linkend="gboolean">gboolean</link>            <link linkend="lgl-xml-is-node">lgl_xml_is_node</link>                     (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
68                                                          const <link linkend="gchar">gchar</link> *name);
69 <link linkend="gchar">gchar</link> *             <link linkend="lgl-xml-get-node-content">lgl_xml_get_node_content</link>            (<link linkend="xmlNodePtr">xmlNodePtr</link> node);
70
71 <link linkend="void">void</link>                <link linkend="lgl-xml-set-default-units">lgl_xml_set_default_units</link>           (<link linkend="lglUnitsType">lglUnitsType</link> units);
72 </synopsis>
73 </refsynopsisdiv>
74
75
76
77
78
79
80
81
82
83 <refsect1 id="libglabels-xml.description" role="desc">
84 <title role="desc.title">Description</title>
85 <para>
86 This section describes a number of "helper" functions for formatting and
87 parsing various types of properties for tags in glabels XML file formats.
88 </para>
89 <para>
90 These functions are basically wrappers to functions from libxml2.
91 </para>
92 </refsect1>
93
94 <refsect1 id="libglabels-xml.details" role="details">
95 <title role="details.title">Details</title>
96 <refsect2 id="LGL-XML-NAME-SPACE--CAPS" role="macro">
97 <title>LGL_XML_NAME_SPACE</title>
98 <indexterm zone="LGL-XML-NAME-SPACE--CAPS"><primary sortas="LGL_XML_NAME_SPACE">LGL_XML_NAME_SPACE</primary></indexterm><programlisting>#define LGL_XML_NAME_SPACE "http://snaught.com/glabels/2.2/"
99 </programlisting>
100 <para>
101 </para></refsect2>
102 <refsect2 id="lgl-xml-get-prop-string" role="function">
103 <title>lgl_xml_get_prop_string ()</title>
104 <indexterm zone="lgl-xml-get-prop-string"><primary sortas="lgl_xml_get_prop_string">lgl_xml_get_prop_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             lgl_xml_get_prop_string             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
105                                                          const <link linkend="gchar">gchar</link> *property,
106                                                          const <link linkend="gchar">gchar</link> *default_val);</programlisting>
107 <para>
108 Return value of property as a string.</para>
109 <para>
110 </para><variablelist role="params">
111 <varlistentry><term><parameter>node</parameter>&#160;:</term>
112 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
113 </simpara></listitem></varlistentry>
114 <varlistentry><term><parameter>property</parameter>&#160;:</term>
115 <listitem><simpara>    the property name
116 </simpara></listitem></varlistentry>
117 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
118 <listitem><simpara> a default value to return if property not found
119 </simpara></listitem></varlistentry>
120 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as a pointer to a gchar string.  This string should
121          be freed with <link linkend="g-free"><function>g_free()</function></link>.
122
123 </simpara></listitem></varlistentry>
124 </variablelist></refsect2>
125 <refsect2 id="lgl-xml-get-prop-i18n-string" role="function">
126 <title>lgl_xml_get_prop_i18n_string ()</title>
127 <indexterm zone="lgl-xml-get-prop-i18n-string"><primary sortas="lgl_xml_get_prop_i18n_string">lgl_xml_get_prop_i18n_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             lgl_xml_get_prop_i18n_string        (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
128                                                          const <link linkend="gchar">gchar</link> *property,
129                                                          const <link linkend="gchar">gchar</link> *default_val);</programlisting>
130 <para>
131 Return value of a translatable property as a string.</para>
132 <para>
133 </para><variablelist role="params">
134 <varlistentry><term><parameter>node</parameter>&#160;:</term>
135 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
136 </simpara></listitem></varlistentry>
137 <varlistentry><term><parameter>property</parameter>&#160;:</term>
138 <listitem><simpara>    the property name
139 </simpara></listitem></varlistentry>
140 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
141 <listitem><simpara> a default value to return if property not found
142 </simpara></listitem></varlistentry>
143 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as a pointer to a gchar string.  This string should
144          be freed with <link linkend="g-free"><function>g_free()</function></link>.
145
146 </simpara></listitem></varlistentry>
147 </variablelist></refsect2>
148 <refsect2 id="lgl-xml-get-prop-double" role="function">
149 <title>lgl_xml_get_prop_double ()</title>
150 <indexterm zone="lgl-xml-get-prop-double"><primary sortas="lgl_xml_get_prop_double">lgl_xml_get_prop_double</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             lgl_xml_get_prop_double             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
151                                                          const <link linkend="gchar">gchar</link> *property,
152                                                          <link linkend="gdouble">gdouble</link> default_val);</programlisting>
153 <para>
154 Return value of property as a double.</para>
155 <para>
156 </para><variablelist role="params">
157 <varlistentry><term><parameter>node</parameter>&#160;:</term>
158 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
159 </simpara></listitem></varlistentry>
160 <varlistentry><term><parameter>property</parameter>&#160;:</term>
161 <listitem><simpara>    the property name
162 </simpara></listitem></varlistentry>
163 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
164 <listitem><simpara> a default value to return if property not found
165 </simpara></listitem></varlistentry>
166 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as a double.
167
168 </simpara></listitem></varlistentry>
169 </variablelist></refsect2>
170 <refsect2 id="lgl-xml-get-prop-boolean" role="function">
171 <title>lgl_xml_get_prop_boolean ()</title>
172 <indexterm zone="lgl-xml-get-prop-boolean"><primary sortas="lgl_xml_get_prop_boolean">lgl_xml_get_prop_boolean</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lgl_xml_get_prop_boolean            (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
173                                                          const <link linkend="gchar">gchar</link> *property,
174                                                          <link linkend="gboolean">gboolean</link> default_val);</programlisting>
175 <para>
176 Return value of property as a boolean.</para>
177 <para>
178 </para><variablelist role="params">
179 <varlistentry><term><parameter>node</parameter>&#160;:</term>
180 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
181 </simpara></listitem></varlistentry>
182 <varlistentry><term><parameter>property</parameter>&#160;:</term>
183 <listitem><simpara>    the property name
184 </simpara></listitem></varlistentry>
185 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
186 <listitem><simpara> a default value to return if property not found
187 </simpara></listitem></varlistentry>
188 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as a boolean.
189
190 </simpara></listitem></varlistentry>
191 </variablelist></refsect2>
192 <refsect2 id="lgl-xml-get-prop-int" role="function">
193 <title>lgl_xml_get_prop_int ()</title>
194 <indexterm zone="lgl-xml-get-prop-int"><primary sortas="lgl_xml_get_prop_int">lgl_xml_get_prop_int</primary></indexterm><programlisting><link linkend="gint">gint</link>                lgl_xml_get_prop_int                (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
195                                                          const <link linkend="gchar">gchar</link> *property,
196                                                          <link linkend="gint">gint</link> default_val);</programlisting>
197 <para>
198 Return value of property as an integer.</para>
199 <para>
200 </para><variablelist role="params">
201 <varlistentry><term><parameter>node</parameter>&#160;:</term>
202 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
203 </simpara></listitem></varlistentry>
204 <varlistentry><term><parameter>property</parameter>&#160;:</term>
205 <listitem><simpara>    the property name
206 </simpara></listitem></varlistentry>
207 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
208 <listitem><simpara> a default value to return if property not found
209 </simpara></listitem></varlistentry>
210 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as an integer.
211
212 </simpara></listitem></varlistentry>
213 </variablelist></refsect2>
214 <refsect2 id="lgl-xml-get-prop-uint" role="function">
215 <title>lgl_xml_get_prop_uint ()</title>
216 <indexterm zone="lgl-xml-get-prop-uint"><primary sortas="lgl_xml_get_prop_uint">lgl_xml_get_prop_uint</primary></indexterm><programlisting><link linkend="guint">guint</link>               lgl_xml_get_prop_uint               (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
217                                                          const <link linkend="gchar">gchar</link> *property,
218                                                          <link linkend="guint">guint</link> default_val);</programlisting>
219 <para>
220 Return value of property (usually formatted in hex) as an unsigned integer.</para>
221 <para>
222 </para><variablelist role="params">
223 <varlistentry><term><parameter>node</parameter>&#160;:</term>
224 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
225 </simpara></listitem></varlistentry>
226 <varlistentry><term><parameter>property</parameter>&#160;:</term>
227 <listitem><simpara>    the property name
228 </simpara></listitem></varlistentry>
229 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
230 <listitem><simpara> a default value to return if property not found
231 </simpara></listitem></varlistentry>
232 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as an unsigned integer.
233
234 </simpara></listitem></varlistentry>
235 </variablelist></refsect2>
236 <refsect2 id="lgl-xml-get-prop-length" role="function">
237 <title>lgl_xml_get_prop_length ()</title>
238 <indexterm zone="lgl-xml-get-prop-length"><primary sortas="lgl_xml_get_prop_length">lgl_xml_get_prop_length</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             lgl_xml_get_prop_length             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
239                                                          const <link linkend="gchar">gchar</link> *property,
240                                                          <link linkend="gdouble">gdouble</link> default_val);</programlisting>
241 <para>
242 Return value of a length property as a double, converting to internal
243 units (points).  The property is expected to be formatted as a number
244 followed by a units string.  If there is no units string, the length
245 is assumed to be in points.  Valid units strings are "pt" for points,
246 "in" for inches, "mm" for millimeters, "cm" for centimeters, and
247 "pc" for picas.</para>
248 <para>
249 </para><variablelist role="params">
250 <varlistentry><term><parameter>node</parameter>&#160;:</term>
251 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
252 </simpara></listitem></varlistentry>
253 <varlistentry><term><parameter>property</parameter>&#160;:</term>
254 <listitem><simpara>    the property name
255 </simpara></listitem></varlistentry>
256 <varlistentry><term><parameter>default_val</parameter>&#160;:</term>
257 <listitem><simpara> a default value to return if property not found
258 </simpara></listitem></varlistentry>
259 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the length in points.
260
261 </simpara></listitem></varlistentry>
262 </variablelist></refsect2>
263 <refsect2 id="lgl-xml-set-prop-string" role="function">
264 <title>lgl_xml_set_prop_string ()</title>
265 <indexterm zone="lgl-xml-set-prop-string"><primary sortas="lgl_xml_set_prop_string">lgl_xml_set_prop_string</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_prop_string             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
266                                                          const <link linkend="gchar">gchar</link> *property,
267                                                          const <link linkend="gchar">gchar</link> *val);</programlisting>
268 <para>
269 Set a property from a string.</para>
270 <para>
271 </para><variablelist role="params">
272 <varlistentry><term><parameter>node</parameter>&#160;:</term>
273 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
274 </simpara></listitem></varlistentry>
275 <varlistentry><term><parameter>property</parameter>&#160;:</term>
276 <listitem><simpara>    the property name
277 </simpara></listitem></varlistentry>
278 <varlistentry><term><parameter>val</parameter>&#160;:</term>
279 <listitem><simpara>         the value to set
280 </simpara></listitem></varlistentry>
281 </variablelist></refsect2>
282 <refsect2 id="lgl-xml-set-prop-double" role="function">
283 <title>lgl_xml_set_prop_double ()</title>
284 <indexterm zone="lgl-xml-set-prop-double"><primary sortas="lgl_xml_set_prop_double">lgl_xml_set_prop_double</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_prop_double             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
285                                                          const <link linkend="gchar">gchar</link> *property,
286                                                          <link linkend="gdouble">gdouble</link> val);</programlisting>
287 <para>
288 Set a property from a double.</para>
289 <para>
290 </para><variablelist role="params">
291 <varlistentry><term><parameter>node</parameter>&#160;:</term>
292 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
293 </simpara></listitem></varlistentry>
294 <varlistentry><term><parameter>property</parameter>&#160;:</term>
295 <listitem><simpara>    the property name
296 </simpara></listitem></varlistentry>
297 <varlistentry><term><parameter>val</parameter>&#160;:</term>
298 <listitem><simpara>         the value to set
299 </simpara></listitem></varlistentry>
300 </variablelist></refsect2>
301 <refsect2 id="lgl-xml-set-prop-boolean" role="function">
302 <title>lgl_xml_set_prop_boolean ()</title>
303 <indexterm zone="lgl-xml-set-prop-boolean"><primary sortas="lgl_xml_set_prop_boolean">lgl_xml_set_prop_boolean</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_prop_boolean            (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
304                                                          const <link linkend="gchar">gchar</link> *property,
305                                                          <link linkend="gboolean">gboolean</link> val);</programlisting>
306 <para>
307 Set a property from a boolean.</para>
308 <para>
309 </para><variablelist role="params">
310 <varlistentry><term><parameter>node</parameter>&#160;:</term>
311 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
312 </simpara></listitem></varlistentry>
313 <varlistentry><term><parameter>property</parameter>&#160;:</term>
314 <listitem><simpara>    the property name
315 </simpara></listitem></varlistentry>
316 <varlistentry><term><parameter>val</parameter>&#160;:</term>
317 <listitem><simpara>         the value to set
318 </simpara></listitem></varlistentry>
319 </variablelist></refsect2>
320 <refsect2 id="lgl-xml-set-prop-int" role="function">
321 <title>lgl_xml_set_prop_int ()</title>
322 <indexterm zone="lgl-xml-set-prop-int"><primary sortas="lgl_xml_set_prop_int">lgl_xml_set_prop_int</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_prop_int                (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
323                                                          const <link linkend="gchar">gchar</link> *property,
324                                                          <link linkend="gint">gint</link> val);</programlisting>
325 <para>
326 Set a property from an integer.</para>
327 <para>
328 </para><variablelist role="params">
329 <varlistentry><term><parameter>node</parameter>&#160;:</term>
330 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
331 </simpara></listitem></varlistentry>
332 <varlistentry><term><parameter>property</parameter>&#160;:</term>
333 <listitem><simpara>    the property name
334 </simpara></listitem></varlistentry>
335 <varlistentry><term><parameter>val</parameter>&#160;:</term>
336 <listitem><simpara>         the value to set
337 </simpara></listitem></varlistentry>
338 </variablelist></refsect2>
339 <refsect2 id="lgl-xml-set-prop-uint-hex" role="function">
340 <title>lgl_xml_set_prop_uint_hex ()</title>
341 <indexterm zone="lgl-xml-set-prop-uint-hex"><primary sortas="lgl_xml_set_prop_uint_hex">lgl_xml_set_prop_uint_hex</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_prop_uint_hex           (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
342                                                          const <link linkend="gchar">gchar</link> *property,
343                                                          <link linkend="guint">guint</link> val);</programlisting>
344 <para>
345 Set a property from an unsigned integer and format in hex.</para>
346 <para>
347 </para><variablelist role="params">
348 <varlistentry><term><parameter>node</parameter>&#160;:</term>
349 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
350 </simpara></listitem></varlistentry>
351 <varlistentry><term><parameter>property</parameter>&#160;:</term>
352 <listitem><simpara>    the property name
353 </simpara></listitem></varlistentry>
354 <varlistentry><term><parameter>val</parameter>&#160;:</term>
355 <listitem><simpara>         the value to set
356 </simpara></listitem></varlistentry>
357 </variablelist></refsect2>
358 <refsect2 id="lgl-xml-set-prop-length" role="function">
359 <title>lgl_xml_set_prop_length ()</title>
360 <indexterm zone="lgl-xml-set-prop-length"><primary sortas="lgl_xml_set_prop_length">lgl_xml_set_prop_length</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_prop_length             (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
361                                                          const <link linkend="gchar">gchar</link> *property,
362                                                          <link linkend="gdouble">gdouble</link> val);</programlisting>
363 <para>
364 Set a property from a length, performing any necessary conversion.
365 Length properties are formatted as a number followed by a units string.
366 The units of the formatted property is determined by the most recent call to
367 <link linkend="lgl-xml-set-default-units"><function>lgl_xml_set_default_units()</function></link>.</para>
368 <para>
369 </para><variablelist role="params">
370 <varlistentry><term><parameter>node</parameter>&#160;:</term>
371 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
372 </simpara></listitem></varlistentry>
373 <varlistentry><term><parameter>property</parameter>&#160;:</term>
374 <listitem><simpara>    the property name
375 </simpara></listitem></varlistentry>
376 <varlistentry><term><parameter>val</parameter>&#160;:</term>
377 <listitem><simpara>         the length to set in internal units (points)
378 </simpara></listitem></varlistentry>
379 </variablelist></refsect2>
380 <refsect2 id="lgl-xml-is-node" role="function">
381 <title>lgl_xml_is_node ()</title>
382 <indexterm zone="lgl-xml-is-node"><primary sortas="lgl_xml_is_node">lgl_xml_is_node</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            lgl_xml_is_node                     (<link linkend="xmlNodePtr">xmlNodePtr</link> node,
383                                                          const <link linkend="gchar">gchar</link> *name);</programlisting>
384 <para>
385 Test if a node name matches given name.</para>
386 <para>
387 </para><variablelist role="params">
388 <varlistentry><term><parameter>node</parameter>&#160;:</term>
389 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
390 </simpara></listitem></varlistentry>
391 <varlistentry><term><parameter>name</parameter>&#160;:</term>
392 <listitem><simpara>    the node name
393 </simpara></listitem></varlistentry>
394 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the name of the node matches.  Otherwise FALSE.
395
396 </simpara></listitem></varlistentry>
397 </variablelist></refsect2>
398 <refsect2 id="lgl-xml-get-node-content" role="function">
399 <title>lgl_xml_get_node_content ()</title>
400 <indexterm zone="lgl-xml-get-node-content"><primary sortas="lgl_xml_get_node_content">lgl_xml_get_node_content</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             lgl_xml_get_node_content            (<link linkend="xmlNodePtr">xmlNodePtr</link> node);</programlisting>
401 <para>
402 Get the content of a node.</para>
403 <para>
404 </para><variablelist role="params">
405 <varlistentry><term><parameter>node</parameter>&#160;:</term>
406 <listitem><simpara>        the libxml2 <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> of the node
407 </simpara></listitem></varlistentry>
408 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the property as a pointer to a gchar string.  This string should
409          be freed with <link linkend="g-free"><function>g_free()</function></link>.
410 </simpara></listitem></varlistentry>
411 </variablelist></refsect2>
412 <refsect2 id="lgl-xml-set-default-units" role="function">
413 <title>lgl_xml_set_default_units ()</title>
414 <indexterm zone="lgl-xml-set-default-units"><primary sortas="lgl_xml_set_default_units">lgl_xml_set_default_units</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_set_default_units           (<link linkend="lglUnitsType">lglUnitsType</link> units);</programlisting>
415 <para>
416 Set the default units when formatting lengths.  See
417 <link linkend="lgl-xml-set-prop-length"><function>lgl_xml_set_prop_length()</function></link>.</para>
418 <para>
419 </para><variablelist role="params">
420 <varlistentry><term><parameter>units</parameter>&#160;:</term>
421 <listitem><simpara>       default units selection (<link linkend="lglUnitsType"><type>lglUnitsType</type></link>)
422 </simpara></listitem></varlistentry>
423 </variablelist></refsect2>
424
425 </refsect1>
426
427
428
429
430 </refentry>