<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: iDocument Struct Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>iDocument Struct Reference<br> <small> [<a class="el" href="group__util.html">Utilities</a>]</small> </h1><!-- doxytag: class="iDocument" --><!-- doxytag: inherits="iBase" -->Representation of a document containing a hierarchical structure of nodes. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="document_8h-source.html">iutil/document.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for iDocument:</div> <div class="dynsection"> <p><center><img src="structiDocument__inherit__graph.png" border="0" usemap="#iDocument__inherit__map" alt="Inheritance graph"></center> <map name="iDocument__inherit__map"> <area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="23,7,79,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="structiDocument-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#2d2d1a9f40572e6e4c1704efbfede5f4">Changeable</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns how far this document can be changed. <a href="#2d2d1a9f40572e6e4c1704efbfede5f4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#7a3b311d687285d6252727887996a39b">Clear</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the document. <a href="#7a3b311d687285d6252727887996a39b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br> < <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#e16013f5679cfcd6ed7a23797b7c76de">CreateRoot</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a root node. This will clear the previous root node if any. <a href="#e16013f5679cfcd6ed7a23797b7c76de"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br> < <a class="el" href="structiDocumentNode.html">iDocumentNode</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#60039523bba5207661cd04e89fd996cc">GetRoot</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current root node. <a href="#60039523bba5207661cd04e89fd996cc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#695484b6a5e5d1538bd07cde1666ebb3">Parse</a> (const char *buf, bool collapse=false)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parse document file from a null-terminated C-string. <a href="#695484b6a5e5d1538bd07cde1666ebb3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#9a311c0d37f23e2b6d33c13c2f8dc750">Parse</a> (<a class="el" href="structiString.html">iString</a> *str, bool collapse=false)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parse document file from an <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>. <a href="#9a311c0d37f23e2b6d33c13c2f8dc750"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#55896edfa6e24b56dd099bf75e2dcf84">Parse</a> (<a class="el" href="structiDataBuffer.html">iDataBuffer</a> *buf, bool collapse=false)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parse document file from an <a class="el" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>. <a href="#55896edfa6e24b56dd099bf75e2dcf84"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#41697f135ccbcd45ece2789186ba5a79">Parse</a> (<a class="el" href="structiFile.html">iFile</a> *file, bool collapse=false)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Parse document file from an <a class="el" href="structiFile.html" title="A replacement for FILE type in the virtual file space.">iFile</a>. <a href="#41697f135ccbcd45ece2789186ba5a79"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#99ee40858db02ab380ad5f19ab78acbe">Write</a> (<a class="el" href="structiVFS.html">iVFS</a> *vfs, const char *filename)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write out document file to a VFS file. <a href="#99ee40858db02ab380ad5f19ab78acbe"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#a008abf96f2767bbda2911d8fead4f24">Write</a> (<a class="el" href="structiString.html">iString</a> *str)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write out document file to an <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>. <a href="#a008abf96f2767bbda2911d8fead4f24"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDocument.html#1ba88d38ecfb4e6e46b72d08c8bbe3c2">Write</a> (<a class="el" href="structiFile.html">iFile</a> *file)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write out document file to an <a class="el" href="structiFile.html" title="A replacement for FILE type in the virtual file space.">iFile</a>. <a href="#1ba88d38ecfb4e6e46b72d08c8bbe3c2"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Representation of a document containing a hierarchical structure of nodes. <p> Main creators of instances implementing this interface:<ul> <li><a class="el" href="structiDocumentSystem.html#bd7da32b9b25a5c260c2c27db90b1126" title="Create a new empty document.">iDocumentSystem::CreateDocument()</a> </li></ul> <p>Definition at line <a class="el" href="document_8h-source.html#l00323">323</a> of file <a class="el" href="document_8h-source.html">document.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="2d2d1a9f40572e6e4c1704efbfede5f4"></a><!-- doxytag: member="iDocument::Changeable" ref="2d2d1a9f40572e6e4c1704efbfede5f4" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int iDocument::Changeable </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns how far this document can be changed. <p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html#gae8a3014baff809714bc2bc26813c0d8" title="The document can not be changed, CreateRoot() is not supported.">CS_CHANGEABLE_NEVER</a> <a class="el" href="group__util.html#g4ad560ac8bbb66e1ec9d071773a3de08" title="The document only allows changes with a newly created root.">CS_CHANGEABLE_NEWROOT</a> <a class="el" href="group__util.html#g8a23a87f097d54b2fd65377bfcbe4357" title="The document can be changed.">CS_CHANGEABLE_YES</a> </dd></dl> </div> </div><p> <a class="anchor" name="7a3b311d687285d6252727887996a39b"></a><!-- doxytag: member="iDocument::Clear" ref="7a3b311d687285d6252727887996a39b" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iDocument::Clear </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Clear the document. <p> </div> </div><p> <a class="anchor" name="e16013f5679cfcd6ed7a23797b7c76de"></a><!-- doxytag: member="iDocument::CreateRoot" ref="e16013f5679cfcd6ed7a23797b7c76de" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiDocumentNode.html">iDocumentNode</a>> iDocument::CreateRoot </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a root node. This will clear the previous root node if any. <p> </div> </div><p> <a class="anchor" name="60039523bba5207661cd04e89fd996cc"></a><!-- doxytag: member="iDocument::GetRoot" ref="60039523bba5207661cd04e89fd996cc" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiDocumentNode.html">iDocumentNode</a>> iDocument::GetRoot </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the current root node. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Never returns 0. </dd></dl> </div> </div><p> <a class="anchor" name="695484b6a5e5d1538bd07cde1666ebb3"></a><!-- doxytag: member="iDocument::Parse" ref="695484b6a5e5d1538bd07cde1666ebb3" args="(const char *buf, bool collapse=false)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Parse </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>collapse</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Parse document file from a null-terminated C-string. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The buffer to parse. It should contain data in whatever format is understood by the <a class="el" href="structiDocument.html" title="Representation of a document containing a hierarchical structure of nodes.">iDocument</a> implementation receiving this invocation. </td></tr> <tr><td valign="top"></td><td valign="top"><em>collapse</em> </td><td>Document format implementations have the option of condensing extraneous whitespace in returned <a class="el" href="group__util.html#ggb42cea72c57ecad9c3d599a08bce4475acda242ee76ec9e6e6181ddbb6b57223" title="Text.">CS_NODE_TEXT</a> nodes. Set this to true to enable this option. By default, whitepsace is preserved. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if all is okay; otherwise an error message. </dd></dl> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This will clear the previous root node if any. </dd></dl> </div> </div><p> <a class="anchor" name="9a311c0d37f23e2b6d33c13c2f8dc750"></a><!-- doxytag: member="iDocument::Parse" ref="9a311c0d37f23e2b6d33c13c2f8dc750" args="(iString *str, bool collapse=false)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Parse </td> <td>(</td> <td class="paramtype"><a class="el" href="structiString.html">iString</a> * </td> <td class="paramname"> <em>str</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>collapse</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Parse document file from an <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The string to parse. It should contain data in whatever format is understood by the <a class="el" href="structiDocument.html" title="Representation of a document containing a hierarchical structure of nodes.">iDocument</a> implementation receiving this invocation. </td></tr> <tr><td valign="top"></td><td valign="top"><em>collapse</em> </td><td>Document format implementations have the option of condensing extraneous whitespace in returned <a class="el" href="group__util.html#ggb42cea72c57ecad9c3d599a08bce4475acda242ee76ec9e6e6181ddbb6b57223" title="Text.">CS_NODE_TEXT</a> nodes. Set this to true to enable this option. By default, whitepsace is preserved. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if all is okay; otherwise an error message. </dd></dl> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This will clear the previous root node if any. </dd></dl> </div> </div><p> <a class="anchor" name="55896edfa6e24b56dd099bf75e2dcf84"></a><!-- doxytag: member="iDocument::Parse" ref="55896edfa6e24b56dd099bf75e2dcf84" args="(iDataBuffer *buf, bool collapse=false)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Parse </td> <td>(</td> <td class="paramtype"><a class="el" href="structiDataBuffer.html">iDataBuffer</a> * </td> <td class="paramname"> <em>buf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>collapse</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Parse document file from an <a class="el" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a>. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The buffer to parse. It should contain data in whatever format is understood by the <a class="el" href="structiDocument.html" title="Representation of a document containing a hierarchical structure of nodes.">iDocument</a> implementation receiving this invocation. </td></tr> <tr><td valign="top"></td><td valign="top"><em>collapse</em> </td><td>Document format implementations have the option of condensing extraneous whitespace in returned <a class="el" href="group__util.html#ggb42cea72c57ecad9c3d599a08bce4475acda242ee76ec9e6e6181ddbb6b57223" title="Text.">CS_NODE_TEXT</a> nodes. Set this to true to enable this option. By default, whitepsace is preserved. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if all is okay; otherwise an error message. </dd></dl> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This will clear the previous root node if any. </dd></dl> </div> </div><p> <a class="anchor" name="41697f135ccbcd45ece2789186ba5a79"></a><!-- doxytag: member="iDocument::Parse" ref="41697f135ccbcd45ece2789186ba5a79" args="(iFile *file, bool collapse=false)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Parse </td> <td>(</td> <td class="paramtype"><a class="el" href="structiFile.html">iFile</a> * </td> <td class="paramname"> <em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>collapse</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Parse document file from an <a class="el" href="structiFile.html" title="A replacement for FILE type in the virtual file space.">iFile</a>. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>The file to parse. It should contain data in whatever format is understood by the <a class="el" href="structiDocument.html" title="Representation of a document containing a hierarchical structure of nodes.">iDocument</a> implementation receiving this invocation. </td></tr> <tr><td valign="top"></td><td valign="top"><em>collapse</em> </td><td>Document format implementations have the option of condensing extraneous whitespace in returned <a class="el" href="group__util.html#ggb42cea72c57ecad9c3d599a08bce4475acda242ee76ec9e6e6181ddbb6b57223" title="Text.">CS_NODE_TEXT</a> nodes. Set this to true to enable this option. By default, whitepsace is preserved. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if all is okay; otherwise an error message. </dd></dl> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This will clear the previous root node if any. </dd></dl> </div> </div><p> <a class="anchor" name="99ee40858db02ab380ad5f19ab78acbe"></a><!-- doxytag: member="iDocument::Write" ref="99ee40858db02ab380ad5f19ab78acbe" args="(iVFS *vfs, const char *filename)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Write </td> <td>(</td> <td class="paramtype"><a class="el" href="structiVFS.html">iVFS</a> * </td> <td class="paramname"> <em>vfs</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>filename</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write out document file to a VFS file. <p> This will return 0 if all is ok. Otherwise it will return an error string. </div> </div><p> <a class="anchor" name="a008abf96f2767bbda2911d8fead4f24"></a><!-- doxytag: member="iDocument::Write" ref="a008abf96f2767bbda2911d8fead4f24" args="(iString *str)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Write </td> <td>(</td> <td class="paramtype"><a class="el" href="structiString.html">iString</a> * </td> <td class="paramname"> <em>str</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write out document file to an <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>. <p> This will return 0 if all is ok. Otherwise it will return an error string. </div> </div><p> <a class="anchor" name="1ba88d38ecfb4e6e46b72d08c8bbe3c2"></a><!-- doxytag: member="iDocument::Write" ref="1ba88d38ecfb4e6e46b72d08c8bbe3c2" args="(iFile *file)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* iDocument::Write </td> <td>(</td> <td class="paramtype"><a class="el" href="structiFile.html">iFile</a> * </td> <td class="paramname"> <em>file</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Write out document file to an <a class="el" href="structiFile.html" title="A replacement for FILE type in the virtual file space.">iFile</a>. <p> This will return 0 if all is ok. Otherwise it will return an error string. </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>iutil/<a class="el" href="document_8h-source.html">document.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>