TiXmlAttribute Class Reference

An attribute is a name-value pair. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Inheritance graph
[legend]
Collaboration diagram for TiXmlAttribute:

Collaboration graph
[legend]

Public Member Functions

 TiXmlAttribute ()
 Construct an empty attribute.
 TiXmlAttribute (const std::string &_name, const std::string &_value)
 std::string constructor.
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
const char * Name () const
 Return the name of this attribute.
const char * Value () const
 Return the value of this attribute.
const int IntValue () const
 Return the value of this attribute, converted to an integer.
const double DoubleValue () const
 Return the value of this attribute, converted to a double.
void SetName (const char *_name)
 Set the name of this attribute.
void SetValue (const char *_value)
 Set the value.
void SetIntValue (int value)
 Set the value from an integer.
void SetDoubleValue (double value)
 Set the value from a double.
void SetName (const std::string &_name)
 STL std::string form.
void SetValue (const std::string &_value)
 STL std::string form.
TiXmlAttribute * Next () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttribute * Previous () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
bool operator== (const TiXmlAttribute &rhs) const
bool operator< (const TiXmlAttribute &rhs) const
bool operator> (const TiXmlAttribute &rhs) const
virtual const char * Parse (const char *p)
virtual void Print (FILE *cfile, int depth) const
 All TinyXml classes can print themselves to a filestream.
virtual void StreamOut (TIXML_OSTREAM *out) const
void SetDocument (TiXmlDocument *doc)

Private Attributes

TiXmlDocument * document
TIXML_STRING name
TIXML_STRING value
TiXmlAttribute * prev
TiXmlAttribute * next

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.

Attributes have a parent

Definition at line 519 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute (  )  [inline]

Construct an empty attribute.

Definition at line 525 of file tinyxml.h.

TiXmlAttribute::TiXmlAttribute ( const std::string &  _name,
const std::string &  _value 
) [inline]

std::string constructor.

Definition at line 529 of file tinyxml.h.

TiXmlAttribute::TiXmlAttribute ( const char *  _name,
const char *  _value 
) [inline]

Construct an attribute with a name and value.

Definition at line 537 of file tinyxml.h.


Member Function Documentation

const double TiXmlAttribute::DoubleValue (  )  const

Return the value of this attribute, converted to a double.

Definition at line 912 of file tinyxml.cpp.

const int TiXmlAttribute::IntValue (  )  const

Return the value of this attribute, converted to an integer.

Definition at line 907 of file tinyxml.cpp.

const char* TiXmlAttribute::Name (  )  const [inline]

Return the name of this attribute.

Definition at line 538 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Add(), TiXmlElement::Clone(), TiXmlElement::Parse(), and Print().

TiXmlAttribute * TiXmlAttribute::Next (  )  const

Get the next sibling attribute in the DOM. Returns null at end.

Definition at line 841 of file tinyxml.cpp.

References name, next, and value.

Referenced by TiXmlElement::Clone(), TiXmlElement::Print(), and TiXmlElement::StreamOut().

bool TiXmlAttribute::operator< ( const TiXmlAttribute &  rhs  )  const [inline]

Definition at line 568 of file tinyxml.h.

References name.

bool TiXmlAttribute::operator== ( const TiXmlAttribute &  rhs  )  const [inline]

Definition at line 567 of file tinyxml.h.

References name.

bool TiXmlAttribute::operator> ( const TiXmlAttribute &  rhs  )  const [inline]

Definition at line 569 of file tinyxml.h.

References name.

const char * TiXmlAttribute::Parse ( const char *  p  )  [virtual]

TiXmlAttribute * TiXmlAttribute::Previous (  )  const

Get the previous sibling attribute in the DOM. Returns null at beginning.

Definition at line 851 of file tinyxml.cpp.

References name, prev, and value.

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

Definition at line 861 of file tinyxml.cpp.

References Name(), TiXmlBase::PutString(), TIXML_STRING, and Value().

void TiXmlAttribute::SetDocument ( TiXmlDocument *  doc  )  [inline]

Definition at line 583 of file tinyxml.h.

Referenced by TiXmlElement::Parse().

void TiXmlAttribute::SetDoubleValue ( double  value  ) 

Set the value from a double.

Definition at line 900 of file tinyxml.cpp.

References SetValue().

void TiXmlAttribute::SetIntValue ( int  value  ) 

Set the value from an integer.

Definition at line 893 of file tinyxml.cpp.

References SetValue().

void TiXmlAttribute::SetName ( const std::string &  _name  )  [inline]

STL std::string form.

Definition at line 551 of file tinyxml.h.

void TiXmlAttribute::SetName ( const char *  _name  )  [inline]

Set the name of this attribute.

Definition at line 543 of file tinyxml.h.

void TiXmlAttribute::SetValue ( const std::string &  _value  )  [inline]

STL std::string form.

Definition at line 556 of file tinyxml.h.

void TiXmlAttribute::SetValue ( const char *  _value  )  [inline]

Set the value.

Definition at line 544 of file tinyxml.h.

Referenced by TiXmlElement::SetAttribute(), SetDoubleValue(), and SetIntValue().

void TiXmlAttribute::StreamOut ( TIXML_OSTREAM *  out  )  const [virtual]

Implements TiXmlBase.

Definition at line 875 of file tinyxml.cpp.

References TiXmlBase::PutString().

Referenced by TiXmlElement::StreamOut().

const char* TiXmlAttribute::Value (  )  const [inline]

Return the value of this attribute.

Definition at line 539 of file tinyxml.h.

Referenced by TiXmlElement::Attribute(), TiXmlElement::Clone(), TiXmlDeclaration::Parse(), TiXmlElement::Parse(), and Print().


Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

Definition at line 521 of file tinyxml.h.


Field Documentation

Definition at line 586 of file tinyxml.h.

Referenced by Parse().

TIXML_STRING TiXmlAttribute::name [private]

Definition at line 587 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Find(), Next(), operator<(), operator==(), operator>(), Parse(), and Previous().

TIXML_STRING TiXmlAttribute::value [private]

Definition at line 588 of file tinyxml.h.

Referenced by Next(), Parse(), and Previous().


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

Generated on Sun Nov 23 04:12:55 2008 for Sofa by  doxygen 1.5.7.1