|
|
Always the top level node. 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.
TiXmlDocument ()
| TiXmlDocument |
TiXmlDocument ( const char * documentName )
| TiXmlDocument |
TiXmlDocument ( const std::string& documentName )
| TiXmlDocument |
TiXmlDocument ( const TiXmlDocument& copy )
| TiXmlDocument |
void operator= ( const TiXmlDocument& copy )
| operator= |
Reimplemented from TiXmlNode.
~TiXmlDocument ()
| ~TiXmlDocument |
[virtual]
bool LoadFile ( TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )
| LoadFile |
Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.
bool SaveFile ()
| SaveFile |
[const]
bool LoadFile ( const char * filename, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )
| LoadFile |
bool SaveFile ( const char * filename )
| SaveFile |
[const]
bool LoadFile ( FILE*, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )
| LoadFile |
Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.
bool SaveFile ( FILE* )
| SaveFile |
[const]
bool LoadFile ( const std::string& filename, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )
| LoadFile |
bool SaveFile ( const std::string& filename )
| SaveFile |
[const]
const char* Parse ( const char* p, TiXmlParsingData* data = 0, TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )
| Parse |
[virtual]
Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.
Returns: The location where parsing stopped. On error, this is the start point of the first level node that generated the error.
Reimplemented from TiXmlBase.
const TiXmlElement* RootElement ()
| RootElement |
[const]
Get the root element -- the only top level element -- of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.
TiXmlElement* RootElement ()
| RootElement |
bool Error ()
| Error |
[const]
If an error occurs, Error will be set to true. Also, - The ErrorId() will contain the integer identifier of the error (not generally useful) - The ErrorDesc() method will return the name of the error. (very useful) - The ErrorRow() and ErrorCol() will return the location of the error (if known)
const char * ErrorDesc ()
| ErrorDesc |
[const]
int ErrorId ()
| ErrorId |
[const]
Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.
int ErrorRow ()
| ErrorRow |
Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)
@sa SetTabSize, Row, Column
int ErrorCol ()
| ErrorCol |
void SetTabSize ( int _tabsize )
| SetTabSize |
SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.
By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.
The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.
Note that row and column tracking is not supported when using operator>>.
The tab size needs to be enabled before the parse or load. Correct usage: @verbatim TiXmlDocument doc; doc.SetTabSize( 8 ); doc.Load( "myfile.xml" ); @endverbatim
@sa Row, Column
int TabSize ()
| TabSize |
[const]
void ClearError ()
| ClearError |
If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.
void Print ()
|
[const]
Reimplemented from TiXmlBase.
void Print ( FILE* cfile, int depth = 0 )
|
[const virtual]
Reimplemented from TiXmlBase.
void SetError ( int err, const char* errorLocation, TiXmlParsingData* prevData, TiXmlEncoding encoding )
| SetError |
const TiXmlDocument* ToDocument ()
| ToDocument |
[const virtual]
Reimplemented from TiXmlNode.
TiXmlDocument* ToDocument ()
| ToDocument |
[virtual]
Reimplemented from TiXmlNode.
void StreamOut ( TIXML_OSTREAM * out, bool unclosed = false )
| StreamOut |
[const virtual]
Reimplemented from TiXmlBase.
TiXmlNode* Clone ()
| Clone |
[protected const virtual]
Reimplemented from TiXmlNode.
void StreamIn ( TIXML_ISTREAM * in, TIXML_STRING * tag )
| StreamIn |
[protected virtual]
Reimplemented from TiXmlNode.
Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54. |