wide_output_truncate Class Reference

#include <truncate.h>

Inheritance diagram for wide_output_truncate:


Public Member Functions
virtual	~wide_output_truncate ()
Static Public Member Functions
static pointer	open (const wide_output::pointer &deeper, int width)
Protected Member Functions
nstring	filename ()
int	page_width ()
int	page_length ()
const char *	type_name () const
void	write_inner (const wchar_t *data, size_t len)
void	flush_inner ()
void	end_of_line_inner ()
Private Member Functions
	wide_output_truncate (const wide_output::pointer &deeper, int width)
	wide_output_truncate ()
	wide_output_truncate (const wide_output_truncate &)
wide_output_truncate &	operator= (const wide_output_truncate &)
Private Attributes
wide_output::pointer	deeper
int	width
wstring_accumulator	buf
int	column

Detailed Description

The wide_output_truncate class is used to truncate lines to a specified printing width. Characters beyond on each line this limit are discarded.

Definition at line 31 of file truncate.h.

Constructor & Destructor Documentation

virtual wide_output_truncate::~wide_output_truncate ( ) [virtual]

The destructor.

wide_output_truncate::wide_output_truncate	(	const wide_output::pointer &	deeper,
		int	width
	)			`[private]`

The constructor. It is private on purpose, use the open class method instead.

Parameters:

	deeper	where to write the filtered output
	width	the width to crop to, or -1 if should use deeper->page_width

wide_output_truncate::wide_output_truncate ( ) [private]

wide_output_truncate::wide_output_truncate ( const wide_output_truncate & ) [private]

Member Function Documentation

static pointer wide_output_truncate::open	(	const wide_output::pointer &	deeper,
		int	width
	)			`[static]`

The open class method is used to create new dynamically allocated instances of this class.

Parameters:

	deeper	where to write the filtered output
	width	the width to crop to, or -1 if should use deeper->page_width

nstring wide_output_truncate::filename ( ) [protected, virtual]

The filename method is used to obtain the name of the file being written by this output stream.

Returns:: the name of the destination

Implements wide_output.

int wide_output_truncate::page_width ( ) [protected, virtual]

The page-width method is used to obtain the width (in printing columns) of the output destination.

Implements wide_output.

int wide_output_truncate::page_length ( ) [protected, virtual]

The length method is used to obtain the length (in whole lines) of the output destination.

Implements wide_output.

const char* wide_output_truncate::type_name ( ) const [protected, virtual]

The type_name method is used to return the name of the class of output. Useful for debugging.

Implements wide_output.

void wide_output_truncate::write_inner	(	const wchar_t *	data,
		size_t	len
	)			`[protected, virtual]`

The write_inner method is called by the write method to emit buffered data.

Parameters:

	data	The data to be written
	len	The number of wide characters to be written

Implements wide_output.

void wide_output_truncate::flush_inner ( ) [protected, virtual]

The flush_inner method is called by the flush method, after it writes any buffered data via the write_inner method.

Implements wide_output.

void wide_output_truncate::end_of_line_inner ( ) [protected, virtual]

The end_of_line_inner method is used to do end-of-line processing by the derived class, if the buffered character state is not sufficient for the end_of_line method to determine whether or not the output position is currently at the start of a line.

Implements wide_output.

wide_output_truncate& wide_output_truncate::operator= ( const wide_output_truncate & ) [private]