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.

TextFormat	singleLine () const
	returns a copy of this format with newLineChars set to nullptr.

TextFormat	withoutHeader () const
	returns a copy of this format with the addDefaultHeader flag set to false.

Public Attributes
String	dtd
	If supplied, this DTD will be added to the document.

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

String	customEncoding
	If not empty and addDefaultHeader is true, this will be set as the encoding.

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

int	lineWrapLength
	A maximum line length before wrapping is done.

const char *	newLineChars
	Allows the newline characters to be set.

Detailed Description

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

Definition at line 135 of file juce_XmlElement.h.

Constructor & Destructor Documentation

◆ TextFormat()

juce::XmlElement::TextFormat::TextFormat ( )

Default constructor.

Definition at line 336 of file juce_XmlElement.cpp.

Member Function Documentation

◆ singleLine()

XmlElement::TextFormat juce::XmlElement::TextFormat::singleLine ( ) const

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

Definition at line 338 of file juce_XmlElement.cpp.

◆ withoutHeader()

XmlElement::TextFormat juce::XmlElement::TextFormat::withoutHeader ( ) const

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

Definition at line 345 of file juce_XmlElement.cpp.

Member Data Documentation

◆ addDefaultHeader

bool juce::XmlElement::TextFormat::addDefaultHeader

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

Definition at line 143 of file juce_XmlElement.h.

◆ 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

Definition at line 142 of file juce_XmlElement.h.

◆ customHeader

String juce::XmlElement::TextFormat::customHeader

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

Definition at line 141 of file juce_XmlElement.h.

◆ dtd

String juce::XmlElement::TextFormat::dtd

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

Definition at line 140 of file juce_XmlElement.h.

◆ lineWrapLength

int juce::XmlElement::TextFormat::lineWrapLength

A maximum line length before wrapping is done.

(If newLineChars is nullptr, this is ignored)

Definition at line 144 of file juce_XmlElement.h.

◆ newLineChars

const char* juce::XmlElement::TextFormat::newLineChars

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.

Definition at line 145 of file juce_XmlElement.h.

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

juce_core/xml/juce_XmlElement.h
juce_core/xml/juce_XmlElement.cpp

Public Member Functions

Public Attributes