Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

TiXmlComment Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlComment:

Inheritance graph
[legend]
Collaboration diagram for TiXmlComment:

Collaboration graph
[legend]
List of all members.

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  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_STRING_COUNT
}

Public Member Functions

 TiXmlComment ()
 Constructs an empty comment.
 TiXmlComment (const TiXmlComment &)
void operator= (const TiXmlComment &base)
virtual ~TiXmlComment ()
virtual TiXmlNodeClone () const
 Returns a copy of this Comment.
virtual void Print (FILE *cfile, int depth) const
 Write this Comment to a FILE stream.
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
const char * Value () const
void SetValue (const char *_value)
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNodeParent ()
 One step up the DOM.
const TiXmlNodeParent () const
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNodeFirstChild ()
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNodeLastChild () const
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNodeLastChild (const char *value) const
TiXmlNodeLastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNodeIterateChildren (TiXmlNode *previous) const
TiXmlNodeIterateChildren (TiXmlNode *previous)
const TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling (const char *)
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling ()
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling (const char *)
const TiXmlElementNextSiblingElement () const
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement (const char *)
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlElementFirstChildElement ()
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement (const char *value)
virtual int Type () const
const TiXmlDocumentGetDocument () const
TiXmlDocumentGetDocument ()
bool NoChildren () const
 Returns true if this node has no children.
const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
const TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlElementToElement ()
 Cast to a more defined type. Will return null not of the requested type.
const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlCommentToComment ()
 Cast to a more defined type. Will return null not of the requested type.
const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null not of the requested type.
const TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlTextToText ()
 Cast to a more defined type. Will return null not of the requested type.
const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null not of the requested type.
int Row () const
int Column () const
 See Row().
void SetUserData (void *user)
void * GetUserData ()

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.

Static Public Attributes

static const int utf8ByteTable [256]

Protected Member Functions

void CopyTo (TiXmlComment *target) const
virtual void StreamOut (TIXML_OSTREAM *out) const
void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
const TIXML_STRING & SValue () const

Static Protected Member Functions

static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool IsWhiteSpace (char c)
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static int ToLower (int v, TiXmlEncoding encoding)
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)

Protected Attributes

TiXmlNodeparent
NodeType type
TiXmlNodefirstChild
TiXmlNodelastChild
TIXML_STRING value
TiXmlNodeprev
TiXmlNodenext
TiXmlCursor location
void * userData
 Field containing a generic user pointer.

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]

Friends

TIXML_OSTREAM & operator<< (TIXML_OSTREAM &out, const TiXmlNode &base)

Detailed Description

An XML comment.

Definition at line 957 of file tinyxml.h.


Member Enumeration Documentation

anonymous enum [inherited]
 

Enumerator:
TIXML_NO_ERROR 
TIXML_ERROR 
TIXML_ERROR_OPENING_FILE 
TIXML_ERROR_OUT_OF_MEMORY 
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_STRING_COUNT 

Definition at line 193 of file tinyxml.h.

enum TiXmlNode::NodeType [inherited]
 

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator:
DOCUMENT 
ELEMENT 
COMMENT 
UNKNOWN 
TEXT 
DECLARATION 
TYPECOUNT 

Definition at line 400 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlComment::TiXmlComment  )  [inline]
 

Constructs an empty comment.

Definition at line 961 of file tinyxml.h.

Referenced by Clone().

TiXmlComment::TiXmlComment const TiXmlComment  ) 
 

Definition at line 1159 of file tinyxml.cpp.

References CopyTo().

virtual TiXmlComment::~TiXmlComment  )  [inline, virtual]
 

Definition at line 965 of file tinyxml.h.


Member Function Documentation

void TiXmlNode::Clear  )  [inherited]
 

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

Definition at line 170 of file tinyxml.cpp.

References TiXmlNode::firstChild, TiXmlNode::lastChild, and TiXmlNode::next.

Referenced by TiXmlElement::ClearThis(), TiXmlDocument::LoadFile(), TiXmlDeclaration::operator=(), operator=(), and TiXmlDocument::operator=().

TiXmlNode * TiXmlComment::Clone  )  const [virtual]
 

Returns a copy of this Comment.

Implements TiXmlNode.

Definition at line 1196 of file tinyxml.cpp.

References CopyTo(), and TiXmlComment().

int TiXmlBase::Column  )  const [inline, inherited]
 

See Row().

