TiXmlAttribute Class Reference
An attribute is a name-value pair. More...
#include <tinyxml.h>
Public Types | |
| enum | { TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT } |
Public Member Functions | |
| TiXmlAttribute () | |
| Construct an empty attribute. | |
| 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. | |
| 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. | |
| 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) |
| int | Row () const |
| Return the position, in the original source file, of this node or attribute. | |
| int | Column () const |
| See Row(). | |
| void | SetUserData (void *user) |
| Set a pointer to arbitrary user data. | |
| void * | GetUserData () |
| Get a pointer to arbitrary user data. | |
| const void * | GetUserData () const |
| Get a pointer to arbitrary user data. | |
Static Public Member Functions | |
| static void | SetCondenseWhiteSpace (bool condense) |
| The world does not agree on whether white space should be kept or not. | |
| static bool | IsWhiteSpaceCondensed () |
| Return the current white space setting. | |
| static void | EncodeString (const TIXML_STRING &str, TIXML_STRING *out) |
| Expands entities in a string. | |
Static Public Attributes | |
| static const int | utf8ByteTable [256] |
Static Protected Member Functions | |
| static const char * | SkipWhiteSpace (const char *, TiXmlEncoding encoding) |
| static bool | IsWhiteSpace (char c) |
| static bool | IsWhiteSpace (int c) |
| static const char * | ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding) |
| static const char * | ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
| static const char * | GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding) |
| static const char * | GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding) |
| static bool | StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding) |
| static int | IsAlpha (unsigned char anyByte, TiXmlEncoding encoding) |
| static int | IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding) |
| static int | ToLower (int v, TiXmlEncoding encoding) |
| static void | ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length) |
Protected Attributes | |
| TiXmlCursor | location |
| void * | userData |
| Field containing a generic user pointer. | |
Static Protected Attributes | |
| static const char * | errorString [TIXML_ERROR_STRING_COUNT] |
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.
Member Enumeration Documentation
anonymous enum [inherited] |
- Enumerator:
Constructor & Destructor Documentation
| TiXmlAttribute::TiXmlAttribute | ( | ) | [inline] |
Construct an empty attribute.
| TiXmlAttribute::TiXmlAttribute | ( | const char * | _name, | |
| const char * | _value | |||
| ) | [inline] |
Construct an attribute with a name and value.
Member Function Documentation
| int TiXmlBase::Column | ( | ) | const [inline, inherited] |
See Row().
| static void TiXmlBase::ConvertUTF32ToUTF8 | ( | unsigned long | input, | |
| char * | output, | |||
| int * | length | |||
| ) | [static, protected, inherited] |
| double TiXmlAttribute::DoubleValue | ( | ) | const |
Return the value of this attribute, converted to a double.
| static void TiXmlBase::EncodeString | ( | const TIXML_STRING & | str, | |
| TIXML_STRING * | out | |||
| ) | [static, inherited] |
Expands entities in a string.
Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!
| static const char* TiXmlBase::GetChar | ( | const char * | p, | |
| char * | _value, | |||
| int * | length, | |||
| TiXmlEncoding | encoding | |||
| ) | [inline, static, protected, inherited] |
| static const char* TiXmlBase::GetEntity | ( | const char * | in, | |
| char * | value, | |||
| int * | length, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
Referenced by TiXmlBase::GetChar().
| const void* TiXmlBase::GetUserData | ( | ) | const [inline, inherited] |
Get a pointer to arbitrary user data.
| void* TiXmlBase::GetUserData | ( | ) | [inline, inherited] |
Get a pointer to arbitrary user data.
| int TiXmlAttribute::IntValue | ( | ) | const |
Return the value of this attribute, converted to an integer.
| static int TiXmlBase::IsAlpha | ( | unsigned char | anyByte, | |
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
| static int TiXmlBase::IsAlphaNum | ( | unsigned char | anyByte, | |
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
| static bool TiXmlBase::IsWhiteSpace | ( | int | c | ) | [inline, static, protected, inherited] |
| static bool TiXmlBase::IsWhiteSpace | ( | char | c | ) | [inline, static, protected, inherited] |
Referenced by TiXmlBase::IsWhiteSpace().
| static bool TiXmlBase::IsWhiteSpaceCondensed | ( | ) | [inline, static, inherited] |
Return the current white space setting.
| const char* TiXmlAttribute::Name | ( | ) | const [inline] |
Return the name of this attribute.
| const TIXML_STRING& TiXmlAttribute::NameTStr | ( | ) | const [inline] |
| TiXmlAttribute* TiXmlAttribute::Next | ( | ) | [inline] |
| const TiXmlAttribute* TiXmlAttribute::Next | ( | ) | const |
Get the next sibling attribute in the DOM. Returns null at end.
| bool TiXmlAttribute::operator< | ( | const TiXmlAttribute & | rhs | ) | const [inline] |
| bool TiXmlAttribute::operator== | ( | const TiXmlAttribute & | rhs | ) | const [inline] |
| bool TiXmlAttribute::operator> | ( | const TiXmlAttribute & | rhs | ) | const [inline] |
| virtual const char* TiXmlAttribute::Parse | ( | const char * | p, | |
| TiXmlParsingData * | data, | |||
| TiXmlEncoding | encoding | |||
| ) | [virtual] |
Implements TiXmlBase.
| TiXmlAttribute* TiXmlAttribute::Previous | ( | ) | [inline] |
| const TiXmlAttribute* TiXmlAttribute::Previous | ( | ) | const |
Get the previous sibling attribute in the DOM. Returns null at beginning.
| void TiXmlAttribute::Print | ( | FILE * | cfile, | |
| int | depth, | |||
| TIXML_STRING * | str | |||
| ) | const |
| 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.
| int TiXmlAttribute::QueryDoubleValue | ( | double * | _value | ) | const |
QueryDoubleValue examines the value string. See QueryIntValue().
| 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.
| static const char* TiXmlBase::ReadName | ( | const char * | p, | |
| TIXML_STRING * | name, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
| static const char* TiXmlBase::ReadText | ( | const char * | in, | |
| TIXML_STRING * | text, | |||
| bool | ignoreWhiteSpace, | |||
| const char * | endTag, | |||
| bool | ignoreCase, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
| int TiXmlBase::Row | ( | ) | const [inline, inherited] |
Return the position, in the original source file, of this node or attribute.
The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.
Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.
The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.
There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.
- See also:
- TiXmlDocument::SetTabSize()
| static void TiXmlBase::SetCondenseWhiteSpace | ( | bool | condense | ) | [inline, static, inherited] |
The world does not agree on whether white space should be kept or not.
In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.
| void TiXmlAttribute::SetDocument | ( | TiXmlDocument * | doc | ) | [inline] |
| void TiXmlAttribute::SetDoubleValue | ( | double | _value | ) |
Set the value from a double.
| void TiXmlAttribute::SetIntValue | ( | int | _value | ) |
Set the value from an integer.
| void TiXmlAttribute::SetName | ( | const char * | _name | ) | [inline] |
Set the name of this attribute.
| void TiXmlBase::SetUserData | ( | void * | user | ) | [inline, inherited] |
Set a pointer to arbitrary user data.
| void TiXmlAttribute::SetValue | ( | const char * | _value | ) | [inline] |
Set the value.
| static const char* TiXmlBase::SkipWhiteSpace | ( | const char * | , | |
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
| static bool TiXmlBase::StringEqual | ( | const char * | p, | |
| const char * | endTag, | |||
| bool | ignoreCase, | |||
| TiXmlEncoding | encoding | |||
| ) | [static, protected, inherited] |
| static int TiXmlBase::ToLower | ( | int | v, | |
| TiXmlEncoding | encoding | |||
| ) | [inline, static, protected, inherited] |
| const char* TiXmlAttribute::Value | ( | ) | const [inline] |
Return the value of this attribute.
Friends And Related Function Documentation
friend class TiXmlAttributeSet [friend] |
Member Data Documentation
const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT] [static, protected, inherited] |
TiXmlCursor TiXmlBase::location [protected, inherited] |
Referenced by TiXmlBase::Column(), and TiXmlBase::Row().
void* TiXmlBase::userData [protected, inherited] |
Field containing a generic user pointer.
Referenced by TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().
const int TiXmlBase::utf8ByteTable[256] [static, inherited] |
Referenced by TiXmlBase::GetChar().
The documentation for this class was generated from the following file:
- include/sk/other/tinyxml/tinyxml.h
