#include <textwriter.h>

Detailed Description

A friendly interface for writing text data to a stream.

Copyright: (C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Public Member Functions
	TextWriter ()
	constructor

virtual	~TextWriter ()
	destructor

void	WriteChar (unsigned char c)
	write a single character

void	WriteString (const Util::String &str)
	write a string

void	WriteFormatted (const char *fmtString,...)
	write some formatted text

void	WriteLine (const Util::String &line)
	write a line of text and append a new-line

void	WriteLines (const Util::Array< Util::String > &lines)
	write a number of lines, separated by new-lines

template<typename T >
void	Write (const T &t)
	generic writer method

Public Member Functions inherited from IO::StreamWriter
	StreamWriter ()
	constructor

virtual	~StreamWriter ()
	destructor

void	SetStream (const Ptr< Stream > &s)
	set stream to write to

const Ptr< Stream > &	GetStream () const
	get currently set stream

bool	HasStream () const
	return true if a stream is set

virtual bool	Open ()
	begin reading from the stream

virtual void	Close ()
	end reading from the stream

bool	IsOpen () const
	return true if currently open

Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor

int	GetRefCount () const
	get the current refcount

void	AddRef ()
	increment refcount by one

void	Release ()
	decrement refcount and destroy object if refcount is zero

bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class

bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string

bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc

bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class

bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string

bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc

const Util::String &	GetClassName () const
	get the class name

Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (TextWriter)

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)

Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Protected Attributes inherited from IO::StreamWriter
Ptr< Stream >	stream

bool	isOpen

bool	streamWasOpen

Constructor & Destructor Documentation

◆ TextWriter()

TextWriter::TextWriter ( )

constructor

◆ ~TextWriter()

TextWriter::~TextWriter ( )

virtual

destructor

Member Function Documentation

◆ __DeclareClass()

IO::TextWriter::__DeclareClass ( TextWriter )

private

◆ Write()

template<typename T >

void IO::TextWriter::Write ( const T & t )

generic writer method

◆ WriteChar()

void TextWriter::WriteChar ( unsigned char c )

write a single character

◆ WriteFormatted()

void TextWriter::WriteFormatted	(	const char *	fmtString,
			... )

write some formatted text

◆ WriteLine()

void TextWriter::WriteLine ( const Util::String & line )

write a line of text and append a new-line

◆ WriteLines()

void TextWriter::WriteLines ( const Util::Array< Util::String > & lines )

write a number of lines, separated by new-lines

◆ WriteString()

void TextWriter::WriteString ( const Util::String & str )

write a string

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

/github/workspace/code/foundation/io/textwriter.h
/github/workspace/code/foundation/io/textwriter.cc