Class: TSourceTray

Declaration: Printer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPrinterAttribute

Inherited By:

None.

Purpose:

This class represents the media source tray for a device. It is used by API clients to get the attributes of an input tray of the printing device. The available attributes are: duplex printing choice, tray orientation, and current print media in the tray.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This is an abstract class that provides only getters. Other clients can derive to provide setters.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSourceTray::~TSourceTray

virtual ~ TSourceTray ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSourceTray::operator=

TSourceTray & operator =(const TSourceTray &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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: TSourceTray::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called to generate a hash value.

Parameters:

Return Value:

A long hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSourceTray::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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: TSourceTray::GetDuplexPrintingChoice

virtual TPageDescription::EDuplexOption GetDuplexPrintingChoice () const

Interface Category:

API.

Purpose:

Returns the duplex printing ability of the printer. The value returned represents unknown ability, one-sided ability, or double-sided ability.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the EDuplexOption enumeration value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSourceTray::GetTrayOrientation

virtual ETrayOrientation GetTrayOrientation () const

Interface Category:

API.

Purpose:

Returns the orientation of the source tray.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the ETrayOrientation enumeration value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSourceTray::CreateCurrentMediaInTray

virtual TPrintMedia * CreateCurrentMediaInTray () const

Interface Category:

API.

Purpose:

Returns the current print media in the source tray.

Calling Context:

Called by clients to get the current print media in the source tray.

Parameters:

Return Value:

Returns a pointer to TPrintMedia. Clients must delete it when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSourceTray::TSourceTray

  1. TSourceTray ()
  2. TSourceTray (const TSourceTray &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

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

Parameters:

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.
Copyright©1995 Taligent,Inc. All rights reserved.