Public Member Functions | Private Member Functions | Private Attributes
TiXmlPrinter Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlPrinter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const char * CStr ()
 Return the result.
const char * Indent ()
 Query the indention string.
const char * LineBreak ()
 Query the current line breaking string.
void SetIndent (const char *_indent)
void SetLineBreak (const char *_lineBreak)
void SetStreamPrinting ()
size_t Size ()
 Return the length of the result string.
const std::string & Str ()
 Return the result.
 TiXmlPrinter ()
virtual bool Visit (const TiXmlDeclaration &declaration)
 Visit a declaration.
virtual bool Visit (const TiXmlText &text)
 Visit a text node.
virtual bool Visit (const TiXmlComment &comment)
 Visit a comment node.
virtual bool Visit (const TiXmlUnknown &unknown)
 Visit an unknown node.
virtual bool VisitEnter (const TiXmlDocument &doc)
 Visit a document.
virtual bool VisitEnter (const TiXmlElement &element, const TiXmlAttribute *firstAttribute)
 Visit an element.
virtual bool VisitExit (const TiXmlDocument &doc)
 Visit a document.
virtual bool VisitExit (const TiXmlElement &element)
 Visit an element.

Private Member Functions

void DoIndent ()
void DoLineBreak ()

Private Attributes

TIXML_STRING buffer
int depth
TIXML_STRING indent
TIXML_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 1742 of file tinyxml.h.


Constructor & Destructor Documentation

Definition at line 1745 of file tinyxml.h.


Member Function Documentation

const char* TiXmlPrinter::CStr ( ) [inline]

Return the result.

Definition at line 1780 of file tinyxml.h.

void TiXmlPrinter::DoIndent ( ) [inline, private]

Definition at line 1790 of file tinyxml.h.

void TiXmlPrinter::DoLineBreak ( ) [inline, private]

Definition at line 1794 of file tinyxml.h.

const char* TiXmlPrinter::Indent ( ) [inline]

Query the indention string.

Definition at line 1764 of file tinyxml.h.

const char* TiXmlPrinter::LineBreak ( ) [inline]

Query the current line breaking string.

Definition at line 1771 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 1762 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 1769 of file tinyxml.h.

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

size_t TiXmlPrinter::Size ( ) [inline]

Return the length of the result string.

Definition at line 1782 of file tinyxml.h.

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

Return the result.

Definition at line 1786 of file tinyxml.h.

bool TiXmlPrinter::Visit ( const TiXmlDeclaration ) [virtual]

Visit a declaration.

Reimplemented from TiXmlVisitor.

Definition at line 1857 of file tinyxml.cpp.

bool TiXmlPrinter::Visit ( const TiXmlText ) [virtual]

Visit a text node.

Reimplemented from TiXmlVisitor.

Definition at line 1829 of file tinyxml.cpp.

bool TiXmlPrinter::Visit ( const TiXmlComment ) [virtual]

Visit a comment node.

Reimplemented from TiXmlVisitor.

Definition at line 1866 of file tinyxml.cpp.

bool TiXmlPrinter::Visit ( const TiXmlUnknown ) [virtual]

Visit an unknown node.

Reimplemented from TiXmlVisitor.

Definition at line 1877 of file tinyxml.cpp.

bool TiXmlPrinter::VisitEnter ( const TiXmlDocument ) [virtual]

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1756 of file tinyxml.cpp.

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

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1766 of file tinyxml.cpp.

bool TiXmlPrinter::VisitExit ( const TiXmlDocument ) [virtual]

Visit a document.

Reimplemented from TiXmlVisitor.

Definition at line 1761 of file tinyxml.cpp.

bool TiXmlPrinter::VisitExit ( const TiXmlElement ) [virtual]

Visit an element.

Reimplemented from TiXmlVisitor.

Definition at line 1803 of file tinyxml.cpp.


Member Data Documentation

Definition at line 1800 of file tinyxml.h.

int TiXmlPrinter::depth [private]

Definition at line 1798 of file tinyxml.h.

Definition at line 1801 of file tinyxml.h.

Definition at line 1802 of file tinyxml.h.

Definition at line 1799 of file tinyxml.h.


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


win_tinyxml
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:28:38