File: xml.xml

package info (click to toggle)
libgsf 1.14.8-1lenny2
links: PTS, VCS
area: main
in suites: lenny
size: 4,984 kB
ctags: 3,344
sloc: ansic: 18,428; sh: 9,392; xml: 6,653; makefile: 496; perl: 35; python: 13
file content (1037 lines) | stat: -rw-r--r-- 61,004 bytes
<refentry id="gsf-XML-and-libxml">
<refmeta>
<refentrytitle role="top_of_page">XML and libxml</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GSF Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>XML and libxml</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="GsfXMLOut"/>
<synopsis>




                    <link linkend="GsfXMLIn">GsfXMLIn</link>;
                    <link linkend="GsfXMLInDoc">GsfXMLInDoc</link>;
<link linkend="gboolean">gboolean</link>            (<link linkend="GsfXMLInUnknownFunc">*GsfXMLInUnknownFunc</link>)              (<link linkend="GsfXMLIn">GsfXMLIn</link> *xin,
                                                         <link linkend="xmlChar">xmlChar</link> const *elem,
                                                         <link linkend="xmlChar">xmlChar</link> const **attrs);
                    <link linkend="GsfXMLInNS">GsfXMLInNS</link>;
                    <link linkend="GsfXMLInNode">GsfXMLInNode</link>;
<link linkend="void">void</link>                (<link linkend="GsfXMLInExtDtor">*GsfXMLInExtDtor</link>)                  (<link linkend="GsfXMLIn">GsfXMLIn</link> *xin,
                                                         <link linkend="gpointer">gpointer</link> old_state);
enum                <link linkend="GsfXMLContent">GsfXMLContent</link>;
                    <link linkend="GsfXMLBlob">GsfXMLBlob</link>;
                    <link linkend="GsfInputHTTP">GsfInputHTTP</link>;
#define             <link linkend="GSF-XML-IN-NODE-FULL:CAPS">GSF_XML_IN_NODE_FULL</link>                (parent_id, id, ns, name, has_content, 	
                                                         			     share_children_with_parent, check_ns, start, end, user)
#define             <link linkend="GSF-XML-IN-NODE:CAPS">GSF_XML_IN_NODE</link>                     (parent_id, id, ns, name, has_content, start, end)
#define             <link linkend="GSF-XML-IN-NODE-END:CAPS">GSF_XML_IN_NODE_END</link>
#define             <link linkend="GSF-XML-IN-NS:CAPS">GSF_XML_IN_NS</link>                       (id, uri)
#define             <link linkend="GSF-XML-IN-NS-END:CAPS">GSF_XML_IN_NS_END</link>
<link linkend="GsfXMLInDoc">GsfXMLInDoc</link>*        <link linkend="gsf-xml-in-doc-new">gsf_xml_in_doc_new</link>                  (<link linkend="GsfXMLInNode">GsfXMLInNode</link> const *nodes,
                                                         <link linkend="GsfXMLInNS">GsfXMLInNS</link> const *ns);
<link linkend="void">void</link>                <link linkend="gsf-xml-in-doc-free">gsf_xml_in_doc_free</link>                 (<link linkend="GsfXMLInDoc">GsfXMLInDoc</link> *doc);
<link linkend="gboolean">gboolean</link>            <link linkend="gsf-xml-in-doc-parse">gsf_xml_in_doc_parse</link>                (<link linkend="GsfXMLInDoc">GsfXMLInDoc</link> *doc,
                                                         <link linkend="GsfInput">GsfInput</link> *input,
                                                         <link linkend="gpointer">gpointer</link> user_state);
<link linkend="void">void</link>                <link linkend="gsf-xml-in-doc-set-unknown-handler">gsf_xml_in_doc_set_unknown_handler</link>  (<link linkend="GsfXMLInDoc">GsfXMLInDoc</link> *doc,
                                                         <link linkend="GsfXMLInUnknownFunc">GsfXMLInUnknownFunc</link> handler);
