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

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

#include </home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.h>

Inheritance diagram for TiXmlAttribute:
Inheritance graph
Collaboration diagram for TiXmlAttribute:
Collaboration graph

Public Member Functions

 TiXmlAttribute ()
 Construct an empty attribute. More...
 
 TiXmlAttribute (const std::string &_name, const std::string &_value)
 std::string constructor. 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 std::string & ValueStr () const
 Return the value of this attribute. More...
 
int IntValue () const
 Return the value of this attribute, converted to an integer. More...
 
double DoubleValue () const
 Return the value of this attribute, converted to a double. More...
 
const TIXML_STRINGNameTStr () const
 
int QueryIntValue (int *_value) const
 QueryIntValue examines the value string. More...
 
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...
 
void SetName (const std::string &_name)
 STL std::string form. More...
 
void SetValue (const std::string &_value)
 STL std::string form. More...
 
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end. More...
 
TiXmlAttributeNext ()
 
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning. More...
 
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 (FILE *cfile, int depth) const
 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. More...
 
void Print (FILE *cfile, int depth, TIXML_STRING *str) 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. More...
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 Set a pointer to arbitrary user data. More...
 
void * GetUserData ()
 Get a pointer to arbitrary user data. More...
 
const void * GetUserData () const
 Get a pointer to arbitrary user data. More...
 

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_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_DOCUMENT_TOP_ONLY ,
  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. More...
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
 Expands entities in a string. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- 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 bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
 
static bool StreamTo (std::istream *in, int character, TIXML_STRING *tag)
 
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 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.

Definition at line 733 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlAttribute() [1/4]

TiXmlAttribute ( )
inline

Construct an empty attribute.

Definition at line 739 of file tinyxml.h.

◆ TiXmlAttribute() [2/4]

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

std::string constructor.

Definition at line 746 of file tinyxml.h.

◆ TiXmlAttribute() [3/4]

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

Construct an attribute with a name and value.

Definition at line 755 of file tinyxml.h.

◆ TiXmlAttribute() [4/4]

TiXmlAttribute ( const TiXmlAttribute )
private

Member Function Documentation

◆ Name()

const char* Name ( ) const
inline

Return the name of this attribute.

Definition at line 763 of file tinyxml.h.

◆ Value()

const char* Value ( ) const
inline

Return the value of this attribute.

Definition at line 764 of file tinyxml.h.

◆ ValueStr()

const std::string& ValueStr ( ) const
inline

Return the value of this attribute.

Definition at line 765 of file tinyxml.h.

◆ IntValue()

int IntValue ( ) const

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

Definition at line 1240 of file tinyxml.cpp.

◆ DoubleValue()

double DoubleValue ( ) const

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

Definition at line 1245 of file tinyxml.cpp.

◆ NameTStr()

const TIXML_STRING& NameTStr ( ) const
inline

Definition at line 770 of file tinyxml.h.

◆ QueryIntValue()

int 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 1204 of file tinyxml.cpp.

◆ QueryDoubleValue()

int QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1211 of file tinyxml.cpp.

◆ SetName() [1/2]

void SetName ( const char *  _name)
inline

Set the name of this attribute.

Definition at line 785 of file tinyxml.h.

◆ SetValue() [1/2]

void SetValue ( const char *  _value)
inline

Set the value.

Definition at line 786 of file tinyxml.h.

◆ SetIntValue()

void SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1218 of file tinyxml.cpp.

◆ SetDoubleValue()

void SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1229 of file tinyxml.cpp.

◆ SetName() [2/2]

void SetName ( const std::string &  _name)
inline

STL std::string form.

Definition at line 792 of file tinyxml.h.

◆ SetValue() [2/2]

void SetValue ( const std::string &  _value)
inline

STL std::string form.

Definition at line 794 of file tinyxml.h.

◆ Next() [1/2]

const TiXmlAttribute * Next ( ) const

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

Definition at line 1138 of file tinyxml.cpp.

◆ Next() [2/2]

TiXmlAttribute* Next ( )
inline

Definition at line 798 of file tinyxml.h.

◆ Previous() [1/2]

const TiXmlAttribute * Previous ( ) const

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

Definition at line 1158 of file tinyxml.cpp.

◆ Previous() [2/2]

TiXmlAttribute* Previous ( )
inline

Definition at line 804 of file tinyxml.h.

◆ operator==()

bool operator== ( const TiXmlAttribute rhs) const
inline

Definition at line 808 of file tinyxml.h.

◆ operator<()

bool operator< ( const TiXmlAttribute rhs) const
inline

Definition at line 809 of file tinyxml.h.

◆ operator>()

bool operator> ( const TiXmlAttribute rhs) const
inline

Definition at line 810 of file tinyxml.h.

◆ Parse()

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

Implements TiXmlBase.

Definition at line 1379 of file tinyxmlparser.cpp.

◆ Print() [1/2]

virtual void Print ( FILE *  cfile,
int  depth 
) const
inlinevirtual

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 818 of file tinyxml.h.

◆ Print() [2/2]

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

Definition at line 1178 of file tinyxml.cpp.

◆ SetDocument()

void SetDocument ( TiXmlDocument doc)
inline

Definition at line 825 of file tinyxml.h.

◆ operator=()

void operator= ( const TiXmlAttribute base)
private

Friends And Related Function Documentation

◆ TiXmlAttributeSet

friend class TiXmlAttributeSet
friend

Definition at line 735 of file tinyxml.h.

Member Data Documentation

◆ document

TiXmlDocument* document
private

Definition at line 831 of file tinyxml.h.

◆ name

TIXML_STRING name
private

Definition at line 832 of file tinyxml.h.

◆ value

TIXML_STRING value
private

Definition at line 833 of file tinyxml.h.

◆ prev

TiXmlAttribute* prev
private

Definition at line 834 of file tinyxml.h.

◆ next

TiXmlAttribute* next
private

Definition at line 835 of file tinyxml.h.


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