Nebula
|
#include <tinyxml.h>
The element is a container class.
It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.
Inherits TiXmlNode.
Public Member Functions | |
TiXmlElement (const char *in_value) | |
Construct an element. | |
TiXmlElement (const TiXmlElement &) | |
void | operator= (const TiXmlElement &base) |
virtual | ~TiXmlElement () |
const char * | Attribute (const char *name) const |
Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. | |
const char * | Attribute (const char *name, int *i) const |
Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. | |
const char * | Attribute (const char *name, double *d) const |
Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. | |
int | QueryIntAttribute (const char *name, int *_value) const |
QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking. | |
int | QueryDoubleAttribute (const char *name, double *_value) const |
QueryDoubleAttribute examines the attribute - see QueryIntAttribute(). | |
int | QueryFloatAttribute (const char *name, float *_value) const |
QueryFloatAttribute examines the attribute - see QueryIntAttribute(). | |
void | SetAttribute (const char *name, const char *_value) |
Sets an attribute of name to a given value. | |
void | SetAttribute (const char *name, int value) |
Sets an attribute of name to a given value. | |
void | SetDoubleAttribute (const char *name, double value) |
Sets an attribute of name to a given value. | |
void | RemoveAttribute (const char *name) |
Deletes an attribute with the given name. | |
const TiXmlAttribute * | FirstAttribute () const |
Access the first attribute in this element. | |
TiXmlAttribute * | FirstAttribute () |
const TiXmlAttribute * | LastAttribute () const |
Access the last attribute in this element. | |
TiXmlAttribute * | LastAttribute () |
const char * | GetText () const |
Convenience function for easy access to the text inside an element. | |
virtual TiXmlNode * | Clone () const |
Creates a new Element and returns it - the returned element is a copy. | |
virtual void | Print (const Ptr< IO::TextWriter > &textWriter, int depth) const |
All TinyXml classes can print themselves to a filestream. | |
virtual const char * | Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding) |
virtual const TiXmlElement * | ToElement () const |
Cast to a more defined type. Will return null not of the requested type. | |
virtual TiXmlElement * | ToElement () |
Cast to a more defined type. Will return null not of the requested type. | |
Public Member Functions inherited from TiXmlNode | |
virtual | ~TiXmlNode () |
const char * | Value () const |
The meaning of 'value' changes for the specific type of TiXmlNode. | |
void | SetValue (const char *_value) |
Changes the value of the node. | |
void | Clear () |
Delete all the children of this node. Does not affect 'this'. | |
TiXmlNode * | Parent () |
One step up the DOM. | |
const TiXmlNode * | Parent () const |
const TiXmlNode * | FirstChild () const |
The first child of this node. Will be null if there are no children. | |
TiXmlNode * | FirstChild () |
const TiXmlNode * | FirstChild (const char *value) const |
The first child of this node with the matching 'value'. Will be null if none found. | |
TiXmlNode * | FirstChild (const char *value) |
The first child of this node with the matching 'value'. Will be null if none found. | |
const TiXmlNode * | LastChild () const |
TiXmlNode * | LastChild () |
The last child of this node. Will be null if there are no children. | |
const TiXmlNode * | LastChild (const char *value) const |
TiXmlNode * | LastChild (const char *value) |
The last child of this node matching 'value'. Will be null if there are no children. | |
const TiXmlNode * | IterateChildren (const TiXmlNode *previous) const |
An alternate way to walk the children of a node. | |
TiXmlNode * | IterateChildren (TiXmlNode *previous) |
const TiXmlNode * | IterateChildren (const char *value, const TiXmlNode *previous) const |
This flavor of IterateChildren searches for children with a particular 'value'. | |
TiXmlNode * | IterateChildren (const char *value, TiXmlNode *previous) |
TiXmlNode * | InsertEndChild (const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | LinkEndChild (TiXmlNode *addThis) |
Add a new node related to this. | |
TiXmlNode * | InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis) |
Add a new node related to this. | |
TiXmlNode * | ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis) |
Replace a child of this node. | |
bool | RemoveChild (TiXmlNode *removeThis) |
Delete a child of this node. | |
const TiXmlNode * | PreviousSibling () const |
Navigate to a sibling node. | |
TiXmlNode * | PreviousSibling () |
const TiXmlNode * | PreviousSibling (const char *) const |
Navigate to a sibling node. | |
TiXmlNode * | PreviousSibling (const char *) |
const TiXmlNode * | NextSibling () const |
Navigate to a sibling node. | |
TiXmlNode * | NextSibling () |
const TiXmlNode * | NextSibling (const char *) const |
Navigate to a sibling node with the given 'value'. | |
TiXmlNode * | NextSibling (const char *) |
const TiXmlElement * | NextSiblingElement () const |
Convenience function to get through elements. | |
TiXmlElement * | NextSiblingElement () |
const TiXmlElement * | NextSiblingElement (const char *) const |
Convenience function to get through elements. | |
TiXmlElement * | NextSiblingElement (const char *) |
const TiXmlElement * | FirstChildElement () const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement () |
const TiXmlElement * | FirstChildElement (const char *value) const |
Convenience function to get through elements. | |
TiXmlElement * | FirstChildElement (const char *value) |
int | Type () const |
Query the type (as an enumerated value, above) of this node. | |
const TiXmlDocument * | GetDocument () const |
Return a pointer to the Document this node lives in. | |
TiXmlDocument * | GetDocument () |
bool | NoChildren () const |
Returns true if this node has no children. | |
virtual const TiXmlDocument * | ToDocument () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlComment * | ToComment () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlUnknown * | ToUnknown () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlText * | ToText () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual const TiXmlDeclaration * | ToDeclaration () const |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlDocument * | ToDocument () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlComment * | ToComment () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlUnknown * | ToUnknown () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlText * | ToText () |
Cast to a more defined type. Will return null if not of the requested type. | |
virtual TiXmlDeclaration * | ToDeclaration () |
Cast to a more defined type. Will return null if not of the requested type. | |
Public Member Functions inherited from TiXmlBase | |
TiXmlBase () | |
virtual | ~TiXmlBase () |
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) |
void * | GetUserData () |
Protected Member Functions | |
void | CopyTo (TiXmlElement *target) const |
void | ClearThis () |
virtual void | StreamOut (TIXML_OSTREAM *out) const |
const char * | ReadValue (const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding) |
Protected Member Functions inherited from TiXmlNode | |
TiXmlNode (NodeType _type) | |
void | CopyTo (TiXmlNode *target) const |
TiXmlNode * | Identify (const char *start, TiXmlEncoding encoding) |
Protected Member Functions inherited from TiXmlBase |
Private Attributes | |
TiXmlAttributeSet | attributeSet |
Additional Inherited Members | |
Public Types inherited from TiXmlNode | |
enum | NodeType { DOCUMENT , ELEMENT , COMMENT , UNKNOWN , TEXT , DECLARATION , TYPECOUNT } |
The types of XML nodes supported by TinyXml. More... | |
Public Types inherited from TiXmlBase | |
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_STRING_COUNT } |
Static Public Member Functions inherited from TiXmlBase | |
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 Public Attributes inherited from TiXmlBase | |
static const int | utf8ByteTable [256] |
Static Protected Member Functions inherited from TiXmlBase | |
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 void | PutString (const TIXML_STRING &str, TIXML_OSTREAM *out) |
static void | PutString (const TIXML_STRING &str, TIXML_STRING *out) |
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 inherited from TiXmlNode | |
TiXmlNode * | parent |
NodeType | type |
TiXmlNode * | firstChild |
TiXmlNode * | lastChild |
TIXML_STRING | value |
TiXmlNode * | prev |
TiXmlNode * | next |
Protected Attributes inherited from TiXmlBase | |
TiXmlCursor | location |
void * | userData |
Field containing a generic user pointer. | |
Static Protected Attributes inherited from TiXmlBase | |
static const char * | errorString [TIXML_ERROR_STRING_COUNT] |
TiXmlElement::TiXmlElement | ( | const char * | in_value | ) |
Construct an element.
TiXmlElement::TiXmlElement | ( | const TiXmlElement & | copy | ) |
|
virtual |
const char * TiXmlElement::Attribute | ( | const char * | name | ) | const |
Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
const char * TiXmlElement::Attribute | ( | const char * | name, |
double * | d ) const |
Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.
const char * TiXmlElement::Attribute | ( | const char * | name, |
int * | i ) const |
Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.
|
protected |
|
virtual |
Creates a new Element and returns it - the returned element is a copy.
Implements TiXmlNode.
|
protected |
|
inline |
|
inline |
Access the first attribute in this element.
const char * TiXmlElement::GetText | ( | ) | const |
Convenience function for easy access to the text inside an element.
Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.
If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.
This is a convenient method for getting the text of simple contained text:
<foo>This is text</foo> const char* str = fooElement->GetText();
'str' will be a pointer to "This is text".
Note that this function can be misleading. If the element foo was created from this XML:
<foo><b>This is text</b></foo>
then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:
<foo>This is <b>text</b></foo>
GetText() will return "This is ".
WARNING: GetText() accesses a child node - don't become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.
|
inline |
|
inline |
Access the last attribute in this element.
void TiXmlElement::operator= | ( | const TiXmlElement & | base | ) |
|
virtual |
Implements TiXmlBase.
|
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 TiXmlBase.
int TiXmlElement::QueryDoubleAttribute | ( | const char * | name, |
double * | _value ) const |
QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
|
inline |
QueryFloatAttribute examines the attribute - see QueryIntAttribute().
int TiXmlElement::QueryIntAttribute | ( | const char * | name, |
int * | _value ) const |
QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.
If the attribute 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. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.
|
protected |
void TiXmlElement::RemoveAttribute | ( | const char * | name | ) |
Deletes an attribute with the given name.
void TiXmlElement::SetAttribute | ( | const char * | name, |
const char * | _value ) |
Sets an attribute of name to a given value.
The attribute will be created if it does not exist, or changed if it does.
void TiXmlElement::SetAttribute | ( | const char * | name, |
int | value ) |
Sets an attribute of name to a given value.
The attribute will be created if it does not exist, or changed if it does.
void TiXmlElement::SetDoubleAttribute | ( | const char * | name, |
double | value ) |
Sets an attribute of name to a given value.
The attribute will be created if it does not exist, or changed if it does.
|
protectedvirtual |
Implements TiXmlBase.
|
inlinevirtual |
Cast to a more defined type. Will return null not of the requested type.
Reimplemented from TiXmlNode.
|
inlinevirtual |
Cast to a more defined type. Will return null not of the requested type.
Reimplemented from TiXmlNode.
|
private |