<link linkend="void">void</link>                <link linkend="gsf-xml-in-push-state">gsf_xml_in_push_state</link>               (<link linkend="GsfXMLIn">GsfXMLIn</link> *xin,
                                                         <link linkend="GsfXMLInDoc">GsfXMLInDoc</link> const *doc,
                                                         <link linkend="gpointer">gpointer</link> new_state,
                                                         <link linkend="GsfXMLInExtDtor">GsfXMLInExtDtor</link> dtor,
                                                         <link linkend="xmlChar">xmlChar</link> const **attrs);
<link linkend="gboolean">gboolean</link>            <link linkend="gsf-xml-in-namecmp">gsf_xml_in_namecmp</link>                  (<link linkend="GsfXMLIn">GsfXMLIn</link> const *xin,
                                                         <link linkend="char">char</link> const *str,
                                                         unsigned <link linkend="int">int</link> ns_id,
                                                         <link linkend="char">char</link> const *name);
<link linkend="char">char</link>const  *        <link linkend="gsf-xml-in-check-ns">gsf_xml_in_check_ns</link>                 (<link linkend="GsfXMLIn">GsfXMLIn</link> const *xin,
                                                         <link linkend="char">char</link> const *str,
                                                         unsigned <link linkend="int">int</link> ns_id);
<link linkend="GsfInput">GsfInput</link>*           <link linkend="gsf-xml-in-get-input">gsf_xml_in_get_input</link>                (<link linkend="GsfXMLIn">GsfXMLIn</link> const *xin);

                    <link linkend="GsfXMLOut-struct">GsfXMLOut</link>;
<link linkend="GsfXMLOut">GsfXMLOut</link>*          <link linkend="gsf-xml-out-new">gsf_xml_out_new</link>                     (<link linkend="GsfOutput">GsfOutput</link> *output);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-set-doc-type">gsf_xml_out_set_doc_type</link>            (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *type);
<link linkend="GsfOutput">GsfOutput</link>*          <link linkend="gsf-xml-out-get-output">gsf_xml_out_get_output</link>              (<link linkend="GsfXMLOut">GsfXMLOut</link> const *xout);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-start-element">gsf_xml_out_start_element</link>           (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id);
<link linkend="char">char</link>const *         <link linkend="gsf-xml-out-end-element">gsf_xml_out_end_element</link>             (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-cstr">gsf_xml_out_add_cstr</link>                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="char">char</link> const *val_utf8);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-cstr-unchecked">gsf_xml_out_add_cstr_unchecked</link>      (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="char">char</link> const *val_utf8);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-bool">gsf_xml_out_add_bool</link>                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="gboolean">gboolean</link> val);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-int">gsf_xml_out_add_int</link>                 (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="int">int</link> val);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-uint">gsf_xml_out_add_uint</link>                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         unsigned <link linkend="int">int</link> val);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-float">gsf_xml_out_add_float</link>               (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="double">double</link> val,
                                                         <link linkend="int">int</link> precision);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-enum">gsf_xml_out_add_enum</link>                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="GType">GType</link> etype,
                                                         <link linkend="gint">gint</link> val);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-color">gsf_xml_out_add_color</link>               (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         unsigned <link linkend="int">int</link> r,
                                                         unsigned <link linkend="int">int</link> g,
                                                         unsigned <link linkend="int">int</link> b);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-base64">gsf_xml_out_add_base64</link>              (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="guint8">guint8</link> const *data,
                                                         unsigned <link linkend="int">int</link> len);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-add-gvalue">gsf_xml_out_add_gvalue</link>              (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="GValue">GValue</link> const *val);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-simple-element">gsf_xml_out_simple_element</link>          (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="char">char</link> const *content);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-simple-float-element">gsf_xml_out_simple_float_element</link>    (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="double">double</link> val,
                                                         <link linkend="int">int</link> precision);
<link linkend="void">void</link>                <link linkend="gsf-xml-out-simple-int-element">gsf_xml_out_simple_int_element</link>      (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="int">int</link> val);

