X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Flibglabels%2Fhtml%2Flibglabels-3.0-xml.html;fp=docs%2Flibglabels%2Fhtml%2Flibglabels-3.0-xml.html;h=e33b860ba7d013f1620b8bb3b3c72d14378ad4e9;hb=0be9b6d8653b1020e466541b890e97a03590f83b;hp=f4b04aece48aca05cf21bec1d26611e62a67947a;hpb=8e4c50283c4f353b18c68474f91209b8bd050557;p=glabels diff --git a/docs/libglabels/html/libglabels-3.0-xml.html b/docs/libglabels/html/libglabels-3.0-xml.html index f4b04aec..e33b860b 100644 --- a/docs/libglabels/html/libglabels-3.0-xml.html +++ b/docs/libglabels/html/libglabels-3.0-xml.html @@ -2,21 +2,20 @@ -LibGlabels 3.0 Reference Manual: XML Helper Functions +XML Helper Functions: LibGlabels 3.0 Reference Manual - + - + @@ -42,7 +41,7 @@
-

Object Hierarchy

-
-
-
-

Includes

#include <libglabels/lgl-xml.h>
@@ -208,13 +202,13 @@ These functions are basically wrappers to functions from libxml2.

Functions

lgl_xml_get_prop_string ()

-
gchar *
+
gchar *
 lgl_xml_get_prop_string (xmlNodePtr node,
-                         const gchar *property,
-                         const gchar *default_val);

+                         const gchar *property,
+                         const gchar *default_val);

Return value of property as a string.

-

Parameters

+

Parameters

@@ -241,22 +235,21 @@ lgl_xml_get_prop_string (xmlNodeP
-

Returns

+

Returns

the property as a pointer to a gchar string. This string should -be freed with g_free().

-

+be freed with g_free().

lgl_xml_get_prop_i18n_string ()

-
gchar *
+
gchar *
 lgl_xml_get_prop_i18n_string (xmlNodePtr node,
-                              const gchar *property,
-                              const gchar *default_val);

+                              const gchar *property,
+                              const gchar *default_val);

Return value of a translatable property as a string.

-

Parameters

+

Parameters

@@ -283,22 +276,21 @@ lgl_xml_get_prop_i18n_string (xml
-

Returns

+

Returns

the property as a pointer to a gchar string. This string should -be freed with g_free().

-

+be freed with g_free().

lgl_xml_get_prop_double ()

-
gdouble
+
gdouble
 lgl_xml_get_prop_double (xmlNodePtr node,
-                         const gchar *property,
-                         gdouble default_val);

+                         const gchar *property,
+                         gdouble default_val);

Return value of property as a double.

-

Parameters

+

Parameters

@@ -325,21 +317,20 @@ lgl_xml_get_prop_double (xmlNodeP
-

Returns

+

Returns

the property as a double.

-

lgl_xml_get_prop_boolean ()

-
gboolean
+
gboolean
 lgl_xml_get_prop_boolean (xmlNodePtr node,
-                          const gchar *property,
-                          gboolean default_val);

+                          const gchar *property,
+                          gboolean default_val);

Return value of property as a boolean.

-

Parameters

+

Parameters

@@ -366,21 +357,20 @@ lgl_xml_get_prop_boolean (xmlNode
-

Returns

+

Returns

the property as a boolean.

-

lgl_xml_get_prop_int ()

-
gint
+
gint
 lgl_xml_get_prop_int (xmlNodePtr node,
-                      const gchar *property,
-                      gint default_val);

+                      const gchar *property,
+                      gint default_val);

Return value of property as an integer.

-

Parameters

+

Parameters

@@ -407,21 +397,20 @@ lgl_xml_get_prop_int (xmlNodePtr<
-

Returns

+

Returns

the property as an integer.

-

lgl_xml_get_prop_uint ()

-
guint
+
guint
 lgl_xml_get_prop_uint (xmlNodePtr node,
-                       const gchar *property,
-                       guint default_val);

+                       const gchar *property,
+                       guint default_val);

Return value of property (usually formatted in hex) as an unsigned integer.

-

Parameters

+

Parameters

@@ -448,18 +437,17 @@ lgl_xml_get_prop_uint (xmlNodePtr
-

Returns

+

Returns

the property as an unsigned integer.

-

lgl_xml_get_prop_length ()

-
gdouble
+
gdouble
 lgl_xml_get_prop_length (xmlNodePtr node,
-                         const gchar *property,
-                         gdouble default_val);

+                         const gchar *property,
+                         gdouble default_val);

