#include <tinyxml.h>
Public Member Functions | |
TiXmlDocument (const char *documentName) | |
bool | LoadFile () |
bool | SaveFile () const |
bool | LoadFile (const char *filename) |
bool | SaveFile (const char *filename) const |
virtual const char * | Parse (const char *p, TiXmlParsingData *data=0) |
TiXmlElement * | RootElement () const |
bool | Error () const |
const char * | ErrorDesc () const |
const int | ErrorId () const |
int | ErrorRow () |
int | ErrorCol () |
The column where the error occured. See ErrorRow() | |
void | SetTabSize (int _tabsize) |
int | TabSize () const |
void | ClearError () |
void | Print () const |
virtual void | Print (FILE *cfile, int depth=0) const |
void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData) |
![]() | |
const char * | Value () const |
void | SetValue (const char *_value) |
void | Clear () |
TiXmlNode * | Parent () const |
TiXmlNode * | FirstChild () const |
The first child of this node. Will be null if there are no children. | |
TiXmlNode * | FirstChild (const char *value) const |
The first child of this node with the matching 'value'. Will be null if none found. | |
TiXmlNode * | LastChild () const |
TiXmlNode * | LastChild (const char *value) const |
TiXmlNode * | IterateChildren (TiXmlNode *previous) const |
TiXmlNode * | IterateChildren (const char *value, TiXmlNode *previous) const |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
bool | RemoveChild (TiXmlNode *removeThis) |
TiXmlNode * | PreviousSibling () const |
TiXmlNode * | PreviousSibling (const char *) const |
TiXmlNode * | NextSibling () const |
TiXmlNode * | NextSibling (const char *) const |
TiXmlElement * | NextSiblingElement () const |
TiXmlElement * | NextSiblingElement (const char *) const |
TiXmlElement * | FirstChildElement () const |
TiXmlElement * | FirstChildElement (const char *value) const |
virtual int | Type () const |
TiXmlDocument * | GetDocument () const |
bool | NoChildren () const |
TiXmlDocument * | ToDocument () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlComment * | ToComment () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlUnknown * | ToUnknown () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlText * | ToText () const |
Cast to a more defined type. Will return null not of the requested type. | |
TiXmlDeclaration * | ToDeclaration () const |
Cast to a more defined type. Will return null not of the requested type. | |
void | SetUserData (void *user) |
void * | GetUserData () |
![]() | |
int | Row () const |
int | Column () const |
See Row() | |
Protected Member Functions | |
virtual void | StreamOut (TIXML_OSTREAM *out) const |
virtual TiXmlNode * | Clone () const |
![]() | |
TiXmlNode (NodeType type) | |
TiXmlNode * | Identify (const char *start) |
void | CopyToClone (TiXmlNode *target) const |
TIXML_STRING | SValue () const |
Additional Inherited Members | |
![]() | |
enum | NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT } |
![]() | |
static void | SetCondenseWhiteSpace (bool condense) |
static bool | IsWhiteSpaceCondensed () |
![]() | |
enum | { TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_STRING_COUNT } |
![]() | |
static const char * | SkipWhiteSpace (const char *) |
static bool | IsWhiteSpace (int c) |
static const char * | ReadName (const char *p, TIXML_STRING *name) |
static const char * | ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase) |
static const char * | GetEntity (const char *in, char *value) |
static const char * | GetChar (const char *p, char *_value) |
static void | PutString (const TIXML_STRING &str, TIXML_OSTREAM *out) |
static void | PutString (const TIXML_STRING &str, TIXML_STRING *out) |
static bool | StringEqual (const char *p, const char *endTag, bool ignoreCase) |
![]() | |
TiXmlNode * | parent |
NodeType | type |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TIXML_STRING | value |
TiXmlNode * | prev |
TiXmlNode * | next |
void * | userData |
![]() | |
TiXmlCursor | location |
![]() | |
static const char * | errorString [TIXML_ERROR_STRING_COUNT] |
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.
|
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.
|
inline |
If an error occurs, Error will be set to true. Also,
|
inline |
Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.
|
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.)
bool TiXmlDocument::LoadFile | ( | ) |
Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.
|
virtual |
Parse the given null terminated block of xml data.
Implements TiXmlBase.
|
inline |
Dump the document to standard out.
|
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.
|
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.
|
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" );