Printing functionality. More...
#include <tinyxml2.h>
Public Member Functions | |
XMLPrinter (FILE *file=0, bool compact=false) | |
Construct the printer. More... | |
~XMLPrinter () | |
void | PushHeader (bool writeBOM, bool writeDeclaration) |
If streaming, write the BOM and declaration. More... | |
void | OpenElement (const char *name) |
If streaming, start writing an element. More... | |
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 | CloseElement () |
If streaming, close the Element. More... | |
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 | PushComment (const char *comment) |
Add a comment. More... | |
void | PushDeclaration (const char *value) |
void | PushUnknown (const char *value) |
virtual bool | VisitEnter (const XMLDocument &) |
Visit a document. More... | |
virtual bool | VisitExit (const XMLDocument &) |
Visit a document. More... | |
virtual bool | VisitEnter (const XMLElement &element, const XMLAttribute *attribute) |
Visit an element. More... | |
virtual bool | VisitExit (const XMLElement &element) |
Visit an element. More... | |
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... | |
const char * | CStr () const |
If in print to memory mode, return a pointer to the XML file in memory. More... | |
int | CStrSize () const |
If in print to memory mode, return the size of the XML file in memory. More... | |
![]() | |
virtual | ~XMLVisitor () |
Printing functionality.
The XMLPrinter gives you more options than the XMLDocument::Print() method.
It can:
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();
XMLPrinter | ( | 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.
|
inline |
void CloseElement | ( | ) |
If streaming, close the Element.
|
inline |
If in print to memory mode, return a pointer to the XML file in memory.
|
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 OpenElement | ( | const char * | name | ) |
If streaming, start writing an element.
The element must be closed with CloseElement()
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 PushComment | ( | const char * | comment | ) |
Add a comment.
void PushDeclaration | ( | const char * | value | ) |
void PushHeader | ( | bool | writeBOM, |
bool | writeDeclaration | ||
) |
If streaming, write the BOM and declaration.
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 PushUnknown | ( | const char * | value | ) |
|
virtual |
Visit a text node.
Reimplemented from XMLVisitor.
|
virtual |
Visit a comment node.
Reimplemented from XMLVisitor.
|
virtual |
Visit a declaration.
Reimplemented from XMLVisitor.
|
virtual |
Visit an unknown node.
Reimplemented from XMLVisitor.
|
virtual |
Visit a document.
Reimplemented from XMLVisitor.
|
virtual |
Visit an element.
Reimplemented from XMLVisitor.
|
inlinevirtual |
Visit a document.
Reimplemented from XMLVisitor.
|
virtual |
Visit an element.
Reimplemented from XMLVisitor.