Class: TDeviceJobDescription

Declaration: PrintJobDescription.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

To a developer who provides printers or creates a printer handler for the printing system, TDeviceJobDescription provides a point of control or access to print job actions at print time. This class is the printer handler developer's portion of a print job description. It allows clients to specify print time options that are printer specific. It is normally provided by the creator of TPrinter and printer handler for the printer. Note that a printer handler developer and an application developer are considered to be separate developers. The application developer controls a print job through a TClientJobDescription and a printer handler developer controls a print job through a TDeviceJobDescription. This class provides means to specify printer specific actions to occur at print time.

Instantiation:

Abstract class; do not instantiate. Its derived class must be allocated on the heap because it is adopted by the TPrintJobDescription constructor.

Deriving Classes:

Clients are not required to override this class since a standard default and behavior is provided automatically for you by a TPrinter object. If you are a printer handler developer you may derive from this class to add to or alter default behavior of a printer handler at print time. It may then be supplied to the constructor of TPrintJobDescription when a print job is created prior to submitting a print job to the printing system. If clients choose to derive from TDeviceJobDescription, all pure virtual functions must be overridden. CreateDocumentFinishing creates a TDocumentFinishing derived class to specify document finishing behavior on the printer. This printer attribute may be named. CreateSourceTray returns a caller owned TSourceTray derived class that specifies which source tray to use on the printer for obtaining printing media for the job. CreateDestinationBin returns a caller owned TDestinationBin object which specifies in which output bin to place the printed job. CreateResolution produces a resolution specification to be used on the printer. CreatePrintMedia specifies which media to use on the printer if media options are provided. All of these choices are necessarily printer dependent. To this may be added any other control specifications clients wish to make at print time.

Concurrency:

Not multithread safe.

Resource Use:

Instances of this class and its derived classes must be allocated on a heap.

Member Function: TDeviceJobDescription::~TDeviceJobDescription

virtual ~ TDeviceJobDescription ()

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: TDeviceJobDescription::CreateDocumentFinishing

virtual TDocumentFinishing * CreateDocumentFinishing () const

Interface Category:

API.

Purpose:

Returns the document finishing required for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a pointer to the TDocumentFinishing object. Client must delete it when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeviceJobDescription::CreateSourceTray

virtual TSourceTray * CreateSourceTray () const

Interface Category:

API.

Purpose:

Returns the source tray required for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a pointer to the TSourceTray object. Clients must delete it when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeviceJobDescription::CreateDestinationBin

virtual TDestinationBin * CreateDestinationBin () const

Interface Category:

API.

Purpose:

Returns the destination bin required for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a pointer to the TDestinationBin object. Clients must delete it when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeviceJobDescription::CreateResolution

virtual TResolution * CreateResolution () const

Interface Category:

API.

Purpose:

Returns the resolution required for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a pointer to the TResolution object. Clients must delete it when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeviceJobDescription::CreatePrintMedia

virtual TPrintMedia * CreatePrintMedia () const

Interface Category:

API.

Purpose:

Returns the print media required for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeviceJobDescription::operator=

TDeviceJobDescription & operator =(const TDeviceJobDescription &)

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: TDeviceJobDescription::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: TDeviceJobDescription::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: TDeviceJobDescription::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: TDeviceJobDescription::TDeviceJobDescription

  1. TDeviceJobDescription (const TDeviceJobDescription &)
  2. TDeviceJobDescription ()

Interface Category:

API.

Purpose:

  1. Copy constructor.
  2. Default constructor.

Calling Context:

  1. Called to copy an object.
  2. Called by the stream-in operators and the derived class default constructor.

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.