Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

TiXmlBase TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown List of all members.

Public Types

enum  NodeType

Public Member Functions

const char * pcValue () const
void SetValue (const char *_value)
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNode * Parent () const
 One step up the DOM.
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 char *value) const
 The last child of this node. Will be null if there are no children.
TiXmlNode * IterateChildren (TiXmlNode *previous) const
 The last child of this node matching 'value'. Will be null if there are no children.
TiXmlNode * IterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
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)
 Delete a child of this node.
TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNode * NextSibling () const
 Navigate to a sibling node.
TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlElement * NextSiblingElement () const
TiXmlElement * NextSiblingElement (const char *) const
TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement (const char *value) const
 Convenience function to get through elements.
virtual int Type () const
TiXmlDocument * GetDocument () const
bool NoChildren () const
 Returns true if this node has no children.
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.
virtual TiXmlNode * Clone () const =0

Detailed Description

The parent class for everything in the Document Object Model. (Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Definition at line 356 of file tinyxml.h.

Member Enumeration Documentation

enum TiXmlNode::NodeType
 

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)Definition at line 398 of file tinyxml.h.

Member Function Documentation

virtual TiXmlNode* TiXmlNode::Clone (   )  const [pure virtual]
 

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

Implemented in TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), CXMLResource::LoadXML(), and ReplaceChild().

TiXmlDocument * TiXmlNode::GetDocument (   )  const
 

Return a pointer to the Document this node lives in. Returns null if not in a document.Definition at line 454 of file tinyxml.cpp.

References parent, and ToDocument().

Referenced by TiXmlElement::SetAttribute().

TiXmlNode * TiXmlNode::InsertAfterChild (  TiXmlNode *  afterThis,
const TiXmlNode &  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.Definition at line 238 of file tinyxml.cpp.

References Clone(), next, parent, and prev.

TiXmlNode * TiXmlNode::InsertBeforeChild (  TiXmlNode *  beforeThis,
const TiXmlNode &  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.Definition at line 212 of file tinyxml.cpp.

References Clone(), next, parent, and prev.

TiXmlNode * TiXmlNode::InsertEndChild (  const TiXmlNode &  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.Definition at line 202 of file tinyxml.cpp.

References Clone(), and LinkEndChild().

Referenced by CGUIButton::SaveButtonStates(), CGUIButton::SaveStateEvents(), CTextureManager::SaveXML(), CTextureFrameAnimation::SaveXML(), CTexture::SaveXML(), CMaterialManager::SaveXML(), CMaterial::SaveXML(), CGUIStatic::SaveXML(), CGUIScrollBar::SaveXML(), CGUIProgressBar::SaveXML(), CGUIElement::SaveXML(), CGUIDropList::SaveXML(), CGUIButton::SaveXML(), CGUI::SaveXML(), CFontManager::SaveXML(), CBitmapFont::SaveXML(), and CAnimationManager::SaveXML().

TiXmlNode * TiXmlNode::IterateChildren (  TiXmlNode *  previous  )  const
 

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(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax: 

			child = 0;
			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.Definition at line 336 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and parent.

Referenced by CGUIButton::LoadButtonStates(), CGUIButton::LoadStateEvents(), CTextureManager::LoadXML(), CTextureFrameAnimation::LoadXML(), CMaterialManager::LoadXML(), CGUIElement::LoadXML(), CFontManager::LoadXML(), and CAnimationManager::LoadXML().

TiXmlNode * TiXmlNode::LinkEndChild (  TiXmlNode *  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
Definition at line 185 of file tinyxml.cpp.

References next, parent, and prev.

Referenced by InsertEndChild(), and TiXmlDocument::Parse().

TiXmlElement * TiXmlNode::NextSiblingElement (  const char *   )  const
 

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.Definition at line 438 of file tinyxml.cpp.

References NextSibling(), and ToElement().

TiXmlElement * TiXmlNode::NextSiblingElement (   )  const
 

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.Definition at line 424 of file tinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement().

const char* TiXmlNode::pcValue (   )  const [inline]
 

The meaning of 'value' changes for the specific type of TiXmlNode. 

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

The subclasses will wrap this function.Definition at line 423 of file tinyxml.h.

Referenced by TiXmlElement::Clone(), CGUIButton::LoadButtonStates(), CMaterialManager::LoadResource(), CAnimationManager::LoadResource(), CGUIButton::LoadStateEvents(), CTextureManager::LoadXML(), CTextureFrameAnimation::LoadXML(), CTexture::LoadXML(), CMaterialManager::LoadXML(), CMaterial::LoadXML(), CGUIElement::LoadXML(), CFontManager::LoadXML(), CBitmapFont::LoadXML(), CAnimationManager::LoadXML(), and CAnimation::LoadXML().

TiXmlNode * TiXmlNode::ReplaceChild (  TiXmlNode *  replaceThis,
const TiXmlNode &  withThis
) 
 

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.Definition at line 264 of file tinyxml.cpp.

References Clone(), next, parent, and prev.

void TiXmlNode::SetValue (  const char *  _value  )  [inline]
 

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
Definition at line 434 of file tinyxml.h.

Referenced by TiXmlText::TiXmlText().

virtual int TiXmlNode::Type (   )  const [inline, virtual]
 

Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.Definition at line 569 of file tinyxml.h.

The documentation for this class was generated from the following files:
Generated on Sun Jul 17 21:34:30 2005 for OpenGL GUI by doxygen 1.3.8