<link linkend="gchar">gchar</link>*              <link linkend="gsf-input-http-get-content-type">gsf_input_http_get_content_type</link>     (<link linkend="GsfInputHTTP">GsfInputHTTP</link> *input);
<link linkend="GType">GType</link>               <link linkend="gsf-input-http-get-type">gsf_input_http_get_type</link>             (void);
<link linkend="gchar">gchar</link>*              <link linkend="gsf-input-http-get-url">gsf_input_http_get_url</link>              (<link linkend="GsfInputHTTP">GsfInputHTTP</link> *input);

<link linkend="xmlParserCtxt">xmlParserCtxt</link>*      <link linkend="gsf-xml-parser-context">gsf_xml_parser_context</link>              (<link linkend="GsfInput">GsfInput</link> *input);
<link linkend="gboolean">gboolean</link>            <link linkend="gsf-xml-gvalue-from-str">gsf_xml_gvalue_from_str</link>             (<link linkend="GValue">GValue</link> *res,
                                                         <link linkend="GType">GType</link> t,
                                                         <link linkend="char">char</link> const *str);
<link linkend="int">int</link>                 <link linkend="gsf-xmlDocFormatDump">gsf_xmlDocFormatDump</link>                (<link linkend="GsfOutput">GsfOutput</link> *output,
                                                         <link linkend="xmlDoc">xmlDoc</link> *cur,
                                                         <link linkend="char">char</link> const *encoding,
                                                         <link linkend="gboolean">gboolean</link> format);

</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----GsfXMLOut
</synopsis>

</refsect1>





<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>

  &quot;<link linkend="GsfXMLOut--pretty-print">pretty-print</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
</synopsis>
</refsect1>



<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GsfXMLIn" role="struct"/>GsfXMLIn</title>
<indexterm><primary>GsfXMLIn</primary></indexterm><programlisting>typedef struct {
	/* public state : read only */
	gpointer	    user_state;
	GString		   *content;
	GsfXMLInDoc  const *doc;
	GsfXMLInNode const *node;	/* current node (not on the stack) */
	GSList	 	   *node_stack;	/* stack of GsfXMLInNode */
} GsfXMLIn;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GsfXMLInDoc" role="struct"/>GsfXMLInDoc</title>
<indexterm><primary>GsfXMLInDoc</primary></indexterm><programlisting>typedef struct _GsfXMLInDoc GsfXMLInDoc;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GsfXMLInUnknownFunc" role="function"/>GsfXMLInUnknownFunc ()</title>
<indexterm><primary>GsfXMLInUnknownFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*GsfXMLInUnknownFunc)              (<link linkend="GsfXMLIn">GsfXMLIn</link> *xin,
                                                         <link linkend="xmlChar">xmlChar</link> const *elem,
                                                         <link linkend="xmlChar">xmlChar</link> const **attrs);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>elem</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attrs</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfXMLInNS" role="struct"/>GsfXMLInNS</title>
<indexterm><primary>GsfXMLInNS</primary></indexterm><programlisting>typedef struct {
	char const *uri;
	unsigned    ns_id;
} GsfXMLInNS;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GsfXMLInNode" role="struct"/>GsfXMLInNode</title>
<indexterm><primary>GsfXMLInNode</primary></indexterm><programlisting>typedef struct {
	char const *id;		/* unique in the entire tree */
	int	    ns_id;
	char const *name;
	char const *parent_id;
	void (*start) (GsfXMLIn *xin, xmlChar const **attrs);
	void (*end)   (GsfXMLIn *xin, GsfXMLBlob *unknown);

	union {
		int	    v_int;
		gboolean    v_bool;
		gpointer    v_blob;
		char const *v_str;
	} user_data;
	GsfXMLContent has_content;

	unsigned int check_children_for_ns : 1;
	unsigned int share_children_with_parent : 1;
} GsfXMLInNode;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GsfXMLInExtDtor" role="function"/>GsfXMLInExtDtor ()</title>
<indexterm><primary>GsfXMLInExtDtor</primary></indexterm><programlisting><link linkend="void">void</link>                (*GsfXMLInExtDtor)                  (<link linkend="GsfXMLIn">GsfXMLIn</link> *xin,
                                                         <link linkend="gpointer">gpointer</link> old_state);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>old_state</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfXMLContent" role="enum"/>enum GsfXMLContent</title>
