edelib  2.0.0
Public Member Functions
TiXmlElement Class Reference

Container xml class. More...

#include <edelib/TiXml.h>

Inheritance diagram for TiXmlElement:
TiXmlNode TiXmlBase

List of all members.

Public Member Functions

 TiXmlElement (const char *in_value)
 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
int QueryFloatAttribute (const char *name, float *_value) const
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)
const TiXmlAttributeFirstAttribute () const
TiXmlAttributeFirstAttribute ()
const TiXmlAttributeLastAttribute () const
TiXmlAttributeLastAttribute ()
const char * GetText () const
virtual TiXmlNodeClone () const
virtual void Print (FILE *cfile, int depth) const
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual const TiXmlElementToElement () const
virtual TiXmlElementToElement ()
virtual bool Accept (TiXmlVisitor *visitor) const

Detailed Description

Container xml class.

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 ( const char *  in_value)

Construct an element

TiXmlElement ( const TiXmlElement )

Construct an element from previous TiXmlElement

virtual ~TiXmlElement ( ) [virtual]

Hem... destructor


Member Function Documentation

virtual bool Accept ( TiXmlVisitor visitor) const [virtual]

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

Implements TiXmlNode.

const char* Attribute ( const char *  name) const

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

const char* 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.

const char* 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.

virtual TiXmlNode* Clone ( ) const [virtual]

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

Implements TiXmlNode.

const TiXmlAttribute* FirstAttribute ( ) const [inline]

Access the first attribute in this element.

Access the first attribute in this element.

const char* GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text:

	 *   <foo>This is text</foo>
	 *   const char* str = fooElement->GetText();
	 * 

'str' will be a pointer to "This is text".

Note that this function can be misleading. If the element foo was created from this XML:

	 *   <foo><b>This is text</b></foo>
	 * 

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

	 *   <foo>This is <b>text</b></foo>
	 * 

GetText() will return "This is ".

WARNING: GetText() accesses a child node - don't become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

const TiXmlAttribute* LastAttribute ( ) const [inline]

Access the last attribute in this element.

Access the last attribute in this element.

void operator= ( const TiXmlElement base)

Construct an element from previous TiXmlElement

virtual const char* Parse ( const char *  p,
TiXmlParsingData *  data,
TiXmlEncoding  encoding 
) [virtual]

Attribtue parsing starts: next char past '<' returns: next char past '>'

virtual void Print ( FILE *  cfile,
int  depth 
) const [virtual]

Print the Element to a FILE stream

Implements TiXmlBase.

int QueryDoubleAttribute ( const char *  name,
double *  _value 
) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute()

int QueryFloatAttribute ( const char *  name,
float *  _value 
) const [inline]

QueryFloatAttribute examines the attribute - see QueryIntAttribute()

int 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.

void RemoveAttribute ( const char *  name)

Deletes an attribute with the given name.

void 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.

void 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.

void 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.

virtual const TiXmlElement* ToElement ( ) const [inline, virtual]

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

Reimplemented from TiXmlNode.

virtual TiXmlElement* ToElement ( ) [inline, virtual]

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

Reimplemented from TiXmlNode.


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