TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

Collaboration diagram for TiXmlElement:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const
const char *	Attribute (const char *name) const
const char *	Attribute (const char *name, double *d) const
const char *	Attribute (const char *name, int *i) const
virtual TiXmlNode *	Clone () const
	Creates a new Element and returns it - the returned element is a copy. More...
TiXmlAttribute *	FirstAttribute ()
const TiXmlAttribute *	FirstAttribute () const
	Access the first attribute in this element. More...
const char *	GetText () const
TiXmlAttribute *	LastAttribute ()
const TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element. More...
TiXmlElement &	operator= (const TiXmlElement &base)
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
int	QueryBoolAttribute (const char *name, bool *_value) const
int	QueryDoubleAttribute (const char *name, double *_value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute(). More...
int	QueryFloatAttribute (const char *name, float *_value) const
	QueryFloatAttribute examines the attribute - see QueryIntAttribute(). More...
int	QueryIntAttribute (const char *name, int *_value) const
int	QueryUnsignedAttribute (const char *name, unsigned *_value) const
	QueryUnsignedAttribute examines the attribute - see QueryIntAttribute(). More...
void	RemoveAttribute (const char *name)
void	SetAttribute (const char *name, const char *_value)
void	SetAttribute (const char *name, int value)
void	SetDoubleAttribute (const char *name, double value)
	TiXmlElement (const char *in_value)
	Construct an element. More...
	TiXmlElement (const TiXmlElement &)
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null not of the requested type. More...
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null not of the requested type. More...
virtual	~TiXmlElement ()
Public Member Functions inherited from TiXmlNode
virtual bool	Accept (TiXmlVisitor *visitor) const =0
void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...
virtual TiXmlNode *	Clone () const =0
TiXmlNode *	FirstChild ()
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children. More...
TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found. More...
const TiXmlNode *	FirstChild (const char *value) const
TiXmlElement *	FirstChildElement ()
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...
TiXmlElement *	FirstChildElement (const char *_value)
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements. More...
TiXmlDocument *	GetDocument ()
const TiXmlDocument *	GetDocument () const
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
TiXmlNode *	IterateChildren (const char *_value, 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 TiXmlNode *previous)
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...
const TiXmlNode *	LastChild () const
TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children. More...
const TiXmlNode *	LastChild (const char *value) const
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
TiXmlNode *	NextSibling ()
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...
TiXmlNode *	NextSibling (const char *_next)
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement () const
const TiXmlElement *	NextSiblingElement (const char *) const
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
TiXmlNode *	PreviousSibling ()
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...
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)
void	SetValue (const char *_value)
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type. More...
virtual const TiXmlComment *	ToComment () 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 TiXmlDeclaration *	ToDeclaration () 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 TiXmlDocument *	ToDocument () 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 TiXmlElement *	ToElement () 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 TiXmlText *	ToText () 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...
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type. More...
int	Type () const
const char *	Value () const
const TIXML_STRING &	ValueTStr () const
virtual	~TiXmlNode ()
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...
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0
virtual void	Print (FILE *cfile, int depth) const =0
int	Row () const
void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...
	TiXmlBase ()
virtual	~TiXmlBase ()

Protected Member Functions
void	ClearThis ()
void	CopyTo (TiXmlElement *target) const
const char *	ReadValue (const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding)
Protected Member Functions inherited from TiXmlNode
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
	TiXmlNode (NodeType _type)