Definition at line 180 of file tinyxml.h.

References TiXmlCursor::col, and TiXmlBase::location.

void TiXmlBase::ConvertUTF32ToUTF8 unsigned long  input,
char *  output,
int *  length
[static, protected, inherited]
 

Definition at line 78 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::GetEntity().

void TiXmlNode::CopyTo TiXmlNode target  )  const [protected, inherited]
 

Definition at line 163 of file tinyxml.cpp.

References TiXmlNode::SetValue(), TiXmlBase::userData, and TiXmlNode::value.

Referenced by TiXmlUnknown::CopyTo(), TiXmlDeclaration::CopyTo(), TiXmlText::CopyTo(), CopyTo(), and TiXmlElement::CopyTo().

void TiXmlComment::CopyTo TiXmlComment target  )  const [protected]
 

Definition at line 1190 of file tinyxml.cpp.

References TiXmlNode::CopyTo().

Referenced by Clone(), operator=(), and TiXmlComment().

TiXmlNode * TiXmlNode::FirstChild const char *  value  )  [inherited]
 

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

Definition at line 328 of file tinyxml.cpp.

References TiXmlNode::firstChild, TiXmlNode::next, TiXmlNode::SValue(), and TIXML_CAST_STRING.

const TiXmlNode * TiXmlNode::FirstChild const char *  value  )  const [inherited]
 

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

Definition at line 316 of file tinyxml.cpp.

References TiXmlNode::firstChild, TiXmlNode::next, TiXmlNode::SValue(), and TIXML_CAST_STRING.

TiXmlNode* TiXmlNode::FirstChild  )  [inline, inherited]
 

Definition at line 455 of file tinyxml.h.

References TiXmlNode::firstChild.

const TiXmlNode* TiXmlNode::FirstChild  )  const [inline, inherited]
 

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

Definition at line 454 of file tinyxml.h.

References TiXmlNode::firstChild.

Referenced by TiXmlHandle::Child(), TiXmlHandle::FirstChild(), TiXmlNode::FirstChildElement(), TiXmlNode::IterateChildren(), TiXmlDocument::Print(), and TiXmlDocument::StreamOut().

TiXmlElement * TiXmlNode::FirstChildElement const char *  value  )  [inherited]
 

Definition at line 510 of file tinyxml.cpp.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

const TiXmlElement * TiXmlNode::FirstChildElement const char *  value  )  const [inherited]
 

Convenience function to get through elements.

Definition at line 496 of file tinyxml.cpp.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

TiXmlElement * TiXmlNode::FirstChildElement  )  [inherited]
 

Definition at line 482 of file tinyxml.cpp.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

const TiXmlElement * TiXmlNode::FirstChildElement  )  const [inherited]
 

Convenience function to get through elements.

Definition at line 468 of file tinyxml.cpp.

References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

Referenced by TiXmlHandle::ChildElement(), TiXmlHandle::FirstChildElement(), CEGUI::TinyXMLDocument::processElement(), and TiXmlDocument::RootElement().

static const char* TiXmlBase::GetChar const char *  p,
char *  _value,
int *  length,
TiXmlEncoding  encoding
[inline, static, protected, inherited]
 

Definition at line 260 of file tinyxml.h.

References TiXmlBase::GetEntity(), TIXML_ENCODING_UTF8, and TiXmlBase::utf8ByteTable.

Referenced by TiXmlBase::ReadText().

TiXmlDocument * TiXmlNode::GetDocument  )  [inherited]
 

Definition at line 593 of file tinyxml.cpp.

References TiXmlNode::parent, and TiXmlNode::ToDocument().

const TiXmlDocument * TiXmlNode::GetDocument  )  const [inherited]
 

Return a pointer to the Document this node lives in. Returns null if not in a document.

Definition at line 581 of file tinyxml.cpp.

References TiXmlNode::parent, and TiXmlNode::ToDocument().

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

const char * TiXmlBase::GetEntity const char *  in,
char *  value,
int *  length,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 413 of file tinyxmlparser.cpp.

References TiXmlBase::ConvertUTF32ToUTF8(), TIXML_ENCODING_UTF8, and TIXML_STRING.

Referenced by TiXmlBase::GetChar().

void* TiXmlBase::GetUserData  )  [inline, inherited]
 

Definition at line 183 of file tinyxml.h.

References TiXmlBase::userData.

