Class: TClientJobDescription

Declaration: PrintJobDescription.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TGenericClientJobDescription

Purpose:

TClientJobDescription defines a class interface where clients can modify, enhance, or otherwise affect a print job submitted to the printing system. It provides the clients access to a print job description, TPrintJobDescription. It allows clients to specify any attribute or option for a print job by providing control to the client at print time. 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.

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. If clients wish to add to or alter default behavior they may provide a derived class using the prescribed interface of this class and supply it 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 TClientJobDescription, all pure virtual functions must be overridden. GetJobName returns a TText object specifying the name to be used for this job which is used to identify this job in user interface appearances. GetCopies returns the number of copies to print of this job. GetCoverPage returns the specified banner page requirements of the client. GetEndPage provides for a similar banner page at the end of the job. CopyPageRange creates and returns a derived class of TPageRange which specifies which pages of the job are actually to be printed. GetPageMismatchChoice specifies what to do when a page to be printed and the page on the printer do not match. 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 the heap because they are adopted by TPrintJobDescription.

Member Function: TClientJobDescription::TClientJobDescription

TClientJobDescription (const TClientJobDescription &)
TClientJobDescription ()

Interface Category:

API.

Purpose:

Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

const TClientJobDescription & -The object to copy from.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::~TClientJobDescription

virtual ~ TClientJobDescription ()

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: TClientJobDescription::GetCopies

virtual unsigned long GetCopies () const

Interface Category:

API.

Purpose:

Returns the number of copies to be printed for this print job.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an unsigned long representing the number of copies.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::GetCoverPage

virtual EBannerPage GetCoverPage () const

Interface Category:

API.

Purpose:

Returns the cover page choice for this print job.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns one of the possible EBannerPage enumerations.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::GetEndPage

virtual EBannerPage GetEndPage () const

Interface Category:

API.

Purpose:

Returns the end page choice for this print job.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns one of the possible EBannerPage enumerations.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::CopyPageRange

virtual TPageRange * CopyPageRange () const

Interface Category:

API.

Purpose:

Returns the page range for this print job.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to a TPageRange derived class. Clients must delete this pointer when done.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::GetPageMismatchChoice

virtual TPageDescription::EPageMismatchOption GetPageMismatchChoice() const

Interface Category:

API.

Purpose:

Returns the page mismatch choice for this print job. The page mismatch choice specifies what you want to do when the page sizes do not match between the document and the printer. These options are defined in PageDescription.h (kPrintTiled, kPrintClipped, kPrintScaled, kNonUniformScale, kNoPrint).

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns one of the EPageMismatchOption values.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::operator=

TClientJobDescription & operator =(const TClientJobDescription &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TClientJobDescription & -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: TClientJobDescription::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: TClientJobDescription::IsEqual

virtual bool IsEqual (const MCollectible * right) const

Interface Category:

API.

Purpose:

Compares two objects for equality.

Calling Context:

Called to compare compatible objects.

Parameters:

const MCollectible * -The MCollectible to compare to.

Return Value:

Returns true if the objects match.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TClientJobDescription::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: TClientJobDescription::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: TClientJobDescription::GetJobName

virtual const TText * GetJobName () const

Interface Category:

API.

Purpose:

This retrieves the name of the job as set by the client document.

Calling Context:

Called to retrieve the name of this job as named by the client document.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the name of the job which cannot be modified or deleted.

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.