Class: TBookPageFolio

Declaration: HighLevelPrint.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPaginatedPageFolio

Inherited By:

None.

Purpose:

A specialized version of TPaginatedPageFolio that has only whole pages (no partial pages). A partial page is one that falls off the edge of the MGraphic so that only part of it has MGraphic data on it.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This is a fully functional class and should not be derived except to override specific functional behavior.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TBookPageFolio::TBookPageFolio

TBookPageFolio (const TBookPageFolio &)
TBookPageFolio (const TPageDescription & pageDescription, const MGraphic * aliasGraphic, bool wholePages =true, const TGPoint & topLeftOffset =TGPoint :: kOrigin, const TGPoint & bottomRightOffset =TGPoint :: kOrigin, const TGPoint & gap =TGPoint :: kOrigin)
TBookPageFolio ()

Interface Category:

API.

Purpose:

Copy constructor.
Same as the constructor for TPaginatedPageFolio but WhollyContainedPages defaults to true.
Default constructor. Used for streaming only.

Calling Context:

Called to copy an object.
Called to create a page folio as specified by the parameters.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TBookPageFolio & -The object to copy.
const TPageDescription & pageDescription -The page description whose active area is used as the size of the block for paginating the canvas into pages.
const MGraphic * aliasGraphic -This represents the canvas area that will be divided into pages. The area used for pagination is obtained by calling GetGeometricBounds on this MGraphic. This parameter should never be NIL.
bool wholePages =true -Specifies whether or not to stretch the canvas to cover the paginated pages in whole, or to let some pages at the edge of the canvas be only partially covered by the canvas. It defaults to true. This is the only difference between this class and TPaginatedPageFolio.
const TGPoint & topLeftOffset =TGPoint :: kOrigin -Specifies the offset between the top-left edge of the canvas and the pagination blocks. This parameter defaults to no offset at all.
const TGPoint & bottomRightOffset =TGPoint :: kOrigin -Specifies the offset between the bottom-right edge of the canvas and the pagination blocks. This parameter defaults to no offset at all.
const TGPoint & gap =TGPoint :: kOrigin -Specifies the gap between pages of the pagination blocks. It defaults to no gaps.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBookPageFolio::~TBookPageFolio

virtual ~ TBookPageFolio ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBookPageFolio::operator=

TBookPageFolio & operator =(const TBookPageFolio &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TBookPageFolio & -The object to assign from.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.