LDK::XmlAttribute Class Reference

#include <LDK/XML.h>

Inheritance diagram for LDK::XmlAttribute:

Inheritance graph
[legend]
Collaboration diagram for LDK::XmlAttribute:

Collaboration graph
[legend]

Public Member Functions

 XmlAttribute ()
 Construct an empty attribute.
 XmlAttribute (const String &_name, const String &_value)
 String constructor.
 XmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
const char * Name () const
 Return the name of this attribute.
const char * Value () const
 Return the value of this attribute.
const int IntValue () const
 Return the value of this attribute, converted to an integer.
const double DoubleValue () const
 Return the value of this attribute, converted to a double.
int QueryIntValue (int *value) const
int QueryDoubleValue (double *value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
void SetName (const char *_name)
 Set the name of this attribute.
void SetValue (const char *_value)
 Set the value.
void SetIntValue (int value)
 Set the value from an integer.
void SetDoubleValue (double value)
 Set the value from a double.
void SetName (const String &_name)
 LDK::String form.
void SetValue (const String &_value)
 LDK::String form.
const XmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
XmlAttributeNext ()
const XmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
XmlAttributePrevious ()
bool operator== (const XmlAttribute &rhs) const
bool operator< (const XmlAttribute &rhs) const
bool operator> (const XmlAttribute &rhs) const
virtual const char * Parse (const char *p, XmlParsingData *data, XmlEncoding encoding)
virtual void Print (SmartFile f, int depth) const
virtual void StreamOut (LDKXML_OSTREAM *out) const
void SetDocument (XmlDocument *doc)

Friends

class LDK_API XmlAttributeSet

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, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Definition at line 680 of file XML.h.


Member Function Documentation

int LDK::XmlAttribute::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 LDKXML_SUCCESS. If it is not an integer, it returns LDKXML_WRONG_TYPE.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

virtual void LDK::XmlAttribute::Print ( SmartFile  f,
int  depth 
) const [virtual]

All TinyXml classes can print themselves to a filestream. This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements LDK::XmlBase.


The documentation for this class was generated from the following file:
Generated on Fri Aug 17 18:32:28 2007 for LDK by  doxygen 1.5.1