openshot-audio  0.1.4
Classes | Macros
juce_XmlElement.h File Reference

Go to the source code of this file.

Classes

class  XmlElement
 

Macros

#define JUCE_XMLELEMENT_H_INCLUDED
 
#define forEachXmlChildElement(parentXmlElement, childElementVariableName)
 
#define forEachXmlChildElementWithTagName(parentXmlElement, childElementVariableName, requiredTagName)
 
#define forEachXmlChildElement(parentXmlElement, childElementVariableName)
 
#define forEachXmlChildElementWithTagName(parentXmlElement, childElementVariableName, requiredTagName)
 

Macro Definition Documentation

◆ forEachXmlChildElement [1/2]

#define forEachXmlChildElement (   parentXmlElement,
  childElementVariableName 
)
Value:
\
for (juce::XmlElement* childElementVariableName = (parentXmlElement).getFirstChildElement(); \
childElementVariableName != nullptr; \
childElementVariableName = childElementVariableName->getNextElement())
Definition: juce_core.h:143
XmlElement * getNextElement() const noexcept
Definition: juce_core.h:466

◆ forEachXmlChildElement [2/2]

#define forEachXmlChildElement (   parentXmlElement,
  childElementVariableName 
)
Value:
\
for (juce::XmlElement* childElementVariableName = (parentXmlElement).getFirstChildElement(); \
childElementVariableName != nullptr; \
childElementVariableName = childElementVariableName->getNextElement())
Definition: juce_core.h:143
XmlElement * getNextElement() const noexcept
Definition: juce_core.h:466

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 [1/2]

#define forEachXmlChildElementWithTagName (   parentXmlElement,
  childElementVariableName,
  requiredTagName 
)
Value:
\
for (juce::XmlElement* childElementVariableName = (parentXmlElement).getChildByName (requiredTagName); \
childElementVariableName != nullptr; \
childElementVariableName = childElementVariableName->getNextElementWithTagName (requiredTagName))
Definition: juce_core.h:143
XmlElement * getNextElementWithTagName(StringRef requiredTagName) const
Definition: juce_core.cpp:423

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

◆ forEachXmlChildElementWithTagName [2/2]

#define forEachXmlChildElementWithTagName (   parentXmlElement,
  childElementVariableName,
  requiredTagName 
)
Value:
\
for (juce::XmlElement* childElementVariableName = (parentXmlElement).getChildByName (requiredTagName); \
childElementVariableName != nullptr; \
childElementVariableName = childElementVariableName->getNextElementWithTagName (requiredTagName))
Definition: juce_core.h:143
XmlElement * getNextElementWithTagName(StringRef requiredTagName) const
Definition: juce_core.cpp:423

◆ JUCE_XMLELEMENT_H_INCLUDED

#define JUCE_XMLELEMENT_H_INCLUDED