wide_output_header Class Reference

#include <header.h>

Inheritance diagram for wide_output_header:


Public Types
typedef aegis_shared_ptr < wide_output_header >	hpointer
Public Member Functions
	~wide_output_header ()
void	title (const char , const char )
void	need (int)
void	need1 (int)
void	eject ()
bool	is_at_top_of_page ()
Static Public Member Functions
static hpointer	open (const wide_output::pointer &deeper)
static void	title (wide_output::pointer fp, const char l1, const char l2)
static void	need1 (wide_output::pointer fp, int x)
static void	eject (wide_output::pointer fp)
static bool	is_at_top_of_page (wide_output::pointer fp)
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_header (const wide_output::pointer &deeper)
void	left_and_right (const wstring &lhs, const char *rhs)
void	top_of_page_processing ()
void	bottom_of_page_processing ()
	wide_output_header ()
	wide_output_header (const wide_output_header &)
wide_output_header &	operator= (const wide_output_header &)
Private Attributes
pointer	deeper
wstring	title1
wstring	title2
int	line_number
int	length
int	width
bool	is_a_printer
int	column
int	page_number
time_t	page_time
bool	already_top_diverted

Detailed Description

The wide_output_header class is used to add page headers to the output.

Definition at line 29 of file header.h.

Member Typedef Documentation

typedef aegis_shared_ptr<wide_output_header> wide_output_header::hpointer

Definition at line 33 of file header.h.

Constructor & Destructor Documentation

wide_output_header::~wide_output_header ( )

The destructor.

wide_output_header::wide_output_header ( const wide_output::pointer & deeper ) [private]

The constructor.

Parameters:

deeper

where to write the filtered output

wide_output_header::wide_output_header ( ) [private]

The default constructor. Do not use.

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

The copy constructor. Do not use.

Member Function Documentation

static hpointer wide_output_header::open ( const wide_output::pointer & deeper ) [static]

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

void wide_output_header::title	(	const char *	,
		const char *
	)

static void wide_output_header::title	(	wide_output::pointer	fp,
		const char *	l1,
		const char *	l2
	)			`[inline, static]`

Definition at line 59 of file header.h.

void wide_output_header::need ( int )

void wide_output_header::need1 ( int )

static void wide_output_header::need1	(	wide_output::pointer	fp,
		int	x
	)			`[inline, static]`

Definition at line 71 of file header.h.

void wide_output_header::eject ( )

static void wide_output_header::eject ( wide_output::pointer fp ) [inline, static]

Definition at line 81 of file header.h.

bool wide_output_header::is_at_top_of_page ( )

static bool wide_output_header::is_at_top_of_page ( wide_output::pointer fp ) [inline, static]

Definition at line 91 of file header.h.

nstring wide_output_header::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_header::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_header::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_header::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_header::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_header::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_header::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.