GOAT (Geometrical optics application tool) 0.1
Loading...
Searching...
No Matches
tinyxml2::XMLText Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLText:
tinyxml2::XMLNode tinyxml2::XMLNode

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
virtual bool Accept (XMLVisitor *visitor) const
bool CData () const
 Returns true if this is a CDATA text element.
bool CData () const
 Returns true if this is a CDATA text element.
void SetCData (bool isCData)
 Declare whether this should be CDATA or standard text.
void SetCData (bool isCData)
 Declare whether this should be CDATA or standard text.
virtual XMLNodeShallowClone (XMLDocument *document) const
virtual XMLNodeShallowClone (XMLDocument *document) const
virtual bool ShallowEqual (const XMLNode *compare) const
virtual bool ShallowEqual (const XMLNode *compare) const
virtual XMLTextToText ()
 Safely cast to Text, or null.
virtual XMLTextToText ()
 Safely cast to Text, or null.
virtual const XMLTextToText () const
virtual const XMLTextToText () const
Public Member Functions inherited from tinyxml2::XMLNode
XMLNodeDeepClone (XMLDocument *target) const
XMLNodeDeepClone (XMLDocument *target) const
void DeleteChild (XMLNode *node)
void DeleteChild (XMLNode *node)
void DeleteChildren ()
void DeleteChildren ()
XMLNodeFirstChild ()
XMLNodeFirstChild ()
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists.
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists.
XMLElementFirstChildElement (const char *name=0)
XMLElementFirstChildElement (const char *name=0)
const XMLElementFirstChildElement (const char *name=0) const
const XMLElementFirstChildElement (const char *name=0) const
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode.
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode.
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode.
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode.
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file.
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file.
void * GetUserData () const
void * GetUserData () const
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
XMLNodeInsertEndChild (XMLNode *addThis)
XMLNodeInsertEndChild (XMLNode *addThis)
XMLNodeInsertFirstChild (XMLNode *addThis)
XMLNodeInsertFirstChild (XMLNode *addThis)
XMLNodeLastChild ()
XMLNodeLastChild ()
const XMLNodeLastChild () const
 Get the last child node, or null if none exists.
const XMLNodeLastChild () const
 Get the last child node, or null if none exists.
XMLElementLastChildElement (const char *name=0)
XMLElementLastChildElement (const char *name=0)
const XMLElementLastChildElement (const char *name=0) const
const XMLElementLastChildElement (const char *name=0) const
XMLNodeLinkEndChild (XMLNode *addThis)
XMLNodeLinkEndChild (XMLNode *addThis)
XMLNodeNextSibling ()
XMLNodeNextSibling ()
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node.
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node.
XMLElementNextSiblingElement (const char *name=0)
XMLElementNextSiblingElement (const char *name=0)
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name.
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name.
bool NoChildren () const
 Returns true if this node has no children.
bool NoChildren () const
 Returns true if this node has no children.
XMLNodeParent ()
XMLNodeParent ()
const XMLNodeParent () const
 Get the parent of this node on the DOM.
const XMLNodeParent () const
 Get the parent of this node on the DOM.
XMLNodePreviousSibling ()
XMLNodePreviousSibling ()
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node.
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node.
XMLElementPreviousSiblingElement (const char *name=0)
XMLElementPreviousSiblingElement (const char *name=0)
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name.
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name.
void SetUserData (void *userData)
void SetUserData (void *userData)
void SetValue (const char *val, bool staticMem=false)
void SetValue (const char *val, bool staticMem=false)
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null.
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null.
virtual const XMLCommentToComment () const
virtual const XMLCommentToComment () const
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null.
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null.
virtual const XMLDeclarationToDeclaration () const
virtual const XMLDeclarationToDeclaration () const
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null.
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null.
virtual const XMLDocumentToDocument () const
virtual const XMLDocumentToDocument () const
virtual XMLElementToElement ()
 Safely cast to an Element, or null.
virtual XMLElementToElement ()
 Safely cast to an Element, or null.
virtual const XMLElementToElement () const
virtual const XMLElementToElement () const
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null.
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null.
virtual const XMLUnknownToUnknown () const
virtual const XMLUnknownToUnknown () const
const char * Value () const
const char * Value () const

Protected Member Functions

char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 XMLText (XMLDocument *doc)
 XMLText (XMLDocument *doc)
virtual ~XMLText ()
virtual ~XMLText ()
Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 XMLNode (XMLDocument *)
virtual ~XMLNode ()
virtual ~XMLNode ()

