MADARA  3.0.6
TiXmlPrinter Class Reference

Print to memory functionality. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlPrinter:
Collaboration diagram for TiXmlPrinter:

Public Member Functions

 TiXmlPrinter ()
 
const char * CStr ()
 Return the result. More...
 
const char * Indent ()
 Query the indention string. More...
 
const char * LineBreak ()
 Query the current line breaking string. More...
 
void SetIndent (const char *_indent)
 Set the indent characters for printing. More...
 
void SetLineBreak (const char *_lineBreak)
 Set the line breaking string. More...
 
void SetStreamPrinting ()
 Switch over to "stream printing" which is the most dense formatting without linebreaks. More...
 
size_t Size ()
 Return the length of the result string. More...
 
const std::string & Str ()
 Return the result. More...
 
virtual bool Visit (const TiXmlDeclaration &declaration)
 Visit a declaration. More...
 
virtual bool Visit (const TiXmlText &text)
 Visit a text node. More...
 
virtual bool Visit (const TiXmlComment &comment)
 Visit a comment node. More...
 
virtual bool Visit (const TiXmlUnknown &unknown)
 Visit an unknow node. More...
 
virtual bool VisitEnter (const TiXmlDocument &doc)
 Visit a document. More...
 
virtual bool VisitEnter (const TiXmlElement &element, const TiXmlAttribute *firstAttribute)
 Visit an element. More...
 
virtual bool VisitExit (const TiXmlDocument &doc)
 Visit a document. More...
 
virtual bool VisitExit (const TiXmlElement &element)
 Visit an element. More...
 

Private Member Functions

void DoIndent ()
 
void DoLineBreak ()
 

Private Attributes

std::string buffer
 
int depth
 
std::string indent
 
std::string lineBreak
 
bool simpleTextPrint
 

Detailed Description

Print to memory functionality.

The TiXmlPrinter is useful when you need to:

  1. Print to memory (especially in non-STL mode)
  2. Control formatting (line endings, etc.)

When constructed, the TiXmlPrinter is in its default "pretty printing" mode. Before calling Accept() you can call methods to control the printing of the XML document. After TiXmlNode::Accept() is called, the printed document can be accessed via the CStr(), Str(), and Size() methods.

TiXmlPrinter uses the Visitor API.

TiXmlPrinter printer;
printer.SetIndent( "\t" );

doc.Accept( &printer );
fprintf( stdout, "%s", printer.CStr() );

Definition at line 1767 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlPrinter::TiXmlPrinter ( )
inline

Definition at line 1770 of file tinyxml.h.

Member Function Documentation

const char* TiXmlPrinter::CStr ( )
inline

Return the result.

Definition at line 1805 of file tinyxml.h.

void TiXmlPrinter::DoIndent ( )
inlineprivate

Definition at line 1815 of file tinyxml.h.

void TiXmlPrinter::DoLineBreak ( )
inlineprivate

Definition at line 1819 of file tinyxml.h.

const char* TiXmlPrinter::Indent ( )
inline

Query the indention string.

Definition at line 1789 of file tinyxml.h.

const char* TiXmlPrinter::LineBreak ( )
inline

Query the current line breaking string.

Definition at line 1796 of file tinyxml.h.

void TiXmlPrinter::SetIndent ( const char *  _indent)
inline

Set the indent characters for printing.

By default 4 spaces but tab is also useful, or null/empty string for no indentation.

Definition at line 1787 of file tinyxml.h.

void TiXmlPrinter::SetLineBreak ( const char *  _lineBreak)
inline

Set the line breaking string.

By default set to newline (
). Some operating systems prefer other characters, or can be set to the null/empty string for no indenation.

Definition at line 1794 of file tinyxml.h.

void TiXmlPrinter::SetStreamPrinting ( )
inline

Switch over to "stream printing" which is the most dense formatting without linebreaks.

Common when the XML is needed for network transmission.

Definition at line 1801 of file tinyxml.h.

size_t TiXmlPrinter::Size ( )
inline

Return the length of the result string.

Definition at line 1807 of file tinyxml.h.

const std::string& TiXmlPrinter::Str ( )
inline

Return the result.

Definition at line 1811 of file tinyxml.h.

bool TiXmlPrinter::Visit ( const TiXmlDeclaration )
virtual

Visit a declaration.

Reimplemented from TiXmlVisitor.

Definition at line 1812 of file tinyxml.cpp.

bool TiXmlPrinter::Visit ( const TiXmlText )
virtual

Visit a text node.

Reimplemented from TiXmlVisitor.

Definition at line 1784 of file tinyxml.cpp.

bool TiXmlPrinter::Visit ( const TiXmlComment )
virtual

Visit a comment node.

Reimplemented from TiXmlVisitor.

Definition at line 1821 of file tinyxml.cpp.

bool TiXmlPrinter::Visit ( const TiXmlUnknown )
virtual

Visit an unknow node.

Reimplemented from TiXmlVisitor.

Definition at line 1832 of file tinyxml.cpp.

bool TiXmlPrinter::VisitEnter ( const TiXmlDocument )
virtual

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1711 of file tinyxml.cpp.

bool TiXmlPrinter::VisitEnter ( const TiXmlElement ,
const TiXmlAttribute  
)
virtual

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1721 of file tinyxml.cpp.

bool TiXmlPrinter::VisitExit ( const TiXmlDocument )
virtual

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1716 of file tinyxml.cpp.

bool TiXmlPrinter::VisitExit ( const TiXmlElement )
virtual

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1758 of file tinyxml.cpp.

Member Data Documentation

std::string TiXmlPrinter::buffer
private

Definition at line 1825 of file tinyxml.h.

int TiXmlPrinter::depth
private

Definition at line 1823 of file tinyxml.h.

std::string TiXmlPrinter::indent
private

Definition at line 1826 of file tinyxml.h.

std::string TiXmlPrinter::lineBreak
private

Definition at line 1827 of file tinyxml.h.

bool TiXmlPrinter::simpleTextPrint
private

Definition at line 1824 of file tinyxml.h.


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