1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<refentry id="libgda-GdaXmlDocument">
<refmeta>
<refentrytitle role="top_of_page" id="libgda-GdaXmlDocument.top_of_page">GdaXmlDocument</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GdaXmlDocument</refname>
<refpurpose>Base class for XML document management</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libgda-GdaXmlDocument.synopsis" role="synopsis">
<title role="synopsis.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);
<link linkend="void">void</link> <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);
<link linkend="void">void</link> <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="gboolean">gboolean</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> *uri);
<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 id="libgda-GdaXmlDocument.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libgda-GdaXmlDocument.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="gda-xml-document-new" role="function">
<title>gda_xml_document_new ()</title>
<indexterm zone="gda-xml-document-new"><primary>gda_xml_document_new</primary></indexterm><programlisting><link linkend="GdaXmlDocument">GdaXmlDocument</link>* gda_xml_document_new (const <link linkend="gchar">gchar</link> *root_doc);</programlisting>
<para>
Creates a new <link linkend="GdaXmlDocument"><type>GdaXmlDocument</type></link> object, with a root document of type
<parameter>root_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>root_doc</parameter> :</term>
<listitem><simpara> root document.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-xml-document-construct" role="function">
<title>gda_xml_document_construct ()</title>
<indexterm zone="gda-xml-document-construct"><primary>gda_xml_document_construct</primary></indexterm><programlisting><link linkend="void">void</link> gda_xml_document_construct (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmlfile,
const <link linkend="gchar">gchar</link> *root_doc);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xmlfile</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root_doc</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-xml-document-get-compress-mode" role="function">
<title>gda_xml_document_get_compress_mode ()</title>
<indexterm zone="gda-xml-document-get-compress-mode"><primary>gda_xml_document_get_compress_mode</primary></indexterm><programlisting><link linkend="gint">gint</link> gda_xml_document_get_compress_mode (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xmldoc</parameter> :</term>
<listitem><simpara> a <link linkend="GdaXmlDocument"><type>GdaXmlDocument</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the compression mode being used by the given
XML document.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-xml-document-set-compress-mode" role="function">
<title>gda_xml_document_set_compress_mode ()</title>
<indexterm zone="gda-xml-document-set-compress-mode"><primary>gda_xml_document_set_compress_mode</primary></indexterm><programlisting><link linkend="void">void</link> gda_xml_document_set_compress_mode (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc,
<link linkend="gint">gint</link> mode);</programlisting>
<para>
Sets the compression mode that the given XML document should use.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xmldoc</parameter> :</term>
<listitem><simpara> a <link linkend="GdaXmlDocument"><type>GdaXmlDocument</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> a compression mode.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-xml-document-to-file" role="function">
<title>gda_xml_document_to_file ()</title>
<indexterm zone="gda-xml-document-to-file"><primary>gda_xml_document_to_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gda_xml_document_to_file (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc,
const <link linkend="gchar">gchar</link> *uri);</programlisting>
<para>
Saves the given <link linkend="GdaXmlDocument"><type>GdaXmlDocument</type></link> into a disk file. That is, it
translates the in-memory document structure, transforms it to
XML and saves, in the given file, the resulting XML output.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xmldoc</parameter> :</term>
<listitem><simpara> a <link linkend="GdaXmlDocument"><type>GdaXmlDocument</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> URI of the resulting file.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-xml-document-stringify" role="function">
<title>gda_xml_document_stringify ()</title>
<indexterm zone="gda-xml-document-stringify"><primary>gda_xml_document_stringify</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gda_xml_document_stringify (<link linkend="GdaXmlDocument">GdaXmlDocument</link> *xmldoc);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>xmldoc</parameter> :</term>
<listitem><simpara> a <link linkend="GdaXmlDocument"><type>GdaXmlDocument</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string representation of the given XML document.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