<indexterm><primary>GsfXMLContent</primary></indexterm><programlisting>typedef enum {
	GSF_XML_NO_CONTENT = FALSE,
	GSF_XML_CONTENT,
	GSF_XML_SHARED_CONTENT
} GsfXMLContent;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GsfXMLBlob" role="struct"/>GsfXMLBlob</title>
<indexterm><primary>GsfXMLBlob</primary></indexterm><programlisting>typedef struct _GsfXMLBlob GsfXMLBlob;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GsfInputHTTP" role="struct"/>GsfInputHTTP</title>
<indexterm><primary>GsfInputHTTP</primary></indexterm><programlisting>typedef struct _GsfInputHTTP GsfInputHTTP;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GSF-XML-IN-NODE-FULL:CAPS" role="macro"/>GSF_XML_IN_NODE_FULL()</title>
<indexterm><primary>GSF_XML_IN_NODE_FULL</primary></indexterm><programlisting>#define             GSF_XML_IN_NODE_FULL(parent_id, id, ns, name, has_content, 	\
            			     share_children_with_parent, check_ns, start, end, user)</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent_id</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>has_content</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>share_children_with_parent</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>check_ns</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GSF-XML-IN-NODE:CAPS" role="macro"/>GSF_XML_IN_NODE()</title>
<indexterm><primary>GSF_XML_IN_NODE</primary></indexterm><programlisting>#define             GSF_XML_IN_NODE(parent_id, id, ns, name, has_content, start, end)</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>parent_id</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>has_content</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GSF-XML-IN-NODE-END:CAPS" role="macro"/>GSF_XML_IN_NODE_END</title>
<indexterm><primary>GSF_XML_IN_NODE_END</primary></indexterm><programlisting>#define             GSF_XML_IN_NODE_END</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GSF-XML-IN-NS:CAPS" role="macro"/>GSF_XML_IN_NS()</title>
<indexterm><primary>GSF_XML_IN_NS</primary></indexterm><programlisting>#define             GSF_XML_IN_NS(id, uri)</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GSF-XML-IN-NS-END:CAPS" role="macro"/>GSF_XML_IN_NS_END</title>
<indexterm><primary>GSF_XML_IN_NS_END</primary></indexterm><programlisting>#define             GSF_XML_IN_NS_END</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-doc-new" role="function"/>gsf_xml_in_doc_new ()</title>
<indexterm><primary>gsf_xml_in_doc_new</primary></indexterm><programlisting><link linkend="GsfXMLInDoc">GsfXMLInDoc</link>*        gsf_xml_in_doc_new                  (<link linkend="GsfXMLInNode">GsfXMLInNode</link> const *nodes,
                                                         <link linkend="GsfXMLInNS">GsfXMLInNS</link> const *ns);</programlisting>
<para>
Combine the nodes in the <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array starting at <parameter>nodes</parameter> with the
name spaces in the <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated array starting at <parameter>ns</parameter>.  Prepare the
data structures necessary to validate a doument based on that description.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>nodes</parameter>&nbsp;:</term>
<listitem><simpara> an array of node descriptors
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns</parameter>&nbsp;:</term>
<listitem><simpara> an array of namespace identifiers
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-doc-free" role="function"/>gsf_xml_in_doc_free ()</title>
<indexterm><primary>gsf_xml_in_doc_free</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_in_doc_free                 (<link linkend="GsfXMLInDoc">GsfXMLInDoc</link> *doc);</programlisting>
<para>
Free up resources</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>doc</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLInDoc"><type>GsfXMLInDoc</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-doc-parse" role="function"/>gsf_xml_in_doc_parse ()</title>
<indexterm><primary>gsf_xml_in_doc_parse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gsf_xml_in_doc_parse                (<link linkend="GsfXMLInDoc">GsfXMLInDoc</link> *doc,
                                                         <link linkend="GsfInput">GsfInput</link> *input,
                                                         <link linkend="gpointer">gpointer</link> user_state);</programlisting>
