Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
tinyxml2::XMLElement Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:
Inheritance graph
[legend]

Public Types

enum  ElementClosingType { OPEN, CLOSED, CLOSING }
 

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
 
const char * Attribute (const char *name, const char *value=0) const
 
bool BoolAttribute (const char *name, bool defaultValue=false) const
 See IntAttribute() More...
 
bool BoolText (bool defaultValue=false) const
 See QueryIntText() More...
 
ElementClosingType ClosingType () const
 
void DeleteAttribute (const char *name)
 
double DoubleAttribute (const char *name, double defaultValue=0) const
 See IntAttribute() More...
 
double DoubleText (double defaultValue=0) const
 See QueryIntText() More...
 
const XMLAttributeFindAttribute (const char *name) const
 Query a specific attribute in the list. More...
 
const XMLAttributeFirstAttribute () const
 Return the first attribute in the list. More...
 
float FloatAttribute (const char *name, float defaultValue=0) const
 See IntAttribute() More...
 
float FloatText (float defaultValue=0) const
 See QueryIntText() More...
 
const char * GetText () const
 
XMLElementInsertNewChildElement (const char *name)
 
XMLCommentInsertNewComment (const char *comment)
 See InsertNewChildElement() More...
 
XMLDeclarationInsertNewDeclaration (const char *text)
 See InsertNewChildElement() More...
 
XMLTextInsertNewText (const char *text)
 See InsertNewChildElement() More...
 
XMLUnknownInsertNewUnknown (const char *text)
 See InsertNewChildElement() More...
 
int64_t Int64Attribute (const char *name, int64_t defaultValue=0) const
 See IntAttribute() More...
 
int64_t Int64Text (int64_t defaultValue=0) const
 See QueryIntText() More...
 
int IntAttribute (const char *name, int defaultValue=0) const
 
int IntText (int defaultValue=0) const
 
const char * Name () const
 Get the name of an element (which is the Value() of the node.) More...
 
XMLError QueryAttribute (const char *name, bool *value) const
 
XMLError QueryAttribute (const char *name, const char **value) const
 
XMLError QueryAttribute (const char *name, double *value) const
 
XMLError QueryAttribute (const char *name, float *value) const
 
XMLError QueryAttribute (const char *name, int *value) const
 
XMLError QueryAttribute (const char *name, int64_t *value) const
 
XMLError QueryAttribute (const char *name, uint64_t *value) const
 
XMLError QueryAttribute (const char *name, unsigned int *value) const
 
XMLError QueryBoolAttribute (const char *name, bool *value) const
 See QueryIntAttribute() More...
 
XMLError QueryBoolText (bool *bval) const
 See QueryIntText() More...
 
XMLError QueryDoubleAttribute (const char *name, double *value) const
 See QueryIntAttribute() More...
 
XMLError QueryDoubleText (double *dval) const
 See QueryIntText() More...
 
XMLError QueryFloatAttribute (const char *name, float *value) const
 See QueryIntAttribute() More...
 
XMLError QueryFloatText (float *fval) const
 See QueryIntText() More...
 
XMLError QueryInt64Attribute (const char *name, int64_t *value) const
 See QueryIntAttribute() More...
 
XMLError QueryInt64Text (int64_t *uval) const
 See QueryIntText() More...
 
XMLError QueryIntAttribute (const char *name, int *value) const
 
XMLError QueryIntText (int *ival) const
 
XMLError QueryStringAttribute (const char *name, const char **value) const
 See QueryIntAttribute() More...
 
XMLError QueryUnsigned64Attribute (const char *name, uint64_t *value) const
 See QueryIntAttribute() More...
 
XMLError QueryUnsigned64Text (uint64_t *uval) const
 See QueryIntText() More...
 
XMLError QueryUnsignedAttribute (const char *name, unsigned int *value) const
 See QueryIntAttribute() More...
 
XMLError QueryUnsignedText (unsigned *uval) const
 See QueryIntText() More...
 
