omegalib  13.1
omega::xml::TiXmlPrinter Class Reference

Print to memory functionality. More...

#include <tinyxml.h>

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...
 
- Public Member Functions inherited from omega::xml::TiXmlVisitor
virtual ~TiXmlVisitor ()
 

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() );
+ Inheritance diagram for omega::xml::TiXmlPrinter:

Constructor & Destructor Documentation

omega::xml::TiXmlPrinter::TiXmlPrinter ( )
inline

Member Function Documentation

const char* omega::xml::TiXmlPrinter::CStr ( )
inline

Return the result.

const char* omega::xml::TiXmlPrinter::Indent ( )
inline

Query the indention string.

const char* omega::xml::TiXmlPrinter::LineBreak ( )
inline

Query the current line breaking string.

void omega::xml::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.

void omega::xml::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.

void omega::xml::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.

size_t omega::xml::TiXmlPrinter::Size ( )
inline

Return the length of the result string.

virtual bool omega::xml::TiXmlPrinter::Visit ( const TiXmlDeclaration )
virtual

Visit a declaration.

Reimplemented from omega::xml::TiXmlVisitor.

virtual bool omega::xml::TiXmlPrinter::Visit ( const TiXmlText )
virtual

Visit a text node.

Reimplemented from omega::xml::TiXmlVisitor.

virtual bool omega::xml::TiXmlPrinter::Visit ( const TiXmlComment )
virtual

Visit a comment node.

Reimplemented from omega::xml::TiXmlVisitor.

virtual bool omega::xml::TiXmlPrinter::Visit ( const TiXmlUnknown )
virtual

Visit an unknown node.

Reimplemented from omega::xml::TiXmlVisitor.

virtual bool omega::xml::TiXmlPrinter::VisitEnter ( const TiXmlDocument )
virtual

Visit a document.

Reimplemented from omega::xml::TiXmlVisitor.

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

Visit an element.

Reimplemented from omega::xml::TiXmlVisitor.

virtual bool omega::xml::TiXmlPrinter::VisitExit ( const TiXmlDocument )
virtual

Visit a document.

Reimplemented from omega::xml::TiXmlVisitor.

virtual bool omega::xml::TiXmlPrinter::VisitExit ( const TiXmlElement )
virtual

Visit an element.

Reimplemented from omega::xml::TiXmlVisitor.


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