Panda3D
Public Member Functions | List of all members
TiXmlComment Class Reference

An XML comment. More...

#include "tinyxml.h"

Inheritance diagram for TiXmlComment:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlComment ()
 Constructs an empty comment. More...
 
 TiXmlComment (const char *_value)
 Construct a comment from text. More...
 
 TiXmlComment (const TiXmlComment &)
 
virtual bool Accept (TiXmlVisitor *visitor) const
 Walk the XML tree visiting this node and all of its children. More...
 
virtual TiXmlNode * Clone () const
 Returns a copy of this Comment. More...
 
void operator= (const TiXmlComment &base)
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
virtual void Print (FILE *cfile, int depth) const
 All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null. More...
 
virtual const TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
- Public Member Functions inherited from TiXmlNode
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
const TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNode * FirstChild ()
 
const TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'. More...
 
TiXmlNode * FirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
const TiXmlElement * FirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElement * FirstChildElement ()
 
const TiXmlElement * FirstChildElement (const char *_value) const
 Convenience function to get through elements. More...
 
TiXmlElement * FirstChildElement (const char *_value)
 
const TiXmlDocument * GetDocument () const
 Return a pointer to the Document this node lives in. More...
 
TiXmlDocument * GetDocument ()
 
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this. More...
 
const TiXmlNode * IterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node. More...
 
TiXmlNode * IterateChildren (const TiXmlNode *previous)
 
const TiXmlNode * IterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
TiXmlNode * IterateChildren (const char *_value, const TiXmlNode *previous)
 
const TiXmlNode * LastChild () const
 
TiXmlNode * LastChild ()
 The last child of this node. Will be null if there are no children. More...
 
const TiXmlNode * LastChild (const char *value) const
 
TiXmlNode * LastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
 Add a new node related to this. More...
 
const TiXmlNode * NextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNode * NextSibling ()
 
const TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlNode * NextSibling (const char *_next)
 
const TiXmlElement * NextSiblingElement () const
 Convenience function to get through elements. More...
 
TiXmlElement * NextSiblingElement ()
 
const TiXmlElement * NextSiblingElement (const char *) const
 Convenience function to get through elements. More...
 
TiXmlElement * NextSiblingElement (const char *_next)
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
TiXmlNode * Parent ()
 One step up the DOM. More...
 
const TiXmlNode * Parent () const
 
const TiXmlNode * PreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNode * PreviousSibling ()
 
const TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNode * PreviousSibling (const char *_prev)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node. More...
 
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node. More...
 
void SetValue (const char *_value)
 Changes the value of the node. More...
 
virtual const TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDeclaration * ToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlText * ToText () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlText * ToText ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
int Type () const
 Query the type (as an enumerated value, above) of this node. More...
 
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode. More...
 
const TiXmlString & ValueTStr () const
 
- Public Member Functions inherited from TiXmlBase
int Column () const
 See Row() More...
 
void * GetUserData ()
 Get a pointer to arbitrary user data. More...
 
const void * GetUserData () const
 Get a pointer to arbitrary user data. More...
 
int Row () const
 Return the position, in the original source file, of this node or attribute. More...
 
void SetUserData (void *user)
 Set a pointer to arbitrary user data. More...
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN,
  TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 
- Public Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT,
  TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY,
  TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION,
  TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY,
  TIXML_ERROR_STRING_COUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void EncodeString (const TiXmlString &str, TiXmlString *out)
 Expands entities in a string. More...
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 

Detailed Description

An XML comment.

Definition at line 1155 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlComment() [1/2]

TiXmlComment::TiXmlComment ( )
inline

Constructs an empty comment.

Definition at line 1159 of file tinyxml.h.

Referenced by Clone().

◆ TiXmlComment() [2/2]

TiXmlComment::TiXmlComment ( const char *  _value)
inline

Construct a comment from text.

Definition at line 1161 of file tinyxml.h.

References TiXmlNode::SetValue().

Member Function Documentation

◆ Accept()

bool TiXmlComment::Accept ( TiXmlVisitor *  visitor) const
virtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 1290 of file tinyxml.cpp.

References TiXmlVisitor::Visit().

◆ Clone()

TiXmlNode * TiXmlComment::Clone ( ) const
virtual

Returns a copy of this Comment.

Implements TiXmlNode.

Definition at line 1296 of file tinyxml.cpp.

References TiXmlComment().

◆ Print()

void TiXmlComment::Print ( FILE *  cfile,
int  depth 
) const
virtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 1273 of file tinyxml.cpp.

◆ ToComment() [1/2]

virtual const TiXmlComment* TiXmlComment::ToComment ( ) const
inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1179 of file tinyxml.h.

◆ ToComment() [2/2]

virtual TiXmlComment* TiXmlComment::ToComment ( )
inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1180 of file tinyxml.h.


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