void SetAttribute (const char *name, bool value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, const char *value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, double value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, float value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, int value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, int64_t value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, uint64_t value)
 Sets the named attribute to value. More...
 
void SetAttribute (const char *name, unsigned value)
 Sets the named attribute to value. More...
 
void SetName (const char *str, bool staticMem=false)
 Set the name of the element. More...
 
void SetText (bool value)
 
void SetText (const char *inText)
 
void SetText (double value)
 
void SetText (float value)
 
void SetText (int value)
 
void SetText (int64_t value)
 
void SetText (uint64_t value)
 
void SetText (unsigned value)
 
virtual XMLNodeShallowClone (XMLDocument *document) const
 
virtual bool ShallowEqual (const XMLNode *compare) const
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual const XMLElementToElement () const
 
uint64_t Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const
 See IntAttribute() More...
 
uint64_t Unsigned64Text (uint64_t defaultValue=0) const
 See QueryIntText() More...
 
unsigned UnsignedAttribute (const char *name, unsigned defaultValue=0) const
 See IntAttribute() More...
 
unsigned UnsignedText (unsigned defaultValue=0) const
 See QueryIntText() More...
 
- Public Member Functions inherited from tinyxml2::XMLNode
XMLNodeDeepClone (XMLDocument *target) const
 
void DeleteChild (XMLNode *node)
 
void DeleteChildren ()
 
XMLNodeFirstChild ()
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLElementFirstChildElement (const char *name=0)
 
const XMLElementFirstChildElement (const char *name=0) const
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file. More...
 
void * GetUserData () const
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
XMLNodeLastChild ()
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLElementLastChildElement (const char *name=0)
 
const XMLElementLastChildElement (const char *name=0) const
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
XMLNodeNextSibling ()
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLElementNextSiblingElement (const char *name=0)
 
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name. More...
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
XMLNodeParent ()
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodePreviousSibling ()
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLElementPreviousSiblingElement (const char *name=0)
 
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name. More...
 
void SetUserData (void *userData)
 
void SetValue (const char *val, bool staticMem=false)
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual const XMLCommentToComment () const
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual const XMLDeclarationToDeclaration () const
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual const XMLDocumentToDocument () const
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual const XMLTextToText () const
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 

Protected Member Functions

char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 
- Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 

Private Types

enum  { BUF_SIZE = 200 }
 

Private Member Functions

XMLAttributeCreateAttribute ()
 
XMLAttributeFindOrCreateAttribute (const char *name)
 
void operator= (const XMLElement &)
 
char * ParseAttributes (char *p, int *curLineNumPtr)
 
 XMLElement (const XMLElement &)
 
 XMLElement (XMLDocument *doc)
 
virtual ~XMLElement ()
 

Static Private Member Functions

static void DeleteAttribute (XMLAttribute *attribute)
 

Private Attributes

ElementClosingType _closingType
 
XMLAttribute_rootAttribute
 

Friends

class XMLDocument
 

Additional Inherited Members

- Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument_document
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_next
 
XMLNode_parent
 
int _parseLineNum
 
XMLNode_prev
 
void * _userData
 
StrPair _value
 

Detailed Description

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.

Definition at line 1267 of file tinyxml2.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
BUF_SIZE 

Definition at line 1727 of file tinyxml2.h.

◆ ElementClosingType

Enumerator
OPEN 
CLOSED 
CLOSING 

Definition at line 1703 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLElement() [1/2]

tinyxml2::XMLElement::XMLElement ( XMLDocument doc)
private

Definition at line 1727 of file tinyxml2.cpp.

◆ ~XMLElement()

tinyxml2::XMLElement::~XMLElement ( )
privatevirtual

Definition at line 1735 of file tinyxml2.cpp.

◆ XMLElement() [2/2]

tinyxml2::XMLElement::XMLElement ( const XMLElement )
private

Member Function Documentation

◆ Accept()

