Public Member Functions | Private Member Functions | Private Attributes | Friends
TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:
Inheritance graph
[legend]

List of all members.

Public Member Functions

double DoubleValue () const
 Return the value of this attribute, converted to a double.
int IntValue () const
 Return the value of this attribute, converted to an integer.
const char * Name () const
 Return the name of this attribute.
const TIXML_STRINGNameTStr () const
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttributeNext ()
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)
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttributePrevious ()
virtual void Print (FILE *cfile, int depth) const
void Print (FILE *cfile, int depth, TIXML_STRING *str) const
int QueryDoubleValue (double *_value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
int QueryIntValue (int *_value) const
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.
 TiXmlAttribute ()
 Construct an empty attribute.
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
const char * Value () const
 Return the value of this attribute.

Private Member Functions

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

Private Attributes

TiXmlDocumentdocument
TIXML_STRING name
TiXmlAttributenext
TiXmlAttributeprev
TIXML_STRING value

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.

Definition at line 843 of file tinyxml.h.


Constructor & Destructor Documentation

Construct an empty attribute.

Definition at line 848 of file tinyxml.h.

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

Construct an attribute with a name and value.

Definition at line 866 of file tinyxml.h.


Member Function Documentation

double TiXmlAttribute::DoubleValue ( ) const

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

Definition at line 1089 of file tinyxml.cpp.

int TiXmlAttribute::IntValue ( ) const

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

Definition at line 1085 of file tinyxml.cpp.

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

Return the name of this attribute.

Definition at line 873 of file tinyxml.h.

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const [inline]

Definition at line 886 of file tinyxml.h.

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

Definition at line 986 of file tinyxml.cpp.

Definition at line 922 of file tinyxml.h.

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

Definition at line 935 of file tinyxml.h.

void TiXmlAttribute::operator= ( const TiXmlAttribute base) [private]
bool TiXmlAttribute::operator== ( const TiXmlAttribute rhs) const [inline]

Definition at line 932 of file tinyxml.h.

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

Definition at line 938 of file tinyxml.h.

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

Implements TiXmlBase.

Definition at line 1260 of file tinyxmlparser.cpp.

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

Definition at line 1005 of file tinyxml.cpp.

Definition at line 928 of file tinyxml.h.

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

Definition at line 949 of file tinyxml.h.

void TiXmlAttribute::Print ( FILE *  cfile,
int  depth,
TIXML_STRING str 
) const

Definition at line 1024 of file tinyxml.cpp.

int TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1059 of file tinyxml.cpp.

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.

Definition at line 1053 of file tinyxml.cpp.

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

Definition at line 956 of file tinyxml.h.

void TiXmlAttribute::SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1075 of file tinyxml.cpp.

void TiXmlAttribute::SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1065 of file tinyxml.cpp.

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

Set the name of this attribute.

Definition at line 903 of file tinyxml.h.

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

Set the value.

Definition at line 906 of file tinyxml.h.

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

Return the value of this attribute.

Definition at line 876 of file tinyxml.h.


Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

Definition at line 844 of file tinyxml.h.


Member Data Documentation

Definition at line 964 of file tinyxml.h.

Definition at line 965 of file tinyxml.h.

Definition at line 968 of file tinyxml.h.

Definition at line 967 of file tinyxml.h.

Definition at line 966 of file tinyxml.h.


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


appl
Author(s): petercai
autogenerated on Tue Jan 7 2014 11:02:30