XmlElement Class Reference
juce_core » xml

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

## Classes

struct | TextFormat
| A struct containing options for formatting the text when representing an XML element as a string. More...

## Public Member Functions

| XmlElement (const String &tagName)
| Creates an XmlElement with this tag name. More...
| XmlElement (const char *tagName)
| Creates an XmlElement with this tag name. More...
| XmlElement (const Identifier &tagName)
| Creates an XmlElement with this tag name. More...
| XmlElement (StringRef tagName)
| Creates an XmlElement with this tag name. More...
| XmlElement (String::CharPointerType tagNameBegin, String::CharPointerType tagNameEnd)
| Creates an XmlElement with this tag name. More...
| XmlElement (const XmlElement &)
| Creates a (deep) copy of another element. More...
XmlElement & | operator= (const XmlElement &)
| Creates a (deep) copy of another element. More...
XmlElement & | operator= (XmlElement &&) noexcept
| Move assignment operator. More...
| XmlElement (XmlElement &&) noexcept
| Move constructor. More...
| ~XmlElement () noexcept
| Deleting an XmlElement will also delete all of its child elements. More...
bool | isEquivalentTo (const XmlElement *other, bool ignoreOrderOfAttributes) const noexcept
| Compares two XmlElements to see if they contain the same text and attributes. More...
String | toString (const TextFormat &format={}) const
| Returns a text version of this XML element. More...
void | writeTo (OutputStream &output, const TextFormat &format={}) const
| Writes the document to a stream as UTF-8. More...
bool | writeTo (const File &destinationFile, const TextFormat &format={}) const
| Writes the document to a file as UTF-8. More...
const String & | getTagName () const noexcept
| Returns this element's tag type name. More...
String | getNamespace () const
| Returns the namespace portion of the tag-name, or an empty string if none is specified. More...
String | getTagNameWithoutNamespace () const
| Returns the part of the tag-name that follows any namespace declaration. More...
bool | hasTagName (StringRef possibleTagName) const noexcept
| Tests whether this element has a particular tag name. More...
bool | hasTagNameIgnoringNamespace (StringRef possibleTagName) const
| Tests whether this element has a particular tag name, ignoring any XML namespace prefix. More...
void | setTagName (StringRef newTagName)
| Changes this elements tag name. More...
int | getNumAttributes () const noexcept
| Returns the number of XML attributes this element contains. More...
const String & | getAttributeName (int attributeIndex) const noexcept
| Returns the name of one of the elements attributes. More...
const String & | getAttributeValue (int attributeIndex) const noexcept
| Returns the value of one of the elements attributes. More...
bool | hasAttribute (StringRef attributeName) const noexcept
| Checks whether the element contains an attribute with a certain name. More...
const String & | getStringAttribute (StringRef attributeName) const noexcept
| Returns the value of a named attribute. More...
String | getStringAttribute (StringRef attributeName, const String &defaultReturnValue) const
| Returns the value of a named attribute. More...
bool | compareAttribute (StringRef attributeName, StringRef stringToCompareAgainst, bool ignoreCase=false) const noexcept
| Compares the value of a named attribute with a value passed-in. More...
int | getIntAttribute (StringRef attributeName, int defaultReturnValue=0) const
| Returns the value of a named attribute as an integer. More...
double | getDoubleAttribute (StringRef attributeName, double defaultReturnValue=0.0) const
| Returns the value of a named attribute as floating-point. More...
bool | getBoolAttribute (StringRef attributeName, bool defaultReturnValue=false) const
| Returns the value of a named attribute as a boolean. More...
void | setAttribute (const Identifier &attributeName, const String &newValue)
| Adds a named attribute to the element. More...
void | setAttribute (const Identifier &attributeName, int newValue)
| Adds a named attribute to the element, setting it to an integer value. More...
void | setAttribute (const Identifier &attributeName, double newValue)
| Adds a named attribute to the element, setting it to a floating-point value. More...
void | removeAttribute (const Identifier &attributeName) noexcept
| Removes a named attribute from the element. More...
void | removeAllAttributes () noexcept
| Removes all attributes from this element. More...
XmlElement * | getFirstChildElement () const noexcept
| Returns the first of this element's sub-elements. More...
XmlElement * | getNextElement () const noexcept
| Returns the next of this element's siblings. More...
XmlElement * | getNextElementWithTagName (StringRef requiredTagName) const
| Returns the next of this element's siblings which has the specified tag name. More...
int | getNumChildElements () const noexcept
| Returns the number of sub-elements in this element. More...
XmlElement * | getChildElement (int index) const noexcept
| Returns the sub-element at a certain index. More...
XmlElement * | getChildByName (StringRef tagNameToLookFor) const noexcept
| Returns the first sub-element with a given tag-name. More...
XmlElement * | getChildByAttribute (StringRef attributeName, StringRef attributeValue) const noexcept
| Returns the first sub-element which has an attribute that matches the given value. More...
void | addChildElement (XmlElement *newChildElement) noexcept
| Appends an element to this element's list of children. More...
void | insertChildElement (XmlElement *newChildElement, int indexToInsertAt) noexcept
| Inserts an element into this element's list of children. More...
void | prependChildElement (XmlElement *newChildElement) noexcept
| Inserts an element at the beginning of this element's list of children. More...
XmlElement * | createNewChildElement (StringRef tagName)
| Creates a new element with the given name and returns it, after adding it as a child element. More...
bool | replaceChildElement (XmlElement *currentChildElement, XmlElement *newChildNode) noexcept
| Replaces one of this element's children with another node. More...
void | removeChildElement (XmlElement *childToRemove, bool shouldDeleteTheChild) noexcept
| Removes a child element. More...
void | deleteAllChildElements () noexcept
| Deletes all the child elements in the element. More...
void | deleteAllChildElementsWithTagName (StringRef tagName) noexcept
| Deletes all the child elements with a given tag name. More...
bool | containsChildElement (const XmlElement *possibleChild) const noexcept
| Returns true if the given element is a child of this one. More...
XmlElement * | findParentElementOf (const XmlElement *childToSearchFor) noexcept
| Recursively searches all sub-elements of this one, looking for an element which is the direct parent of the specified element. More...
template<class ElementComparator >
void | sortChildElements (ElementComparator &comparator, bool retainOrderOfEquivalentItems=false)
| Sorts the child elements using a comparator. More...
bool | isTextElement () const noexcept
| Returns true if this element is a section of text. More...
const String & | getText () const noexcept
| Returns the text for a text element. More...
void | setText (const String &newText)
| Sets the text in a text element. More...
String | getAllSubText () const
| Returns all the text from this element's child nodes. More...
String | getChildElementAllSubText (StringRef childTagName, const String &defaultReturnValue) const
| Returns all the sub-text of a named child element. More...
void | addTextElement (const String &text)
| Appends a section of text to this element. More...
void | deleteAllTextElements () noexcept
| Removes all the text elements from this element. More...
| JUCE_DEPRECATED (String createDocument(StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const)
| This has been deprecated in favour of the toString() method. More...
| JUCE_DEPRECATED (void writeToStream(OutputStream &output, StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const)
| This has been deprecated in favour of the writeTo() method. More...
| JUCE_DEPRECATED (bool writeToFile(const File &destinationFile, StringRef dtdToUse, StringRef encodingType="UTF-8", int lineWrapLength=60) const)
| This has been deprecated in favour of the writeTo() method. More...

## Static Public Member Functions

static XmlElement * | createTextElement (const String &text)
| Creates a text element that can be added to a parent element. More...
static bool | isValidXmlName (StringRef possibleName) noexcept
| Checks if a given string is a valid XML name. More...

## 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 textual XML
auto xmlString = animalsList.toString();

See also
  parseXML, parseXMLIfTagMatches, XmlDocument

## Constructor & Destructor Documentation

## XmlElement() [1/7]

XmlElement::XmlElement | ( | const String & | tagName | ) |

explicit

Creates an XmlElement with this tag name.

## XmlElement() [2/7]

XmlElement::XmlElement | ( | const char * | tagName | ) |

explicit

Creates an XmlElement with this tag name.

## XmlElement() [3/7]

XmlElement::XmlElement | ( | const Identifier & | tagName | ) |

explicit

Creates an XmlElement with this tag name.

## XmlElement() [4/7]

XmlElement::XmlElement | ( | StringRef | tagName | ) |

explicit

Creates an XmlElement with this tag name.

## XmlElement() [5/7]

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

Creates an XmlElement with this tag name.

## XmlElement() [6/7]

XmlElement::XmlElement | ( | const XmlElement & |  | ) |

Creates a (deep) copy of another element.

## XmlElement() [7/7]

XmlElement::XmlElement | ( | XmlElement && |  | ) |

noexcept

Move constructor.

## ~XmlElement()

XmlElement::~XmlElement | ( |  | ) |

noexcept

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

## Member Function Documentation

## operator=() [1/2]

XmlElement& XmlElement::operator= | ( | const XmlElement & |  | ) |

Creates a (deep) copy of another element.

## operator=() [2/2]

XmlElement& XmlElement::operator= | ( | XmlElement && |  | ) |

noexcept

Move assignment operator.

## isEquivalentTo()

bool XmlElement::isEquivalentTo | ( | const XmlElement * | other,
|  | bool | ignoreOrderOfAttributes
| ) |  | const

noexcept

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

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

Parameters

  other | the other element to compare to
  ignoreOrderOfAttributes | if 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

## toString()

String XmlElement::toString | ( | const TextFormat & | format = `{}` | ) | const

Returns a text version of this XML element.

If your intention is to write the XML to a file or stream, it's probably more efficient to use writeTo() instead of creating an intermediate string.

See also
  writeTo

## writeTo() [1/2]

void XmlElement::writeTo | ( | OutputStream & | output,
|  | const TextFormat & | format = `{}`
| ) |  | const

Writes the document to a stream as UTF-8.

See also
  writeTo, toString

## writeTo() [2/2]

bool XmlElement::writeTo | ( | const File & | destinationFile,
|  | const TextFormat & | format = `{}`
| ) |  | const

Writes the document to a file as UTF-8.

See also
  writeTo, toString

## getTagName()

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

## getNamespace()

String XmlElement::getNamespace | ( |  | ) | const

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

## getTagNameWithoutNamespace()

String XmlElement::getTagNameWithoutNamespace | ( |  | ) | const

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

## hasTagName()

bool XmlElement::hasTagName | ( | StringRef | possibleTagName | ) | const

noexcept

Tests whether this element has a particular tag name.

Parameters

  possibleTagName | the tag name you're comparing it with

See also
  getTagName

## hasTagNameIgnoringNamespace()

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

## setTagName()

void XmlElement::setTagName | ( | StringRef | newTagName | ) |

Changes this elements tag name.

See also
  getTagName

## getNumAttributes()

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.

## getAttributeName()

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

## getAttributeValue()

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

## hasAttribute()

bool XmlElement::hasAttribute | ( | StringRef | attributeName | ) | const

noexcept

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

## getStringAttribute() [1/2]

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

noexcept

Returns the value of a named attribute.

Parameters

  attributeName | the name of the attribute to look up

## getStringAttribute() [2/2]

String XmlElement::getStringAttribute | ( | StringRef | attributeName,
|  | const String & | defaultReturnValue
| ) |  | const

Returns the value of a named attribute.

Parameters

  attributeName | the name of the attribute to look up
  defaultReturnValue | a value to return if the element doesn't have an attribute with this name

## compareAttribute()

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

  attributeName | the name of the attribute to look up
  stringToCompareAgainst | the value to compare it with
  ignoreCase | whether 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)

## getIntAttribute()

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

  attributeName | the name of the attribute to look up
  defaultReturnValue | a value to return if the element doesn't have an attribute with this name

See also
  setAttribute

## getDoubleAttribute()

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 a double (using the String::getDoubleValue() method).

Parameters

  attributeName | the name of the attribute to look up
  defaultReturnValue | a value to return if the element doesn't have an attribute with this name

See also
  setAttribute

## getBoolAttribute()

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

  attributeName | the name of the attribute to look up
  defaultReturnValue | a value to return if the element doesn't have an attribute with this name

## setAttribute() [1/3]

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

  attributeName | the name of the attribute to set
  newValue | the value to set it to

See also
  removeAttribute

## setAttribute() [2/3]

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

  attributeName | the name of the attribute to set
  newValue | the value to set it to

## setAttribute() [3/3]

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

  attributeName | the name of the attribute to set
  newValue | the value to set it to

## removeAttribute()

void XmlElement::removeAttribute | ( | const Identifier & | attributeName | ) |

noexcept

Removes a named attribute from the element.

Parameters

  attributeName | the name of the attribute to remove

See also
  removeAllAttributes

## removeAllAttributes()

void XmlElement::removeAllAttributes | ( |  | ) |

noexcept

Removes all attributes from this element.

## getFirstChildElement()

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

## getNextElement()

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 a nullptr if this is the last element in its parent

See also
  getNextElement, isTextElement, forEachXmlChildElement

## getNextElementWithTagName()

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

## getNumChildElements()

int XmlElement::getNumChildElements | ( |  | ) | const

noexcept

Returns the number of sub-elements in this element.

See also
  getChildElement

## 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

## getChildByName()

XmlElement* XmlElement::getChildByName | ( | StringRef | tagNameToLookFor | ) | const

noexcept

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

Parameters

  tagNameToLookFor | the 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

## 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

  attributeName | the name of the attribute to check
  attributeValue | the target value of the attribute

Returns
  the first element with this attribute value, or nullptr if none is found

See also
  getChildByName

## addChildElement()

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

## insertChildElement()

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

  newChildElement | the element to add
  indexToInsertAt | the 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

## prependChildElement()

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

## createNewChildElement()

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");

## replaceChildElement()

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.

## removeChildElement()

void XmlElement::removeChildElement | ( | XmlElement * | childToRemove,
|  | bool | shouldDeleteTheChild
| ) |  |

noexcept

Removes a child element.

Parameters

  childToRemove | the child to look for and remove
  shouldDeleteTheChild | if true, the child will be deleted, if false it'll just remove it

## deleteAllChildElements()

void XmlElement::deleteAllChildElements | ( |  | ) |

noexcept

Deletes all the child elements in the element.

See also
  removeChildElement, deleteAllChildElementsWithTagName

## deleteAllChildElementsWithTagName()

void XmlElement::deleteAllChildElementsWithTagName | ( | StringRef | tagName | ) |

noexcept

Deletes all the child elements with a given tag name.

See also
  removeChildElement

## containsChildElement()

bool XmlElement::containsChildElement | ( | const XmlElement * | possibleChild | ) | const

noexcept

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

## findParentElementOf()

XmlElement* XmlElement::findParentElementOf | ( | const XmlElement * | childToSearchFor | ) |

noexcept

Recursively searches all sub-elements of this one, looking for an element which is the direct parent of the specified element.

Because elements don't store a pointer to their parent, if you have one and need to find its parent, the only way to do so is to exhaustively search the whole tree for it.

If the given child is found somewhere in this element's hierarchy, then this method will return its parent. If not, it will return nullptr.

## sortChildElements()

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

  comparator | the comparator to use for comparing elements.
  retainOrderOfEquivalentItems | if 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.

## isTextElement()

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 section of text, so this is used to find out what kind of element this one is.

See also
  getAllText, addTextElement, deleteAllTextElements

## getText()

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

## setText()

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.

## getAllSubText()

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

## getChildElementAllSubText()

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

## addTextElement()

void XmlElement::addTextElement | ( | const String & | text | ) |

Appends a section of text to this element.

See also
  isTextElement, getText, getAllSubText

## deleteAllTextElements()

void XmlElement::deleteAllTextElements | ( |  | ) |

noexcept

Removes all the text elements from this element.

See also
  isTextElement, getText, getAllSubText, addTextElement

## createTextElement()

static XmlElement* XmlElement::createTextElement | ( | const String & | text | ) |

static

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

## isValidXmlName()

static bool XmlElement::isValidXmlName | ( | StringRef | possibleName | ) |

static noexcept

Checks if a given string is a valid XML name.

## JUCE_DEPRECATED() [1/3]

XmlElement::JUCE_DEPRECATED | ( | String createDocument(StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const |  | ) |

This has been deprecated in favour of the toString() method.

## JUCE_DEPRECATED() [2/3]

XmlElement::JUCE_DEPRECATED | ( | void writeToStream(OutputStream &output, StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const |  | ) |

This has been deprecated in favour of the writeTo() method.

## JUCE_DEPRECATED() [3/3]

XmlElement::JUCE_DEPRECATED | ( | bool writeToFile(const File &destinationFile, StringRef dtdToUse, StringRef encodingType="UTF-8", int lineWrapLength=60) const |  | ) |

This has been deprecated in favour of the writeTo() method.

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

- juce_XmlElement.h

XmlElement::createNewChildElement
XmlElement * createNewChildElement(StringRef tagName)
Creates a new element with the given name and returns it, after adding it as a child element.
String
The JUCE String class!
Definition: juce_String.h:39
XmlElement::getNextElement
XmlElement * getNextElement() const noexcept
Returns the next of this element's siblings.
Definition: juce_XmlElement.h:434
XmlElement::setAttribute
void setAttribute(const Identifier &attributeName, const String &newValue)
Adds a named attribute to the element.
forEachXmlChildElement
#define forEachXmlChildElement(parentXmlElement, childElementVariableName)
A handy macro to make it easy to iterate all the child elements in an XmlElement.
Definition: juce_XmlElement.h:46
XmlElement::getFirstChildElement
XmlElement * getFirstChildElement() const noexcept
Returns the first of this element's sub-elements.
Definition: juce_XmlElement.h:406
XmlElement::XmlElement
XmlElement(const String &tagName)
Creates an XmlElement with this tag name.
XmlElement
Used to build a tree of elements representing an XML document.
Definition: juce_XmlElement.h:138