juce::XmlElement::TextFormat Struct Reference

#include <juce_XmlElement.h>

Public Member Functions
	TextFormat ()
JUCE_NODISCARD TextFormat	singleLine () const
JUCE_NODISCARD TextFormat	withoutHeader () const

Public Attributes
String	dtd
String	customHeader
String	customEncoding
bool	addDefaultHeader = true
int	lineWrapLength = 60
const char *	newLineChars = "\r\n"

Detailed Description

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

Constructor & Destructor Documentation

TextFormat()

juce::XmlElement::TextFormat::TextFormat

(

)

Default constructor.

Member Function Documentation

singleLine()

XmlElement::TextFormat juce::XmlElement::TextFormat::singleLine

(

)

const

returns a copy of this format with newLineChars set to nullptr.

withoutHeader()

XmlElement::TextFormat juce::XmlElement::TextFormat::withoutHeader

(

)

const

returns a copy of this format with the addDefaultHeader flag set to false.

Member Data Documentation

addDefaultHeader

bool juce::XmlElement::TextFormat::addDefaultHeader = true

If true, a default header will be generated; otherwise just bare XML will be emitted.

customEncoding

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

customHeader

String juce::XmlElement::TextFormat::customHeader

If supplied, this header will be used (and customEncoding & addDefaultHeader will be ignored).

dtd

String juce::XmlElement::TextFormat::dtd

If supplied, this DTD will be added to the document.

lineWrapLength

int juce::XmlElement::TextFormat::lineWrapLength = 60

A maximum line length before wrapping is done. (If newLineChars is nullptr, this is ignored)

newLineChars

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.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/xml/juce_XmlElement.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/xml/juce_XmlElement.cpp