Class: TResolution

Declaration: Printer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPrinterAttribute

Inherited By:

TStandardResolution

Purpose:

Represents the resolution of a printing device.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This is an abstract class that provides only getters. Clients can derive from this class to provide setters and other functionality.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TResolution::~TResolution

virtual ~ TResolution ()

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: TResolution::operator=

TResolution & operator =(const TResolution &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TResolution & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TResolution::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

A long hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TResolution::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed 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: TResolution::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object is streamed 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.

Member Function: TResolution::TResolution

TResolution ()
TResolution (const TResolution &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TSourceTray & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TResolution::MatchResolution

virtual TGPoint MatchResolution (const TGPoint & resolution) const

Interface Category:

API.

Purpose:

For this device, find an available resolution that this device can accommodate, which is closest to the resolution requested. Find the closest matching resolution among all resolutions available.

Calling Context:

Called to obtain the closest match to a given resolution.

Parameters:

const TGPoint & resolution -The resolution to be matched.

Return Value:

Returns the closest match to the resolution that can be found for this device.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TResolution::CreateResolutionRangeIterator

virtual TIteratorOver < TResolutionRange > * CreateResolutionRangeIterator () const

Interface Category:

API.

Purpose:

Creates a resolution range iterator that the client can parse or examine for all the available resolution ranges pertinent to this device.

Calling Context:

Called to create an iterator for all resolutions on this device.

Parameters:

Takes no parameters.

Return Value:

Returns an iterator of resolution ranges.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The created iterator is owned by the client who is then responsible for deleting it.

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