This class defines a layout using a matrix of pages. More...

#include <ilviews/printing/mlayout.h>

Inheritance diagram for IlvPrintableLayoutMultiplePages:

Public Member Functions
	IlvPrintableLayoutMultiplePages (int columns=2, int rows=2)
	Default constructor. More...

virtual int	getColumns () const
	Returns the number of columns of the layout. More...

virtual IlvDim	getFooterAreaHeight () const
	Returns the height of the footer area. More...

virtual IlvDim	getHeaderAreaHeight () const
	Returns the height of the header area. More...

virtual int	getPageNumber (IlvPrintableJob &job) const
	Gets the number of logical pages for this layout and the print settings given as argument. More...

IlvRect	getPrintableArea (IlvPrinter const &printer) const
	Returns the total usable area. More...

virtual int	getRows () const
	Returns the number of rows of the layout. More...

virtual void	initializeBackgroundArea (IlvPrintableJob &job) const
	Initializes the background area. More...

virtual void	initializeFooterArea (IlvPrintableJob &job) const
	Initializes the footer area. More...

virtual void	initializeForegroundArea (IlvPrintableJob &job) const
	Initializes the foreground area. More...

virtual void	initializeHeaderArea (IlvPrintableJob &job) const
	Initializes the header area. More...

virtual void	initializeMainArea (IlvPrintableJob &job) const
	Initializes the main area. More...

void	setColumns (int columns)
	Sets the number of columns of the layout. More...

virtual void	setFooterAreaHeight (IlvDim height)
	Sets the height of the footer area. More...

virtual void	setHeaderAreaHeight (IlvDim height)
	Sets the height of the header area. More...

void	setRows (int rows)
	Sets the number of rows of the layout. More...

virtual void	updateBackgroundArea (IlvPrintableJob &job, int pageIndex) const
	Updates the background area. More...

virtual void	updateFooterArea (IlvPrintableJob &job, int pageIndex) const
	Updates the footer area. More...

virtual void	updateForegroundArea (IlvPrintableJob &job, int pageIndex) const
	Updates the foreground area. More...

virtual void	updateHeaderArea (IlvPrintableJob &job, int pageIndex) const
	Updates the header area. More...

virtual void	updateMainArea (IlvPrintableJob &job, int pageIndex) const
	Updates the main area. More...

Public Member Functions inherited from IlvPrintableLayout
	IlvPrintableLayout ()
	Default constructor. More...

virtual	~IlvPrintableLayout ()
	Destructor. More...

IlvPrintableArea const &	getBackgroundArea (IlvPrintableJob &job, int pageIndex) const
	Gets the updated background area. More...

IlvPrintable *	getBackgroundPrintable () const
	Gets the `IlvPrintable` used to print the background. More...

IlvDim	getBottomMargin () const
	Returns the bottom margin. More...

IlvPrintableArea const &	getFooterArea (IlvPrintableJob &job, int pageIndex) const
	Gets the updated footer area. More...

IlvPrintable *	getFooterPrintable () const
	Gets the `IlvPrintable` used to print the footer. More...

IlvPrintableArea const &	getForegroundArea (IlvPrintableJob &job, int pageIndex) const
	Gets the updated foreground area. More...

IlvPrintable *	getForegroundPrintable () const
	Gets the `IlvPrintable` used to print the foreground. More...

IlvDim	getGutterMargin () const
	Returns the gutter margin. More...

IlvPrintableArea const &	getHeaderArea (IlvPrintableJob &job, int pageIndex) const
	Gets the updated header area. More...

IlvPrintable *	getHeaderPrintable () const
	Gets the `IlvPrintable` used to print the header. More...

IlvDim	getLeftMargin () const
	Returns the left margin. More...

IlvPrintableArea const &	getMainArea (IlvPrintableJob &job, int pageIndex) const
	Gets the updated main area. More...

void	getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom, IlvDim &gutter) const
	Returns the margins. More...

IlUInt	getRefCount () const
	Returns the number of references on this instance. More...

IlvDim	getRightMargin () const
	Returns the right margin. More...

IlvDim	getTopMargin () const
	Returns the top margin. More...

