rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPrintableLayoutMultiplePages Class Reference

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

#include <ilviews/printing/mlayout.h>

Inheritance diagram for IlvPrintableLayoutMultiplePages:
IlvPrintableLayout IlvPrintableLayoutFixedSize IlvPrintableLayoutIdentity

List of all members.

Public Member Functions

 IlvPrintableLayoutMultiplePages (int columns=2, int rows=2)
 Default constructor.
virtual int getColumns () const
 Returns the number of columns of the layout.
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.
IlvRect getPrintableArea (IlvPrinter const &printer) const
 Returns the total usable area.
virtual int getRows () const
 Returns the number of rows of the layout.
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.
void setColumns (int columns)
 Sets the number of columns of the layout.
virtual void setFooterAreaHeight (IlvDim height)
 Sets the height of the footer area.
virtual void setHeaderAreaHeight (IlvDim height)
 Sets the height of the header area.
void setRows (int rows)
 Sets the number of rows of the layout.
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 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.

param job The current print settings.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::initializeFooterArea ( IlvPrintableJob job  )  const [virtual]

Initializes the footer area.

param job The current print settings.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::initializeForegroundArea ( IlvPrintableJob job  )  const [virtual]

Initializes the foreground area.

param job The current print settings.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::initializeHeaderArea ( IlvPrintableJob job  )  const [virtual]

Initializes the header area.

param job The current print settings.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::initializeMainArea ( IlvPrintableJob job  )  const [virtual]

Initializes the main area.

param job The current print settings.

Implements IlvPrintableLayout.

void IlvPrintableLayoutMultiplePages::setColumns ( int  columns  ) 

Sets the number of columns of the layout.

Parameters:
columns The new number of columns.
virtual void IlvPrintableLayoutMultiplePages::setFooterAreaHeight ( IlvDim  height  )  [virtual]

Sets the height of the footer area.

Parameters:
height The height of the footer area.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::setHeaderAreaHeight ( IlvDim  height  )  [virtual]

Sets the height of the header area.

Parameters:
height The height of the header area.

Implements IlvPrintableLayout.

void IlvPrintableLayoutMultiplePages::setRows ( int  rows  ) 

Sets the number of rows of the layout.

Parameters:
rows The new number of rows.
virtual void IlvPrintableLayoutMultiplePages::updateBackgroundArea ( IlvPrintableJob job,
int  pageIndex 
) const [virtual]

Updates the background area.

This method updates the current background area for the current page.

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

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::updateFooterArea ( IlvPrintableJob job,
int  pageIndex 
) const [virtual]

Updates the footer area.

This method updates the current footer area for the current page.

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

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::updateForegroundArea ( IlvPrintableJob job,
int  pageIndex 
) const [virtual]

Updates the foreground area.

This method updates the current foreground area for the current page.

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

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::updateHeaderArea ( IlvPrintableJob job,
int  pageIndex 
) const [virtual]

Updates the header area.

This method updates the current header area for the current page.

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

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutMultiplePages::updateMainArea ( IlvPrintableJob job,
int  pageIndex 
) const [virtual]

Updates the main area.

This method updates the current main area for the current page.

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

Implements IlvPrintableLayout.

Reimplemented in IlvPrintableLayoutFixedSize, and IlvPrintableLayoutIdentity.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.