TiXmlNode * TiXmlNode::Identify const char *  start,
TiXmlEncoding  encoding
[protected, inherited]
 

Definition at line 790 of file tinyxmlparser.cpp.

References TiXmlNode::GetDocument(), TiXmlBase::IsAlpha(), TiXmlNode::parent, TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, TIXML_LOG, and TiXmlNode::TiXmlElement.

Referenced by TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

TiXmlNode * TiXmlNode::InsertAfterChild TiXmlNode afterThis,
const TiXmlNode addThis
[inherited]
 

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 240 of file tinyxml.cpp.

References TiXmlNode::Clone(), TiXmlNode::lastChild, TiXmlNode::next, TiXmlNode::parent, and TiXmlNode::prev.

TiXmlNode * TiXmlNode::InsertBeforeChild TiXmlNode beforeThis,
const TiXmlNode addThis
[inherited]
 

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 214 of file tinyxml.cpp.

References TiXmlNode::Clone(), TiXmlNode::firstChild, TiXmlNode::next, TiXmlNode::parent, and TiXmlNode::prev.

TiXmlNode * TiXmlNode::InsertEndChild const TiXmlNode addThis  )  [inherited]
 

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 204 of file tinyxml.cpp.

References TiXmlNode::Clone(), and TiXmlNode::LinkEndChild().

int TiXmlBase::IsAlpha unsigned char  anyByte,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 119 of file tinyxmlparser.cpp.

Referenced by TiXmlNode::Identify(), and TiXmlBase::ReadName().

int TiXmlBase::IsAlphaNum unsigned char  anyByte,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 140 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::ReadName().

static bool TiXmlBase::IsWhiteSpace char  c  )  [inline, static, protected, inherited]
 

Definition at line 227 of file tinyxml.h.

Referenced by TiXmlText::Blank(), TiXmlDeclaration::Parse(), TiXmlAttribute::Parse(), TiXmlBase::ReadText(), and TiXmlBase::SkipWhiteSpace().

static bool TiXmlBase::IsWhiteSpaceCondensed  )  [inline, static, inherited]
 

Return the current white space setting.

Definition at line 159 of file tinyxml.h.

Referenced by TiXmlElement::ReadValue().

TiXmlNode * TiXmlNode::IterateChildren const char *  value,
TiXmlNode previous
[inherited]
 

Definition at line 401 of file tinyxml.cpp.

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

const TiXmlNode * TiXmlNode::IterateChildren const char *  value,
TiXmlNode previous
const [inherited]
 

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

Definition at line 388 of file tinyxml.cpp.

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

TiXmlNode * TiXmlNode::IterateChildren TiXmlNode previous  )  [inherited]
 

Definition at line 375 of file tinyxml.cpp.

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

const TiXmlNode * TiXmlNode::IterateChildren TiXmlNode previous  )  const [inherited]
 

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 362 of file tinyxml.cpp.

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

TiXmlNode * TiXmlNode::LastChild const char *  value  )  [inherited]
 

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

Definition at line 351 of file tinyxml.cpp.

References TiXmlNode::lastChild, TiXmlNode::prev, TiXmlNode::SValue(), and TIXML_CAST_STRING.

const TiXmlNode * TiXmlNode::LastChild const char *  value  )  const [inherited]
 

Definition at line 340 of file tinyxml.cpp.

References TiXmlNode::lastChild, TiXmlNode::prev, TiXmlNode::SValue(), and TIXML_CAST_STRING.

TiXmlNode* TiXmlNode::LastChild  )  [inline, inherited]
 

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

Definition at line 460 of file tinyxml.h.

References TiXmlNode::lastChild.

const TiXmlNode* TiXmlNode::LastChild  )  const [inline, inherited]
 

Definition at line 459 of file tinyxml.h.

References TiXmlNode::lastChild.

TiXmlNode * TiXmlNode::LinkEndChild TiXmlNode addThis  )  [inherited]
 

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 187 of file tinyxml.cpp.

References TiXmlNode::firstChild, TiXmlNode::lastChild, TiXmlNode::next, TiXmlNode::parent, and TiXmlNode::prev.

Referenced by TiXmlElement::CopyTo(), TiXmlNode::InsertEndChild(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

TiXmlNode * TiXmlNode::NextSibling const char *   )  [inherited]
 

Definition at line 425 of file tinyxml.cpp.

References TiXmlNode::next, TiXmlNode::SValue(), and TIXML_CAST_STRING.

