- Cal3D 0.11 API Reference -

cal3d::TiXmlElement Class Reference

The element is a container class. More...

#include <tinyxml.h>

Inheritance diagram for cal3d::TiXmlElement:

cal3d::TiXmlNode cal3d::TiXmlBase List of all members.

Public Member Functions

 TiXmlElement (const char *in_value)
 Construct an element.
 TiXmlElement (const std::string &_value)
 std::string constructor.
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.
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.
int QueryIntAttribute (const char *name, int *value) const
 QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.
int QueryDoubleAttribute (const char *name, double *value) const
 QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
void SetAttribute (const char *name, const char *value)
 Sets an attribute of name to a given value.
const char * Attribute (const std::string &name) const
const char * Attribute (const std::string &name, int *i) const
void SetAttribute (const std::string &name, const std::string &_value)
 STL std::string form. STL std::string form.
void SetAttribute (const std::string &name, int _value)
void SetAttribute (const char *name, int value)
 Sets an attribute of name to a given value.
void RemoveAttribute (const char *name)
 Deletes an attribute with the given name.
void RemoveAttribute (const std::string &name)
 STL std::string form.
TiXmlAttributeFirstAttribute () const
 Access the first attribute in this element.
TiXmlAttributeLastAttribute () const
 Access the last attribute in this element.
virtual TiXmlNodeClone () const
virtual void Print (FILE *cfile, int depth) const
 All TinyXml classes can print themselves to a filestream.

Protected Member Functions

virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
virtual void StreamOut (TIXML_OSTREAM *out) const
virtual const char * Parse (const char *p, TiXmlParsingData *data)
const char * ReadValue (const char *in, TiXmlParsingData *prevData)

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.


Member Function Documentation

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

void cal3d::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 cal3d::TiXmlBase.

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

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


The documentation for this class was generated from the following files:
Generated at Thu Jun 29 19:04:00 2006 by The Cal3D Team with Doxygen 1.4.6