ddc
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
TiXmlAttribute Class Reference

#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. More...
 
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value. More...
 
const char * Name () const
 Return the name of this attribute. More...
 
const char * Value () const
 Return the value of this attribute. More...
 
const int IntValue () const
 Return the value of this attribute, converted to an integer. More...
 
const double DoubleValue () const
 Return the value of this attribute, converted to a double. More...
 
int QueryIntValue (int *value) const
 
int QueryDoubleValue (double *value) const
 QueryDoubleValue examines the value string. See QueryIntValue(). More...
 
void SetName (const char *_name)
 Set the name of this attribute. More...
 
void SetValue (const char *_value)
 Set the value. More...
 
void SetIntValue (int value)
 Set the value from an integer. More...
 
void SetDoubleValue (double value)
 Set the value from a double. More...
 
TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end. More...
 
TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning. More...
 
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)
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
int Row () const
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 
void * GetUserData ()
 

Private Member Functions

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

Private Attributes

TiXmlDocumentdocument
 
TiXmlString name
 
TiXmlString value
 
TiXmlAttributeprev
 
TiXmlAttributenext
 

Friends

class TiXmlAttributeSet
 

Additional Inherited Members

- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Protected Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES,
  TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT,
  TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_STRING_COUNT
}
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static const char * ReadName (const char *p, TiXmlString *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TiXmlString *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static void PutString (const TiXmlString &str, TiXmlOutStream *out)
 
static void PutString (const TiXmlString &str, TiXmlString *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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() [1/3]

TiXmlAttribute::TiXmlAttribute ( )
inline

Construct an empty attribute.

◆ TiXmlAttribute() [2/3]

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

Construct an attribute with a name and value.

◆ TiXmlAttribute() [3/3]

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute )
private

Member Function Documentation

◆ Name()

const char* TiXmlAttribute::Name ( ) const
inline

Return the name of this attribute.

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

Here is the caller graph for this function:

◆ Value()

const char* TiXmlAttribute::Value ( ) const
inline

Return the value of this attribute.

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

Here is the caller graph for this function:

◆ IntValue()

const int TiXmlAttribute::IntValue ( ) const

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

References TiXmlString::c_str(), and TiXmlNode::value.

Here is the call graph for this function:

◆ DoubleValue()

const double TiXmlAttribute::DoubleValue ( ) const

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

References TiXmlString::c_str(), and TiXmlNode::value.

Here is the call graph for this function:

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

References TiXmlString::c_str(), TIXML_SUCCESS, TIXML_WRONG_TYPE, and TiXmlNode::value.

Referenced by TiXmlElement::QueryIntAttribute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ QueryDoubleValue()

int TiXmlAttribute::QueryDoubleValue ( double *  value) const

QueryDoubleValue examines the value string. See QueryIntValue().

References TiXmlString::c_str(), TIXML_SUCCESS, TIXML_WRONG_TYPE, and TiXmlNode::value.

Referenced by TiXmlElement::QueryDoubleAttribute().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetName()

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

Set the name of this attribute.

◆ SetValue()

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

Set the value.

References TiXmlBase::StringToBuffer::buffer.

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

Here is the caller graph for this function:

◆ SetIntValue()

void TiXmlAttribute::SetIntValue ( int  value)

Set the value from an integer.

References TiXmlNode::SetValue().

Here is the call graph for this function:

◆ SetDoubleValue()

void TiXmlAttribute::SetDoubleValue ( double  value)

Set the value from a double.

References TiXmlNode::SetValue().

Here is the call graph for this function:

◆ Next()

TiXmlAttribute * TiXmlAttribute::Next ( ) const

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

References TiXmlString::empty(), TiXmlNode::next, and TiXmlNode::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:

◆ Previous()

TiXmlAttribute * TiXmlAttribute::Previous ( ) const

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

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

Here is the call graph for this function:

◆ operator==()

bool TiXmlAttribute::operator== ( const TiXmlAttribute rhs) const
inline

References name.

◆ operator<()

bool TiXmlAttribute::operator< ( const TiXmlAttribute rhs) const
inline

References name.

◆ operator>()

bool TiXmlAttribute::operator> ( const TiXmlAttribute rhs) const
inline

References name, and TIXML_OSTREAM.

◆ Parse()

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

◆ Print()

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(), TiXmlBase::PutString(), TIXML_STRING, and TiXmlNode::value.

Here is the call graph for this function:

◆ StreamOut()

void TiXmlAttribute::StreamOut ( TiXmlOutStream out) const
virtual

Implements TiXmlBase.

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

Referenced by TiXmlElement::StreamOut().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetDocument()

void TiXmlAttribute::SetDocument ( TiXmlDocument doc)
inline

Referenced by TiXmlElement::Parse().

Here is the caller graph for this function:

◆ operator=()

void TiXmlAttribute::operator= ( const TiXmlAttribute base)
private

Friends And Related Function Documentation

◆ TiXmlAttributeSet

friend class TiXmlAttributeSet
friend

Member Data Documentation

◆ document

TiXmlDocument* TiXmlAttribute::document
private

◆ name

TiXmlString TiXmlAttribute::name
private

◆ value

TiXmlString TiXmlAttribute::value
private

◆ prev

TiXmlAttribute* TiXmlAttribute::prev
private

◆ next

TiXmlAttribute* TiXmlAttribute::next
private

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