Private Member Functions

XMLTextoperator= (const XMLText &)
XMLTextoperator= (const XMLText &)
 XMLText (const XMLText &)
 XMLText (const XMLText &)

Private Attributes

bool _isCData

Friends

class XMLDocument

Additional Inherited Members

Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument_document
XMLNode_firstChild
XMLNode_lastChild
XMLNode_next
XMLNode_parent
int _parseLineNum
XMLNode_prev
void * _userData
StrPair _value

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().

Definition at line 991 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLText() [1/4]

tinyxml2::XMLText::XMLText ( XMLDocument * doc)
inlineexplicitprotected

Definition at line 1017 of file tinyxml2.h.

◆ ~XMLText() [1/2]

virtual tinyxml2::XMLText::~XMLText ( )
inlineprotectedvirtual

Definition at line 1018 of file tinyxml2.h.

◆ XMLText() [2/4]

tinyxml2::XMLText::XMLText ( const XMLText & )
private

◆ XMLText() [3/4]

tinyxml2::XMLText::XMLText ( XMLDocument * doc)
inlineexplicitprotected

Definition at line 1017 of file tinyxml2.h.

◆ ~XMLText() [2/2]

virtual tinyxml2::XMLText::~XMLText ( )
inlineprotectedvirtual

Definition at line 1018 of file tinyxml2.h.

◆ XMLText() [4/4]

tinyxml2::XMLText::XMLText ( const XMLText & )
private

Member Function Documentation

◆ Accept() [1/2]

virtual bool tinyxml2::XMLText::Accept ( XMLVisitor * visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements tinyxml2::XMLNode.

◆ Accept() [2/2]

virtual bool tinyxml2::XMLText::Accept ( XMLVisitor * visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements tinyxml2::XMLNode.

◆ CData() [1/2]

bool tinyxml2::XMLText::CData ( ) const
inline

Returns true if this is a CDATA text element.

Definition at line 1009 of file tinyxml2.h.

◆ CData() [2/2]

bool tinyxml2::XMLText::CData ( ) const
inline

Returns true if this is a CDATA text element.

Definition at line 1009 of file tinyxml2.h.

◆ operator=() [1/2]

XMLText & tinyxml2::XMLText::operator= ( const XMLText & )
private

◆ operator=() [2/2]

XMLText & tinyxml2::XMLText::operator= ( const XMLText & )
private

◆ ParseDeep() [1/2]

char * tinyxml2::XMLText::ParseDeep ( char * p,
StrPair * parentEndTag,
int * curLineNumPtr )
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

◆ ParseDeep() [2/2]

char * tinyxml2::XMLText::ParseDeep ( char * p,
StrPair * parentEndTag,
int * curLineNumPtr )
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

◆ SetCData() [1/2]

void tinyxml2::XMLText::SetCData ( bool isCData)
inline

Declare whether this should be CDATA or standard text.

Definition at line 1005 of file tinyxml2.h.

◆ SetCData() [2/2]

void tinyxml2::XMLText::SetCData ( bool isCData)
inline

Declare whether this should be CDATA or standard text.

Definition at line 1005 of file tinyxml2.h.

◆ ShallowClone() [1/2]

virtual XMLNode * tinyxml2::XMLText::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 tinyxml2::XMLNode.

◆ ShallowClone() [2/2]

virtual XMLNode * tinyxml2::XMLText::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 tinyxml2::XMLNode.

◆ ShallowEqual() [1/2]

virtual bool tinyxml2::XMLText::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 tinyxml2::XMLNode.

◆ ShallowEqual() [2/2]

virtual bool tinyxml2::XMLText::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 tinyxml2::XMLNode.

◆ ToText() [1/4]

virtual XMLText * tinyxml2::XMLText::ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 997 of file tinyxml2.h.

◆ ToText() [2/4]

virtual XMLText * tinyxml2::XMLText::ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 997 of file tinyxml2.h.

◆ ToText() [3/4]

virtual const XMLText * tinyxml2::XMLText::ToText ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1000 of file tinyxml2.h.

◆ ToText() [4/4]

virtual const XMLText * tinyxml2::XMLText::ToText ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1000 of file tinyxml2.h.

◆ XMLDocument

XMLDocument
friend

Definition at line 993 of file tinyxml2.h.

Member Data Documentation

◆ _isCData

bool tinyxml2::XMLText::_isCData
private

Definition at line 1023 of file tinyxml2.h.


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