DigitalSpaces::DIXMLNode1 Struct Reference
[XML]

#include <ContainerInterfaces.h>

Inherited by TiXmlNode.

Detailed Description

The basic XML interface, contains all the functionality common to the XML system.


Public Member Functions
const char *	GetValue ()
void	SetValue (const char *_value)
	Changes the value of the node.
void	Clear ()
	Delete all the children of this node. Does not affect 'this'.
DIXMLNode1 *	GetParent ()
	One step up the DOM.
DIXMLNode1 *	GetFirstChild ()
	The first child of this node. Will be null if there are no children.
DIXMLNode1 *	GetFirstChild (const char *value)
	The first child of this node with the matching 'value'. Will be null if none found.
DIXMLNode1 *	GetLastChild ()
DIXMLNode1 *	GetLastChild (const char *value)
	The last child of this node. Will be null if there are no children.
DIXMLNode1 *	_IterateChildren (DIXMLNode1 *previous)
	The last child of this node matching 'value'. Will be null if there are no children.
DIXMLNode1 *	_IterateChildren (const char value, DIXMLNode1 previous)
	This flavor of IterateChildren searches for children with a particular 'value'.
DIXMLNode1 *	InsertEndChild (const DIXMLNode1 *addThis)
	Add a new node related to this.
DIXMLNode1 *	_LinkEndChild (DIXMLNode1 *addThis)
	Add a new node related to this.
DIXMLNode1 *	InsertBeforeChild (DIXMLNode1 beforeThis, const DIXMLNode1 addThis)
	Add a new node related to this.
DIXMLNode1 *	InsertAfterChild (DIXMLNode1 afterThis, const DIXMLNode1 addThis)
	Add a new node related to this.
DIXMLNode1 *	ReplaceChild (DIXMLNode1 replaceThis, const DIXMLNode1 withThis)
	Replace a child of this node.
bool	RemoveChild (DIXMLNode1 *removeThis)
	Delete a child of this node.
DIXMLNode1 *	GetPreviousSibling ()
	Navigate to a sibling node.
DIXMLNode1 *	GetPreviousSibling (const char *)
	Navigate to a sibling node.
DIXMLNode1 *	GetNextSibling ()
	Navigate to a sibling node.
DIXMLNode1 *	GetNextSibling (const char *)
	Navigate to a sibling node with the given 'value'.
DIXMLElement1 *	GetNextSiblingElement ()
	Convenience function to get through elements.
DIXMLElement1 *	GetNextSiblingElement (const char *)
	Convenience function to get through elements.
DIXMLElement1 *	GetFirstChildElement ()
	Convenience function to get through elements.
DIXMLElement1 *	GetFirstChildElement (const char *value)
	Convenience function to get through elements.
XMLNodeType	Type ()
	Query the type (as an enumerated value, above) of this node.
bool	NoChildren ()
	Return a pointer to the Document this node lives in.
DIXMLNode1 *	DoClone ()

Member Function Documentation

const char* DigitalSpaces::DIXMLNode1::GetValue ( )

Reimplemented in TiXmlNode.

void DigitalSpaces::DIXMLNode1::SetValue ( const char * _value )

Changes the value of the node.

Defined as:

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

Reimplemented in TiXmlNode.

void DigitalSpaces::DIXMLNode1::Clear ( )

Delete all the children of this node. Does not affect 'this'.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetParent ( )

One step up the DOM.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetFirstChild ( )

The first child of this node. Will be null if there are no children.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetFirstChild ( const char * value )

The first child of this node with the matching 'value'. Will be null if none found.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetLastChild ( )

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetLastChild ( const char * value )

The last child of this node. Will be null if there are no children.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::_IterateChildren ( DIXMLNode1 * previous )

The last child of this node matching 'value'. Will be null if there are no children.

An alternate way to walk the children of a node. One way to iterate over nodes is:

		for( child = parent->FirstChild( DNoParams ); child; child = child->NextSibling( DNoParams ) )

IterateChildren does the same thing with the syntax:

		child DMethodDeclEnd
		while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::_IterateChildren	(	const char *	value,
		DIXMLNode1 *	previous
	)

This flavor of IterateChildren searches for children with a particular 'value'.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::InsertEndChild ( const DIXMLNode1 * addThis )

Add a new node related to this.

Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::_LinkEndChild ( DIXMLNode1 * addThis )

Add a new node related to this.

Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also:: InsertEndChild

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::InsertBeforeChild	(	DIXMLNode1 *	beforeThis,
		const DIXMLNode1 *	addThis
	)

Add a new node related to this.

Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::InsertAfterChild	(	DIXMLNode1 *	afterThis,
		const DIXMLNode1 *	addThis
	)

Add a new node related to this.

Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::ReplaceChild	(	DIXMLNode1 *	replaceThis,
		const DIXMLNode1 *	withThis
	)

Replace a child of this node.

Returns a pointer to the new object or NULL if an error occured.

Reimplemented in TiXmlNode.

bool DigitalSpaces::DIXMLNode1::RemoveChild ( DIXMLNode1 * removeThis )

Delete a child of this node.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetPreviousSibling ( )

Navigate to a sibling node.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetPreviousSibling ( const char * )

Navigate to a sibling node.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetNextSibling ( )

Navigate to a sibling node.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::GetNextSibling ( const char * )

Navigate to a sibling node with the given 'value'.

Reimplemented in TiXmlNode.

DIXMLElement1* DigitalSpaces::DIXMLNode1::GetNextSiblingElement ( )

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Reimplemented in TiXmlNode.

DIXMLElement1* DigitalSpaces::DIXMLNode1::GetNextSiblingElement ( const char * )

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Reimplemented in TiXmlNode.

DIXMLElement1* DigitalSpaces::DIXMLNode1::GetFirstChildElement ( )

Convenience function to get through elements.

Reimplemented in TiXmlNode.

DIXMLElement1* DigitalSpaces::DIXMLNode1::GetFirstChildElement ( const char * value )

Convenience function to get through elements.

Reimplemented in TiXmlNode.

XMLNodeType DigitalSpaces::DIXMLNode1::Type ( )

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

Reimplemented in TiXmlNode.

bool DigitalSpaces::DIXMLNode1::NoChildren ( )

Return a pointer to the Document this node lives in.

Returns null if not in a document. Returns true if this node has no children.

Reimplemented in TiXmlNode.

DIXMLNode1* DigitalSpaces::DIXMLNode1::DoClone ( )

Reimplemented in TiXmlNode.

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

CoreInterfaces/ContainerInterfaces.h

DigitalSpaces::DIXMLNode1 Struct Reference [XML]

Detailed Description

Public Member Functions

Member Function Documentation

DigitalSpaces::DIXMLNode1 Struct Reference
[XML]