<para>
Read an xml document from <parameter>input</parameter> and parse based on the the descriptor in
<parameter>doc</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>doc</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLInDoc"><type>GsfXMLInDoc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>input</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfInput"><type>GsfInput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_state</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-doc-set-unknown-handler" role="function"/>gsf_xml_in_doc_set_unknown_handler ()</title>
<indexterm><primary>gsf_xml_in_doc_set_unknown_handler</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_in_doc_set_unknown_handler  (<link linkend="GsfXMLInDoc">GsfXMLInDoc</link> *doc,
                                                         <link linkend="GsfXMLInUnknownFunc">GsfXMLInUnknownFunc</link> handler);</programlisting>
<para>
Call the function <parameter>handler</parameter> when an unexpected child node is found</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>doc</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLInDoc"><type>GsfXMLInDoc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>handler</parameter>&nbsp;:</term>
<listitem><simpara> The function to call
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-push-state" role="function"/>gsf_xml_in_push_state ()</title>
<indexterm><primary>gsf_xml_in_push_state</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_in_push_state               (<link linkend="GsfXMLIn">GsfXMLIn</link> *xin,
                                                         <link linkend="GsfXMLInDoc">GsfXMLInDoc</link> const *doc,
                                                         <link linkend="gpointer">gpointer</link> new_state,
                                                         <link linkend="GsfXMLInExtDtor">GsfXMLInExtDtor</link> dtor,
                                                         <link linkend="xmlChar">xmlChar</link> const **attrs);</programlisting>
<para>
Take the first node from <parameter>doc</parameter> as the current node and call it's start handler.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xin</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLIn"><type>GsfXMLIn</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>doc</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLInDoc"><type>GsfXMLInDoc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_state</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dtor</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLInExtDtor"><type>GsfXMLInExtDtor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attrs</parameter>&nbsp;:</term>
<listitem><simpara> array of xmlChar const *
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-namecmp" role="function"/>gsf_xml_in_namecmp ()</title>
<indexterm><primary>gsf_xml_in_namecmp</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gsf_xml_in_namecmp                  (<link linkend="GsfXMLIn">GsfXMLIn</link> const *xin,
                                                         <link linkend="char">char</link> const *str,
                                                         unsigned <link linkend="int">int</link> ns_id,
                                                         <link linkend="char">char</link> const *name);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xin</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GsfXMLIn"><type>GsfXMLIn</type></link> we are reading from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> The potentially namespace qualified node name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns_id</parameter>&nbsp;:</term>
<listitem><simpara> The name space id to check
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> The target node name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>str</parameter> == <parameter>ns_id</parameter>:<parameter>name</parameter> according to <parameter>state</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-check-ns" role="function"/>gsf_xml_in_check_ns ()</title>
<indexterm><primary>gsf_xml_in_check_ns</primary></indexterm><programlisting><link linkend="char">char</link>const  *        gsf_xml_in_check_ns                 (<link linkend="GsfXMLIn">GsfXMLIn</link> const *xin,
                                                         <link linkend="char">char</link> const *str,
                                                         unsigned <link linkend="int">int</link> ns_id);</programlisting>
<para>
According to <parameter>state</parameter> is <parameter>str</parameter> in the namespace <parameter>ns_id</parameter> ?</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xin</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLIn"><type>GsfXMLIn</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns_id</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to <parameter>str</parameter> after the namespace if successful,
	otherwise NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-in-get-input" role="function"/>gsf_xml_in_get_input ()</title>
