TiXmlBase

class TiXmlBase

TiXmlBase is a base class for every class in TinyXml. It does little except to establish that TinyXml classes can be printed and provide some utility functions.

In XML, the document and elements can contain other elements and other types of nodes.

A Document can contain: Element (container or leaf)
                        Comment (leaf)
                        Unknown (leaf)
                        Declaration( leaf )

An Element can contain: Element (container or leaf)
                        Text    (leaf)
                        Attributes (not on tree)
                        Comment (leaf)
                        Unknown (leaf)

A Decleration contains: Attributes (not on tree)

Inheritance diagram

int Column(void) const: ///< See Row()

static void EncodeString(std::string const &str, std::string *out): Expands entities in a string. Note this should not contian the tag’s ‘<’, ‘>’, etc, or they will be transformed into entities!

void *GetUserData(void)

void const *GetUserData(void) const: ///< Get a pointer to arbitrary user data.

static bool IsWhiteSpaceCondensed(void): /// Return the current white space setting.

virtual char const *Parse(char const *p, TiXmlParsingData *data, TiXmlEncoding encoding) = 0

virtual void Print(FILE *cfile, int depth) const = 0

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

int Row(void) const

Return the position, in the original source file, of this node or attribute. The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.