interreality.org [VOS]
[Home] [About]
[Screenshots]
 [Download]
[News]
 [Community]
[Documentation] [Manual]
[Bugs & Requests] [Wiki]

TiXmlElement Class Reference

#include <tinyxml.hh>

Inheritance diagram for TiXmlElement:

TiXmlNode TiXmlBase List of all members.

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.

Definition at line 849 of file tinyxml.hh.

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

TiXmlElement::TiXmlElement ( const char *  in_value  ) 

Construct an element.

TiXmlElement::TiXmlElement ( const std::string &  _value  ) 

std::string constructor.

TiXmlElement::TiXmlElement ( const TiXmlElement &   ) 

virtual TiXmlElement::~TiXmlElement (  )  [virtual]

Member Function Documentation

const char* TiXmlElement::Attribute ( const std::string &  name,
double *  d 
) const [inline]

Definition at line 915 of file tinyxml.hh.

const char* TiXmlElement::Attribute ( const std::string &  name,
int *  i 
) const [inline]

Definition at line 914 of file tinyxml.hh.

const char* TiXmlElement::Attribute ( const std::string &  name  )  const [inline]

Definition at line 913 of file tinyxml.hh.

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

void TiXmlElement::ClearThis (  )  [protected]

virtual TiXmlNode* TiXmlElement::Clone (  )  const [virtual]

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

Implements TiXmlNode.

void TiXmlElement::CopyTo ( TiXmlElement *  target  )  const [protected]

TiXmlAttribute* TiXmlElement::FirstAttribute (  )  [inline]

Definition at line 954 of file tinyxml.hh.

const TiXmlAttribute* TiXmlElement::FirstAttribute (  )  const [inline]

Access the first attribute in this element.

Definition at line 953 of file tinyxml.hh.

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.

TiXmlAttribute* TiXmlElement::LastAttribute (  )  [inline]

Definition at line 956 of file tinyxml.hh.

const TiXmlAttribute* TiXmlElement::LastAttribute (  )  const [inline]

Access the last attribute in this element.

Definition at line 955 of file tinyxml.hh.

void TiXmlElement::operator= ( const TiXmlElement &  base  ) 

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

Implements TiXmlBase.

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

int TiXmlElement::QueryDoubleAttribute ( const std::string &  name,
double *  _value 
) const [inline]

Definition at line 917 of file tinyxml.hh.

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

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

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

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

Definition at line 898 of file tinyxml.hh.

int TiXmlElement::QueryIntAttribute ( const std::string &  name,
int *  _value 
) const [inline]

Definition at line 916 of file tinyxml.hh.

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 char* TiXmlElement::ReadValue ( const char *  in,
TiXmlParsingData *  prevData,
TiXmlEncoding  encoding 
) [protected]

void TiXmlElement::RemoveAttribute ( const std::string &  name  )  [inline]

STL std::string form.

Definition at line 950 of file tinyxml.hh.

void TiXmlElement::RemoveAttribute ( const char *  name  ) 

Deletes an attribute with the given name.

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.

void TiXmlElement::SetAttribute ( const std::string &  name,
int  _value 
) [inline]

Definition at line 928 of file tinyxml.hh.

void TiXmlElement::SetAttribute ( const std::string &  name,
const std::string &  _value 
) [inline]

STL std::string form. STL std::string form.

Definition at line 920 of file tinyxml.hh.

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.

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.

virtual void TiXmlElement::StreamIn ( TIXML_ISTREAM *  in,
TIXML_STRING *  tag 
) [protected, virtual]

Implements TiXmlNode.

virtual void TiXmlElement::StreamOut ( TIXML_OSTREAM *  out,
int  depth 
) const [protected, virtual]

Implements TiXmlBase.

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