<indexterm><primary>gsf_xml_in_get_input</primary></indexterm><programlisting><link linkend="GsfInput">GsfInput</link>*           gsf_xml_in_get_input                (<link linkend="GsfXMLIn">GsfXMLIn</link> const *xin);</programlisting>
<para>
(New in 1.14.2)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xin</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLIn"><type>GsfXMLIn</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> (but does not reference) the stream being parsed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GsfXMLOut-struct" role="struct"/>GsfXMLOut</title>
<indexterm><primary>GsfXMLOut</primary></indexterm><programlisting>typedef struct _GsfXMLOut GsfXMLOut;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-new" role="function"/>gsf_xml_out_new ()</title>
<indexterm><primary>gsf_xml_out_new</primary></indexterm><programlisting><link linkend="GsfXMLOut">GsfXMLOut</link>*          gsf_xml_out_new                     (<link linkend="GsfOutput">GsfOutput</link> *output);</programlisting>
<para>
Create an XML output stream.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfOutput"><type>GsfOutput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-set-doc-type" role="function"/>gsf_xml_out_set_doc_type ()</title>
<indexterm><primary>gsf_xml_out_set_doc_type</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_set_doc_type            (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *type);</programlisting>
<para>
Store some optional some &lt;!DOCTYPE .. &gt; content</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> the document type declaration
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-get-output" role="function"/>gsf_xml_out_get_output ()</title>
<indexterm><primary>gsf_xml_out_get_output</primary></indexterm><programlisting><link linkend="GsfOutput">GsfOutput</link>*          gsf_xml_out_get_output              (<link linkend="GsfXMLOut">GsfXMLOut</link> const *xout);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-start-element" role="function"/>gsf_xml_out_start_element ()</title>
<indexterm><primary>gsf_xml_out_start_element</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_start_element           (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id);</programlisting>
<para>
Output a start element <parameter>id</parameter>, if necessary preceeded by an XML declaration.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> Element name
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-end-element" role="function"/>gsf_xml_out_end_element ()</title>
<indexterm><primary>gsf_xml_out_end_element</primary></indexterm><programlisting><link linkend="char">char</link>const *         gsf_xml_out_end_element             (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout);</programlisting>
<para>
Closes/ends an XML element.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the element that has been closed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-cstr" role="function"/>gsf_xml_out_add_cstr ()</title>
<indexterm><primary>gsf_xml_out_add_cstr</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_cstr                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="char">char</link> const *val_utf8);</programlisting>
<para>
dump <parameter>val_utf8</parameter> to an attribute named <parameter>id</parameter> or as the nodes content escaping
characters as necessary.  If <parameter>val_utf8</parameter> is NULL do nothing (no warning, no
output)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val_utf8</parameter>&nbsp;:</term>
<listitem><simpara> a utf8 encoded string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-cstr-unchecked" role="function"/>gsf_xml_out_add_cstr_unchecked ()</title>
<indexterm><primary>gsf_xml_out_add_cstr_unchecked</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_cstr_unchecked      (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="char">char</link> const *val_utf8);</programlisting>
<para>
dump <parameter>val_utf8</parameter> to an attribute named <parameter>id</parameter> without checking to see if the
content needs escaping.  A useful performance enhancement when the
application knows that structure of the content well.  If <parameter>val_utf8</parameter> is NULL
do nothing (no warning, no output)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val_utf8</parameter>&nbsp;:</term>
<listitem><simpara> a utf8 encoded string to export
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-bool" role="function"/>gsf_xml_out_add_bool ()</title>
<indexterm><primary>gsf_xml_out_add_bool</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_bool                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="gboolean">gboolean</link> val);</programlisting>
<para>
dump boolean value <parameter>val</parameter> to an attribute named <parameter>id</parameter> or as the nodes content
Use '1' or '0' to simplify import</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> a boolean
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-int" role="function"/>gsf_xml_out_add_int ()</title>
<indexterm><primary>gsf_xml_out_add_int</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_int                 (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="int">int</link> val);</programlisting>
<para>
dump integer value <parameter>val</parameter> to an attribute named <parameter>id</parameter> or as the nodes content</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> the value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-uint" role="function"/>gsf_xml_out_add_uint ()</title>
<indexterm><primary>gsf_xml_out_add_uint</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_uint                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         unsigned <link linkend="int">int</link> val);</programlisting>
<para>
dump unsigned integer value <parameter>val</parameter> to an attribute named <parameter>id</parameter> or as the nodes
content</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> the value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-float" role="function"/>gsf_xml_out_add_float ()</title>
<indexterm><primary>gsf_xml_out_add_float</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_float               (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="double">double</link> val,
                                                         <link linkend="int">int</link> precision);</programlisting>