bool tinyxml2::XMLElement::Accept ( XMLVisitor visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

XMLPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implements tinyxml2::XMLNode.

Definition at line 2321 of file tinyxml2.cpp.

◆ Attribute()

const char * tinyxml2::XMLElement::Attribute ( const char *  name,
const char *  value = 0 
) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. For example:

const char* value = ele->Attribute( "foo" );

The 'value' parameter is normally null. However, if specified, the attribute will only be returned if the 'name' and 'value' match. This allow you to write code:

if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();

rather than:

if ( ele->Attribute( "foo" ) ) {
  if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
}

Definition at line 1759 of file tinyxml2.cpp.

◆ BoolAttribute()

bool tinyxml2::XMLElement::BoolAttribute ( const char *  name,
bool  defaultValue = false 
) const

See IntAttribute()

Definition at line 1801 of file tinyxml2.cpp.

◆ BoolText()

bool tinyxml2::XMLElement::BoolText ( bool  defaultValue = false) const

See QueryIntText()

Definition at line 2043 of file tinyxml2.cpp.

◆ ClosingType()

ElementClosingType tinyxml2::XMLElement::ClosingType ( ) const
inline

Definition at line 1709 of file tinyxml2.h.

◆ CreateAttribute()

XMLAttribute * tinyxml2::XMLElement::CreateAttribute ( )
private

Definition at line 2198 of file tinyxml2.cpp.

◆ DeleteAttribute() [1/2]

void tinyxml2::XMLElement::DeleteAttribute ( const char *  name)

Delete an attribute.

Definition at line 2096 of file tinyxml2.cpp.

◆ DeleteAttribute() [2/2]

void tinyxml2::XMLElement::DeleteAttribute ( XMLAttribute attribute)
staticprivate

Definition at line 2187 of file tinyxml2.cpp.

◆ DoubleAttribute()

double tinyxml2::XMLElement::DoubleAttribute ( const char *  name,
double  defaultValue = 0 
) const

See IntAttribute()

Definition at line 1808 of file tinyxml2.cpp.

◆ DoubleText()

double tinyxml2::XMLElement::DoubleText ( double  defaultValue = 0) const

See QueryIntText()

Definition at line 2050 of file tinyxml2.cpp.

◆ FindAttribute()

const XMLAttribute * tinyxml2::XMLElement::FindAttribute ( const char *  name) const

Query a specific attribute in the list.

Definition at line 1746 of file tinyxml2.cpp.

◆ FindOrCreateAttribute()

XMLAttribute * tinyxml2::XMLElement::FindOrCreateAttribute ( const char *  name)
private

Definition at line 2065 of file tinyxml2.cpp.

◆ FirstAttribute()

const XMLAttribute* tinyxml2::XMLElement::FirstAttribute ( ) const
inline

Return the first attribute in the list.

Definition at line 1541 of file tinyxml2.h.

◆ FloatAttribute()

float tinyxml2::XMLElement::FloatAttribute ( const char *  name,
float  defaultValue = 0 
) const

See IntAttribute()

Definition at line 1815 of file tinyxml2.cpp.

◆ FloatText()

float tinyxml2::XMLElement::FloatText ( float  defaultValue = 0) const

See QueryIntText()

Definition at line 2057 of file tinyxml2.cpp.

◆ GetText()

const char * tinyxml2::XMLElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the XMLText child and accessing it directly.

If the first child of 'this' is a XMLText, 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 ".

Definition at line 1822 of file tinyxml2.cpp.

◆ InsertNewChildElement()

XMLElement * tinyxml2::XMLElement::InsertNewChildElement ( const char *  name)

Convenience method to create a new XMLElement and add it as last (right) child of this node. Returns the created and inserted element.

Definition at line 2209 of file tinyxml2.cpp.

◆ InsertNewComment()

XMLComment * tinyxml2::XMLElement::InsertNewComment ( const char *  comment)

See InsertNewChildElement()

Definition at line 2215 of file tinyxml2.cpp.

◆ InsertNewDeclaration()

XMLDeclaration * tinyxml2::XMLElement::InsertNewDeclaration ( const char *  text)

See InsertNewChildElement()

Definition at line 2227 of file tinyxml2.cpp.

◆ InsertNewText()

XMLText * tinyxml2::XMLElement::InsertNewText ( const char *  text)

See InsertNewChildElement()

Definition at line 2221 of file tinyxml2.cpp.

◆ InsertNewUnknown()

XMLUnknown * tinyxml2::XMLElement::InsertNewUnknown ( const char *  text)

See InsertNewChildElement()

Definition at line 2233 of file tinyxml2.cpp.

◆ Int64Attribute()

int64_t tinyxml2::XMLElement::Int64Attribute ( const char *  name,
int64_t  defaultValue = 0 
) const

See IntAttribute()

Definition at line 1787 of file tinyxml2.cpp.

◆ Int64Text()

int64_t tinyxml2::XMLElement::Int64Text ( int64_t  defaultValue = 0) const

See QueryIntText()

Definition at line 2029 of file tinyxml2.cpp.

◆ IntAttribute()

int tinyxml2::XMLElement::IntAttribute ( const char *  name,
int  defaultValue = 0 
) const

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).

