ddc
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:
Inheritance graph
[legend]
Collaboration diagram for TiXmlElement:
Collaboration graph
[legend]

Public Member Functions

 TiXmlElement (const char *in_value)
 Construct an element. More...
 
 TiXmlElement (const TiXmlElement &)
 
void operator= (const TiXmlElement &base)
 
virtual ~TiXmlElement ()
 
const char * Attribute (const char *name) const
 
const char * Attribute (const char *name, int *i) const
 
const char * Attribute (const char *name, double *d) const
 
int QueryIntAttribute (const char *name, int *value) const
 
int QueryDoubleAttribute (const char *name, double *value) const
 QueryDoubleAttribute examines the attribute - see QueryIntAttribute(). More...
 
void SetAttribute (const char *name, const char *value)
 
void SetAttribute (const char *name, int value)
 
void SetDoubleAttribute (const char *name, double value)
 
void RemoveAttribute (const char *name)
 
TiXmlAttributeFirstAttribute () const
 Access the first attribute in this element. More...
 
TiXmlAttributeLastAttribute () const
 Access the last attribute in this element. More...
 
virtual TiXmlNodeClone () const
 Creates a new Element and returns it - the returned element is a copy. More...
 
virtual void Print (FILE *cfile, int depth) const
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNodeParent () const
 One step up the DOM. More...
 
TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
TiXmlNodeLastChild () const
 
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children. More...
 
TiXmlNodeIterateChildren (TiXmlNode *previous) const
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
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. More...
 
TiXmlNodePreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementFirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements. More...
 
virtual int Type () const
 
TiXmlDocumentGetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
int Row () const
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 
void * GetUserData ()
 

Protected Member Functions

void CopyTo (TiXmlElement *target) const
 
void ClearThis ()
 
virtual void StreamOut (TiXmlOutStream *out) const
 
const char * ReadValue (const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 
const TiXmlStringSValue () const
 

Private Attributes

TiXmlAttributeSet attributeSet
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Protected Types inherited from TiXmlBase
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
}
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static const char * ReadName (const char *p, TiXmlString *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TiXmlString *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 TiXmlString &str, TiXmlOutStream *out)
 