<para>
dump float value <parameter>val</parameter> to an attribute named <parameter>id</parameter> or as the nodes
content with precision <parameter>precision</parameter>.  The number will be formattted
according to the "C" locale.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> the value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>precision</parameter>&nbsp;:</term>
<listitem><simpara> the number of significant digits to use, -1 meaning "enough".
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-enum" role="function"/>gsf_xml_out_add_enum ()</title>
<indexterm><primary>gsf_xml_out_add_enum</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_enum                (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="GType">GType</link> etype,
                                                         <link linkend="gint">gint</link> val);</programlisting>
<para>
Output the name of value <parameter>val</parameter> of enumeration type <parameter>etype</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>etype</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GType"><type>GType</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> enum element number
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-color" role="function"/>gsf_xml_out_add_color ()</title>
<indexterm><primary>gsf_xml_out_add_color</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_color               (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         unsigned <link linkend="int">int</link> r,
                                                         unsigned <link linkend="int">int</link> g,
                                                         unsigned <link linkend="int">int</link> b);</programlisting>
<para>
dump Color <parameter>r</parameter>.<parameter>g</parameter>.<parameter>b</parameter> to an attribute named <parameter>id</parameter> or as the nodes content</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>r</parameter>&nbsp;:</term>
<listitem><simpara> Red value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>g</parameter>&nbsp;:</term>
<listitem><simpara> Green value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter>&nbsp;:</term>
<listitem><simpara> Blue value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-base64" role="function"/>gsf_xml_out_add_base64 ()</title>
<indexterm><primary>gsf_xml_out_add_base64</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_base64              (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="guint8">guint8</link> const *data,
                                                         unsigned <link linkend="int">int</link> len);</programlisting>
<para>
dump <parameter>len</parameter> bytes in <parameter>data</parameter> into the content of node <parameter>id</parameter> using base64</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> Data to be written
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
<listitem><simpara> Length of data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-add-gvalue" role="function"/>gsf_xml_out_add_gvalue ()</title>
<indexterm><primary>gsf_xml_out_add_gvalue</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_add_gvalue              (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="GValue">GValue</link> const *val);</programlisting>
<para>
Output the value of <parameter>val</parameter> as a string.  Does NOT store any type information
with the string, just thevalue.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> optionally NULL for content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GValue"><type>GValue</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-simple-element" role="function"/>gsf_xml_out_simple_element ()</title>
<indexterm><primary>gsf_xml_out_simple_element</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_simple_element          (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="char">char</link> const *content);</programlisting>
<para>
Convenience routine to output a simple <parameter>id</parameter> element with content <parameter>content</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> Element name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content</parameter>&nbsp;:</term>
<listitem><simpara> Content of the element
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-simple-float-element" role="function"/>gsf_xml_out_simple_float_element ()</title>
<indexterm><primary>gsf_xml_out_simple_float_element</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_simple_float_element    (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="double">double</link> val,
                                                         <link linkend="int">int</link> precision);</programlisting>