IlvRect	getUsableArea (IlvPrinter const &printer, IlBoolean isGutterOnLeft=IlTrue) const
	Returns the usable logical printable area for a page. More...

IlBoolean	isRatioKept () const
	Returns whether the ratio is kept. More...

void	lock ()
	Locks the current instance. More...

IlBoolean	print (IlvPrintableJob &job, int copyNumber) const
	Prints an `IlvPrintable` according to the layout specified by this object. More...

void	setBackgroundPrintable (IlvPrintable *printable)
	Sets the `IlvPrintable` used to print the background. More...

void	setBottomMargin (IlvDim margin)
	Sets the bottom margin. More...

void	setFooterPrintable (IlvPrintable *printable)
	Sets the `IlvPrintable` used to print the footer. More...

void	setForegroundPrintable (IlvPrintable *printable)
	Sets the `IlvPrintable` used to print the foreground. More...

void	setGutterMargin (IlvDim margin)
	Sets the gutter margin. More...

void	setHeaderPrintable (IlvPrintable *printable)
	Sets the `IlvPrintable` used to print the header. More...

void	setKeepingRatio (IlBoolean keepRatio)
	Sets whether the ratio is kept. More...

void	setLeftMargin (IlvDim margin)
	Sets the left margin. More...

void	setMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom, IlvDim gutter)
	Sets the margins. More...

void	setRightMargin (IlvDim margin)
	Sets the right margin. More...

void	setTopMargin (IlvDim margin)
	Sets the top margin. More...

void	unlock ()
	Unlocks the current instance. More...

Additional Inherited Members
Protected Member Functions inherited from IlvPrintableLayout
IlvPrintableArea &	getBackgroundArea () const
	Gets the background area. More...

IlvPrintableArea &	getFooterArea () const
	Gets the footer area. More...

IlvPrintableArea &	getForegroundArea () const
	Gets the foreground area. More...

IlvPrintableArea &	getHeaderArea () const
	Gets the header area. More...

IlvPrintableArea &	getMainArea () const
	Gets the main area. More...

void	setBackgroundArea (IlvPrintableArea *area) const
	Sets the background area. More...

void	setFooterArea (IlvPrintableArea *area) const
	Sets the footer area. More...

void	setForegroundArea (IlvPrintableArea *area) const
	Sets the foreground area. More...

void	setHeaderArea (IlvPrintableArea *area) const
	Sets the header area. More...

void	setMainArea (IlvPrintableArea *area) const
	Sets the main area. More...

Detailed Description

This class defines a layout using a matrix of pages.

Library: ilvprint

See also: IlvPrintableDocument::append

Constructor & Destructor Documentation

IlvPrintableLayoutMultiplePages::IlvPrintableLayoutMultiplePages	(	int	columns = `2`,
		int	rows = `2`
	)

Default constructor.

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

Parameters

columns	The number of pages in a row.
rows	The number of pages in a columns.

Member Function Documentation

int IlvPrintableLayoutMultiplePages::getColumns ( ) const

virtual

Returns the number of columns of the layout.

Returns: The number of columns.

virtual IlvDim IlvPrintableLayoutMultiplePages::getFooterAreaHeight ( ) const

virtual

Returns the height of the footer area.

Returns: The height of the footer area.

Implements IlvPrintableLayout.

virtual IlvDim IlvPrintableLayoutMultiplePages::getHeaderAreaHeight ( ) const

virtual

Returns the height of the header area.

Returns: The height of the header area.

Implements IlvPrintableLayout.

virtual int IlvPrintableLayoutMultiplePages::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.

Implements IlvPrintableLayout.

Reimplemented in IlvPrintableLayoutFixedSize, and IlvPrintableLayoutIdentity.

IlvRect IlvPrintableLayoutMultiplePages::getPrintableArea ( IlvPrinter const & printer ) const

Returns the total usable area.

Parameters

printer The printer to use.

int IlvPrintableLayoutMultiplePages::getRows ( ) const

virtual

Returns the number of rows of the layout.

Returns: The number of rows.

virtual void IlvPrintableLayoutMultiplePages::initializeBackgroundArea ( IlvPrintableJob & job ) const

virtual

Initializes the background area.