static void PutString (const TiXmlString &str, TiXmlString *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 inherited from TiXmlNode
TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TiXmlString value
 
TiXmlNodeprev
 
TiXmlNodenext
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Detailed Description

The element is a container class. It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.

Constructor & Destructor Documentation

◆ TiXmlElement() [1/2]

TiXmlElement::TiXmlElement ( const char *  in_value)

Construct an element.

References TiXmlNode::ELEMENT, TiXmlNode::firstChild, TiXmlNode::lastChild, TiXmlNode::TiXmlNode(), and TiXmlNode::value.

Referenced by Clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TiXmlElement() [2/2]

TiXmlElement::TiXmlElement ( const TiXmlElement copy)

References CopyTo(), TiXmlNode::firstChild, and TiXmlNode::lastChild.

Here is the call graph for this function:

◆ ~TiXmlElement()

TiXmlElement::~TiXmlElement ( )
virtual

References ClearThis().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

void TiXmlElement::operator= ( const TiXmlElement base)

References ClearThis(), and CopyTo().

Here is the call graph for this function:

◆ Attribute() [1/3]

const char * TiXmlElement::Attribute ( const char *  name) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

References attributeSet, TiXmlAttributeSet::Find(), and TiXmlAttribute::Value().

Referenced by Attribute(), and GetCWBFormattedStringRecursive().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Attribute() [2/3]

const char * TiXmlElement::Attribute ( const char *  name,
int *  i 
) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.

References Attribute().

Here is the call graph for this function:

◆ Attribute() [3/3]

const char * TiXmlElement::Attribute ( const char *  name,
double *  d 
) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.

References Attribute().

Here is the call graph for this function:

◆ QueryIntAttribute()

int TiXmlElement::QueryIntAttribute ( const char *  name,
int *  value 
) const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking. If the attribute is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

References attributeSet, TiXmlAttributeSet::Find(), TiXmlAttribute::QueryIntValue(), and TIXML_NO_ATTRIBUTE.

Here is the call graph for this function:

◆ QueryDoubleAttribute()

int TiXmlElement::QueryDoubleAttribute ( const char *  name,
double *  value 
) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

References attributeSet, TiXmlAttributeSet::Find(), TiXmlAttribute::QueryDoubleValue(), and TIXML_NO_ATTRIBUTE.

Here is the call graph for this function:

◆ SetAttribute() [1/2]

void TiXmlElement::SetAttribute ( const char *  name,
const char *  value 
)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

References TiXmlAttributeSet::Add(), attributeSet, TiXmlAttributeSet::Find(), TiXmlNode::GetDocument(), TiXmlDocument::SetError(), TiXmlAttribute::SetValue(), TIXML_ENCODING_UNKNOWN, and TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY.

Referenced by CopyTo(), SetAttribute(), and SetDoubleAttribute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetAttribute() [2/2]

void TiXmlElement::SetAttribute ( const char *  name,
int  value 
)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

References SetAttribute().

Here is the call graph for this function:

◆ SetDoubleAttribute()

void TiXmlElement::SetDoubleAttribute ( const char *  name,
double  value 
)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

References SetAttribute().

Here is the call graph for this function:

◆ RemoveAttribute()

void TiXmlElement::RemoveAttribute ( const char *  name)

Deletes an attribute with the given name.

◆ FirstAttribute()

TiXmlAttribute* TiXmlElement::FirstAttribute ( ) const
inline

Access the first attribute in this element.

◆ LastAttribute()

TiXmlAttribute* TiXmlElement::LastAttribute ( ) const
inline

Access the last attribute in this element.

References TIXML_OSTREAM, and TIXML_STRING.

◆ Clone()

TiXmlNode * TiXmlElement::Clone ( void  ) const
virtual

Creates a new Element and returns it - the returned element is a copy.

Implements TiXmlNode.

References CopyTo(), TiXmlElement(), and TiXmlNode::Value().

Referenced by TiXmlText::operator=(), and TiXmlNode::ToDeclaration().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Print()

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

All TinyXml classes can print themselves to a filestream. This is a formatted print, and will insert tabs and newlines.

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

Implements TiXmlBase.

References attributeSet, TiXmlString::c_str(), TiXmlAttributeSet::First(), TiXmlNode::firstChild, TiXmlNode::lastChild, TiXmlAttribute::Next(), TiXmlNode::NextSibling(), TiXmlBase::Print(), TiXmlNode::ToText(), and TiXmlNode::value.

Referenced by TiXmlText::operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Parse()

const char * TiXmlElement::Parse ( const char *  p,
TiXmlParsingData data,
TiXmlEncoding  encoding 
)
virtual

◆ CopyTo()

void TiXmlElement::CopyTo ( TiXmlElement target) const
protected

◆ ClearThis()

void TiXmlElement::ClearThis ( )
protected

References attributeSet, TiXmlNode::Clear(), TiXmlAttributeSet::First(), and TiXmlAttributeSet::Remove().

Referenced by operator=(), and ~TiXmlElement().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StreamOut()

void TiXmlElement::StreamOut ( TiXmlOutStream out) const
protectedvirtual

Implements TiXmlBase.

References attributeSet, TiXmlAttributeSet::First(), TiXmlNode::firstChild, TiXmlAttribute::Next(), TiXmlNode::NextSibling(), TiXmlBase::StreamOut(), TiXmlAttribute::StreamOut(), and TiXmlNode::value.

Referenced by TiXmlText::operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ReadValue()

const char * TiXmlElement::ReadValue ( const char *  in,
TiXmlParsingData prevData,
TiXmlEncoding  encoding 
)
protected

Member Data Documentation

◆ attributeSet

TiXmlAttributeSet TiXmlElement::attributeSet
private

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