const TiXmlNode * TiXmlNode::NextSibling const char *   )  const [inherited]
 

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

Definition at line 414 of file tinyxml.cpp.

References TiXmlNode::next, TiXmlNode::SValue(), and TIXML_CAST_STRING.

TiXmlNode* TiXmlNode::NextSibling  )  [inline, inherited]
 

Definition at line 551 of file tinyxml.h.

References TiXmlNode::next.

const TiXmlNode* TiXmlNode::NextSibling  )  const [inline, inherited]
 

Navigate to a sibling node.

Definition at line 550 of file tinyxml.h.

References TiXmlNode::next.

Referenced by TiXmlHandle::Child(), TiXmlElement::CopyTo(), TiXmlNode::FirstChildElement(), TiXmlNode::IterateChildren(), TiXmlNode::NextSiblingElement(), TiXmlDocument::Print(), TiXmlElement::Print(), TiXmlDocument::StreamOut(), and TiXmlElement::StreamOut().

TiXmlElement * TiXmlNode::NextSiblingElement const char *   )  [inherited]
 

Definition at line 566 of file tinyxml.cpp.

References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

const TiXmlElement * TiXmlNode::NextSiblingElement const char *   )  const [inherited]
 

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 552 of file tinyxml.cpp.

References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

TiXmlElement * TiXmlNode::NextSiblingElement  )  [inherited]
 

Definition at line 538 of file tinyxml.cpp.

References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

const TiXmlElement * TiXmlNode::NextSiblingElement  )  const [inherited]
 

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 524 of file tinyxml.cpp.

References TiXmlNode::NextSibling(), and TiXmlNode::ToElement().

Referenced by TiXmlHandle::ChildElement().

bool TiXmlNode::NoChildren  )  const [inline, inherited]
 

Returns true if this node has no children.

Definition at line 602 of file tinyxml.h.

References TiXmlNode::firstChild.

void TiXmlComment::operator= const TiXmlComment base  ) 
 

Definition at line 1165 of file tinyxml.cpp.

References TiXmlNode::Clear(), and CopyTo().

const TiXmlNode* TiXmlNode::Parent  )  const [inline, inherited]
 

Definition at line 452 of file tinyxml.h.

References TiXmlNode::parent.

TiXmlNode* TiXmlNode::Parent  )  [inline, inherited]
 

One step up the DOM.

Definition at line 451 of file tinyxml.h.

References TiXmlNode::parent.

const char * TiXmlComment::Parse const char *  p,
TiXmlParsingData data,
TiXmlEncoding  encoding
[virtual]
 

Implements TiXmlBase.

Definition at line 1276 of file tinyxmlparser.cpp.

References TiXmlParsingData::Cursor(), TiXmlNode::GetDocument(), TiXmlBase::location, TiXmlBase::ReadText(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_PARSING_COMMENT, and TiXmlNode::value.

TiXmlNode * TiXmlNode::PreviousSibling const char *   )  [inherited]
 

Definition at line 447 of file tinyxml.cpp.

References TiXmlNode::prev, TiXmlNode::SValue(), and TIXML_CAST_STRING.

const TiXmlNode * TiXmlNode::PreviousSibling const char *   )  const [inherited]
 

Navigate to a sibling node.

Definition at line 436 of file tinyxml.cpp.

References TiXmlNode::prev, TiXmlNode::SValue(), and TIXML_CAST_STRING.

TiXmlNode* TiXmlNode::PreviousSibling  )  [inline, inherited]
 

Definition at line 536 of file tinyxml.h.

References TiXmlNode::prev.

const TiXmlNode* TiXmlNode::PreviousSibling  )  const [inline, inherited]
 

Navigate to a sibling node.

Definition at line 535 of file tinyxml.h.

References TiXmlNode::prev.

void TiXmlComment::Print FILE *  cfile,
int  depth
const [virtual]
 

Write this Comment to a FILE stream.

Implements TiXmlBase.

Definition at line 1172 of file tinyxml.cpp.

References TiXmlNode::value.

void TiXmlBase::PutString const TIXML_STRING &  str,
TIXML_STRING *  out
[static, protected, inherited]
 

Definition at line 42 of file tinyxml.cpp.

void TiXmlBase::PutString const TIXML_STRING &  str,
TIXML_OSTREAM *  out
[static, protected, inherited]
 

