Nebula
Loading...
Searching...
No Matches
TiXmlAttribute Class Reference

#include <tinyxml.h>

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.

Inherits TiXmlBase.

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.
 
int IntValue () const
 Return the value of this attribute, converted to an integer.
 
double DoubleValue () const
 Return the value of this attribute, converted to a double.
 
const TIXML_STRINGNameTStr () const
 
int QueryIntValue (int *_value) const
 QueryIntValue examines the value string.
 
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.
 
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
 
TiXmlAttributeNext ()
 
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
 
TiXmlAttributePrevious ()
 
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 (const Ptr< IO::TextWriter > &textWriter, int depth) const
 All TinyXml classes can print themselves to a filestream.
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
void SetDocument (TiXmlDocument *doc)
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
int Row () const
 Return the position, in the original source file, of this node or attribute.
 
int Column () const
 See Row()
 
void SetUserData (void *user)
 
void * GetUserData ()
 

Private Member Functions

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

Private Attributes

TiXmlDocumentdocument
 
TIXML_STRING name
 
TIXML_STRING value
 
TiXmlAttributeprev
 
TiXmlAttributenext
 

Friends

class TiXmlAttributeSet
 

Additional Inherited Members

- Public 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_PARSING_CDATA ,
  TIXML_ERROR_STRING_COUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Protected Member Functions inherited from TiXmlBase
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TIXML_STRING *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 TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *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.
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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

◆ DoubleValue()

double TiXmlAttribute::DoubleValue ( ) const

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

◆ IntValue()

int TiXmlAttribute::IntValue ( ) const

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

◆ Name()

const char * TiXmlAttribute::Name ( ) const
inline

Return the name of this attribute.

◆ NameTStr()

const TIXML_STRING & TiXmlAttribute::NameTStr ( ) const
inline

◆ Next() [1/2]

TiXmlAttribute * TiXmlAttribute::Next ( )

◆ Next() [2/2]

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

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

◆ operator<()

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

◆ operator=()

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

◆ operator==()

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

◆ operator>()

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

◆ Parse()

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

Implements TiXmlBase.

◆ Previous() [1/2]

TiXmlAttribute * TiXmlAttribute::Previous ( )

◆ Previous() [2/2]

const TiXmlAttribute * TiXmlAttribute::Previous ( ) const

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

◆ Print()

void TiXmlAttribute::Print ( const Ptr< IO::TextWriter > & textWriter,
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.

◆ QueryDoubleValue()

int TiXmlAttribute::QueryDoubleValue ( double * _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

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

◆ SetDocument()

void TiXmlAttribute::SetDocument ( TiXmlDocument * doc)
inline

◆ SetDoubleValue()

void TiXmlAttribute::SetDoubleValue ( double _value)

Set the value from a double.

◆ SetIntValue()

void TiXmlAttribute::SetIntValue ( int _value)

Set the value from an integer.

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

◆ StreamOut()

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

Implements TiXmlBase.

◆ Value()

const char * TiXmlAttribute::Value ( ) const
inline

Return the value of this attribute.

Friends And Related Symbol Documentation

◆ TiXmlAttributeSet

friend class TiXmlAttributeSet
friend

Member Data Documentation

◆ document

TiXmlDocument* TiXmlAttribute::document
private

◆ name

TIXML_STRING TiXmlAttribute::name
private

◆ next

TiXmlAttribute* TiXmlAttribute::next
private

◆ prev

TiXmlAttribute* TiXmlAttribute::prev
private

◆ value

TIXML_STRING TiXmlAttribute::value
private

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