cocos2d-x  3.0-alpha0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
XMLText Class Reference

XML text. More...

#include <tinyxml2.h>

Inheritance diagram for XMLText:
XMLNode

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
 Accept a hierarchical visit of the nodes in the TinyXML DOM. More...
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual const XMLTextToText () const
void SetCData (bool isCData)
 Declare whether this should be CDATA or standard text. More...
 
bool CData () const
 Returns true if this is a CDATA text element. More...
 
char * ParseDeep (char *, StrPair *endTag)
virtual XMLNodeShallowClone (XMLDocument *document) const
 Make a copy of this node, but not its children. More...
 
virtual bool ShallowEqual (const XMLNode *compare) const
 Test if 2 nodes are the same, but don't test children. More...
 
- Public Member Functions inherited from XMLNode
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLElementToElement () const
virtual const XMLCommentToComment () const
virtual const XMLDocumentToDocument () const
virtual const XMLDeclarationToDeclaration () const
virtual const XMLUnknownToUnknown () const
const char * Value () const
 The meaning of 'value' changes for the specific type. More...
 
void SetValue (const char *val, bool staticMem=false)
 Set the Value of an XML node. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
const XMLElementFirstChildElement (const char *value=0) const
 Get the first child element, or optionally the first child element with the specified name. More...
 
XMLElementFirstChildElement (const char *value=0)
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
const XMLElementLastChildElement (const char *value=0) const
 Get the last child element or optionally the last child element with the specified name. More...
 
XMLElementLastChildElement (const char *value=0)
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
const XMLElementPreviousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an opitionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *value=0)
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
const XMLElementNextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an opitionally supplied name. More...
 
XMLElementNextSiblingElement (const char *value=0)
XMLNodeInsertEndChild (XMLNode *addThis)
 Add a child node as the last (right) child. More...
 
XMLNodeLinkEndChild (XMLNode *addThis)
XMLNodeInsertFirstChild (XMLNode *addThis)
 Add a child node as the first (left) child. More...
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 Add a node after the specified child node. More...
 
void DeleteChildren ()
 Delete all the children of this node. More...
 
void DeleteChild (XMLNode *node)
 Delete a child of this node. More...
 

Protected Member Functions

 XMLText (XMLDocument *doc)
virtual ~XMLText ()
 XMLText (const XMLText &)
XMLTextoperator= (const XMLText &)
- Protected Member Functions inherited from XMLNode
 XMLNode (XMLDocument *)
virtual ~XMLNode ()
 XMLNode (const XMLNode &)
XMLNodeoperator= (const XMLNode &)

Friends

class XMLBase
class XMLDocument

Additional Inherited Members

- Protected Attributes inherited from XMLNode
XMLDocument_document
XMLNode_parent
StrPair _value
XMLNode_firstChild
XMLNode_lastChild
XMLNode_prev
XMLNode_next

Detailed Description

XML text.

Note that a text node can have child element nodes, for example:

<root>This is <b>bold</b></root>

A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCDATA() and query it with CDATA().

Constructor & Destructor Documentation

XMLText ( XMLDocument doc)
inlineprotected
virtual ~XMLText ( )
inlineprotectedvirtual
XMLText ( const XMLText )
protected

Member Function Documentation

virtual bool Accept ( XMLVisitor visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML DOM.

Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

TiXmlPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implements XMLNode.

bool CData ( ) const
inline

Returns true if this is a CDATA text element.

XMLText& operator= ( const XMLText )
protected
char* ParseDeep ( char *  ,
StrPair endTag 
)
virtual

Reimplemented from XMLNode.

void SetCData ( bool  isCData)
inline

Declare whether this should be CDATA or standard text.

virtual XMLNode* ShallowClone ( XMLDocument document) const
virtual

Make a copy of this node, but not its children.

You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements XMLNode.

virtual bool ShallowEqual ( const XMLNode compare) const
virtual

Test if 2 nodes are the same, but don't test children.

The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements XMLNode.

virtual XMLText* ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented from XMLNode.

virtual const XMLText* ToText ( ) const
inlinevirtual

Reimplemented from XMLNode.

Friends And Related Function Documentation

friend class XMLBase
friend
friend class XMLDocument
friend

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