RWWCharOutputStream Class Reference
[Streams]

Handle class for all the wide character output stream implementation classes. More...

#include <rw/stream/RWWCharOutputStream.h>

Inheritance diagram for RWWCharOutputStream:

List of all members.

Public Member Functions
	RWWCharOutputStream (RWWCharOutputStreamImp *ptr)
	RWWCharOutputStream (const RWWCharOutputStream &handle)
RWWCharOutputStream &	operator= (const RWWCharOutputStream &handle)
RWWCharOutputStream &	operator<< (RWWCharOutputStream &(*pf)(RWWCharOutputStream &))
RWWCharOutputStream	operator<< (RWWCharOutputStream(*pf)(RWWCharOutputStream &))
RWWCharOutputStream &	operator<< (wchar_t wcharValue)
void	write (wchar_t wcharValue)
void	write (const wchar_t *wcharArray, RWSize numWChars)
void	close ()
void	flush ()
bool	isBad () const
bool	isFail () const
bool	isGood () const
Related Functions
(Note that these are not member functions.)
RWWCharOutputStream &	rwFlush (RWWCharOutputStream &stream)
RWWCharOutputStream &	rwEndl (RWWCharOutputStream &stream)
RWWCharOutputStream &	rwEnds (RWWCharOutputStream &stream)

---

Detailed Description

Handle class for all the wide character output stream implementation classes. Implements the handle idiom from the handle-body pattern.

---

Constructor & Destructor Documentation

RWWCharOutputStream::RWWCharOutputStream

(

RWWCharOutputStreamImp *

ptr

)

[inline, explicit]

Constructor.

RWWCharOutputStream::RWWCharOutputStream

(

const RWWCharOutputStream &

handle

)

[inline]

Copy constructor.

Parameters:

handle

A wide character stream handle used to initialize the newly created handle.

---

Member Function Documentation

void RWWCharOutputStream::close

(

void

)

[inline]

Closes the stream.

void RWWCharOutputStream::flush

(

void

)

[inline]

Flushes the stream.

bool RWWCharOutputStream::isBad

(

)

const [inline]

Returns true to indicate a loss of integrity resulting from an output operation. Throws no exceptions.

bool RWWCharOutputStream::isFail

(

)

const [inline]

Returns true to indicate that an output operation failed to generate the desired data. Throws no exceptions.

bool RWWCharOutputStream::isGood

(

)

const [inline]

Returns true to indicate a stream in a valid state. Throws no exceptions.

RWWCharOutputStream& RWWCharOutputStream::operator<<

(

wchar_t

wcharValue

)

[inline]

Writes a single wide character to the stream.

Parameters:

wcharValue

The wide character to be written to the stream.

RWWCharOutputStream RWWCharOutputStream::operator<<

(

RWWCharOutputStream(*)(RWWCharOutputStream &)

pf

)

[inline]

Inserter executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWWCharOutputStream& RWWCharOutputStream::operator<<

(

RWWCharOutputStream &(*)(RWWCharOutputStream &)

pf

)

[inline]

Inserter executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWWCharOutputStream& RWWCharOutputStream::operator=

(

const RWWCharOutputStream &

handle

)

[inline]

Assignment operator. Throws no exceptions.

Parameters:

handle

A wide character stream handle used to initialize this handle.

void RWWCharOutputStream::write	(	const wchar_t *	wcharArray,
		RWSize	numWChars
	)			[inline]

Writes an array of wide characters to the stream.

Parameters:

	wcharArray	A pointer to the first element of the array.
	numWChars	The number of wide characters to be written to the stream.

void RWWCharOutputStream::write

(

wchar_t

wcharValue

)

[inline]

Writes a single wide character to the stream.

Parameters:

wcharValue

The wide character to be written to the stream.

---

Friends And Related Function Documentation

RWWCharOutputStream & rwEndl

(

RWWCharOutputStream &

stream

)

[related]

Manipulator that writes an end-of-line control character to the stream.

Parameters:

stream

A wide character output stream.

RWWCharOutputStream & rwEnds

(

RWWCharOutputStream &

stream

)

[related]

Manipulator that writes an end-of-string character to the stream.

Parameters:

stream

A wide character output stream.

RWWCharOutputStream & rwFlush

(

RWWCharOutputStream &

stream

)

[related]

Manipulator that flushes a wide character output stream.

Parameters:

stream

The wide character stream to be flushed.