#include "tinyxml2.h"

Inheritance diagram for tinyxml2::XMLPrinter:

Public Member Functions
	XMLPrinter (FILE *file=0, bool compact=false, int depth=0)

virtual	~XMLPrinter ()

void	ClearBuffer ()

virtual void	CloseElement (bool compactMode=false)
	If streaming, close the Element. More...

const char *	CStr () const

int	CStrSize () const

void	OpenElement (const char *name, bool compactMode=false)

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

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	PushComment (const char *comment)
	Add a comment. More...

void	PushDeclaration (const char *value)

void	PushHeader (bool writeBOM, bool writeDeclaration)

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

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

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

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

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

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

void	PushUnknown (const char *value)

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

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

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

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

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

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

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

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

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

Protected Member Functions
virtual bool	CompactMode (const XMLElement &)

void	Print (const char *format,...)

virtual void	PrintSpace (int depth)

void	SealElement ()

Protected Attributes
bool	_elementJustOpened

DynArray< const char *, 10 >	_stack

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

Constructor & Destructor Documentation

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

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.

virtual tinyxml2::XMLPrinter::~XMLPrinter ( )

inlinevirtual

Member Function Documentation

void tinyxml2::XMLPrinter::ClearBuffer ( )

inline

If in print to memory mode, reset the buffer to the beginning.

virtual void tinyxml2::XMLPrinter::CloseElement ( bool compactMode = false )

virtual

If streaming, close the Element.

virtual bool tinyxml2::XMLPrinter::CompactMode ( const XMLElement & )

inlineprotectedvirtual

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

inline

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

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.)

void tinyxml2::XMLPrinter::OpenElement	(	const char *	name,
		bool	compactMode = `false`
	)

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

void tinyxml2::XMLPrinter::Print	(	const char *	format,
			...
	)

protected

virtual void tinyxml2::XMLPrinter::PrintSpace ( int depth )

protectedvirtual

Prints out the space before an element. You may override to change the space and tabs used. A PrintSpace() override should call Print().

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

If streaming, add an attribute to an open element.

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

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

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

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

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

Add a comment.

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

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

If streaming, write the BOM and declaration.

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

Add a text node.

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

Add a text node from an integer.

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

Add a text node from an unsigned.

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

Add a text node from a bool.

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

Add a text node from a float.

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

Add a text node from a double.

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

void tinyxml2::XMLPrinter::SealElement ( )

protected

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

virtual

Visit a text node.

Reimplemented from tinyxml2::XMLVisitor.

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

virtual

Visit a comment node.

Reimplemented from tinyxml2::XMLVisitor.

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

virtual

Visit a declaration.

Reimplemented from tinyxml2::XMLVisitor.

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

virtual

Visit an unknown node.

Reimplemented from tinyxml2::XMLVisitor.

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

virtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

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

inlinevirtual

Visit a document.

Reimplemented from tinyxml2::XMLVisitor.

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

virtual

Visit an element.

Reimplemented from tinyxml2::XMLVisitor.

Member Data Documentation

bool tinyxml2::XMLPrinter::_elementJustOpened

protected

DynArray< const char*, 10 > tinyxml2::XMLPrinter::_stack

protected

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

/builds/master-contrib_docs-mac/opencv_contrib/modules/datasets/include/opencv2/datasets/tinyxml2/tinyxml2.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation