<refentry id="GdaXmlDocument">
<refmeta>
<refentrytitle>GdaXmlDocument</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA-COMMON Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GdaXmlDocument</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<synopsis>



<link linkend="GdaXmlDocument">GdaXmlDocument</link>* <link linkend="gda-xml-document-new">gda_xml_document_new</link>        (const <link linkend="gchar">gchar</link> *root_doc);
void        <link linkend="gda-xml-document-construct">gda_xml_document_construct</link>      (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmlfile,
                                             const <link linkend="gchar">gchar</link> *root_doc);
<link linkend="gint">gint</link>        <link linkend="gda-xml-document-get-compress-mode">gda_xml_document_get_compress_mode</link>
                                            (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc);
void        <link linkend="gda-xml-document-set-compress-mode">gda_xml_document_set_compress_mode</link>
                                            (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc,
                                             <link linkend="gint">gint</link> mode);
<link linkend="gint">gint</link>        <link linkend="gda-xml-document-to-file">gda_xml_document_to_file</link>        (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc,
                                             const <link linkend="gchar">gchar</link> *filename);
<link linkend="gchar">gchar</link>*      <link linkend="gda-xml-document-stringify">gda_xml_document_stringify</link>      (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GtkObject">GtkObject</link>
   +----GdaXmlDocument
</synopsis>

</refsect1>


<refsect1>
<title>Signal Prototypes</title>
<synopsis>

&quot;<link linkend="GdaXmlDocument-warning">warning</link>&quot;   void        user_function      (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *gdaxmldocument,
                                            <link linkend="gpointer">gpointer</link> arg1,
                                            <link linkend="gpointer">gpointer</link> user_data);
&quot;<link linkend="GdaXmlDocument-error">error</link>&quot;     void        user_function      (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *gdaxmldocument,
                                            <link linkend="gpointer">gpointer</link> arg1,
                                            <link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>


<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gda-xml-document-new">gda_xml_document_new ()</title>
<programlisting><link linkend="GdaXmlDocument">GdaXmlDocument</link>* gda_xml_document_new        (const <link linkend="gchar">gchar</link> *root_doc);</programlisting>
<para>
Create a new <link linkend="GdaXmlDocument">GdaXmlDocument</link> object, with a root document of type <parameter>root_doc</parameter></para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>root_doc</parameter>&nbsp;:</entry>
<entry> root document new
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-xml-document-construct">gda_xml_document_construct ()</title>
<programlisting>void        gda_xml_document_construct      (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmlfile,
                                             const <link linkend="gchar">gchar</link> *root_doc);</programlisting>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>xmlfile</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>root_doc</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-xml-document-get-compress-mode">gda_xml_document_get_compress_mode ()</title>
<programlisting><link linkend="gint">gint</link>        gda_xml_document_get_compress_mode
                                            (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc);</programlisting>
<para>
</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>xmldoc</parameter>&nbsp;:</entry>
<entry> a <link linkend="GdaXmlDocument">GdaXmlDocument</link> object
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>the compression mode being used by the given
XML document
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-xml-document-set-compress-mode">gda_xml_document_set_compress_mode ()</title>
<programlisting>void        gda_xml_document_set_compress_mode
                                            (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc,
                                             <link linkend="gint">gint</link> mode);</programlisting>
<para>
</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>xmldoc</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>mode</parameter>&nbsp;:</entry>
<entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-xml-document-to-file">gda_xml_document_to_file ()</title>
<programlisting><link linkend="gint">gint</link>        gda_xml_document_to_file        (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc,
                                             const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>xmldoc</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>filename</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="gda-xml-document-stringify">gda_xml_document_stringify ()</title>
<programlisting><link linkend="gchar">gchar</link>*      gda_xml_document_stringify      (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc);</programlisting>
<para>
</para>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>xmldoc</parameter>&nbsp;:</entry>
<entry>
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>


</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>

<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="GdaXmlDocument-warning">The &quot;warning&quot; signal</title>
<programlisting>void        user_function                  (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *gdaxmldocument,
                                            <link linkend="gpointer">gpointer</link> arg1,
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>gdaxmldocument</parameter>&nbsp;:</entry>
<entry>the object which received the signal.
</entry></row>
<row><entry align="right"><parameter>arg1</parameter>&nbsp;:</entry>
<entry>

</entry></row>
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
<entry>user data set when the signal handler was connected.</entry></row>
</tbody></tgroup></informaltable></refsect2><refsect2><title><anchor id="GdaXmlDocument-error">The &quot;error&quot; signal</title>
<programlisting>void        user_function                  (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *gdaxmldocument,
                                            <link linkend="gpointer">gpointer</link> arg1,
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>gdaxmldocument</parameter>&nbsp;:</entry>
<entry>the object which received the signal.
</entry></row>
<row><entry align="right"><parameter>arg1</parameter>&nbsp;:</entry>
<entry>

</entry></row>
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
<entry>user data set when the signal handler was connected.</entry></row>
</tbody></tgroup></informaltable></refsect2>
</refsect1>



</refentry>