Definition at line 1773 of file tinyxml2.cpp.

◆ IntText()

int tinyxml2::XMLElement::IntText ( int  defaultValue = 0) const

Definition at line 2015 of file tinyxml2.cpp.

◆ Name()

const char* tinyxml2::XMLElement::Name ( ) const
inline

Get the name of an element (which is the Value() of the node.)

Definition at line 1273 of file tinyxml2.h.

◆ operator=()

void tinyxml2::XMLElement::operator= ( const XMLElement )
private

◆ ParseAttributes()

char * tinyxml2::XMLElement::ParseAttributes ( char *  p,
int *  curLineNumPtr 
)
private

Definition at line 2119 of file tinyxml2.cpp.

◆ ParseDeep()

char * tinyxml2::XMLElement::ParseDeep ( char *  p,
StrPair parentEndTag,
int *  curLineNumPtr 
)
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 2244 of file tinyxml2.cpp.

◆ QueryAttribute() [1/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
bool *  value 
) const
inline

Definition at line 1463 of file tinyxml2.h.

◆ QueryAttribute() [2/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
const char **  value 
) const
inline

Definition at line 1478 of file tinyxml2.h.

◆ QueryAttribute() [3/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
double *  value 
) const
inline

Definition at line 1468 of file tinyxml2.h.

◆ QueryAttribute() [4/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
float *  value 
) const
inline

Definition at line 1473 of file tinyxml2.h.

◆ QueryAttribute() [5/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
int *  value 
) const
inline

Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.

If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

  int value = 10;
  QueryAttribute( "foo", &value );              // if "foo" isn't found, value will still be 10

Definition at line 1443 of file tinyxml2.h.

◆ QueryAttribute() [6/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
int64_t *  value 
) const
inline

Definition at line 1453 of file tinyxml2.h.

◆ QueryAttribute() [7/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
uint64_t *  value 
) const
inline

Definition at line 1458 of file tinyxml2.h.

◆ QueryAttribute() [8/8]

XMLError tinyxml2::XMLElement::QueryAttribute ( const char *  name,
unsigned int *  value 
) const
inline

Definition at line 1448 of file tinyxml2.h.

◆ QueryBoolAttribute()

