A struct containing options for formatting the text when representing an XML element as a string. More...
#include <juce_XmlElement.h>
Public Member Functions | |
TextFormat () | |
Default constructor. More... | |
JUCE_NODISCARD TextFormat | singleLine () const |
returns a copy of this format with newLineChars set to nullptr. More... | |
JUCE_NODISCARD TextFormat | withoutHeader () const |
returns a copy of this format with the addDefaultHeader flag set to false. More... | |
Public Attributes | |
bool | addDefaultHeader = true |
If true, a default header will be generated; otherwise just bare XML will be emitted. More... | |
String | customEncoding |
If not empty and addDefaultHeader is true, this will be set as the encoding. More... | |
String | customHeader |
If supplied, this header will be used (and customEncoding & addDefaultHeader will be ignored). More... | |
String | dtd |
If supplied, this DTD will be added to the document. More... | |
int | lineWrapLength = 60 |
A maximum line length before wrapping is done. More... | |
const char * | newLineChars = "\r\n" |
Allows the newline characters to be set. More... | |
A struct containing options for formatting the text when representing an XML element as a string.
juce::XmlElement::TextFormat::TextFormat | ( | ) |
Default constructor.
JUCE_NODISCARD TextFormat juce::XmlElement::TextFormat::singleLine | ( | ) | const |
returns a copy of this format with newLineChars set to nullptr.
JUCE_NODISCARD TextFormat juce::XmlElement::TextFormat::withoutHeader | ( | ) | const |
returns a copy of this format with the addDefaultHeader flag set to false.
bool juce::XmlElement::TextFormat::addDefaultHeader = true |
If true, a default header will be generated; otherwise just bare XML will be emitted.
String juce::XmlElement::TextFormat::customEncoding |
If not empty and addDefaultHeader is true, this will be set as the encoding.
Otherwise, a default of "UTF-8" will be used
String juce::XmlElement::TextFormat::customHeader |
If supplied, this header will be used (and customEncoding & addDefaultHeader will be ignored).
String juce::XmlElement::TextFormat::dtd |
If supplied, this DTD will be added to the document.
int juce::XmlElement::TextFormat::lineWrapLength = 60 |
A maximum line length before wrapping is done.
(If newLineChars is nullptr, this is ignored)
const char* juce::XmlElement::TextFormat::newLineChars = "\r\n" |
Allows the newline characters to be set.
If you set this to nullptr, then the whole XML document will be placed on a single line.