Return value of a length property as a double, converting to internal units (points). The property is expected to be formatted as a number followed by a units string. If there is no units string, the length @@ -467,7 +455,7 @@ is assumed to be in points. Valid units strings are "pt" for points, "in" for inches, "mm" for millimeters, "cm" for centimeters, and "pc" for picas.

-

Parameters

+

Parameters

@@ -494,9 +482,8 @@ is assumed to be in points. Valid units strings are "pt" for points,
-

Returns

+

Returns

the length in points.

-

@@ -504,11 +491,11 @@ is assumed to be in points. Valid units strings are "pt" for points,

lgl_xml_set_prop_string ()

void
 lgl_xml_set_prop_string (xmlNodePtr node,
-                         const gchar *property,
-                         const gchar *val);
+ const gchar *property, + const gchar *val);

Set a property from a string.

-

Parameters

+

Parameters

@@ -540,11 +527,11 @@ lgl_xml_set_prop_string (xmlNodeP

lgl_xml_set_prop_double ()

void
 lgl_xml_set_prop_double (xmlNodePtr node,
-                         const gchar *property,
-                         gdouble val);
+ const gchar *property, + gdouble val);

Set a property from a double.

-

Parameters

+

Parameters

@@ -576,11 +563,11 @@ lgl_xml_set_prop_double (xmlNodeP

lgl_xml_set_prop_boolean ()

void
 lgl_xml_set_prop_boolean (xmlNodePtr node,
-                          const gchar *property,
-                          gboolean val);
+ const gchar *property, + gboolean val);

Set a property from a boolean.

-

Parameters

+

Parameters

@@ -612,11 +599,11 @@ lgl_xml_set_prop_boolean (xmlNode

lgl_xml_set_prop_int ()

void
 lgl_xml_set_prop_int (xmlNodePtr node,
-                      const gchar *property,
-                      gint val);
+ const gchar *property, + gint val);

Set a property from an integer.

-

Parameters

+

Parameters

@@ -648,11 +635,11 @@ lgl_xml_set_prop_int (xmlNodePtr<

lgl_xml_set_prop_uint_hex ()

void
 lgl_xml_set_prop_uint_hex (xmlNodePtr node,
-                           const gchar *property,
-                           guint val);
+ const gchar *property, + guint val);

Set a property from an unsigned integer and format in hex.

-

Parameters

+

Parameters

@@ -684,14 +671,14 @@ lgl_xml_set_prop_uint_hex (xmlNod

lgl_xml_set_prop_length ()

void
 lgl_xml_set_prop_length (xmlNodePtr node,
-                         const gchar *property,
-                         gdouble val);
+ const gchar *property, + gdouble val);

Set a property from a length, performing any necessary conversion. Length properties are formatted as a number followed by a units string. The units of the formatted property is determined by the most recent call to lgl_xml_set_default_units().

-

Parameters

+

Parameters

@@ -721,12 +708,12 @@ The units of the formatted property is determined by the most recent call to

lgl_xml_is_node ()

-
gboolean
+
gboolean
 lgl_xml_is_node (xmlNodePtr node,
-                 const gchar *name);

+                 const gchar *name);

Test if a node name matches given name.

-

Parameters

+

Parameters

@@ -748,19 +735,18 @@ lgl_xml_is_node (xmlNodePtr
-

Returns

+

Returns

TRUE if the name of the node matches. Otherwise FALSE.

-

lgl_xml_get_node_content ()

-
gchar *
+
gchar *
 lgl_xml_get_node_content (xmlNodePtr node);

 
Get the content of a node.

 

-
Parameters

+
Parameters
@@ -775,10 +761,9 @@ lgl_xml_get_node_content (xmlNode
-

Returns

+

Returns

the property as a pointer to a gchar string. This string should -be freed with g_free().

-

+be freed with g_free().

@@ -789,7 +774,7 @@ lgl_xml_set_default_units (lgl_xml_set_prop_length().

-

Parameters

+

Parameters

@@ -817,7 +802,6 @@ lgl_xml_set_default_units ( -
- Generated by GTK-Doc V1.20 +
Generated by GTK-Doc V1.24 \ No newline at end of file