Class: TNUpCompositor

Declaration: PageCompositor.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPageCompositor

Inherited By:

None.

Purpose:

This is a special example of a TPageCompositor that produces N-Up printing, that is, it places several target pages onto a single destination page in a tiled format.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This is a special derived class of TPageCompositor. It is not designed to be further derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TNUpCompositor::TNUpCompositor

TNUpCompositor (const TNUpCompositor &)
TNUpCompositor (const TULongPair & xyNUpFrequency, const TPageDescription & masterPage, const TPageDescription & tiledPage, TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding, TScanOrder * adoptOrder =NIL)
TNUpCompositor (const TULongPair & xyNUpFrequency, const TPageDescription & masterPage)
TNUpCompositor (const TULongPair & xyNUpFrequency, TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding)
TNUpCompositor ()

Interface Category:

API.

Purpose:

Copy constructor.
Constructs a custom N-Up compositor with the given page frequency. This is the most general of all the available constructors. The destination page description is masterPage and the source page description is tilePage. The page mapping will be defaulted to best with left binding if not otherwise specified and the order of the tiling will be defaulted left-to-right-top-to-bottom unless otherwise specified.
Constructs a generic N-Up compositor with the source pages defaulted to be the same as the masterPage. Orientation is defaulted to kPickBestWithLeftBinding and the order is defaulted to left-to-right-top-to-bottom.
This constructor defers specification of the source and master pages until a page iterator is created, at which time the destination and source pages will be derived from the target page iterator.
Default constructor.

Calling Context:

Called to copy an object.
Called to create a custom N-Up compositor.
Called to create a custom N-Up compositor with some parameters defaulted.
Called to create a custom N-Up compositor with some parameters defaulted.
Called to create a 1-Up compositor with defaulted parameters. Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TNUpCompositor & -The object to copy.
const TULongPair & xyNUpFrequency -The number of pages in x and y for the N-Up composition.
const TPageDescription & masterPage -The page size for the destination mapping.
const TPageDescription & tiledPage -The page size of the source pages.
TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding -The orientation of source pages to destination pages for the mapping.
TScanOrder * adoptOrder =NIL -The order in which the tiling is done over the destination.
const TULongPair & xyNUpFrequency -The number of pages in x and y for the N-Up composition.
const TPageDescription & masterPage -The page size for the destination mapping.
const TULongPair & xyNUpFrequency -The number of pages in x and y for the N-Up composition.
TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding -The orientation of source pages to destination pages for the mapping.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNUpCompositor::~TNUpCompositor

virtual ~ TNUpCompositor ()

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: TNUpCompositor::CreatePageIterator

virtual TPrintPageIterator * CreatePageIterator (TPageIterator * aliasIterator, TPageRange * aliasRange =NIL) const

Interface Category:

API.

Purpose:

Creates a page iterator for pages of aliasIterator arranged in some N-Up configuration as specified by the class. The page range determines which pages are included in any iteration.

Calling Context:

Called directly to create a page iterator with the desired N-Up features over a specific target.

Parameters:

TPageIterator * aliasIterator -The iterator to use as source pages from which to compose N-Up pages.
TPageRange * aliasRange =NIL -The page range or NIL if no page range is specified. Defaults to NIL.

Return Value:

Returns the newly created page iterator.

Exceptions:

Throws TStandardPrintPreprocessingException::kTargetMissing if the adopted page iterator is NIL.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNUpCompositor::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates hash value.

Calling Context:

Called directly to generate a hash value. Also used when an object is placed in a collection.

Parameters:

Takes no parameters.

Return Value:

Returns a hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNUpCompositor::operator=

virtual TNUpCompositor & operator =(const TNUpCompositor &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TNUpCompositor & -The object from which to assign.

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.

Member Function: TNUpCompositor::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called directly to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNUpCompositor::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called directly to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

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.