#include <tinyxml.h>
Public Member Functions | |
| virtual bool | Accept (TiXmlVisitor *content) const |
| void | ClearError () |
| bool | Error () const |
| int | ErrorCol () const |
| The column where the error occured. See ErrorRow(). | |
| const char * | ErrorDesc () const |
| Contains a textual (english) description of the error if one occurs. | |
| int | ErrorId () const |
| int | ErrorRow () const |
| bool | LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| bool | LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| Load a file using the given filename. Returns true if successful. | |
| bool | LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| void | operator= (const TiXmlDocument ©) |
| virtual const char * | Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING) |
| virtual void | Print (FILE *cfile, int depth=0) const |
| Print this Document to a FILE stream. | |
| void | Print () const |
| TiXmlElement * | RootElement () |
| const TiXmlElement * | RootElement () const |
| bool | SaveFile (FILE *) const |
| Save a file using the given FILE*. Returns true if successful. | |
| bool | SaveFile (const char *filename) const |
| Save a file using the given filename. Returns true if successful. | |
| bool | SaveFile () const |
| Save a file using the current document value. Returns true if successful. | |
| void | SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding) |
| void | SetTabSize (int _tabsize) |
| int | TabSize () const |
| TiXmlDocument (const TiXmlDocument ©) | |
| TiXmlDocument (const char *documentName) | |
| Create a document with a name. The name of the document is also the filename of the xml. | |
| TiXmlDocument () | |
| Create an empty document, that has no name. | |
| virtual TiXmlDocument * | ToDocument () |
| Cast to a more defined type. Will return null not of the requested type. | |
| virtual const TiXmlDocument * | ToDocument () const |
| Cast to a more defined type. Will return null not of the requested type. | |
| virtual | ~TiXmlDocument () |
Protected Member Functions | |
| virtual TiXmlNode * | Clone () const |
Private Member Functions | |
| void | CopyTo (TiXmlDocument *target) const |
Private Attributes | |
| bool | error |
| TIXML_STRING | errorDesc |
| int | errorId |
| TiXmlCursor | errorLocation |
| int | tabsize |
| bool | useMicrosoftBOM |
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.
Definition at line 1397 of file tinyxml.h.
| TiXmlDocument::TiXmlDocument | ( | ) |
Create an empty document, that has no name.
Definition at line 884 of file tinyxml.cpp.
| TiXmlDocument::TiXmlDocument | ( | const char * | documentName | ) |
Create a document with a name. The name of the document is also the filename of the xml.
Definition at line 891 of file tinyxml.cpp.
| TiXmlDocument::TiXmlDocument | ( | const TiXmlDocument & | copy | ) |
Definition at line 911 of file tinyxml.cpp.
| virtual TiXmlDocument::~TiXmlDocument | ( | ) | [inline, virtual] |
| bool TiXmlDocument::Accept | ( | TiXmlVisitor * | content | ) | const [virtual] |
Walk the XML tree visiting this node and all of its children.
Implements TiXmlNode.
Definition at line 1160 of file tinyxml.cpp.
| void TiXmlDocument::ClearError | ( | ) | [inline] |
| TiXmlNode * TiXmlDocument::Clone | ( | ) | const [protected, virtual] |
Create an exact duplicate of this node and return it. The memory must be deleted by the caller.
Implements TiXmlNode.
Definition at line 1138 of file tinyxml.cpp.
| void TiXmlDocument::CopyTo | ( | TiXmlDocument * | target | ) | const [private] |
Definition at line 1119 of file tinyxml.cpp.
| bool TiXmlDocument::Error | ( | ) | const [inline] |
If an error occurs, Error will be set to true. Also,
| int TiXmlDocument::ErrorCol | ( | ) | const [inline] |
The column where the error occured. See ErrorRow().
| const char* TiXmlDocument::ErrorDesc | ( | ) | const [inline] |
| 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 | ( | ) | const [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 | ( | FILE * | file, | |
| TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING | |||
| ) |
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.
Definition at line 973 of file tinyxml.cpp.
| bool TiXmlDocument::LoadFile | ( | const char * | filename, | |
| TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING | |||
| ) |
Load a file using the given filename. Returns true if successful.
Definition at line 945 of file tinyxml.cpp.
| bool TiXmlDocument::LoadFile | ( | TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING |
) |
Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.
Definition at line 924 of file tinyxml.cpp.
| void TiXmlDocument::operator= | ( | const TiXmlDocument & | copy | ) |
Definition at line 917 of file tinyxml.cpp.
| const char * TiXmlDocument::Parse | ( | const char * | p, | |
| TiXmlParsingData * | data = 0, |
|||
| TiXmlEncoding | encoding = TIXML_DEFAULT_ENCODING | |||
| ) | [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.
Implements TiXmlBase.
Definition at line 704 of file tinyxmlparser.cpp.
| void TiXmlDocument::Print | ( | FILE * | cfile, | |
| int | depth = 0 | |||
| ) | const [virtual] |
Print this Document to a FILE stream.
Implements TiXmlBase.
Definition at line 1149 of file tinyxml.cpp.
| void TiXmlDocument::Print | ( | ) | const [inline] |
| TiXmlElement* TiXmlDocument::RootElement | ( | ) | [inline] |
| const TiXmlElement* TiXmlDocument::RootElement | ( | ) | const [inline] |
| bool TiXmlDocument::SaveFile | ( | FILE * | fp | ) | const |
Save a file using the given FILE*. Returns true if successful.
Definition at line 1102 of file tinyxml.cpp.
| bool TiXmlDocument::SaveFile | ( | const char * | filename | ) | const |
Save a file using the given filename. Returns true if successful.
Definition at line 1088 of file tinyxml.cpp.
| bool TiXmlDocument::SaveFile | ( | ) | const |
Save a file using the current document value. Returns true if successful.
Definition at line 933 of file tinyxml.cpp.
| void TiXmlDocument::SetError | ( | int | err, | |
| const char * | errorLocation, | |||
| TiXmlParsingData * | prevData, | |||
| TiXmlEncoding | encoding | |||
| ) |
Definition at line 798 of file tinyxmlparser.cpp.
| void TiXmlDocument::SetTabSize | ( | int | _tabsize | ) | [inline] |
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:
TiXmlDocument doc; doc.SetTabSize( 8 ); doc.Load( "myfile.xml" );
| virtual TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | [inline, virtual] |
| virtual const TiXmlDocument* TiXmlDocument::ToDocument | ( | ) | const [inline, virtual] |
bool TiXmlDocument::error [private] |
TIXML_STRING TiXmlDocument::errorDesc [private] |
int TiXmlDocument::errorId [private] |
TiXmlCursor TiXmlDocument::errorLocation [private] |
int TiXmlDocument::tabsize [private] |
bool TiXmlDocument::useMicrosoftBOM [private] |
