col_unformatted Class Reference

#include <unformatted.h>

Inheritance diagram for col_unformatted:

Public Member Functions
virtual	~col_unformatted ()
Static Public Member Functions
static pointer	create (const wide_output::pointer &deeper)
Protected Member Functions
output::pointer	create (int, int, const char *)
void	title (const char *, const char *)
void	eoln ()
void	need (int)
void	eject ()
void	flush ()
void	forget (const output::pointer &op)
Private Member Functions
	col_unformatted (const wide_output::pointer &deeper)
	col_unformatted ()
	col_unformatted (const col_unformatted &)
col_unformatted &	operator= (const col_unformatted &)
Private Attributes
wide_output::pointer	deeper
wchar_t	separator
size_t	ncolumns
size_t	ncolumns_max
column_ty *	column
Data Structures
struct	column_ty

---

Detailed Description

The col_unformatted class is used to represent columnar output wich simply has the columns concatenated on a single line, without any formatting.

Definition at line 34 of file unformatted.h.

---

Constructor & Destructor Documentation

virtual col_unformatted::~col_unformatted

(

)

[virtual]

The destructor.

col_unformatted::col_unformatted

(

const wide_output::pointer &

deeper

)

[private]

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

Parameters:

deeper

the output stream upon which to write the columnar output

col_unformatted::col_unformatted

(

)

[private]

The default constructor. Do not use.

col_unformatted::col_unformatted

(

const col_unformatted &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

static pointer col_unformatted::create

(

const wide_output::pointer &

deeper

)

[static]

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

Parameters:

deeper

the output stream upon which to write the columnar output

output::pointer col_unformatted::create	(	int	left,
		int	right,
		const char *	title
	)			[protected, virtual]

The create method is used to specify a range of locations for an output column.

The contents will be de-tabbed and wrapped before output.

Parameters:

	left	the left-hand edge of the column. If you say -1, it will use the righ-hand side of the previous column, plus one. (Note: NOT the right-most column.)
	right	the right-hand edge of the column, plus one. zero means the rest of the line
	title	the column title to use. Give NULL pointer for none.

Returns:

output::pointer ; a pointer to an output stream to be used to write into this column. Use the delete operator when you are done with the column.

Implements col.

void col_unformatted::title	(	const char *	first,
		const char *	second
	)			[protected, virtual]

The title method is used to set the two lines of page headings. These are ignored for unformatted output.

Parameters:

	first	first line of heading, NULL means blank
	second	second line of heading, NULL means blank

Implements col.

void col_unformatted::eoln

(

)

[protected, virtual]

The eoln method is used to signal that an entire line of columns has been assembled and that it should be emitted to the output file or pager.

Columns all receive an implicit newline, and are flushed before processing. All of the columns are thus aligned into rows, even when (due to newlines or wrapping) they would otherwise be different lengths.

This is the interface used by clients of this subsystem.

Implements col.

void col_unformatted::need

(

int

n

)

[protected, virtual]

The need method is used to nominate that a number of lines is needed before the end of the page. If the lines are available, a blank line is emitted, otherwise a new page is thrown.

Parameters:

n

the number of lines, not counting the blank line.

Implements col.

void col_unformatted::eject

(

)

[protected, virtual]

The eject method is used to move to the top of the next page, if we aren't there already.

Implements col.

void col_unformatted::flush

(

)

[protected, virtual]

The flush method is used to force output of all buffered data.

Implements col.

void col_unformatted::forget

(

const output::pointer &

op

)

[protected, virtual]

The forget method is used to discontinue an output column.

Parameters:

op

The column to forget.

Implements col.

col_unformatted& col_unformatted::operator=

(

const col_unformatted &

)

[private]

The assignment operator. Do not use.

---

Field Documentation

wide_output::pointer col_unformatted::deeper [private]

Definition at line 97 of file unformatted.h.

wchar_t col_unformatted::separator [private]

Definition at line 98 of file unformatted.h.

size_t col_unformatted::ncolumns [private]

Definition at line 99 of file unformatted.h.

size_t col_unformatted::ncolumns_max [private]

Definition at line 100 of file unformatted.h.

column_ty* col_unformatted::column [private]

Definition at line 101 of file unformatted.h.

---

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

• libaegis/col/unformatted.h