#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLPrinter:

Public Member Functions
	XMLPrinter (std::FILE *file=0, bool compact=false)

	~XMLPrinter ()

void	PushHeader (bool writeBOM, bool writeDeclaration)

void	OpenElement (const char *name)

void	PushAttribute (const char name, const char value)
	If streaming, add an attribute to an open element.

void	PushAttribute (const char *name, int value)

void	PushAttribute (const char *name, unsigned value)

void	PushAttribute (const char *name, bool value)

void	PushAttribute (const char *name, double value)

void	CloseElement ()
	If streaming, close the Element.

void	PushText (const char *text, bool cdata=false)
	Add a text node.

void	PushText (int value)
	Add a text node from an integer.

void	PushText (unsigned value)
	Add a text node from an unsigned.

void	PushText (bool value)
	Add a text node from a bool.

void	PushText (float value)
	Add a text node from a float.

void	PushText (double value)
	Add a text node from a double.

void	PushComment (const char *comment)
	Add a comment.

void	PushDeclaration (const char *value)

void	PushUnknown (const char *value)

virtual bool	VisitEnter (const XMLDocument &)
	Visit a document.

virtual bool	VisitExit (const XMLDocument &)
	Visit a document.

virtual bool	VisitEnter (const XMLElement &element, const XMLAttribute *attribute)
	Visit an element.

virtual bool	VisitExit (const XMLElement &element)
	Visit an element.

virtual bool	Visit (const XMLText &text)
	Visit a text node.

virtual bool	Visit (const XMLComment &comment)
	Visit a comment node.

virtual bool	Visit (const XMLDeclaration &declaration)
	Visit a declaration.

virtual bool	Visit (const XMLUnknown &unknown)
	Visit an unknown node.

const char *	CStr () const

int	CStrSize () const

Public Member Functions inherited from tinyxml2::XMLVisitor
virtual	~XMLVisitor ()

Detailed Description

Printing functionality. The XMLPrinter gives you more options than the XMLDocument::Print() method.

It can:

Print to memory.
Print to a file you provide.
Print XML without a XMLDocument.

Print to Memory

XMLPrinter printer;
doc->Print( &printer );
SomeFunction( printer.CStr() );

Print to a File

You provide the file pointer.

XMLPrinter printer( fp );
doc.Print( &printer );

Print without a XMLDocument

When loading, an XML parser is very useful. However, sometimes when saving, it just gets in the way. The code is often set up for streaming, and constructing the DOM is just overhead.

The Printer supports the streaming case. The following code prints out a trivially simple XML file without ever creating an XML document.

XMLPrinter printer( fp );
printer.OpenElement( "foo" );
printer.PushAttribute( "foo", "bar" );
printer.CloseElement();

Definition at line 1787 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLPrinter()

tinyxml2::XMLPrinter::XMLPrinter	(	std::FILE *	file = `0`,
		bool	compact = `false`
	)

Construct the printer. If the FILE* is specified, this will print to the FILE. Else it will print to memory, and the result is available in CStr(). If 'compact' is set to true, then output is created with only required whitespace and newlines.

Definition at line 1727 of file tinyxml2.cpp.

◆ ~XMLPrinter()

tinyxml2::XMLPrinter::~XMLPrinter ( )

inline

Definition at line 1797 of file tinyxml2.h.

Member Function Documentation

◆ CloseElement()

void tinyxml2::XMLPrinter::CloseElement ( )

If streaming, close the Element.

Definition at line 1907 of file tinyxml2.cpp.

◆ CStr()

const char * tinyxml2::XMLPrinter::CStr ( ) const

inline

If in print to memory mode, return a pointer to the XML file in memory.

Definition at line 1850 of file tinyxml2.h.

◆ CStrSize()

int tinyxml2::XMLPrinter::CStrSize ( ) const

inline

If in print to memory mode, return the size of the XML file in memory. (Note the size returned includes the terminating null.)

Definition at line 1858 of file tinyxml2.h.

◆ OpenElement()

void tinyxml2::XMLPrinter::OpenElement ( const char * name )

If streaming, start writing an element. The element must be closed with CloseElement()

Definition at line 1847 of file tinyxml2.cpp.

◆ PushAttribute() [1/5]

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		bool	value
	)

Definition at line 1891 of file tinyxml2.cpp.

◆ PushAttribute() [2/5]

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		const char *	value
	)

If streaming, add an attribute to an open element.

Definition at line 1866 of file tinyxml2.cpp.

◆ PushAttribute() [3/5]

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		double	value
	)

Definition at line 1899 of file tinyxml2.cpp.

◆ PushAttribute() [4/5]

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		int	value
	)