XMLError tinyxml2::XMLElement::QueryBoolAttribute ( const char *  name,
bool *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1383 of file tinyxml2.h.

◆ QueryBoolText()

XMLError tinyxml2::XMLElement::QueryBoolText ( bool *  bval) const

See QueryIntText()

Definition at line 1971 of file tinyxml2.cpp.

◆ QueryDoubleAttribute()

XMLError tinyxml2::XMLElement::QueryDoubleAttribute ( const char *  name,
double *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1393 of file tinyxml2.h.

◆ QueryDoubleText()

XMLError tinyxml2::XMLElement::QueryDoubleText ( double *  dval) const

See QueryIntText()

Definition at line 1986 of file tinyxml2.cpp.

◆ QueryFloatAttribute()

XMLError tinyxml2::XMLElement::QueryFloatAttribute ( const char *  name,
float *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1403 of file tinyxml2.h.

◆ QueryFloatText()

XMLError tinyxml2::XMLElement::QueryFloatText ( float *  fval) const

See QueryIntText()

Definition at line 2001 of file tinyxml2.cpp.

◆ QueryInt64Attribute()

XMLError tinyxml2::XMLElement::QueryInt64Attribute ( const char *  name,
int64_t *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1361 of file tinyxml2.h.

◆ QueryInt64Text()

XMLError tinyxml2::XMLElement::QueryInt64Text ( int64_t *  uval) const

See QueryIntText()

Definition at line 1941 of file tinyxml2.cpp.

◆ QueryIntAttribute()

XMLError tinyxml2::XMLElement::QueryIntAttribute ( const char *  name,
int *  value 
) const
inline

Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

int value = 10;
QueryIntAttribute( "foo", &value );             // if "foo" isn't found, value will still be 10

Definition at line 1339 of file tinyxml2.h.

◆ QueryIntText()

XMLError tinyxml2::XMLElement::QueryIntText ( int *  ival) const

Convenience method to query the value of a child text node. This is probably best shown by example. Given you have a document is this form:

  <point>
    <x>1</x>
    <y>1.4</y>
  </point>

The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.

  int x = 0;
  float y = 0;  // types of x and y are contrived for example
  const XMLElement* xElement = pointElement->FirstChildElement( "x" );
  const XMLElement* yElement = pointElement->FirstChildElement( "y" );
  xElement->QueryIntText( &x );
  yElement->QueryFloatText( &y );
Returns
XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.

Definition at line 1911 of file tinyxml2.cpp.

◆ QueryStringAttribute()

XMLError tinyxml2::XMLElement::QueryStringAttribute ( const char *  name,
const char **  value 
) const
inline

See QueryIntAttribute()

Definition at line 1414 of file tinyxml2.h.

◆ QueryUnsigned64Attribute()

XMLError tinyxml2::XMLElement::QueryUnsigned64Attribute ( const char *  name,
uint64_t *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1372 of file tinyxml2.h.

◆ QueryUnsigned64Text()

XMLError tinyxml2::XMLElement::QueryUnsigned64Text ( uint64_t *  uval) const

See QueryIntText()

Definition at line 1956 of file tinyxml2.cpp.

◆ QueryUnsignedAttribute()

XMLError tinyxml2::XMLElement::QueryUnsignedAttribute ( const char *  name,
unsigned int *  value 
) const
inline

See QueryIntAttribute()

Definition at line 1350 of file tinyxml2.h.

◆ QueryUnsignedText()

XMLError tinyxml2::XMLElement::QueryUnsignedText ( unsigned *  uval) const

See QueryIntText()

Definition at line 1926 of file tinyxml2.cpp.

◆ SetAttribute() [1/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
bool  value 
)
inline

Sets the named attribute to value.

Definition at line 1517 of file tinyxml2.h.

◆ SetAttribute() [2/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
const char *  value 
)
inline

Sets the named attribute to value.

Definition at line 1484 of file tinyxml2.h.

◆ SetAttribute() [3/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
double  value 
)
inline

Sets the named attribute to value.

Definition at line 1523 of file tinyxml2.h.

◆ SetAttribute() [4/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
float  value 
)
inline

Sets the named attribute to value.

Definition at line 1529 of file tinyxml2.h.

◆ SetAttribute() [5/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
int  value 
)
inline

Sets the named attribute to value.

Definition at line 1490 of file tinyxml2.h.

◆ SetAttribute() [6/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
int64_t  value 
)
inline

Sets the named attribute to value.

Definition at line 1503 of file tinyxml2.h.

◆ SetAttribute() [7/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
uint64_t  value 
)
inline

Sets the named attribute to value.

Definition at line 1510 of file tinyxml2.h.

◆ SetAttribute() [8/8]

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
unsigned  value 
)
inline

Sets the named attribute to value.

Definition at line 1496 of file tinyxml2.h.

◆ SetName()

void tinyxml2::XMLElement::SetName ( const char *  str,
bool  staticMem = false 
)
inline

Set the name of the element.

Definition at line 1275 of file tinyxml2.h.

◆ SetText() [1/8]

void tinyxml2::XMLElement::SetText ( bool  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1887 of file tinyxml2.cpp.

◆ SetText() [2/8]

void tinyxml2::XMLElement::SetText ( const char *  inText)

Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.

If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.

This is a convenient method for setting the text of simple contained text:

  <foo>This is text</foo>
    fooElement->SetText( "Hullaballoo!" );
  <foo>Hullaballoo!</foo>

Note that this function can be misleading. If the element foo was created from this XML:

    <foo><b>This is text</b></foo>

then it will not change "This is text", but rather prefix it with a text element:

    <foo>Hullaballoo!<b>This is text</b></foo>

For this XML:

    <foo />

SetText() will generate

    <foo>Hullaballoo!</foo>

Definition at line 1844 of file tinyxml2.cpp.

◆ SetText() [3/8]

void tinyxml2::XMLElement::SetText ( double  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1903 of file tinyxml2.cpp.

◆ SetText() [4/8]

void tinyxml2::XMLElement::SetText ( float  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1895 of file tinyxml2.cpp.

◆ SetText() [5/8]

void tinyxml2::XMLElement::SetText ( int  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1856 of file tinyxml2.cpp.

◆ SetText() [6/8]

void tinyxml2::XMLElement::SetText ( int64_t  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1872 of file tinyxml2.cpp.

◆ SetText() [7/8]

void tinyxml2::XMLElement::SetText ( uint64_t  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1879 of file tinyxml2.cpp.

◆ SetText() [8/8]

void tinyxml2::XMLElement::SetText ( unsigned  value)

Convenience method for setting text inside an element. See SetText() for important limitations.

Definition at line 1864 of file tinyxml2.cpp.

◆ ShallowClone()

XMLNode * tinyxml2::XMLElement::ShallowClone ( XMLDocument document) const
virtual

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements tinyxml2::XMLNode.

Definition at line 2275 of file tinyxml2.cpp.

◆ ShallowEqual()

bool tinyxml2::XMLElement::ShallowEqual ( const XMLNode compare) const
virtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements tinyxml2::XMLNode.

Definition at line 2292 of file tinyxml2.cpp.

◆ ToElement() [1/2]

virtual XMLElement* tinyxml2::XMLElement::ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1277 of file tinyxml2.h.

◆ ToElement() [2/2]

virtual const XMLElement* tinyxml2::XMLElement::ToElement ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1278 of file tinyxml2.h.

◆ Unsigned64Attribute()

uint64_t tinyxml2::XMLElement::Unsigned64Attribute ( const char *  name,
uint64_t  defaultValue = 0 
) const

See IntAttribute()

Definition at line 1794 of file tinyxml2.cpp.

◆ Unsigned64Text()

uint64_t tinyxml2::XMLElement::Unsigned64Text ( uint64_t  defaultValue = 0) const

See QueryIntText()

Definition at line 2036 of file tinyxml2.cpp.

◆ UnsignedAttribute()

unsigned tinyxml2::XMLElement::UnsignedAttribute ( const char *  name,
unsigned  defaultValue = 0 
) const

See IntAttribute()

Definition at line 1780 of file tinyxml2.cpp.

◆ UnsignedText()

unsigned tinyxml2::XMLElement::UnsignedText ( unsigned  defaultValue = 0) const

See QueryIntText()

Definition at line 2022 of file tinyxml2.cpp.

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 1269 of file tinyxml2.h.

Member Data Documentation

◆ _closingType

ElementClosingType tinyxml2::XMLElement::_closingType
private

Definition at line 1731 of file tinyxml2.h.

◆ _rootAttribute

XMLAttribute* tinyxml2::XMLElement::_rootAttribute
private

Definition at line 1735 of file tinyxml2.h.


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


sick_safevisionary_base
Author(s):
autogenerated on Sat Oct 21 2023 02:24:26