Definition at line 35 of file tinyxml.cpp.

References TIXML_STRING.

Referenced by TiXmlText::Print(), TiXmlAttribute::Print(), TiXmlDeclaration::StreamOut(), TiXmlText::StreamOut(), and TiXmlAttribute::StreamOut().

const char * TiXmlBase::ReadName const char *  p,
TIXML_STRING *  name,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 383 of file tinyxmlparser.cpp.

References TiXmlBase::IsAlpha(), and TiXmlBase::IsAlphaNum().

Referenced by TiXmlAttribute::Parse(), and TiXmlElement::Parse().

const char * TiXmlBase::ReadText const char *  in,
TIXML_STRING *  text,
bool  ignoreWhiteSpace,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 549 of file tinyxmlparser.cpp.

References TiXmlBase::GetChar(), TiXmlBase::IsWhiteSpace(), TiXmlBase::SkipWhiteSpace(), and TiXmlBase::StringEqual().

Referenced by TiXmlText::Parse(), TiXmlAttribute::Parse(), and Parse().

bool TiXmlNode::RemoveChild TiXmlNode removeThis  )  [inherited]
 

Delete a child of this node.

Definition at line 294 of file tinyxml.cpp.

References TiXmlNode::firstChild, TiXmlNode::lastChild, TiXmlNode::next, TiXmlNode::parent, and TiXmlNode::prev.

TiXmlNode * TiXmlNode::ReplaceChild TiXmlNode replaceThis,
const TiXmlNode withThis
[inherited]
 

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.

Definition at line 266 of file tinyxml.cpp.

References TiXmlNode::Clone(), TiXmlNode::firstChild, TiXmlNode::lastChild, TiXmlNode::next, TiXmlNode::parent, and TiXmlNode::prev.

int TiXmlBase::Row  )  const [inline, inherited]
 

Return the position, in the original source file, of this node or attribute. The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also:
TiXmlDocument::SetTabSize()

Definition at line 179 of file tinyxml.h.

References TiXmlBase::location, and TiXmlCursor::row.

static void TiXmlBase::SetCondenseWhiteSpace bool  condense  )  [inline, static, inherited]
 

The world does not agree on whether white space should be kept or not. In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this values is not thread safe.

Definition at line 156 of file tinyxml.h.

void TiXmlBase::SetUserData void *  user  )  [inline, inherited]
 

Definition at line 182 of file tinyxml.h.

References TiXmlBase::userData.

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

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 436 of file tinyxml.h.

References TiXmlNode::value.

Referenced by TiXmlNode::CopyTo(), and TiXmlText::TiXmlText().

const char * TiXmlBase::SkipWhiteSpace const char *  ,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 301 of file tinyxmlparser.cpp.

References TiXmlBase::IsWhiteSpace(), TIXML_ENCODING_UTF8, TIXML_UTF_LEAD_0, TIXML_UTF_LEAD_1, and TIXML_UTF_LEAD_2.

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), TiXmlAttribute::Parse(), Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), TiXmlBase::ReadText(), and TiXmlElement::ReadValue().

void TiXmlComment::StreamOut TIXML_OSTREAM *  out  )  const [protected, virtual]
 

Implements TiXmlBase.

Definition at line 1181 of file tinyxml.cpp.

References TiXmlNode::value.

bool TiXmlBase::StringEqual const char *  p,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding
[static, protected, inherited]
 

Definition at line 509 of file tinyxmlparser.cpp.

References TiXmlBase::ToLower().

Referenced by TiXmlNode::Identify(), TiXmlDeclaration::Parse(), Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), TiXmlBase::ReadText(), and TiXmlElement::ReadValue().

const TIXML_STRING& TiXmlNode::SValue  )  const [inline, protected, inherited]
 

Definition at line 639 of file tinyxml.h.

References TiXmlNode::value.

Referenced by TiXmlNode::FirstChild(), TiXmlNode::LastChild(), TiXmlNode::NextSibling(), and TiXmlNode::PreviousSibling().

TiXmlComment* TiXmlNode::ToComment  )  [inline, inherited]
 

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

Definition at line 613 of file tinyxml.h.

References TiXmlNode::COMMENT, and TiXmlNode::type.

const TiXmlComment* TiXmlNode::ToComment  )  const [inline, inherited]
 

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

Definition at line 606 of file tinyxml.h.

References TiXmlNode::COMMENT, and TiXmlNode::type.

