TiXmlAttribute Class Reference
An attribute is a name-value pair. More...
#include <tinyxml.h>
Public Member Functions | |
| TiXmlAttribute () | |
| Construct an empty attribute. | |
| TiXmlAttribute (const std::string &_name, const std::string &_value) | |
| std::string constructor. | |
| TiXmlAttribute (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 std::string & | ValueStr () const |
| Return the value of this attribute. | |
| int | IntValue () const |
| Return the value of this attribute, converted to an integer. | |
| double | DoubleValue () const |
| Return the value of this attribute, converted to a double. | |
| const TIXML_STRING & | NameTStr () const |
| int | QueryIntValue (int *_value) const |
| QueryIntValue examines the value string. | |
| 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 std::string &_name) |
| STL std::string form. | |
| void | SetValue (const std::string &_value) |
| STL std::string form. | |
| const TiXmlAttribute * | Next () const |
| Get the next sibling attribute in the DOM. Returns null at end. | |
| TiXmlAttribute * | Next () |
| const TiXmlAttribute * | Previous () const |
| Get the previous sibling attribute in the DOM. Returns null at beginning. | |
| TiXmlAttribute * | Previous () |
| 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. | |
| void | Print (FILE *cfile, int depth, TIXML_STRING *str) const |
| void | SetDocument (TiXmlDocument *doc) |
Private Member Functions | |
| TiXmlAttribute (const TiXmlAttribute &) | |
| void | operator= (const TiXmlAttribute &base) |
Private Attributes | |
| TiXmlDocument * | document |
| TIXML_STRING | name |
| TIXML_STRING | value |
| TiXmlAttribute * | prev |
| TiXmlAttribute * | next |
Friends | |
| class | TiXmlAttributeSet |
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 780 of file tinyxml.h.
Constructor & Destructor Documentation
| TiXmlAttribute::TiXmlAttribute | ( | ) | [inline] |
| TiXmlAttribute::TiXmlAttribute | ( | const std::string & | _name, | |
| const std::string & | _value | |||
| ) | [inline] |
| TiXmlAttribute::TiXmlAttribute | ( | const char * | _name, | |
| const char * | _value | |||
| ) | [inline] |
| TiXmlAttribute::TiXmlAttribute | ( | const TiXmlAttribute & | ) | [private] |
Member Function Documentation
| const char* TiXmlAttribute::Name | ( | ) | const [inline] |
| const char* TiXmlAttribute::Value | ( | ) | const [inline] |
| const std::string& TiXmlAttribute::ValueStr | ( | ) | const [inline] |
| int TiXmlAttribute::IntValue | ( | ) | const |
Return the value of this attribute, converted to an integer.
Definition at line 1276 of file tinyxml.cpp.
| double TiXmlAttribute::DoubleValue | ( | ) | const |
Return the value of this attribute, converted to a double.
Definition at line 1281 of file tinyxml.cpp.
| const TIXML_STRING& TiXmlAttribute::NameTStr | ( | ) | const [inline] |
| int TiXmlAttribute::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 1240 of file tinyxml.cpp.
| int TiXmlAttribute::QueryDoubleValue | ( | double * | _value | ) | const |
QueryDoubleValue examines the value string. See QueryIntValue().
Definition at line 1247 of file tinyxml.cpp.
| void TiXmlAttribute::SetName | ( | const char * | _name | ) | [inline] |
| void TiXmlAttribute::SetValue | ( | const char * | _value | ) | [inline] |
| void TiXmlAttribute::SetIntValue | ( | int | _value | ) |
| void TiXmlAttribute::SetDoubleValue | ( | double | _value | ) |
| void TiXmlAttribute::SetName | ( | const std::string & | _name | ) | [inline] |
| void TiXmlAttribute::SetValue | ( | const std::string & | _value | ) | [inline] |
| const TiXmlAttribute * TiXmlAttribute::Next | ( | ) | const |
Get the next sibling attribute in the DOM. Returns null at end.
Definition at line 1174 of file tinyxml.cpp.
| TiXmlAttribute* TiXmlAttribute::Next | ( | ) | [inline] |
| const TiXmlAttribute * TiXmlAttribute::Previous | ( | ) | const |
Get the previous sibling attribute in the DOM. Returns null at beginning.
Definition at line 1194 of file tinyxml.cpp.
| TiXmlAttribute* TiXmlAttribute::Previous | ( | ) | [inline] |
| bool TiXmlAttribute::operator== | ( | const TiXmlAttribute & | rhs | ) | const [inline] |
| bool TiXmlAttribute::operator< | ( | const TiXmlAttribute & | rhs | ) | const [inline] |
| bool TiXmlAttribute::operator> | ( | const TiXmlAttribute & | rhs | ) | const [inline] |
| const char * TiXmlAttribute::Parse | ( | const char * | p, | |
| TiXmlParsingData * | data, | |||
| TiXmlEncoding | encoding | |||
| ) | [virtual] |
| virtual void TiXmlAttribute::Print | ( | FILE * | cfile, | |
| int | depth | |||
| ) | const [inline, virtual] |
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.
| void TiXmlAttribute::Print | ( | FILE * | cfile, | |
| int | depth, | |||
| TIXML_STRING * | str | |||
| ) | const |
Definition at line 1214 of file tinyxml.cpp.
| void TiXmlAttribute::SetDocument | ( | TiXmlDocument * | doc | ) | [inline] |
| void TiXmlAttribute::operator= | ( | const TiXmlAttribute & | base | ) | [private] |
Friends And Related Function Documentation
friend class TiXmlAttributeSet [friend] |
Member Data Documentation
TiXmlDocument* TiXmlAttribute::document [private] |
TIXML_STRING TiXmlAttribute::name [private] |
TIXML_STRING TiXmlAttribute::value [private] |
TiXmlAttribute* TiXmlAttribute::prev [private] |
TiXmlAttribute* TiXmlAttribute::next [private] |
The documentation for this class was generated from the following files:
