IlvPrintableLayoutOnePage Class Reference

This class defines a layout using a single page. More...

#include <ilviews/printing/olayout.h>

Inheritance diagram for IlvPrintableLayoutOnePage:

List of all members.

Public Member Functions
	IlvPrintableLayoutOnePage ()
	Default constructor.
virtual IlvDim	getFooterAreaHeight () const
	Returns the height of the footer area.
virtual IlvDim	getHeaderAreaHeight () const
	Returns the height of the header area.
virtual int	getPageNumber (IlvPrintableJob &job) const
	Gets the number of logical pages for this layout and the print settings given as argument.
virtual void	setFooterAreaHeight (IlvDim height)
	Sets the height of the footer area.
virtual void	setHeaderAreaHeight (IlvDim height)
	Sets the height of the header area.
Protected Member Functions
virtual void	initializeBackgroundArea (IlvPrintableJob &job) const
	Initializes the background area.
virtual void	initializeFooterArea (IlvPrintableJob &job) const
	Initializes the footer area.
virtual void	initializeForegroundArea (IlvPrintableJob &job) const
	Initializes the foreground area.
virtual void	initializeHeaderArea (IlvPrintableJob &job) const
	Initializes the header area.
virtual void	initializeMainArea (IlvPrintableJob &job) const
	Initializes the main area.
virtual void	updateBackgroundArea (IlvPrintableJob &job, int pageIndex) const
	Updates the background area.
virtual void	updateFooterArea (IlvPrintableJob &job, int pageIndex) const
	Updates the footer area.
virtual void	updateForegroundArea (IlvPrintableJob &job, int pageIndex) const
	Updates the foreground area.
virtual void	updateHeaderArea (IlvPrintableJob &job, int pageIndex) const
	Updates the header area.
virtual void	updateMainArea (IlvPrintableJob &job, int pageIndex) const
	Updates the main area.

---

Detailed Description

This class defines a layout using a single page.

Library: ilvprint

The entire physical printable area is used.

See also:

IlvPrintableDocument::append

---

Constructor & Destructor Documentation

IlvPrintableLayoutOnePage::IlvPrintableLayoutOnePage

(

)

Default constructor.

It initializes the object in a coherent state. There are no additional margins by default.

---

Member Function Documentation

virtual IlvDim IlvPrintableLayoutOnePage::getFooterAreaHeight

(

)

const [virtual]

Returns the height of the footer area.

Returns:

The height of the footer area.

Implements IlvPrintableLayout.

virtual IlvDim IlvPrintableLayoutOnePage::getHeaderAreaHeight

(

)

const [virtual]

Returns the height of the header area.

Returns:

The height of the header area.

Implements IlvPrintableLayout.

virtual int IlvPrintableLayoutOnePage::getPageNumber

(

IlvPrintableJob &

job

)

const [virtual]

Gets the number of logical pages for this layout and the print settings given as argument.

Parameters:

job

The current print settings.

Returns:

The number of logical pages, always 1.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeBackgroundArea

(

IlvPrintableJob &

job

)

const [protected, virtual]

Initializes the background area.

The purpose of the function is to initialize the background area.

Parameters:

job

The current print settings.

See also:

print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeFooterArea

(

IlvPrintableJob &

job

)

const [protected, virtual]

Initializes the footer area.

The purpose of the function is to initialize the footer area.

Parameters:

job

The current print settings.

See also:

print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeForegroundArea

(

IlvPrintableJob &

job

)

const [protected, virtual]

Initializes the foreground area.

The purpose of the function is to initialize the foreground area.

Parameters:

job

The current print settings.

See also:

print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeHeaderArea

(

IlvPrintableJob &

job

)

const [protected, virtual]

Initializes the header area.

The purpose of the function is to initialize the header area.

Parameters:

job

The current print settings.

See also:

print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeMainArea

(

IlvPrintableJob &

job

)

const [protected, virtual]

Initializes the main area.

The purpose of the function is to initialize the main area.

Parameters:

job

The current print settings.

See also:

print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::setFooterAreaHeight

(

IlvDim

height

)

[virtual]

Sets the height of the footer area.

Parameters:

height

The height of the footer area.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::setHeaderAreaHeight

(

IlvDim

height

)

[virtual]

Sets the height of the header area.

Parameters:

height

The height of the header area.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateBackgroundArea	(	IlvPrintableJob &	job,
		int	pageIndex
	)			const [protected, virtual]

Updates the background area.

The purpose of this function is to update the IlvPrintableArea background object. The job as well as the page index given as parameters may be used to compute the current size of the area.

Parameters:

	job	The current print settings.
	pageIndex	The current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateFooterArea	(	IlvPrintableJob &	job,
		int	pageIndex
	)			const [protected, virtual]

Updates the footer area.

The purpose of this function is to update the IlvPrintableArea footer object. The job as well as the page index given as parameters may be used to compute the current size of the area.

Parameters:

	job	The current print settings.
	pageIndex	The current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateForegroundArea	(	IlvPrintableJob &	job,
		int	pageIndex
	)			const [protected, virtual]

Updates the foreground area.

The purpose of this function is to update the IlvPrintableArea foreground object. The job as well as the page index given as parameters may be used to compute the current size of the area.

Parameters:

	job	The current print settings.
	pageIndex	The current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateHeaderArea	(	IlvPrintableJob &	job,
		int	pageIndex
	)			const [protected, virtual]

Updates the header area.

The purpose of this function is to update the IlvPrintableArea header object. The job as well as the page index given as parameters may be used to compute the current size of the area.

Parameters:

	job	The current print settings.
	pageIndex	The current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateMainArea	(	IlvPrintableJob &	job,
		int	pageIndex
	)			const [protected, virtual]

Updates the main area.

The purpose of this function is to update the IlvPrintableArea main object. The job as well as the page index given as parameters may be used to compute the current size of the area.

Parameters:

	job	The current print settings.
	pageIndex	The current logical page index (for this layout).

Implements IlvPrintableLayout.