TiXmlDeclaration* TiXmlNode::ToDeclaration  )  [inline, inherited]
 

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

Definition at line 616 of file tinyxml.h.

References TiXmlNode::DECLARATION, and TiXmlNode::type.

const TiXmlDeclaration* TiXmlNode::ToDeclaration  )  const [inline, inherited]
 

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

Definition at line 609 of file tinyxml.h.

References TiXmlNode::DECLARATION, and TiXmlNode::type.

Referenced by TiXmlDocument::Parse().

TiXmlDocument* TiXmlNode::ToDocument  )  [inline, inherited]
 

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

Definition at line 611 of file tinyxml.h.

References TiXmlNode::DOCUMENT, and TiXmlNode::type.

const TiXmlDocument* TiXmlNode::ToDocument  )  const [inline, inherited]
 

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

Definition at line 604 of file tinyxml.h.

References TiXmlNode::DOCUMENT, and TiXmlNode::type.

Referenced by TiXmlNode::GetDocument().

TiXmlElement* TiXmlNode::ToElement  )  [inline, inherited]
 

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

Definition at line 612 of file tinyxml.h.

References TiXmlNode::ELEMENT, and TiXmlNode::type.

const TiXmlElement* TiXmlNode::ToElement  )  const [inline, inherited]
 

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

Definition at line 605 of file tinyxml.h.

References TiXmlNode::ELEMENT, and TiXmlNode::type.

Referenced by TiXmlHandle::Element(), TiXmlNode::FirstChildElement(), TiXmlNode::NextSiblingElement(), and TiXmlDocument::StreamOut().

static int TiXmlBase::ToLower int  v,
TiXmlEncoding  encoding
[inline, static, protected, inherited]
 

Definition at line 317 of file tinyxml.h.

References TIXML_ENCODING_UTF8.

Referenced by TiXmlBase::StringEqual().

TiXmlText* TiXmlNode::ToText  )  [inline, inherited]
 

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

Definition at line 615 of file tinyxml.h.

References TiXmlNode::TEXT, and TiXmlNode::type.

const TiXmlText* TiXmlNode::ToText  )  const [inline, inherited]
 

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

Definition at line 608 of file tinyxml.h.

References TiXmlNode::TEXT, and TiXmlNode::type.

Referenced by TiXmlElement::Print(), and TiXmlHandle::Text().

TiXmlUnknown* TiXmlNode::ToUnknown  )  [inline, inherited]
 

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

Definition at line 614 of file tinyxml.h.

References TiXmlNode::type, and TiXmlNode::UNKNOWN.

const TiXmlUnknown* TiXmlNode::ToUnknown  )  const [inline, inherited]
 

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

Definition at line 607 of file tinyxml.h.

References TiXmlNode::type, and TiXmlNode::UNKNOWN.

Referenced by TiXmlHandle::Unknown().

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

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 593 of file tinyxml.h.

References TiXmlNode::type.

const char* TiXmlNode::Value  )  const [inline, inherited]
 

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 425 of file tinyxml.h.

References TiXmlNode::value.

Referenced by TiXmlElement::Clone(), and CEGUI::TinyXMLDocument::processElement().


Friends And Related Function Documentation

TIXML_OSTREAM& operator<< TIXML_OSTREAM &  out,
const TiXmlNode base
[friend, inherited]
 

Definition at line 1452 of file tinyxml.cpp.


Member Data Documentation

const char * TiXmlBase::errorString [static, protected, inherited]
 

Initial value:

{
        "No error",
        "Error",
        "Failed to open file",
        "Memory allocation failed.",
        "Error parsing Element.",
        "Failed to read Element name",
        "Error reading Element value.",
        "Error reading Attributes.",
        "Error: empty tag.",
        "Error reading end tag.",
        "Error parsing Unknown.",
        "Error parsing Comment.",
        "Error parsing Declaration.",
        "Error document empty.",
        "Error null (0) or unexpected EOF found in input stream.",
}

Definition at line 34 of file tinyxmlerror.cpp.

Referenced by TiXmlDocument::SetError().

TiXmlNode* TiXmlNode::firstChild [protected, inherited]
 

Definition at line 644 of file tinyxml.h.

