TinyXML
Public Member Functions | Friends
TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:
TiXmlBase

List of all members.

Public Member Functions

 TiXmlAttribute()
 Construct an empty attribute.
 TiXmlAttribute(const char * _name, const char * _value)
 Construct an attribute with a name and value.
double DoubleValue()
 Return the value of this attribute, converted to a double.
int IntValue()
 Return the value of this attribute, converted to an integer.
const char * Name()
 Return the name of this attribute.
const TIXML_STRING & NameTStr()
const TiXmlAttribute * Next()
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttribute * Next()
bool operator<(const TiXmlAttribute & rhs)
bool operator==(const TiXmlAttribute & rhs)
bool operator>(const TiXmlAttribute & rhs)
virtual const char * Parse(const char * p, TiXmlParsingData * data, TiXmlEncoding encoding)
const TiXmlAttribute * Previous()
 Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttribute * Previous()
virtual void Print(FILE * cfile, int depth)
void Print(FILE * cfile, int depth, TIXML_STRING * str)
int QueryDoubleValue(double * _value)
 QueryDoubleValue examines the value string. See QueryIntValue().
int QueryIntValue(int * _value)
void SetDocument(TiXmlDocument * doc)
void SetDoubleValue(double _value)
 Set the value from a double.
void SetIntValue(int _value)
 Set the value from an integer.
void SetName(const char * _name)
 Set the name of this attribute.
void SetValue(const char * _value)
 Set the value.
const char * Value()
 Return the value of this attribute.

Friends

class TiXmlAttributeSet

Detailed Description

An attribute is a name-value pair. Elements have an arbitrary number of attributes, each with a unique name.

Note:
The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Member Function Documentation

Print

virtual void TiXmlAttribute::Print ( FILE *  cfile,
int  depth 
)  const [inline, virtual]
void TiXmlAttribute::Print ( FILE *  cfile,
int  depth,
TIXML_STRING *  str 
)  const
virtual void TiXmlAttribute::Print(FILE * cfile, int depth) [inline, 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.

QueryIntValue

int TiXmlAttribute::QueryIntValue ( int *  _value) const

QueryIntValue examines the value string. It is an alternative to the IntValue() method with richer error checking. If the value 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.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.


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