libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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. More...
 
const char * Value () const
 The value of the attribute. More...
 
const XMLAttributeNext () const
 The next attribute in the list. More...
 
int IntValue () const
 
unsigned UnsignedValue () const
 Query as an unsigned integer. See IntValue() More...
 
bool BoolValue () const
 Query as a boolean. See IntValue() More...
 
double DoubleValue () const
 Query as a double. See IntValue() More...
 
float FloatValue () const
 Query as a float. See IntValue() More...
 
XMLError QueryIntValue (int *value) const
 
XMLError QueryUnsignedValue (unsigned int *value) const
 See QueryIntValue. More...
 
XMLError QueryBoolValue (bool *value) const
 See QueryIntValue. More...
 
XMLError QueryDoubleValue (double *value) const
 See QueryIntValue. More...
 
XMLError QueryFloatValue (float *value) const
 See QueryIntValue. 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.

Definition at line 1044 of file tinyxml2.h.

Member Function Documentation

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

Query as a boolean. See IntValue()

Definition at line 1075 of file tinyxml2.h.

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

Query as a double. See IntValue()

Definition at line 1081 of file tinyxml2.h.

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

Query as a float. See IntValue()

Definition at line 1087 of file tinyxml2.h.

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

IntValue 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 QueryIntValue() if you need error checking.

Definition at line 1063 of file tinyxml2.h.

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

The name of the attribute.

Definition at line 1242 of file tinyxml2.cpp.

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

The next attribute in the list.

Definition at line 1055 of file tinyxml2.h.

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

See QueryIntValue.

Definition at line 1304 of file tinyxml2.cpp.

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

See QueryIntValue.

Definition at line 1322 of file tinyxml2.cpp.

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

See QueryIntValue.

Definition at line 1313 of file tinyxml2.cpp.

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

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

Definition at line 1286 of file tinyxml2.cpp.

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

See QueryIntValue.

Definition at line 1295 of file tinyxml2.cpp.

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

Set the attribute to a string value.

Definition at line 1331 of file tinyxml2.cpp.

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

Set the attribute to value.

Definition at line 1337 of file tinyxml2.cpp.

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

Set the attribute to value.

Definition at line 1345 of file tinyxml2.cpp.

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

Set the attribute to value.

Definition at line 1353 of file tinyxml2.cpp.

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

Set the attribute to value.

Definition at line 1360 of file tinyxml2.cpp.

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

Set the attribute to value.

Definition at line 1367 of file tinyxml2.cpp.

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

Query as an unsigned integer. See IntValue()

Definition at line 1069 of file tinyxml2.h.

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

The value of the attribute.

Definition at line 1247 of file tinyxml2.cpp.

Friends And Related Function Documentation

friend class XMLElement
friend

Definition at line 1046 of file tinyxml2.h.


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