XmlElement.h File Reference

#include "../containers/LinkedListPointer.h"
#include "../memory/HeapBlock.h"
#include "../text/Identifier.h"

Go to the source code of this file.

Classes
class	water::XmlElement
struct	water::XmlElement::XmlAttributeNode

Namespaces
namespace	water

Macros
#define	__forEachXmlChildElement(parentXmlElement, childElementVariableName)
#define	__forEachXmlChildElementWithTagName(parentXmlElement, childElementVariableName, requiredTagName)

Macro Definition Documentation

__forEachXmlChildElement

#define __forEachXmlChildElement	(		parentXmlElement,
			childElementVariableName )

Value:

\
for (water::XmlElement* childElementVariableName = (parentXmlElement).getFirstChildElement(); \
     childElementVariableName != nullptr; \
     childElementVariableName = childElementVariableName->getNextElement())

A handy macro to make it easy to iterate all the child elements in an XmlElement.

The parentXmlElement should be a reference to the parent XML, and the childElementVariableName will be the name of a pointer to each child element.

E.g.

XmlElement* myParentXml = createSomeKindOfXmlDocument();
 
forEachXmlChildElement (*myParentXml, child)
{
    if (child->hasTagName ("FOO"))
        doSomethingWithXmlElement (child);
}

See also

forEachXmlChildElementWithTagName

__forEachXmlChildElementWithTagName

#define __forEachXmlChildElementWithTagName	(		parentXmlElement,
			childElementVariableName,
			requiredTagName )

Value:

\
for (water::XmlElement* childElementVariableName = (parentXmlElement).getChildByName (requiredTagName); \
     childElementVariableName != nullptr; \
     childElementVariableName = childElementVariableName->getNextElementWithTagName (requiredTagName))

A macro that makes it easy to iterate all the child elements of an XmlElement which have a specified tag.

This does the same job as the forEachXmlChildElement macro, but only for those elements that have a particular tag name.

The parentXmlElement should be a reference to the parent XML, and the childElementVariableName will be the name of a pointer to each child element. The requiredTagName is the tag name to match.

E.g.

XmlElement* myParentXml = createSomeKindOfXmlDocument();
 
forEachXmlChildElementWithTagName (*myParentXml, child, "MYTAG")
{
    // the child object is now guaranteed to be a <MYTAG> element..
    doSomethingWithMYTAGElement (child);
}

See also

forEachXmlChildElement