TDME2  1.9.200
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TiXmlPrinter Class Reference

Print to memory functionality. More...

#include </home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.h>

Inheritance diagram for TiXmlPrinter:
Inheritance graph
Collaboration diagram for TiXmlPrinter:
Collaboration graph

Public Member Functions

 TiXmlPrinter ()
 
virtual bool VisitEnter (const TiXmlDocument &doc)
 Visit a document. More...
 
virtual bool VisitExit (const TiXmlDocument &doc)
 Visit a document. More...
 
virtual bool VisitEnter (const TiXmlElement &element, const TiXmlAttribute *firstAttribute)
 Visit an element. More...
 
virtual bool VisitExit (const TiXmlElement &element)
 Visit an element. 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 unknown node. More...
 
void SetIndent (const char *_indent)
 Set the indent characters for printing. More...
 
const char * Indent ()
 Query the indention string. More...
 
void SetLineBreak (const char *_lineBreak)
 Set the line breaking string. More...
 
const char * LineBreak ()
 Query the current line breaking string. More...
 
void SetStreamPrinting ()
 Switch over to "stream printing" which is the most dense formatting without linebreaks. More...
 
const char * CStr ()
 Return the result. More...
 
size_t Size ()
 Return the length of the result string. More...
 
const std::string & Str ()
 Return the result. More...
 
- Public Member Functions inherited from TiXmlVisitor
virtual ~TiXmlVisitor ()
 

Private Member Functions

void DoIndent ()
 
void DoLineBreak ()
 

Private Attributes

int depth
 
bool simpleTextPrint
 
TIXML_STRING buffer
 
TIXML_STRING indent
 
TIXML_STRING lineBreak
 

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 1652 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlPrinter()

TiXmlPrinter ( )
inline

Definition at line 1655 of file tinyxml.h.

Member Function Documentation

◆ VisitEnter() [1/2]

bool VisitEnter ( const TiXmlDocument )
virtual

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1713 of file tinyxml.cpp.

◆ VisitExit() [1/2]

bool VisitExit ( const TiXmlDocument )
virtual

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1718 of file tinyxml.cpp.

◆ VisitEnter() [2/2]

bool VisitEnter ( const TiXmlElement ,
const TiXmlAttribute  
)
virtual

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1723 of file tinyxml.cpp.

◆ VisitExit() [2/2]

bool VisitExit ( const TiXmlElement )
virtual

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1760 of file tinyxml.cpp.

◆ Visit() [1/4]

bool Visit ( const TiXmlDeclaration )
virtual

Visit a declaration.

Reimplemented from TiXmlVisitor.

Definition at line 1814 of file tinyxml.cpp.

◆ Visit() [2/4]

bool Visit ( const TiXmlText )
virtual

Visit a text node.

Reimplemented from TiXmlVisitor.

Definition at line 1786 of file tinyxml.cpp.

◆ Visit() [3/4]

bool Visit ( const TiXmlComment )
virtual

Visit a comment node.

Reimplemented from TiXmlVisitor.

Definition at line 1823 of file tinyxml.cpp.

◆ Visit() [4/4]

bool Visit ( const TiXmlUnknown )
virtual

Visit an unknown node.

Reimplemented from TiXmlVisitor.

Definition at line 1834 of file tinyxml.cpp.

◆ SetIndent()

void SetIndent ( const char *  _indent)
inline

Set the indent characters for printing.

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

Definition at line 1672 of file tinyxml.h.

◆ Indent()

const char* Indent ( )
inline

Query the indention string.

Definition at line 1674 of file tinyxml.h.

◆ SetLineBreak()

void 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 1679 of file tinyxml.h.

◆ LineBreak()

const char* LineBreak ( )
inline

Query the current line breaking string.

Definition at line 1681 of file tinyxml.h.

◆ SetStreamPrinting()

void 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 1686 of file tinyxml.h.

◆ CStr()

const char* CStr ( )
inline

Return the result.

Definition at line 1690 of file tinyxml.h.

◆ Size()

size_t Size ( )
inline

Return the length of the result string.

Definition at line 1692 of file tinyxml.h.

◆ Str()

const std::string& Str ( )
inline

Return the result.

Definition at line 1695 of file tinyxml.h.

◆ DoIndent()

void DoIndent ( )
inlineprivate

Definition at line 1698 of file tinyxml.h.

◆ DoLineBreak()

void DoLineBreak ( )
inlineprivate

Definition at line 1702 of file tinyxml.h.

Member Data Documentation

◆ depth

int depth
private

Definition at line 1706 of file tinyxml.h.

◆ simpleTextPrint

bool simpleTextPrint
private

Definition at line 1707 of file tinyxml.h.

◆ buffer

TIXML_STRING buffer
private

Definition at line 1708 of file tinyxml.h.

◆ indent

TIXML_STRING indent
private

Definition at line 1709 of file tinyxml.h.

◆ lineBreak

TIXML_STRING lineBreak
private

Definition at line 1710 of file tinyxml.h.


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