TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Collaboration diagram for TiXmlAttribute:

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.
  

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

• int QueryIntValue (int *value) const
• int QueryDoubleValue (double *value) const

  QueryDoubleValue examines the value string. See QueryIntValue().
  

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

• 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, TiXmlParsingData *data, TiXmlEncoding encoding)
• virtual void Print (FILE *cfile, int depth) const
• virtual void StreamOut (TiXmlOutStream *out) const
• void SetDocument (TiXmlDocument *doc)

Private Member Functions

• TiXmlAttribute (const TiXmlAttribute &)
• void operator= (const TiXmlAttribute &base)

Private Attributes

• TiXmlDocument * document
• TiXmlString name
• TiXmlString 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.

---

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute

(

)

[inline]

Construct an empty attribute.

References document, next, and prev.

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

Construct an attribute with a name and value.

References document, name, next, prev, and value.

TiXmlAttribute::TiXmlAttribute

(

const TiXmlAttribute &

)

[private]

---

Member Function Documentation

const char* TiXmlAttribute::Name

(

)

const [inline]

Return the name of this attribute.

References TiXmlString::c_str(), and name.

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

Here is the call graph for this function:

Here is the caller graph for this function:

const char* TiXmlAttribute::Value

(

)

const [inline]

Return the value of this attribute.

References TiXmlString::c_str(), and value.

Referenced by TiXmlElement::Attribute(), TiXmlElement::CopyTo(), TiXmlDeclaration::Parse(), TiXmlElement::Parse(), and ReadXmlField().

Here is the call graph for this function:

Here is the caller graph for this function:

const int TiXmlAttribute::IntValue

(

)

const

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

References TiXmlString::c_str(), and value.

Here is the call graph for this function:

const double TiXmlAttribute::DoubleValue

(

)

const

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

References TiXmlString::c_str(), and value.

Here is the call graph for this function:

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.

References TiXmlString::c_str(), and value.

Referenced by TiXmlElement::QueryIntAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

int TiXmlAttribute::QueryDoubleValue

(

double *

value

)

const

QueryDoubleValue examines the value string. See QueryIntValue().

References TiXmlString::c_str(), and value.

Referenced by TiXmlElement::QueryDoubleAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

void TiXmlAttribute::SetName

(

const char *

_name

)

[inline]

Set the name of this attribute.

References name.

void TiXmlAttribute::SetValue

(

const char *

_value

)

[inline]

Set the value.

References value.

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

Here is the caller graph for this function:

void TiXmlAttribute::SetIntValue

(

int

value

)

Set the value from an integer.

References SetValue().

Here is the call graph for this function:

void TiXmlAttribute::SetDoubleValue

(

double

value

)

Set the value from a double.

References SetValue().

Here is the call graph for this function:

TiXmlAttribute * TiXmlAttribute::Next

(

)

const

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

References TiXmlString::empty(), name, next, and value.

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

Here is the call graph for this function:

Here is the caller graph for this function:

TiXmlAttribute * TiXmlAttribute::Previous

(

)

const

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

References TiXmlString::empty(), name, prev, and value.

Here is the call graph for this function:

bool TiXmlAttribute::operator==

(

const TiXmlAttribute &

rhs

)

const [inline]

References name.

bool TiXmlAttribute::operator<

(

const TiXmlAttribute &

rhs

)

const [inline]

References name.

bool TiXmlAttribute::operator>

(

const TiXmlAttribute &

rhs

)

const [inline]

References name.

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

Implements TiXmlBase.

References TiXmlParsingData::Cursor(), TiXmlBase::IsWhiteSpace(), TiXmlBase::location, name, TiXmlBase::ReadName(), TiXmlBase::ReadText(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlParsingData::Stamp(), TiXmlDocument::TabSize(), TiXmlDocument::tabsize, TiXmlBase::TIXML_ERROR_READING_ATTRIBUTES, and value.

Referenced by TiXmlDeclaration::Parse(), and TiXmlElement::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

References TiXmlString::find(), name, TiXmlBase::PutString(), TIXML_STRING, and value.

Here is the call graph for this function:

void TiXmlAttribute::StreamOut

(

TiXmlOutStream *

out

)

const [virtual]

Implements TiXmlBase.

References TiXmlString::find(), name, TiXmlBase::PutString(), and value.

Referenced by TiXmlElement::StreamOut().

Here is the call graph for this function:

Here is the caller graph for this function:

void TiXmlAttribute::SetDocument

(

TiXmlDocument *

doc

)

[inline]

References document.

Referenced by TiXmlElement::Parse().

Here is the caller graph for this function:

void TiXmlAttribute::operator=

(

const TiXmlAttribute &

base

)

[private]

---

Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

---

Member Data Documentation

TiXmlDocument* TiXmlAttribute::document [private]

Referenced by SetDocument(), and TiXmlAttribute().

TiXmlString TiXmlAttribute::name [private]

Referenced by TiXmlAttributeSet::Find(), Name(), Next(), operator<(), operator==(), operator>(), Parse(), Previous(), Print(), SetName(), StreamOut(), and TiXmlAttribute().

TiXmlString TiXmlAttribute::value [private]

Referenced by DoubleValue(), IntValue(), Next(), Parse(), Previous(), Print(), QueryDoubleValue(), QueryIntValue(), SetValue(), StreamOut(), TiXmlAttribute(), and Value().

TiXmlAttribute* TiXmlAttribute::prev [private]

Referenced by TiXmlAttributeSet::Add(), TiXmlAttributeSet::Last(), Previous(), TiXmlAttributeSet::Remove(), TiXmlAttribute(), TiXmlAttributeSet::TiXmlAttributeSet(), and TiXmlAttributeSet::~TiXmlAttributeSet().

TiXmlAttribute* TiXmlAttribute::next [private]

Referenced by TiXmlAttributeSet::Add(), TiXmlAttributeSet::Find(), TiXmlAttributeSet::First(), Next(), TiXmlAttributeSet::Remove(), TiXmlAttribute(), TiXmlAttributeSet::TiXmlAttributeSet(), and TiXmlAttributeSet::~TiXmlAttributeSet().

---

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

• tinyxml.h
• tinyxml.cpp
• tinyxmlparser.cpp