rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Protected Member Functions
IlvPrintableLayoutOnePage Class Reference

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

#include <ilviews/printing/olayout.h>

Inheritance diagram for IlvPrintableLayoutOnePage:
IlvPrintableLayout

Public Member Functions

 IlvPrintableLayoutOnePage ()
 Default constructor. 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...
 
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...
 
- 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...
 
IlvPrintablegetBackgroundPrintable () 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...
 
IlvPrintablegetFooterPrintable () const
 Gets the IlvPrintable used to print the footer. More...
 
IlvPrintableArea const & getForegroundArea (IlvPrintableJob &job, int pageIndex) const
 Gets the updated foreground area. More...
 
IlvPrintablegetForegroundPrintable () 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...
 
IlvPrintablegetHeaderPrintable () 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=0)
 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...
 

Protected Member Functions

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...
 
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...
 
- Protected Member Functions inherited from IlvPrintableLayout
IlvPrintableAreagetBackgroundArea () const
 Gets the background area. More...
 
IlvPrintableAreagetFooterArea () const
 Gets the footer area. More...
 
IlvPrintableAreagetForegroundArea () const
 Gets the foreground area. More...
 
IlvPrintableAreagetHeaderArea () const
 Gets the header area. More...
 
IlvPrintableAreagetMainArea () 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 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
jobThe current print settings.
Returns
The number of logical pages, always 1.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeBackgroundArea ( IlvPrintableJob job) const
protectedvirtual

Initializes the background area.

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

Parameters
jobThe current print settings.
See Also
print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeFooterArea ( IlvPrintableJob job) const
protectedvirtual

Initializes the footer area.

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

Parameters
jobThe current print settings.
See Also
print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeForegroundArea ( IlvPrintableJob job) const
protectedvirtual

Initializes the foreground area.

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

Parameters
jobThe current print settings.
See Also
print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeHeaderArea ( IlvPrintableJob job) const
protectedvirtual

Initializes the header area.

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

Parameters
jobThe current print settings.
See Also
print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::initializeMainArea ( IlvPrintableJob job) const
protectedvirtual

Initializes the main area.

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

Parameters
jobThe current print settings.
See Also
print.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::setFooterAreaHeight ( IlvDim  height)
virtual

Sets the height of the footer area.

Parameters
heightThe height of the footer area.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::setHeaderAreaHeight ( IlvDim  height)
virtual

Sets the height of the header area.

Parameters
heightThe height of the header area.

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateBackgroundArea ( IlvPrintableJob job,
int  pageIndex 
) const
protectedvirtual

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
jobThe current print settings.
pageIndexThe current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateFooterArea ( IlvPrintableJob job,
int  pageIndex 
) const
protectedvirtual

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
jobThe current print settings.
pageIndexThe current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateForegroundArea ( IlvPrintableJob job,
int  pageIndex 
) const
protectedvirtual

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
jobThe current print settings.
pageIndexThe current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateHeaderArea ( IlvPrintableJob job,
int  pageIndex 
) const
protectedvirtual

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
jobThe current print settings.
pageIndexThe current logical page index (for this layout).

Implements IlvPrintableLayout.

virtual void IlvPrintableLayoutOnePage::updateMainArea ( IlvPrintableJob job,
int  pageIndex 
) const
protectedvirtual

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
jobThe current print settings.
pageIndexThe current logical page index (for this layout).

Implements IlvPrintableLayout.


© 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.