JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | List of all members
XmlElement Class Reference

Used to build a tree of elements representing an XML document. More...

Public Member Functions

 XmlElement (const String &tagName)
 Creates an XmlElement with this tag name.
 
 XmlElement (const char *tagName)
 Creates an XmlElement with this tag name.
 
 XmlElement (const Identifier &tagName)
 Creates an XmlElement with this tag name.
 
 XmlElement (StringRef tagName)
 Creates an XmlElement with this tag name.
 
 XmlElement (String::CharPointerType tagNameBegin, String::CharPointerType tagNameEnd)
 Creates an XmlElement with this tag name.
 
 XmlElement (const XmlElement &)
 Creates a (deep) copy of another element.
 
XmlElementoperator= (const XmlElement &)
 Creates a (deep) copy of another element.
 
 ~XmlElement () noexcept
 Deleting an XmlElement will also delete all of its child elements.
 
bool isEquivalentTo (const XmlElement *other, bool ignoreOrderOfAttributes) const noexcept
 Compares two XmlElements to see if they contain the same text and attiributes.
 
String createDocument (StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const
 Returns an XML text document that represents this element.
 
void writeToStream (OutputStream &output, StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const
 Writes the document to a stream as UTF-8.
 
bool writeToFile (const File &destinationFile, StringRef dtdToUse, StringRef encodingType="UTF-8", int lineWrapLength=60) const
 Writes the element to a file as an XML document.
 
const StringgetTagName () const noexcept
 Returns this element's tag type name.
 
String getNamespace () const
 Returns the namespace portion of the tag-name, or an empty string if none is specified.
 
String getTagNameWithoutNamespace () const
 Returns the part of the tag-name that follows any namespace declaration.
 
bool hasTagName (StringRef possibleTagName) const noexcept
 Tests whether this element has a particular tag name.
 
bool hasTagNameIgnoringNamespace (StringRef possibleTagName) const
 Tests whether this element has a particular tag name, ignoring any XML namespace prefix.
 
int getNumAttributes () const noexcept
 Returns the number of XML attributes this element contains.
 
const StringgetAttributeName (int attributeIndex) const noexcept
 Returns the name of one of the elements attributes.
 
const StringgetAttributeValue (int attributeIndex) const noexcept
 Returns the value of one of the elements attributes.
 
bool hasAttribute (StringRef attributeName) const noexcept
 Checks whether the element contains an attribute with a certain name.
 
const StringgetStringAttribute (StringRef attributeName) const noexcept
 Returns the value of a named attribute.
 
String getStringAttribute (StringRef attributeName, const String &defaultReturnValue) const
 Returns the value of a named attribute.
 
bool compareAttribute (StringRef attributeName, StringRef stringToCompareAgainst, bool ignoreCase=false) const noexcept
 Compares the value of a named attribute with a value passed-in.
 
int getIntAttribute (StringRef attributeName, int defaultReturnValue=0) const
 Returns the value of a named attribute as an integer.
 
double getDoubleAttribute (StringRef attributeName, double defaultReturnValue=0.0) const
 Returns the value of a named attribute as floating-point.
 
bool getBoolAttribute (StringRef attributeName, bool defaultReturnValue=false) const
 Returns the value of a named attribute as a boolean.
 
void setAttribute (const Identifier &attributeName, const String &newValue)
 Adds a named attribute to the element.
 
void setAttribute (const Identifier &attributeName, int newValue)
 Adds a named attribute to the element, setting it to an integer value.
 
void setAttribute (const Identifier &attributeName, double newValue)
 Adds a named attribute to the element, setting it to a floating-point value.
 
void removeAttribute (const Identifier &attributeName) noexcept
 Removes a named attribute from the element.
 
void removeAllAttributes () noexcept
 Removes all attributes from this element.
 
XmlElementgetFirstChildElement () const noexcept
 Returns the first of this element's sub-elements.
 
XmlElementgetNextElement () const noexcept
 Returns the next of this element's siblings.
 
XmlElementgetNextElementWithTagName (StringRef requiredTagName) const
 Returns the next of this element's siblings which has the specified tag name.
 
int getNumChildElements () const noexcept
 Returns the number of sub-elements in this element.
 
XmlElementgetChildElement (int index) const noexcept
 Returns the sub-element at a certain index.
 
XmlElementgetChildByName (StringRef tagNameToLookFor) const noexcept
 Returns the first sub-element with a given tag-name.
 
XmlElementgetChildByAttribute (StringRef attributeName, StringRef attributeValue) const noexcept
 Returns the first sub-element which has an attribute that matches the given value.
 
void addChildElement (XmlElement *newChildElement) noexcept
 Appends an element to this element's list of children.
 
void insertChildElement (XmlElement *newChildElement, int indexToInsertAt) noexcept
 Inserts an element into this element's list of children.
 
void prependChildElement (XmlElement *newChildElement) noexcept
 Inserts an element at the beginning of this element's list of children.
 
XmlElementcreateNewChildElement (StringRef tagName)
 Creates a new element with the given name and returns it, after adding it as a child element.
 
bool replaceChildElement (XmlElement *currentChildElement, XmlElement *newChildNode) noexcept
 Replaces one of this element's children with another node.
 
void removeChildElement (XmlElement *childToRemove, bool shouldDeleteTheChild) noexcept
 Removes a child element.
 
void deleteAllChildElements () noexcept
 Deletes all the child elements in the element.
 
void deleteAllChildElementsWithTagName (StringRef tagName) noexcept
 Deletes all the child elements with a given tag name.
 
bool containsChildElement (const XmlElement *possibleChild) const noexcept
 Returns true if the given element is a child of this one.
 
XmlElementfindParentElementOf (const XmlElement *elementToLookFor) noexcept
 Recursively searches all sub-elements to find one that contains the specified child element.
 
template<class ElementComparator >
void sortChildElements (ElementComparator &comparator, bool retainOrderOfEquivalentItems=false)
 Sorts the child elements using a comparator.
 
bool isTextElement () const noexcept
 Returns true if this element is a section of text.
 
const StringgetText () const noexcept
 Returns the text for a text element.
 
void setText (const String &newText)
 Sets the text in a text element.
 
String getAllSubText () const
 Returns all the text from this element's child nodes.
 
String getChildElementAllSubText (StringRef childTagName, const String &defaultReturnValue) const
 Returns all the sub-text of a named child element.
 
void addTextElement (const String &text)
 Appends a section of text to this element.
 
void deleteAllTextElements () noexcept
 Removes all the text elements from this element.
 

Static Public Member Functions

static XmlElementcreateTextElement (const String &text)
 Creates a text element that can be added to a parent element.
 

Detailed Description

Used to build a tree of elements representing an XML document.

An XML document can be parsed into a tree of XmlElements, each of which represents an XML tag structure, and which may itself contain other nested elements.

An XmlElement can also be converted back into a text document, and has lots of useful methods for manipulating its attributes and sub-elements, so XmlElements can actually be used as a handy general-purpose data structure.

Here's an example of parsing some elements:

// check we're looking at the right kind of document..
if (myElement->hasTagName ("ANIMALS"))
{
// now we'll iterate its sub-elements looking for 'giraffe' elements..
forEachXmlChildElement (*myElement, e)
{
if (e->hasTagName ("GIRAFFE"))
{
// found a giraffe, so use some of its attributes..
String giraffeName = e->getStringAttribute ("name");
int giraffeAge = e->getIntAttribute ("age");
bool isFriendly = e->getBoolAttribute ("friendly");
}
}
}

And here's an example of how to create an XML document from scratch:

// create an outer node called "ANIMALS"
XmlElement animalsList ("ANIMALS");
for (int i = 0; i < numAnimals; ++i)
{
// create an inner element..
XmlElement* giraffe = new XmlElement ("GIRAFFE");
giraffe->setAttribute ("name", "nigel");
giraffe->setAttribute ("age", 10);
giraffe->setAttribute ("friendly", true);
// ..and add our new element to the parent node
animalsList.addChildElement (giraffe);
}
// now we can turn the whole thing into a text document..
String myXmlDoc = animalsList.createDocument (String::empty);
See Also
XmlDocument

Constructor & Destructor Documentation

XmlElement::XmlElement ( const String tagName)
explicit

Creates an XmlElement with this tag name.

XmlElement::XmlElement ( const char *  tagName)
explicit

Creates an XmlElement with this tag name.

XmlElement::XmlElement ( const Identifier tagName)
explicit

Creates an XmlElement with this tag name.

XmlElement::XmlElement ( StringRef  tagName)
explicit

Creates an XmlElement with this tag name.

XmlElement::XmlElement ( String::CharPointerType  tagNameBegin,
String::CharPointerType  tagNameEnd 
)

Creates an XmlElement with this tag name.

XmlElement::XmlElement ( const XmlElement )

Creates a (deep) copy of another element.

XmlElement::~XmlElement ( )
noexcept

Deleting an XmlElement will also delete all of its child elements.

Member Function Documentation

XmlElement& XmlElement::operator= ( const XmlElement )

Creates a (deep) copy of another element.

bool XmlElement::isEquivalentTo ( const XmlElement other,
bool  ignoreOrderOfAttributes 
) const
noexcept

Compares two XmlElements to see if they contain the same text and attiributes.

The elements are only considered equivalent if they contain the same attiributes with the same values, and have the same sub-nodes.

Parameters
otherthe other element to compare to
ignoreOrderOfAttributesif true, this means that two elements with the same attributes in a different order will be considered the same; if false, the attributes must be in the same order as well
String XmlElement::createDocument ( StringRef  dtdToUse,
bool  allOnOneLine = false,
bool  includeXmlHeader = true,
StringRef  encodingType = "UTF-8",
int  lineWrapLength = 60 
) const

Returns an XML text document that represents this element.

The string returned can be parsed to recreate the same XmlElement that was used to create it.

Parameters
dtdToUsethe DTD to add to the document
allOnOneLineif true, this means that the document will not contain any linefeeds, so it'll be smaller but not very easy to read.
includeXmlHeaderwhether to add the "<?xml version..etc" line at the start of the document
encodingTypethe character encoding format string to put into the xml header
lineWrapLengththe line length that will be used before items get placed on a new line. This isn't an absolute maximum length, it just determines how lists of attributes get broken up
See Also
writeToStream, writeToFile
void XmlElement::writeToStream ( OutputStream output,
StringRef  dtdToUse,
bool  allOnOneLine = false,
bool  includeXmlHeader = true,
StringRef  encodingType = "UTF-8",
int  lineWrapLength = 60 
) const

Writes the document to a stream as UTF-8.

Parameters
outputthe stream to write to
dtdToUsethe DTD to add to the document
allOnOneLineif true, this means that the document will not contain any linefeeds, so it'll be smaller but not very easy to read.
includeXmlHeaderwhether to add the "<?xml version..etc" line at the start of the document
encodingTypethe character encoding format string to put into the xml header
lineWrapLengththe line length that will be used before items get placed on a new line. This isn't an absolute maximum length, it just determines how lists of attributes get broken up
See Also
writeToFile, createDocument
bool XmlElement::writeToFile ( const File destinationFile,
StringRef  dtdToUse,
StringRef  encodingType = "UTF-8",
int  lineWrapLength = 60 
) const

Writes the element to a file as an XML document.

To improve safety in case something goes wrong while writing the file, this will actually write the document to a new temporary file in the same directory as the destination file, and if this succeeds, it will rename this new file as the destination file (overwriting any existing file that was there).

Parameters
destinationFilethe file to write to. If this already exists, it will be overwritten.
dtdToUsethe DTD to add to the document
encodingTypethe character encoding format string to put into the xml header
lineWrapLengththe line length that will be used before items get placed on a new line. This isn't an absolute maximum length, it just determines how lists of attributes get broken up
Returns
true if the file is written successfully; false if something goes wrong in the process
See Also
createDocument
const String& XmlElement::getTagName ( ) const
noexcept

Returns this element's tag type name.

E.g. for an element such as <MOOSE legs="4" antlers="2">, this would return "MOOSE".

See Also
hasTagName
String XmlElement::getNamespace ( ) const

Returns the namespace portion of the tag-name, or an empty string if none is specified.

String XmlElement::getTagNameWithoutNamespace ( ) const

Returns the part of the tag-name that follows any namespace declaration.

bool XmlElement::hasTagName ( StringRef  possibleTagName) const
noexcept

Tests whether this element has a particular tag name.

Parameters
possibleTagNamethe tag name you're comparing it with
See Also
getTagName
bool XmlElement::hasTagNameIgnoringNamespace ( StringRef  possibleTagName) const

Tests whether this element has a particular tag name, ignoring any XML namespace prefix.

So a test for e.g. "xyz" will return true for "xyz" and also "foo:xyz", "bar::xyz", etc.

See Also
getTagName
int XmlElement::getNumAttributes ( ) const
noexcept

Returns the number of XML attributes this element contains.

E.g. for an element such as <MOOSE legs="4" antlers="2">, this would return 2.

const String& XmlElement::getAttributeName ( int  attributeIndex) const
noexcept

Returns the name of one of the elements attributes.

E.g. for an element such as <MOOSE legs="4" antlers="2">, then getAttributeName(1) would return "antlers".

See Also
getAttributeValue, getStringAttribute
const String& XmlElement::getAttributeValue ( int  attributeIndex) const
noexcept

Returns the value of one of the elements attributes.

E.g. for an element such as <MOOSE legs="4" antlers="2">, then getAttributeName(1) would return "2".

See Also
getAttributeName, getStringAttribute
bool XmlElement::hasAttribute ( StringRef  attributeName) const
noexcept

Checks whether the element contains an attribute with a certain name.

const String& XmlElement::getStringAttribute ( StringRef  attributeName) const
noexcept

Returns the value of a named attribute.

Parameters
attributeNamethe name of the attribute to look up
String XmlElement::getStringAttribute ( StringRef  attributeName,
const String defaultReturnValue 
) const

Returns the value of a named attribute.

Parameters
attributeNamethe name of the attribute to look up
defaultReturnValuea value to return if the element doesn't have an attribute with this name
bool XmlElement::compareAttribute ( StringRef  attributeName,
StringRef  stringToCompareAgainst,
bool  ignoreCase = false 
) const
noexcept

Compares the value of a named attribute with a value passed-in.

Parameters
attributeNamethe name of the attribute to look up
stringToCompareAgainstthe value to compare it with
ignoreCasewhether the comparison should be case-insensitive
Returns
true if the value of the attribute is the same as the string passed-in; false if it's different (or if no such attribute exists)
int XmlElement::getIntAttribute ( StringRef  attributeName,
int  defaultReturnValue = 0 
) const

Returns the value of a named attribute as an integer.

This will try to find the attribute and convert it to an integer (using the String::getIntValue() method).

Parameters
attributeNamethe name of the attribute to look up
defaultReturnValuea value to return if the element doesn't have an attribute with this name
See Also
setAttribute
double XmlElement::getDoubleAttribute ( StringRef  attributeName,
double  defaultReturnValue = 0.0 
) const

Returns the value of a named attribute as floating-point.

This will try to find the attribute and convert it to an integer (using the String::getDoubleValue() method).

Parameters
attributeNamethe name of the attribute to look up
defaultReturnValuea value to return if the element doesn't have an attribute with this name
See Also
setAttribute
bool XmlElement::getBoolAttribute ( StringRef  attributeName,
bool  defaultReturnValue = false 
) const

Returns the value of a named attribute as a boolean.

This will try to find the attribute and interpret it as a boolean. To do this, it'll return true if the value is "1", "true", "y", etc, or false for other values.

Parameters
attributeNamethe name of the attribute to look up
defaultReturnValuea value to return if the element doesn't have an attribute with this name
void XmlElement::setAttribute ( const Identifier attributeName,
const String newValue 
)

Adds a named attribute to the element.

If the element already contains an attribute with this name, it's value will be updated to the new value. If there's no such attribute yet, a new one will be added.

Note that there are other setAttribute() methods that take integers, doubles, etc. to make it easy to store numbers.

Parameters
attributeNamethe name of the attribute to set
newValuethe value to set it to
See Also
removeAttribute
void XmlElement::setAttribute ( const Identifier attributeName,
int  newValue 
)

Adds a named attribute to the element, setting it to an integer value.

If the element already contains an attribute with this name, it's value will be updated to the new value. If there's no such attribute yet, a new one will be added.

Note that there are other setAttribute() methods that take integers, doubles, etc. to make it easy to store numbers.

Parameters
attributeNamethe name of the attribute to set
newValuethe value to set it to
void XmlElement::setAttribute ( const Identifier attributeName,
double  newValue 
)

Adds a named attribute to the element, setting it to a floating-point value.

If the element already contains an attribute with this name, it's value will be updated to the new value. If there's no such attribute yet, a new one will be added.

Note that there are other setAttribute() methods that take integers, doubles, etc. to make it easy to store numbers.

Parameters
attributeNamethe name of the attribute to set
newValuethe value to set it to
void XmlElement::removeAttribute ( const Identifier attributeName)
noexcept

Removes a named attribute from the element.

Parameters
attributeNamethe name of the attribute to remove
See Also
removeAllAttributes
void XmlElement::removeAllAttributes ( )
noexcept

Removes all attributes from this element.

XmlElement* XmlElement::getFirstChildElement ( ) const
noexcept

Returns the first of this element's sub-elements.

see getNextElement() for an example of how to iterate the sub-elements.

See Also
forEachXmlChildElement
XmlElement* XmlElement::getNextElement ( ) const
noexcept

Returns the next of this element's siblings.

This can be used for iterating an element's sub-elements, e.g.

XmlElement* child = myXmlDocument->getFirstChildElement();
while (child != nullptr)
{
...do stuff with this child..
child = child->getNextElement();
}

Note that when iterating the child elements, some of them might be text elements as well as XML tags - use isTextElement() to work this out.

Also, it's much easier and neater to use this method indirectly via the forEachXmlChildElement macro.

Returns
the sibling element that follows this one, or zero if this is the last element in its parent
See Also
getNextElement, isTextElement, forEachXmlChildElement
XmlElement* XmlElement::getNextElementWithTagName ( StringRef  requiredTagName) const

Returns the next of this element's siblings which has the specified tag name.

This is like getNextElement(), but will scan through the list until it finds an element with the given tag name.

See Also
getNextElement, forEachXmlChildElementWithTagName
int XmlElement::getNumChildElements ( ) const
noexcept

Returns the number of sub-elements in this element.

See Also
getChildElement
XmlElement* XmlElement::getChildElement ( int  index) const
noexcept

Returns the sub-element at a certain index.

It's not very efficient to iterate the sub-elements by index - see getNextElement() for an example of how best to iterate.

Returns
the n'th child of this element, or nullptr if the index is out-of-range
See Also
getNextElement, isTextElement, getChildByName
XmlElement* XmlElement::getChildByName ( StringRef  tagNameToLookFor) const
noexcept

Returns the first sub-element with a given tag-name.

Parameters
tagNameToLookForthe tag name of the element you want to find
Returns
the first element with this tag name, or nullptr if none is found
See Also
getNextElement, isTextElement, getChildElement, getChildByAttribute
XmlElement* XmlElement::getChildByAttribute ( StringRef  attributeName,
StringRef  attributeValue 
) const
noexcept

Returns the first sub-element which has an attribute that matches the given value.

Parameters
attributeNamethe name of the attribute to check
attributeValuethe target value of the attribute
Returns
the first element with this attribute value, or nullptr if none is found
See Also
getChildByName
void XmlElement::addChildElement ( XmlElement newChildElement)
noexcept

Appends an element to this element's list of children.

Child elements are deleted automatically when their parent is deleted, so make sure the object that you pass in will not be deleted by anything else, and make sure it's not already the child of another element.

Note that due to the XmlElement using a singly-linked-list, prependChildElement() is an O(1) operation, but addChildElement() is an O(N) operation - so if you're adding large number of elements, you may prefer to do so in reverse order!

See Also
getFirstChildElement, getNextElement, getNumChildElements, getChildElement, removeChildElement
void XmlElement::insertChildElement ( XmlElement newChildElement,
int  indexToInsertAt 
)
noexcept

Inserts an element into this element's list of children.

Child elements are deleted automatically when their parent is deleted, so make sure the object that you pass in will not be deleted by anything else, and make sure it's not already the child of another element.

Parameters
newChildElementthe element to add
indexToInsertAtthe index at which to insert the new element - if this is below zero, it will be added to the end of the list
See Also
addChildElement, insertChildElement
void XmlElement::prependChildElement ( XmlElement newChildElement)
noexcept

Inserts an element at the beginning of this element's list of children.

Child elements are deleted automatically when their parent is deleted, so make sure the object that you pass in will not be deleted by anything else, and make sure it's not already the child of another element.

Note that due to the XmlElement using a singly-linked-list, prependChildElement() is an O(1) operation, but addChildElement() is an O(N) operation - so if you're adding large number of elements, you may prefer to do so in reverse order!

See Also
addChildElement, insertChildElement
XmlElement* XmlElement::createNewChildElement ( StringRef  tagName)

Creates a new element with the given name and returns it, after adding it as a child element.

This is a handy method that means that instead of writing this:

XmlElement* newElement = new XmlElement ("foobar");
myParentElement->addChildElement (newElement);

..you could just write this:

XmlElement* newElement = myParentElement->createNewChildElement ("foobar");
bool XmlElement::replaceChildElement ( XmlElement currentChildElement,
XmlElement newChildNode 
)
noexcept

Replaces one of this element's children with another node.

If the current element passed-in isn't actually a child of this element, this will return false and the new one won't be added. Otherwise, the existing element will be deleted, replaced with the new one, and it will return true.

void XmlElement::removeChildElement ( XmlElement childToRemove,
bool  shouldDeleteTheChild 
)
noexcept

Removes a child element.

Parameters
childToRemovethe child to look for and remove
shouldDeleteTheChildif true, the child will be deleted, if false it'll just remove it
void XmlElement::deleteAllChildElements ( )
noexcept

Deletes all the child elements in the element.

See Also
removeChildElement, deleteAllChildElementsWithTagName
void XmlElement::deleteAllChildElementsWithTagName ( StringRef  tagName)
noexcept

Deletes all the child elements with a given tag name.

See Also
removeChildElement
bool XmlElement::containsChildElement ( const XmlElement possibleChild) const
noexcept

Returns true if the given element is a child of this one.

XmlElement* XmlElement::findParentElementOf ( const XmlElement elementToLookFor)
noexcept

Recursively searches all sub-elements to find one that contains the specified child element.

template<class ElementComparator >
void XmlElement::sortChildElements ( ElementComparator &  comparator,
bool  retainOrderOfEquivalentItems = false 
)

Sorts the child elements using a comparator.

This will use a comparator object to sort the elements into order. The object passed must have a method of the form:

int compareElements (const XmlElement* first, const XmlElement* second);

..and this method must return:

  • a value of < 0 if the first comes before the second
  • a value of 0 if the two objects are equivalent
  • a value of > 0 if the second comes before the first

To improve performance, the compareElements() method can be declared as static or const.

Parameters
comparatorthe comparator to use for comparing elements.
retainOrderOfEquivalentItemsif this is true, then items which the comparator says are equivalent will be kept in the order in which they currently appear in the array. This is slower to perform, but may be important in some cases. If it's false, a faster algorithm is used, but equivalent elements may be rearranged.
bool XmlElement::isTextElement ( ) const
noexcept

Returns true if this element is a section of text.

Elements can either be an XML tag element or a secton of text, so this is used to find out what kind of element this one is.

See Also
getAllText, addTextElement, deleteAllTextElements
const String& XmlElement::getText ( ) const
noexcept

Returns the text for a text element.

Note that if you have an element like this:

<xyz>hello</xyz>

then calling getText on the "xyz" element won't return "hello", because that is actually stored in a special text sub-element inside the xyz element. To get the "hello" string, you could either call getText on the (unnamed) sub-element, or use getAllSubText() to do this automatically.

Note that leading and trailing whitespace will be included in the string - to remove if, just call String::trim() on the result.

See Also
isTextElement, getAllSubText, getChildElementAllSubText
void XmlElement::setText ( const String newText)

Sets the text in a text element.

Note that this is only a valid call if this element is a text element. If it's not, then no action will be performed. If you're trying to add text inside a normal element, you probably want to use addTextElement() instead.

String XmlElement::getAllSubText ( ) const

Returns all the text from this element's child nodes.

This iterates all the child elements and when it finds text elements, it concatenates their text into a big string which it returns.

E.g.

<xyz>hello <x>there</x> world</xyz>

if you called getAllSubText on the "xyz" element, it'd return "hello there world".

Note that leading and trailing whitespace will be included in the string - to remove if, just call String::trim() on the result.

See Also
isTextElement, getChildElementAllSubText, getText, addTextElement
String XmlElement::getChildElementAllSubText ( StringRef  childTagName,
const String defaultReturnValue 
) const

Returns all the sub-text of a named child element.

If there is a child element with the given tag name, this will return all of its sub-text (by calling getAllSubText() on it). If there is no such child element, this will return the default string passed-in.

See Also
getAllSubText
void XmlElement::addTextElement ( const String text)

Appends a section of text to this element.

See Also
isTextElement, getText, getAllSubText
void XmlElement::deleteAllTextElements ( )
noexcept

Removes all the text elements from this element.

See Also
isTextElement, getText, getAllSubText, addTextElement
static XmlElement* XmlElement::createTextElement ( const String text)
static

Creates a text element that can be added to a parent element.


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