cocos2d-x  3.0-alpha0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
XMLAttribute Class Reference

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

#include <tinyxml2.h>

Public Member Functions

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

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.

Member Function Documentation

bool BoolValue ( ) const
inline

Query as a boolean. See IntAttribute()

local BoolValue ( )
inline

Query as a boolean. See IntAttribute()

double DoubleValue ( ) const
inline

Query as a double. See IntAttribute()

local DoubleValue ( )
inline

Query as a double. See IntAttribute()

float FloatValue ( ) const
inline

Query as a float. See IntAttribute()

local FloatValue ( )
inline

Query as a float. See IntAttribute()

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

local IntValue ( )
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.

const char* Name ( ) const
inline

The name of the attribute.

local Name ( )
inline

The name of the attribute.

const XMLAttribute* Next ( ) const
inline

The next attribute in the list.

local Next ( )
inline

The next attribute in the list.

XMLError QueryBoolValue ( bool *  value) const

See QueryIntAttribute.

local QueryBoolValue ( local  value)

See QueryIntAttribute.

XMLError QueryDoubleValue ( double *  value) const

See QueryIntAttribute.

local QueryDoubleValue ( local  value)

See QueryIntAttribute.

XMLError QueryFloatValue ( float *  value) const

See QueryIntAttribute.

local QueryFloatValue ( local  value)

See QueryIntAttribute.

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

local QueryIntValue ( local  value)

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.

XMLError QueryUnsignedValue ( unsigned int *  value) const

See QueryIntAttribute.

local QueryUnsignedValue ( local  value)

See QueryIntAttribute.

void SetAttribute ( const char *  value)

Set the attribute to a string value.

local SetAttribute ( local  value)

Set the attribute to a string value.

void SetAttribute ( int  value)

Set the attribute to value.

local SetAttribute ( local  value)

Set the attribute to value.

void SetAttribute ( unsigned  value)

Set the attribute to value.

local SetAttribute ( local  value)

Set the attribute to value.

void SetAttribute ( bool  value)

Set the attribute to value.

local SetAttribute ( local  value)

Set the attribute to value.

void SetAttribute ( double  value)

Set the attribute to value.

local SetAttribute ( local  value)

Set the attribute to value.

void SetAttribute ( float  value)

Set the attribute to value.

local SetAttribute ( local  value)

Set the attribute to value.

unsigned UnsignedValue ( ) const
inline

Query as an unsigned integer. See IntAttribute()

local UnsignedValue ( )
inline

Query as an unsigned integer. See IntAttribute()

const char* Value ( ) const
inline

The value of the attribute.

local Value ( )
inline

The value of the attribute.

Friends And Related Function Documentation

friend class XMLElement
friend
local XMLElement
friend

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