- Cal3D 0.11 API Reference -

Public Member Functions | Protected Member Functions
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)
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.
- Public Member Functions inherited from cal3d::TiXmlNode
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
void SetValue (const char *_value)
 Changes the value of the node.
void SetValue (const std::string &_value)
 STL std::string form.
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
TiXmlNodeParent () const
 One step up the DOM.
TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNodeLastChild () const
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children.
TiXmlNodeFirstChild (const std::string &_value) const
 The last child of this node matching 'value'. Will be null if there are no children.
TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeIterateChildren (TiXmlNode *previous) const
 An alternate way to walk the children of a node.
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (const std::string &_value, TiXmlNode *previous) const
 STL std::string form.
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlElementNextSiblingElement () const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
virtual int Type () const
 Query the type (as an enumerated value, above) of this node.
TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in.
bool NoChildren () const
 Returns true if this node has no children.
TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
void SetUserData (void *user)
void * GetUserData ()
- Public Member Functions inherited from cal3d::TiXmlBase
int Row () const
 Return the position, in the original source file, of this node or attribute.
int Column () const
 See Row()

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)
- Protected Member Functions inherited from cal3d::TiXmlNode
 TiXmlNode (NodeType type)
TiXmlNodeIdentify (const char *start)
void CopyToClone (TiXmlNode *target) const
TIXML_STRING SValue () const

Additional Inherited Members

- Public Types inherited from cal3d::TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
- Protected Attributes inherited from cal3d::TiXmlNode
TiXmlNodeparent
NodeType type
TiXmlNodefirstChild
TiXmlNodelastChild
TIXML_STRING value
TiXmlNodeprev
TiXmlNodenext
void * userData
- Protected Attributes inherited from cal3d::TiXmlBase
TiXmlCursor location

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

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,
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 cal3d::TiXmlElement::SetAttribute ( const std::string &  name,
const std::string &  _value 
)
inline

STL std::string form.

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.


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

Generated at Sun Jul 29 2012 12:41:04 by The Cal3D Team with Doxygen 1.8.1.1