Debian Codegraph @

tinyxml/docs/classTiXmlDocument.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>TiXmlDocument class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body bgcolor="#ffffff">
6 <!-- Generated by Doxygen 1.2.10 -->
7 <center>
8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
9 <hr><h1>TiXmlDocument Class Reference</h1>Always the top level node.
10 <a href="#_details">More...</a>
11 <p>
12 <code>#include &lt;<a class="el" href="tinyxml_8h-source.html">tinyxml.h</a>&gt;</code>
13 <p>
14 <p>Inheritance diagram for TiXmlDocument::
15 <p><center><img src="classTiXmlDocument.gif" usemap="#TiXmlDocument_map" border="0"></center>
16 <map name="TiXmlDocument_map">
17 <area href="classTiXmlNode.html" alt="TiXmlNode" shape="rect" coords="0,56,99,80">
18 <area href="classTiXmlBase.html" alt="TiXmlBase" shape="rect" coords="0,0,99,24">
19 </map>
20 <a href="classTiXmlDocument-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
22 <tr><td nowrap align=right valign=top><a name="a0" doxytag="TiXmlDocument::TiXmlDocument"></a>
23 &nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a0">TiXmlDocument</a> ()</td></tr>
24 <tr><td>&nbsp;</td><td><font size=-1><em>Create an empty document, that has no name.</em></font><br><br></td></tr>
25 <tr><td nowrap align=right valign=top><a name="a1" doxytag="TiXmlDocument::TiXmlDocument"></a>
26 &nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a1">TiXmlDocument</a> (const std::string &amp;documentName)</td></tr>
27 <tr><td>&nbsp;</td><td><font size=-1><em>Create a document with a name. The name of the document is also the filename of the xml.</em></font><br><br></td></tr>
28 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a3">LoadFile</a> ()</td></tr>
29 <tr><td>&nbsp;</td><td><font size=-1><em>Load a file using the current document value.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
30 <tr><td nowrap align=right valign=top><a name="a4" doxytag="TiXmlDocument::SaveFile"></a>
31 bool&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a4">SaveFile</a> ()</td></tr>
32 <tr><td>&nbsp;</td><td><font size=-1><em>Save a file using the current document value. Returns true if successful.</em></font><br><br></td></tr>
33 <tr><td nowrap align=right valign=top><a name="a5" doxytag="TiXmlDocument::LoadFile"></a>
34 bool&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a5">LoadFile</a> (const std::string &amp;filename)</td></tr>
35 <tr><td>&nbsp;</td><td><font size=-1><em>Load a file using the given filename. Returns true if successful.</em></font><br><br></td></tr>
36 <tr><td nowrap align=right valign=top><a name="a6" doxytag="TiXmlDocument::SaveFile"></a>
37 bool&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a6">SaveFile</a> (const std::string &amp;filename)</td></tr>
38 <tr><td>&nbsp;</td><td><font size=-1><em>Save a file using the given filename. Returns true if successful.</em></font><br><br></td></tr>
39 <tr><td nowrap align=right valign=top><a name="a7" doxytag="TiXmlDocument::Parse"></a>
40 const char *&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a7">Parse</a> (const char *)</td></tr>
41 <tr><td>&nbsp;</td><td><font size=-1><em>Parse the given null terminated block of xml data.</em></font><br><br></td></tr>
42 <tr><td nowrap align=right valign=top><a name="a8" doxytag="TiXmlDocument::Error"></a>
43 bool&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a8">Error</a> ()</td></tr>
44 <tr><td>&nbsp;</td><td><font size=-1><em>If, during parsing, a error occurs, Error will be set to true.</em></font><br><br></td></tr>
45 <tr><td nowrap align=right valign=top><a name="a9" doxytag="TiXmlDocument::ErrorDesc"></a>
46 const std::string &amp;&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a9">ErrorDesc</a> ()</td></tr>
47 <tr><td>&nbsp;</td><td><font size=-1><em>Contains a textual (english) description of the error if one occurs.</em></font><br><br></td></tr>
48 <tr><td nowrap align=right valign=top><a name="a10" doxytag="TiXmlDocument::Print"></a>
49 virtual void&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a10">Print</a> (FILE *fp, int depth=0)</td></tr>
50 <tr><td>&nbsp;</td><td><font size=-1><em>Write the document to a file -- usually invoked by SaveFile.</em></font><br><br></td></tr>
51 <tr><td nowrap align=right valign=top><a name="a11" doxytag="TiXmlDocument::Print"></a>
52 void&nbsp;</td><td valign=bottom><a class="el" href="classTiXmlDocument.html#a11">Print</a> ()</td></tr>
53 <tr><td>&nbsp;</td><td><font size=-1><em>Dump the document to standard out.</em></font><br><br></td></tr>
54 </table>
55 <hr><a name="_details"></a><h2>Detailed Description</h2>
56 Always the top level node.
57 <p>
58 A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.
59 <p>
60 <hr><h2>Member Function Documentation</h2>
61 <a name="a3" doxytag="TiXmlDocument::LoadFile"></a><p>
62 <table width="100%" cellpadding="2" cellspacing="0" border="0">
63 <tr>
64 <td class="md">
65 <table cellpadding="0" cellspacing="0" border="0">
66 <tr>
67 <td class="md" nowrap valign="top"> bool TiXmlDocument::LoadFile </td>
68 <td class="md">(&nbsp;</td>
69 <td class="mdname1">&nbsp; </td>
70 <td class="md">)&nbsp;</td>
71 <td class="md"></td>
72 </tr>
73
74 </table>
75 </td>
76 </tr>
77 </table>
78 <table cellspacing=5 cellpadding=0 border=0>
79 <tr>
80 <td>
81 &nbsp;
82 </td>
83 <td>
84
85 <p>
86 Load a file using the current document value.
87 <p>
88 Returns true if successful. Will delete any existing document data before loading. </td>
89 </tr>
90 </table>
91 <hr>The documentation for this class was generated from the following file:<ul>
92 <li><a class="el" href="tinyxml_8h-source.html">tinyxml.h</a></ul>
93 <hr><address><small>Generated at Sun Aug 26 20:37:31 2001 for TinyXml by
94 <a href="http://www.doxygen.org/index.html">
95 <img src="doxygen.gif" alt="doxygen" align="middle" border=0
96 width=110 height=53></a>1.2.10 written by <a href="mailto:[email protected]">Dimitri van Heesch</a>,
97 &copy;&nbsp;1997-2001</small></address>
98 </body>
99 </html>