Referenced by TiXmlNode::Clear(), TiXmlElement::CopyTo(), TiXmlNode::FirstChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::LinkEndChild(), TiXmlNode::NoChildren(), TiXmlDocument::Parse(), TiXmlElement::Print(), TiXmlNode::RemoveChild(), TiXmlNode::ReplaceChild(), TiXmlElement::StreamOut(), TiXmlElement::TiXmlElement(), TiXmlNode::TiXmlNode(), and TiXmlNode::~TiXmlNode().

TiXmlNode* TiXmlNode::lastChild [protected, inherited]
 

Definition at line 645 of file tinyxml.h.

Referenced by TiXmlNode::Clear(), TiXmlNode::InsertAfterChild(), TiXmlNode::LastChild(), TiXmlNode::LinkEndChild(), TiXmlElement::Print(), TiXmlNode::RemoveChild(), TiXmlNode::ReplaceChild(), TiXmlElement::TiXmlElement(), and TiXmlNode::TiXmlNode().

TiXmlCursor TiXmlBase::location [protected, inherited]
 

Definition at line 308 of file tinyxml.h.

Referenced by TiXmlBase::Column(), TiXmlDocument::LoadFile(), TiXmlDeclaration::Parse(), TiXmlText::Parse(), TiXmlAttribute::Parse(), Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlDocument::Parse(), and TiXmlBase::Row().

TiXmlNode* TiXmlNode::next [protected, inherited]
 

Definition at line 650 of file tinyxml.h.

Referenced by TiXmlNode::Clear(), TiXmlNode::FirstChild(), TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::LinkEndChild(), TiXmlNode::NextSibling(), TiXmlNode::RemoveChild(), TiXmlNode::ReplaceChild(), TiXmlNode::TiXmlNode(), and TiXmlNode::~TiXmlNode().

TiXmlNode* TiXmlNode::parent [protected, inherited]
 

Definition at line 641 of file tinyxml.h.

Referenced by TiXmlNode::GetDocument(), TiXmlNode::Identify(), TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::IterateChildren(), TiXmlNode::LinkEndChild(), TiXmlNode::Parent(), TiXmlNode::RemoveChild(), TiXmlNode::ReplaceChild(), and TiXmlNode::TiXmlNode().

TiXmlNode* TiXmlNode::prev [protected, inherited]
 

Definition at line 649 of file tinyxml.h.

Referenced by TiXmlNode::InsertAfterChild(), TiXmlNode::InsertBeforeChild(), TiXmlNode::LastChild(), TiXmlNode::LinkEndChild(), TiXmlNode::PreviousSibling(), TiXmlNode::RemoveChild(), TiXmlNode::ReplaceChild(), and TiXmlNode::TiXmlNode().

NodeType TiXmlNode::type [protected, inherited]
 

Definition at line 642 of file tinyxml.h.

Referenced by TiXmlNode::TiXmlNode(), TiXmlNode::ToComment(), TiXmlNode::ToDeclaration(), TiXmlNode::ToDocument(), TiXmlNode::ToElement(), TiXmlNode::ToText(), TiXmlNode::ToUnknown(), and TiXmlNode::Type().

void* TiXmlBase::userData [protected, inherited]
 

Field containing a generic user pointer.

Definition at line 311 of file tinyxml.h.

Referenced by TiXmlNode::CopyTo(), TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().

const int TiXmlBase::utf8ByteTable [static, inherited]
 

Initial value:

 
{
        
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      
                1,      1,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      
                2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      2,      
                3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      3,      
                4,      4,      4,      4,      4,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1,      1       
}

Definition at line 56 of file tinyxmlparser.cpp.

Referenced by TiXmlBase::GetChar(), and TiXmlParsingData::Stamp().

TIXML_STRING TiXmlNode::value [protected, inherited]
 

Definition at line 647 of file tinyxml.h.

Referenced by TiXmlText::Blank(), TiXmlNode::CopyTo(), TiXmlDocument::LoadFile(), TiXmlText::Parse(), TiXmlAttribute::Parse(), Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlUnknown::Print(), TiXmlText::Print(), Print(), TiXmlElement::Print(), TiXmlDocument::SaveFile(), TiXmlNode::SetValue(), TiXmlUnknown::StreamOut(), TiXmlText::StreamOut(), StreamOut(), TiXmlElement::StreamOut(), TiXmlNode::SValue(), TiXmlDocument::TiXmlDocument(), TiXmlElement::TiXmlElement(), and TiXmlNode::Value().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:05:22 2005 for Crazy Eddies GUI System by  doxygen 1.4.3