Private Attributes
TiXmlAttributeSet	attributeSet

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType {   TINYXML_DOCUMENT , TINYXML_ELEMENT , TINYXML_COMMENT , TINYXML_UNKNOWN ,   TINYXML_TEXT , TINYXML_DECLARATION , TINYXML_TYPECOUNT }
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 TIXML_STRING &str, TIXML_STRING *out)
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...
static void	SetCondenseWhiteSpace (bool condense)
Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]
Static Protected Member Functions inherited from TiXmlBase
static void	ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char *	GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char *	GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool	IsWhiteSpace (char c)
static bool	IsWhiteSpace (int 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 *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int	ToLower (int v, TiXmlEncoding encoding)
Protected Attributes inherited from TiXmlNode
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TiXmlNode *	next
TiXmlNode *	parent
TiXmlNode *	prev
NodeType	type
TIXML_STRING	value
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.

    : TiXmlNode( TiXmlNode::TINYXML_ELEMENT )
{
    firstChild = lastChild = 0;
    value = _value;
}

TiXmlElement() [2/2]

TiXmlElement::TiXmlElement

(

const TiXmlElement &

copy

)

    : TiXmlNode( TiXmlNode::TINYXML_ELEMENT )
{
    firstChild = lastChild = 0;
    copy.CopyTo( this );    
}

~TiXmlElement()

TiXmlElement::~TiXmlElement ( )

virtual

{
    ClearThis();
}

Member Function Documentation

Accept()

bool TiXmlElement::Accept ( TiXmlVisitor *  visitor ) const

virtual

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

Implements TiXmlNode.

{
    if ( visitor->VisitEnter( *this, attributeSet.First() ) ) 
    {
        for ( const TiXmlNode* node=FirstChild(); node; node=node->NextSibling() )
        {
            if ( !node->Accept( visitor ) )
                break;
        }
    }
    return visitor->VisitExit( *this );
}

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.

{
    const TiXmlAttribute* node = attributeSet.Find( name );
    if ( node )
        return node->Value();
    return 0;
}

Attribute() [2/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.

{
    const TiXmlAttribute* attrib = attributeSet.Find( name );
    const char* result = 0;
 
    if ( attrib ) {
        result = attrib->Value();
        if ( d ) {
            attrib->QueryDoubleValue( d );
        }
    }
    return result;
}

Attribute() [3/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.

{
    const TiXmlAttribute* attrib = attributeSet.Find( name );
    const char* result = 0;
 
    if ( attrib ) {
        result = attrib->Value();
        if ( i ) {
            attrib->QueryIntValue( i );
        }
    }
    return result;
}

ClearThis()

void TiXmlElement::ClearThis ( )

protected

{
    Clear();
    while( attributeSet.First() )
    {
        TiXmlAttribute* node = attributeSet.First();
        attributeSet.Remove( node );
        delete node;
    }
}

Clone()

TiXmlNode * TiXmlElement::Clone ( ) const

virtual

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

Implements TiXmlNode.

{
    TiXmlElement* clone = new TiXmlElement( Value() );
    if ( !clone )
        return 0;
 
    CopyTo( clone );
    return clone;
}

CopyTo()

void TiXmlElement::CopyTo ( TiXmlElement *  target ) const

protected

{
    // superclass:
    TiXmlNode::CopyTo( target );
 
    // Element class: 
    // Clone the attributes, then clone the children.
    const TiXmlAttribute* attribute = 0;
    for(    attribute = attributeSet.First();
    attribute;
    attribute = attribute->Next() )
    {
        target->SetAttribute( attribute->Name(), attribute->Value() );
    }
 
    TiXmlNode* node = 0;
    for ( node = firstChild; node; node = node->NextSibling() )
    {
        target->LinkEndChild( node->Clone() );
    }
}

FirstAttribute() [1/2]

TiXmlAttribute * TiXmlElement::FirstAttribute ( )

inline

{ return attributeSet.First(); }

FirstAttribute() [2/2]

const TiXmlAttribute * TiXmlElement::FirstAttribute ( ) const

inline

Access the first attribute in this element.

GetText()

const char * TiXmlElement::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 TiXmlNode* child = this->FirstChild();
    if ( child ) {
        const TiXmlText* childText = child->ToText();
        if ( childText ) {
            return childText->Value();
        }
    }
    return 0;
}

LastAttribute() [1/2]

TiXmlAttribute * TiXmlElement::LastAttribute ( )

inline

{ return attributeSet.Last(); }

LastAttribute() [2/2]

const TiXmlAttribute * TiXmlElement::LastAttribute ( ) const

inline

Access the last attribute in this element.

operator=()

TiXmlElement & TiXmlElement::operator=

(

const TiXmlElement &

base

)

{
    ClearThis();
    base.CopyTo( this );
    return *this;
}

Parse()

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

virtual

Implements TiXmlBase.

{
    p = SkipWhiteSpace( p, encoding );
    TiXmlDocument* document = GetDocument();
 
    if ( !p || !*p )
    {
        if ( document ) document->SetError( TIXML_ERROR_PARSING_ELEMENT, 0, 0, encoding );
        return 0;
    }
 
    if ( data )
    {
        data->Stamp( p, encoding );
        location = data->Cursor();
    }
 
    if ( *p != '<' )
    {
        if ( document ) document->SetError( TIXML_ERROR_PARSING_ELEMENT, p, data, encoding );
        return 0;
    }
 
    p = SkipWhiteSpace( p+1, encoding );
 
    // Read the name.
    const char* pErr = p;
 
    p = ReadName( p, &value, encoding );
    if ( !p || !*p )
    {
        if ( document ) document->SetError( TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, pErr, data, encoding );
        return 0;
    }
 
    TIXML_STRING endTag ("</");
    endTag += value;
 
    // Check for and read attributes. Also look for an empty
    // tag or an end tag.
    while ( p && *p )
    {
        pErr = p;
        p = SkipWhiteSpace( p, encoding );
        if ( !p || !*p )
        {
            if ( document ) document->SetError( TIXML_ERROR_READING_ATTRIBUTES, pErr, data, encoding );
            return 0;
        }
        if ( *p == '/' )
        {
            ++p;
            // Empty tag.
            if ( *p  != '>' )
            {
                if ( document ) document->SetError( TIXML_ERROR_PARSING_EMPTY, p, data, encoding );     
                return 0;
            }
            return (p+1);
        }
        else if ( *p == '>' )
        {
            // Done with attributes (if there were any.)
            // Read the value -- which can include other
            // elements -- read the end tag, and return.
            ++p;
            p = ReadValue( p, data, encoding );     // Note this is an Element method, and will set the error if one happens.
            if ( !p || !*p ) {
                // We were looking for the end tag, but found nothing.
                // Fix for [ 1663758 ] Failure to report error on bad XML
                if ( document ) document->SetError( TIXML_ERROR_READING_END_TAG, p, data, encoding );
                return 0;
            }
 
            // We should find the end tag now
            // note that:
            // </foo > and
            // </foo> 
            // are both valid end tags.
            if ( StringEqual( p, endTag.c_str(), false, encoding ) )
            {
                p += endTag.length();
                p = SkipWhiteSpace( p, encoding );
                if ( p && *p && *p == '>' ) {
                    ++p;
                    return p;
                }
                if ( document ) document->SetError( TIXML_ERROR_READING_END_TAG, p, data, encoding );
                return 0;
            }
            else
            {
                if ( document ) document->SetError( TIXML_ERROR_READING_END_TAG, p, data, encoding );
                return 0;
            }
        }
        else
        {
            // Try to read an attribute:
            TiXmlAttribute* attrib = new TiXmlAttribute();
            if ( !attrib )
            {
                return 0;
            }
 
            attrib->SetDocument( document );
            pErr = p;
            p = attrib->Parse( p, data, encoding );
 
            if ( !p || !*p )
            {
                if ( document ) document->SetError( TIXML_ERROR_PARSING_ELEMENT, pErr, data, encoding );
                delete attrib;
                return 0;
            }
 
            // Handle the strange case of double attributes:
            #ifdef TIXML_USE_STL
            TiXmlAttribute* node = attributeSet.Find( attrib->NameTStr() );
            #else
            TiXmlAttribute* node = attributeSet.Find( attrib->Name() );
            #endif
            if ( node )
            {
                if ( document ) document->SetError( TIXML_ERROR_PARSING_ELEMENT, pErr, data, encoding );
                delete attrib;
                return 0;
            }
 
            attributeSet.Add( attrib );
        }
    }
    return p;
}

Print()

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

{
    int i;
    assert( cfile );
    for ( i=0; i<depth; i++ ) {
        fprintf( cfile, "    " );
    }
 
    fprintf( cfile, "<%s", value.c_str() );
 
    const TiXmlAttribute* attrib;
    for ( attrib = attributeSet.First(); attrib; attrib = attrib->Next() )
    {
        fprintf( cfile, " " );
        attrib->Print( cfile, depth );
    }
 
    // There are 3 different formatting approaches:
    // 1) An element without children is printed as a <foo /> node
    // 2) An element with only a text child is printed as <foo> text </foo>
    // 3) An element with children is printed on multiple lines.
    TiXmlNode* node;
    if ( !firstChild )
    {
        fprintf( cfile, " />" );
    }
    else if ( firstChild == lastChild && firstChild->ToText() )
    {
        fprintf( cfile, ">" );
        firstChild->Print( cfile, depth + 1 );
        fprintf( cfile, "</%s>", value.c_str() );
    }
    else
    {
        fprintf( cfile, ">" );
 
        for ( node = firstChild; node; node=node->NextSibling() )
        {
            if ( !node->ToText() )
            {
                fprintf( cfile, "\n" );
            }
            node->Print( cfile, depth+1 );
        }
        fprintf( cfile, "\n" );
        for( i=0; i<depth; ++i ) {
            fprintf( cfile, "    " );
        }
        fprintf( cfile, "</%s>", value.c_str() );
    }
}

QueryBoolAttribute()

int TiXmlElement::QueryBoolAttribute	(	const char *	name,
		bool *	_value
	)		const

QueryBoolAttribute examines the attribute - see QueryIntAttribute(). Note that '1', 'true', or 'yes' are considered true, while '0', 'false' and 'no' are considered false.

{
    const TiXmlAttribute* node = attributeSet.Find( name );
    if ( !node )
        return TIXML_NO_ATTRIBUTE;
    
    int result = TIXML_WRONG_TYPE;
    if (    StringEqual( node->Value(), "true", true, TIXML_ENCODING_UNKNOWN ) 
         || StringEqual( node->Value(), "yes", true, TIXML_ENCODING_UNKNOWN ) 
         || StringEqual( node->Value(), "1", true, TIXML_ENCODING_UNKNOWN ) ) 
    {
        *bval = true;
        result = TIXML_SUCCESS;
    }
    else if (    StringEqual( node->Value(), "false", true, TIXML_ENCODING_UNKNOWN ) 
              || StringEqual( node->Value(), "no", true, TIXML_ENCODING_UNKNOWN ) 
              || StringEqual( node->Value(), "0", true, TIXML_ENCODING_UNKNOWN ) ) 
    {
        *bval = false;
        result = TIXML_SUCCESS;
    }
    return result;
}

QueryDoubleAttribute()

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

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

{
    const TiXmlAttribute* attrib = attributeSet.Find( name );
    if ( !attrib )
        return TIXML_NO_ATTRIBUTE;
    return attrib->QueryDoubleValue( dval );
}

QueryFloatAttribute()

int TiXmlElement::QueryFloatAttribute ( const char *  name, float *  _value  ) const

inline

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

                                                                     {
        double d;
        int result = QueryDoubleAttribute( name, &d );
        if ( result == TIXML_SUCCESS ) {
            *_value = (float)d;
        }
        return result;
    }

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.

{
    const TiXmlAttribute* attrib = attributeSet.Find( name );
    if ( !attrib )
        return TIXML_NO_ATTRIBUTE;
    return attrib->QueryIntValue( ival );
}

QueryUnsignedAttribute()

int TiXmlElement::QueryUnsignedAttribute	(	const char *	name,
		unsigned *	_value
	)		const

QueryUnsignedAttribute examines the attribute - see QueryIntAttribute().

{
    const TiXmlAttribute* node = attributeSet.Find( name );
    if ( !node )
        return TIXML_NO_ATTRIBUTE;
 
    int ival = 0;
    int result = node->QueryIntValue( &ival );
    *value = (unsigned)ival;
    return result;
}

ReadValue()

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

protected

{
    TiXmlDocument* document = GetDocument();
 
    // Read in text and elements in any order.
    const char* pWithWhiteSpace = p;
    p = SkipWhiteSpace( p, encoding );
 
    while ( p && *p )
    {
        if ( *p != '<' )
        {
            // Take what we have, make a text element.
            TiXmlText* textNode = new TiXmlText( "" );
 
            if ( !textNode )
            {
                return 0;
            }
 
            if ( TiXmlBase::IsWhiteSpaceCondensed() )
            {
                p = textNode->Parse( p, data, encoding );
            }
            else
            {
                // Special case: we want to keep the white space
                // so that leading spaces aren't removed.
                p = textNode->Parse( pWithWhiteSpace, data, encoding );
            }
 
            if ( !textNode->Blank() )
                LinkEndChild( textNode );
            else
                delete textNode;
        } 
        else 
        {
            // We hit a '<'
            // Have we hit a new element or an end tag? This could also be
            // a TiXmlText in the "CDATA" style.
            if ( StringEqual( p, "</", false, encoding ) )
            {
                return p;
            }
            else
            {
                TiXmlNode* node = Identify( p, encoding );
                if ( node )
                {
                    p = node->Parse( p, data, encoding );
                    LinkEndChild( node );
                }               
                else
                {
                    return 0;
                }
            }
        }
        pWithWhiteSpace = p;
        p = SkipWhiteSpace( p, encoding );
    }
 
    if ( !p )
    {
        if ( document ) document->SetError( TIXML_ERROR_READING_ELEMENT_VALUE, 0, 0, encoding );
    }   
    return p;
}

RemoveAttribute()

void TiXmlElement::RemoveAttribute

(

const char *

name

)

Deletes an attribute with the given name.

{
    #ifdef TIXML_USE_STL
    TIXML_STRING str( name );
    TiXmlAttribute* node = attributeSet.Find( str );
    #else
    TiXmlAttribute* node = attributeSet.Find( name );
    #endif
    if ( node )
    {
        attributeSet.Remove( node );
        delete node;
    }
}

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.

{
    TiXmlAttribute* attrib = attributeSet.FindOrCreate( cname );
    if ( attrib ) {
        attrib->SetValue( cvalue );
    }
}

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.

{   
    TiXmlAttribute* attrib = attributeSet.FindOrCreate( name );
    if ( attrib ) {
        attrib->SetIntValue( val );
    }
}

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.

{   
    TiXmlAttribute* attrib = attributeSet.FindOrCreate( name );
    if ( attrib ) {
        attrib->SetDoubleValue( val );
    }
}

ToElement() [1/2]

virtual TiXmlElement * TiXmlElement::ToElement ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

ToElement() [2/2]

virtual const TiXmlElement * TiXmlElement::ToElement ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

Member Data Documentation

attributeSet

TiXmlAttributeSet TiXmlElement::attributeSet

private

---

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

• /home/antonio/fedra_doxygen/src/libScan/tinyxml.h
• /home/antonio/fedra_doxygen/src/libScan/tinyxml.cpp
• /home/antonio/fedra_doxygen/src/libScan/tinyxmlparser.cpp