BitmapToolkit Scol plugin
Public Member Functions | Friends | List of all members
tinyxml2::XMLAttribute Class Reference

#include <tinyxml2.h>

Public Member Functions

const char * Name () const
 The name of the attribute.
 
const char * Value () const
 The value of the attribute.
 
const XMLAttributeNext () const
 The next attribute in the list.
 
int IntValue () const
 
unsigned UnsignedValue () const
 Query as an unsigned integer. See IntAttribute()
 
bool BoolValue () const
 Query as a boolean. See IntAttribute()
 
double DoubleValue () const
 Query as a double. See IntAttribute()
 
float FloatValue () const
 Query as a float. See IntAttribute()
 
XMLError QueryIntValue (int *value) const
 
XMLError QueryUnsignedValue (unsigned int *value) const
 See QueryIntAttribute.
 
XMLError QueryBoolValue (bool *value) const
 See QueryIntAttribute.
 
XMLError QueryDoubleValue (double *value) const
 See QueryIntAttribute.
 
XMLError QueryFloatValue (float *value) const
 See QueryIntAttribute.
 
void SetAttribute (const char *value)
 Set the attribute to a string value.
 
void SetAttribute (int value)
 Set the attribute to value.
 
void SetAttribute (unsigned value)
 Set the attribute to value.
 
void SetAttribute (bool value)
 Set the attribute to value.
 
void SetAttribute (double value)
 Set the attribute to value.
 
void SetAttribute (float value)
 Set the attribute to value.
 

Friends

class XMLElement
 

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 XMLNodes. You may only query the Next() attribute in a list.

Definition at line 957 of file tinyxml2.h.

Member Function Documentation

◆ BoolValue()

bool tinyxml2::XMLAttribute::BoolValue ( ) const
inline

Query as a boolean. See IntAttribute()

Definition at line 990 of file tinyxml2.h.

◆ DoubleValue()

double tinyxml2::XMLAttribute::DoubleValue ( ) const
inline

Query as a double. See IntAttribute()

Definition at line 996 of file tinyxml2.h.

◆ FloatValue()

float tinyxml2::XMLAttribute::FloatValue ( ) const
inline

Query as a float. See IntAttribute()

Definition at line 1002 of file tinyxml2.h.

◆ IntValue()

int tinyxml2::XMLAttribute::IntValue ( ) const
inline

IntAttribute interprets the attribute as an integer, and returns the value. If the value isn't an integer, 0 will be returned. There is no error checking; use QueryIntAttribute() if you need error checking.

Definition at line 978 of file tinyxml2.h.

◆ Name()

const char * tinyxml2::XMLAttribute::Name ( ) const
inline

The name of the attribute.

Definition at line 962 of file tinyxml2.h.

◆ Next()

const XMLAttribute * tinyxml2::XMLAttribute::Next ( ) const
inline

The next attribute in the list.

Definition at line 970 of file tinyxml2.h.

◆ QueryBoolValue()

XMLError tinyxml2::XMLAttribute::QueryBoolValue ( bool *  value) const

See QueryIntAttribute.

Definition at line 1095 of file tinyxml2.cpp.

◆ QueryDoubleValue()

XMLError tinyxml2::XMLAttribute::QueryDoubleValue ( double *  value) const

See QueryIntAttribute.

Definition at line 1113 of file tinyxml2.cpp.

◆ QueryFloatValue()

XMLError tinyxml2::XMLAttribute::QueryFloatValue ( float *  value) const

See QueryIntAttribute.

Definition at line 1104 of file tinyxml2.cpp.

◆ QueryIntValue()

XMLError tinyxml2::XMLAttribute::QueryIntValue ( int *  value) const

QueryIntAttribute interprets the attribute as an integer, and returns the value in the provided paremeter. The function will return XML_NO_ERROR on success, and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.

Definition at line 1077 of file tinyxml2.cpp.

◆ QueryUnsignedValue()

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue ( unsigned int *  value) const

See QueryIntAttribute.

Definition at line 1086 of file tinyxml2.cpp.

◆ SetAttribute() [1/6]

void tinyxml2::XMLAttribute::SetAttribute ( bool  value)

Set the attribute to value.

Definition at line 1144 of file tinyxml2.cpp.

◆ SetAttribute() [2/6]

void tinyxml2::XMLAttribute::SetAttribute ( const char *  value)

Set the attribute to a string value.

Definition at line 1122 of file tinyxml2.cpp.

◆ SetAttribute() [3/6]

void tinyxml2::XMLAttribute::SetAttribute ( double  value)

Set the attribute to value.

Definition at line 1151 of file tinyxml2.cpp.

◆ SetAttribute() [4/6]

void tinyxml2::XMLAttribute::SetAttribute ( float  value)

Set the attribute to value.

Definition at line 1158 of file tinyxml2.cpp.

◆ SetAttribute() [5/6]

void tinyxml2::XMLAttribute::SetAttribute ( int  value)

Set the attribute to value.

Definition at line 1128 of file tinyxml2.cpp.

◆ SetAttribute() [6/6]

void tinyxml2::XMLAttribute::SetAttribute ( unsigned  value)

Set the attribute to value.

Definition at line 1136 of file tinyxml2.cpp.

◆ UnsignedValue()

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const
inline

Query as an unsigned integer. See IntAttribute()

Definition at line 984 of file tinyxml2.h.

◆ Value()

const char * tinyxml2::XMLAttribute::Value ( ) const
inline

The value of the attribute.

Definition at line 966 of file tinyxml2.h.

Friends And Related Symbol Documentation

◆ XMLElement

friend class XMLElement
friend

Definition at line 959 of file tinyxml2.h.


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