Class: TPage

Declaration: PageIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MDrawable

Inherited By:

TCompoundPageIterator TPaginatedPageIterator

Purpose:

This is an abstract class that represents a page in a document. Pages are drawable or printable because of their inheritance from MDrawable, plus they also provide some information concerning the page metrics such as the ordinal page number and the page description for the page.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

All pages in printable documents derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TPage::~TPage

virtual ~ TPage ()

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: TPage::GetPageNumber

virtual unsigned long GetPageNumber () const

Interface Category:

API.

Purpose:

Returns the ordinal page number for this page. The ordinal value of a page number is with respect to other pages such as pages contained in a document, a page folio, or an iterator.

Calling Context:

Called to obtain the page number of a page with respect to other pages.

Parameters:

Takes no parameters.

Return Value:

Returns the page number of the page.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPage::GetPageDescription

virtual TPageDescription * GetPageDescription () const

Interface Category:

API.

Purpose:

Provides the page description for a page that specifies media type, margins, and physical and printable areas.

Calling Context:

Called to obtain a page description for this page.

Parameters:

Takes no parameters.

Return Value:

Returns the page description for this page.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPage::Draw

virtual void Draw (TGrafPort & port) const

Interface Category:

API.

Purpose:

Draws the page into the TGrafPort at the correct orientation.

Calling Context:

Called to draw the page.

Parameters:

TGrafPort & port -The TGrafPort into which the page can be drawn.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPage::TPage

TPage ()
TPage (const TPage &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and derived classes.
Called to copy an object.

Parameters:

Takes no parameters.
const TPage & -The object to copy.

Return Value:

None.

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.