#include <TinyXML.h>
Inherits TiXmlNode.
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.
Public Member Functions | |
| TiXmlDocument () | |
| Create an empty document, that has no name. | |
| TiXmlDocument (const char *documentName) | |
| Create a document with a name. The name of the document is also the filename of the xml. | |
| virtual | ~TiXmlDocument () |
| bool | LoadFile () |
| Load a file using the current document value. | |
| bool | SaveFile () const |
| Save a file using the current document value. Returns true if successful. | |
| bool | LoadFile (const char *filename) |
| Load a file using the given filename. Returns true if successful. | |
| bool | SaveFile (const char *filename) const |
| Save a file using the given filename. Returns true if successful. | |
| virtual const char * | Parse (const char *p, TiXmlParsingData *data=0) |
| Parse the given null terminated block of xml data. | |
| TiXmlElement * | RootElement () const |
| Get the root element -- the only top level element -- of the document. | |
| bool | Error () const |
| If an error occurs, Error will be set to true. | |
| const char * | ErrorDesc () const |
| Contains a textual (english) description of the error if one occurs. | |
| const int | ErrorId () const |
| Generally, you probably want the error string ( ErrorDesc() ). | |
| int | ErrorRow () |
| Returns the location (if known) of the error. | |
| int | ErrorCol () |
| The column where the error occured. See ErrorRow(). | |
| void | SetTabSize (int _tabsize) |
| 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. | |
| int | TabSize () const |
| void | ClearError () |
| If you have handled the error, it can be reset with this call. | |
| void | Print () const |
| Dump the document to standard out. | |
| virtual void | Print (FILE *cfile, int depth=0) const |
| All TinyXml classes can print themselves to a filestream. | |
| void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData) |
Protected Member Functions | |
| virtual void | StreamOut (TiXmlOutStream *out) const |
| virtual TiXmlNode * | Clone () const |
Private Member Functions | |
| TiXmlDocument (const TiXmlDocument ©) | |
| void | operator= (const TiXmlDocument ©) |
Private Attributes | |
| bool | error |
| int | errorId |
| TiXmlString | errorDesc |
| int | tabsize |
| TiXmlCursor | errorLocation |
| TiXmlDocument::TiXmlDocument | ( | ) |
Create an empty document, that has no name.
| TiXmlDocument::TiXmlDocument | ( | const char * | documentName | ) |
Create a document with a name. The name of the document is also the filename of the xml.
| virtual TiXmlDocument::~TiXmlDocument | ( | ) | [inline, virtual] |
| TiXmlDocument::TiXmlDocument | ( | const TiXmlDocument & | copy | ) | [private] |
| bool TiXmlDocument::LoadFile | ( | ) |
Load a file using the current document value.
Returns true if successful. Will delete any existing document data before loading.
| bool TiXmlDocument::SaveFile | ( | ) | const |
Save a file using the current document value. Returns true if successful.
| bool TiXmlDocument::LoadFile | ( | const char * | filename | ) |
Load a file using the given filename. Returns true if successful.
| bool TiXmlDocument::SaveFile | ( | const char * | filename | ) | const |
Save a file using the given filename. Returns true if successful.
| virtual const char* TiXmlDocument::Parse | ( | const char * | p, | |
| TiXmlParsingData * | data = 0 | |||
| ) | [virtual] |
| TiXmlElement* TiXmlDocument::RootElement | ( | ) | const [inline] |
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.
| bool TiXmlDocument::Error | ( | ) | const [inline] |
If an error occurs, Error will be set to true.
Also,
| const char* TiXmlDocument::ErrorDesc | ( | ) | const [inline] |
Contains a textual (english) description of the error if one occurs.
| const int TiXmlDocument::ErrorId | ( | ) | const [inline] |
Generally, you probably want the error string ( ErrorDesc() ).
But if you prefer the ErrorId, this function will fetch it.
| int TiXmlDocument::ErrorRow | ( | ) | [inline] |
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.)
| int TiXmlDocument::ErrorCol | ( | ) | [inline] |
The column where the error occured. See ErrorRow().
| void TiXmlDocument::SetTabSize | ( | int | _tabsize | ) | [inline] |
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:
TiXmlDocument doc; doc.SetTabSize( 8 ); doc.Load( "myfile.xml" );
| int TiXmlDocument::TabSize | ( | ) | const [inline] |
| void TiXmlDocument::ClearError | ( | ) | [inline] |
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 TiXmlDocument::Print | ( | ) | const [inline] |
Dump the document to standard out.
| virtual void TiXmlDocument::Print | ( | FILE * | cfile, | |
| int | depth = 0 | |||
| ) | const [virtual] |
All TinyXml classes can print themselves to a filestream.
This is a formatted print, and will insert tabs and newlines.
(For an unformatted stream, use the << operator.)
Implements TiXmlBase.
| void TiXmlDocument::SetError | ( | int | err, | |
| const char * | errorLocation, | |||
| TiXmlParsingData * | prevData | |||
| ) |
| virtual void TiXmlDocument::StreamOut | ( | TiXmlOutStream * | out | ) | const [protected, virtual] |
Implements TiXmlBase.
| void TiXmlDocument::operator= | ( | const TiXmlDocument & | copy | ) | [private] |
bool TiXmlDocument::error [private] |
Referenced by ClearError(), and Error().
int TiXmlDocument::errorId [private] |
Referenced by ClearError(), and ErrorId().
TiXmlString TiXmlDocument::errorDesc [private] |
Referenced by ClearError(), and ErrorDesc().
int TiXmlDocument::tabsize [private] |
Referenced by SetTabSize(), and TabSize().
TiXmlCursor TiXmlDocument::errorLocation [private] |
Referenced by ClearError(), ErrorCol(), and ErrorRow().
1.5.6