LDK::XmlDocument Class Reference

#include <LDK/XML.h>

Inheritance diagram for LDK::XmlDocument:

[legend]Collaboration diagram for LDK::XmlDocument:

[legend]

Public Member Functions
	XmlDocument ()
	Create an empty document, that has no name.
	XmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml.
	XmlDocument (const String &documentName)
	Constructor.
	XmlDocument (const XmlDocument &copy)
void	operator= (const XmlDocument &copy)
virtual	~XmlDocument ()
bool	LoadFile (XmlEncoding encoding=LDKXML_DEFAULT_ENCODING)
bool	SaveFile () const
	Save a file using the current document value. Returns true if successful.
bool	LoadFile (const char *filename, XmlEncoding encoding=LDKXML_DEFAULT_ENCODING)
	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. LDK::String version.
bool	LoadFile (const String &filename, XmlEncoding encoding=LDKXML_DEFAULT_ENCODING)
bool	SaveFile (const String &filename) const
	< LDK::String version.
virtual const char *	Parse (const char *p, XmlParsingData *data=0, XmlEncoding encoding=LDKXML_DEFAULT_ENCODING)
const XmlElement *	RootElement () const
XmlElement *	RootElement ()
bool	Error () const
const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs.
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 (SmartFile f, int depth=0) const
	Print this Document to a FILE stream.
void	SetError (int err, const char *errorLocation, XmlParsingData *prevData, XmlEncoding encoding)
Protected Member Functions
virtual void	StreamOut (LDKXML_OSTREAM *out) const
virtual XmlNode *	Clone () const

---

Detailed Description

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 1148 of file XML.h.

---

Member Function Documentation

bool LDK::XmlDocument::LoadFile

(

XmlEncoding

encoding = LDKXML_DEFAULT_ENCODING

)

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

virtual const char* LDK::XmlDocument::Parse	(	const char *	p,
		XmlParsingData *	data = 0,
		XmlEncoding	encoding = LDKXML_DEFAULT_ENCODING
	)			[virtual]

Parse the given null terminated block of xml data. Passing in an encoding to this method (either LDKXML_ENCODING_LEGACY or LDKXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

Implements LDK::XmlBase.

const XmlElement* LDK::XmlDocument::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.

Definition at line 1201 of file XML.h.

bool LDK::XmlDocument::Error

(

)

const [inline]

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)

Definition at line 1209 of file XML.h.

const int LDK::XmlDocument::ErrorId

(

)

const [inline]

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

Definition at line 1217 of file XML.h.

int LDK::XmlDocument::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.)

See also:

SetTabSize, Row, Column

Definition at line 1226 of file XML.h.

void LDK::XmlDocument::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:

        XmlDocument doc;
        doc.SetTabSize( 8 );
        doc.Load( "myfile.xml" );
        

See also:

Row, Column

Definition at line 1249 of file XML.h.

void LDK::XmlDocument::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.

Definition at line 1256 of file XML.h.

void LDK::XmlDocument::Print

(

)

const [inline]

Dump the document to standard out.

Definition at line 1264 of file XML.h.

virtual XmlNode* LDK::XmlDocument::Clone

(

)

const [protected, virtual]

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implements LDK::XmlNode.

---

The documentation for this class was generated from the following file:

• XML.h

---