<para>
Convenience routine to output an element <parameter>id</parameter> with float value <parameter>val</parameter> using
<parameter>precision</parameter> significant digits.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> Element name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> Element value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>precision</parameter>&nbsp;:</term>
<listitem><simpara> the number of significant digits to use, -1 meaning "enough".
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-out-simple-int-element" role="function"/>gsf_xml_out_simple_int_element ()</title>
<indexterm><primary>gsf_xml_out_simple_int_element</primary></indexterm><programlisting><link linkend="void">void</link>                gsf_xml_out_simple_int_element      (<link linkend="GsfXMLOut">GsfXMLOut</link> *xout,
                                                         <link linkend="char">char</link> const *id,
                                                         <link linkend="int">int</link> val);</programlisting>
<para>
Convenience routine to output an element <parameter>id</parameter> with integer value <parameter>val</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xout</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfXMLOut"><type>GsfXMLOut</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> Element name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> Element value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-http-get-content-type" role="function"/>gsf_input_http_get_content_type ()</title>
<indexterm><primary>gsf_input_http_get_content_type</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gsf_input_http_get_content_type     (<link linkend="GsfInputHTTP">GsfInputHTTP</link> *input);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfInputHTTP"><type>GsfInputHTTP</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an allocated string containing the Content-Type field of the HTTP response.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-http-get-type" role="function"/>gsf_input_http_get_type ()</title>
<indexterm><primary>gsf_input_http_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               gsf_input_http_get_type             (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-input-http-get-url" role="function"/>gsf_input_http_get_url ()</title>
<indexterm><primary>gsf_input_http_get_url</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gsf_input_http_get_url              (<link linkend="GsfInputHTTP">GsfInputHTTP</link> *input);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfInputHTTP"><type>GsfInputHTTP</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an allocated string containing the URL used for input.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-parser-context" role="function"/>gsf_xml_parser_context ()</title>
<indexterm><primary>gsf_xml_parser_context</primary></indexterm><programlisting><link linkend="xmlParserCtxt">xmlParserCtxt</link>*      gsf_xml_parser_context              (<link linkend="GsfInput">GsfInput</link> *input);</programlisting>
<para>
Create a libxml2 pull style parser context wrapper around gsf input <parameter>input</parameter>.
This signature will probably change to supply a SAX structure.
</para>
<para>
<note>This adds a reference to <parameter>input</parameter>.</note>
<note>A simple wrapper around a cleaner implementation that will fold in
when we add other api changes.  Its not worth bumping just for this.</note></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>input</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GsfInput"><type>GsfInput</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A parser context or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xml-gvalue-from-str" role="function"/>gsf_xml_gvalue_from_str ()</title>
<indexterm><primary>gsf_xml_gvalue_from_str</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gsf_xml_gvalue_from_str             (<link linkend="GValue">GValue</link> *res,
                                                         <link linkend="GType">GType</link> t,
                                                         <link linkend="char">char</link> const *str);</programlisting>
<para>
Try to parse <parameter>str</parameter> as a value of type <parameter>t</parameter> into <parameter>res</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>res</parameter>&nbsp;:</term>
<listitem><simpara> Result value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>t</parameter>&nbsp;:</term>
<listitem><simpara> Type of data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> Value string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> True when parsing of <parameter>str</parameter> as a value of type <parameter>t</parameter> was succesfull;
false otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gsf-xmlDocFormatDump" role="function"/>gsf_xmlDocFormatDump ()</title>
<indexterm><primary>gsf_xmlDocFormatDump</primary></indexterm><programlisting><link linkend="int">int</link>                 gsf_xmlDocFormatDump                (<link linkend="GsfOutput">GsfOutput</link> *output,
                                                         <link linkend="xmlDoc">xmlDoc</link> *cur,
                                                         <link linkend="char">char</link> const *encoding,
                                                         <link linkend="gboolean">gboolean</link> format);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>output</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cur</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GsfXMLOut--pretty-print"/>The &quot;<literal>pretty-print</literal>&quot; property</title>
<indexterm><primary>GsfXMLOut:pretty-print</primary></indexterm><programlisting>  &quot;pretty-print&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Should the output auto-indent elements to make reading easier.</para><para>Default value: TRUE</para>
</refsect2>

</refsect1>




</refentry>