Definition at line 1875 of file tinyxml2.cpp.

◆ PushAttribute() [5/5]

void tinyxml2::XMLPrinter::PushAttribute	(	const char *	name,
		unsigned	value
	)

Definition at line 1883 of file tinyxml2.cpp.

◆ PushComment()

void tinyxml2::XMLPrinter::PushComment ( const char * comment )

Add a comment.

Definition at line 1997 of file tinyxml2.cpp.

◆ PushDeclaration()

void tinyxml2::XMLPrinter::PushDeclaration ( const char * value )

Definition at line 2011 of file tinyxml2.cpp.

◆ PushHeader()

void tinyxml2::XMLPrinter::PushHeader	(	bool	writeBOM,
		bool	writeDeclaration
	)

If streaming, write the BOM and declaration.

Definition at line 1835 of file tinyxml2.cpp.

◆ PushText() [1/6]

void tinyxml2::XMLPrinter::PushText ( bool value )

Add a text node from a bool.

Definition at line 1973 of file tinyxml2.cpp.

◆ PushText() [2/6]

void tinyxml2::XMLPrinter::PushText	(	const char *	text,
		bool	cdata = `false`
	)

Add a text node.

Definition at line 1940 of file tinyxml2.cpp.

◆ PushText() [3/6]

void tinyxml2::XMLPrinter::PushText ( double value )

Add a text node from a double.

Definition at line 1989 of file tinyxml2.cpp.

◆ PushText() [4/6]

void tinyxml2::XMLPrinter::PushText ( float value )

Add a text node from a float.

Definition at line 1981 of file tinyxml2.cpp.

◆ PushText() [5/6]

void tinyxml2::XMLPrinter::PushText ( int value )

Add a text node from an integer.

Definition at line 1957 of file tinyxml2.cpp.

◆ PushText() [6/6]

void tinyxml2::XMLPrinter::PushText ( unsigned value )

Add a text node from an unsigned.

Definition at line 1965 of file tinyxml2.cpp.

◆ PushUnknown()

void tinyxml2::XMLPrinter::PushUnknown ( const char * value )

Definition at line 2025 of file tinyxml2.cpp.

◆ Visit() [1/4]

bool tinyxml2::XMLPrinter::Visit ( const XMLComment & )

virtual

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2074 of file tinyxml2.cpp.

◆ Visit() [2/4]

bool tinyxml2::XMLPrinter::Visit ( const XMLDeclaration & )

virtual

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2080 of file tinyxml2.cpp.

◆ Visit() [3/4]

bool tinyxml2::XMLPrinter::Visit ( const XMLText & )

virtual

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2067 of file tinyxml2.cpp.

◆ Visit() [4/4]

bool tinyxml2::XMLPrinter::Visit ( const XMLUnknown & )

virtual

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2087 of file tinyxml2.cpp.

◆ VisitEnter() [1/2]

bool tinyxml2::XMLPrinter::VisitEnter ( const XMLDocument & )

virtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2039 of file tinyxml2.cpp.

◆ VisitEnter() [2/2]

bool tinyxml2::XMLPrinter::VisitEnter	(	const XMLElement &	,
		const XMLAttribute *
	)

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2049 of file tinyxml2.cpp.

◆ VisitExit() [1/2]

virtual bool tinyxml2::XMLPrinter::VisitExit ( const XMLDocument & )

inlinevirtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 1834 of file tinyxml2.h.

◆ VisitExit() [2/2]

bool tinyxml2::XMLPrinter::VisitExit ( const XMLElement & )

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Definition at line 2060 of file tinyxml2.cpp.

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

include/tinyxml2.h
src/tinyxml2.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ XMLPrinter()

◆ ~XMLPrinter()

Member Function Documentation

◆ CloseElement()

◆ CStr()

◆ CStrSize()

◆ OpenElement()

◆ PushAttribute() [1/5]

◆ PushAttribute() [2/5]

◆ PushAttribute() [3/5]

◆ PushAttribute() [4/5]

◆ PushAttribute() [5/5]

◆ PushComment()

◆ PushDeclaration()

◆ PushHeader()

◆ PushText() [1/6]

◆ PushText() [2/6]

◆ PushText() [3/6]

◆ PushText() [4/6]

◆ PushText() [5/6]

◆ PushText() [6/6]

◆ PushUnknown()

◆ Visit() [1/4]

◆ Visit() [2/4]

◆ Visit() [3/4]

◆ Visit() [4/4]

◆ VisitEnter() [1/2]

◆ VisitEnter() [2/2]

◆ VisitExit() [1/2]

◆ VisitExit() [2/2]