Class: TGenericClientJobDescription

Declaration: PrintJobDescription.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TClientJobDescription

Inherited By:

None.

Purpose:

This is a concrete derived class of TClientJobDescription that provides reasonable defaults for print time options. It also allows its state to be altered quite readily for custom jobs.

Instantiation:

Always allocate on the heap.

Deriving Classes:

Clients should not derive from this class. Clients who wish to provide job description behavior should derive from TClientJobDescription. If absolutely necessary, clients may derive from this class and override any of its virtual functions. The derived class can then be safely supplied as a parameter to TPrintJobDescription.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGenericClientJobDescription::TGenericClientJobDescription

  1. TGenericClientJobDescription ()
  2. TGenericClientJobDescription (const TGenericClientJobDescription &)

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.

Member Function: TGenericClientJobDescription::~TGenericClientJobDescription

virtual ~ TGenericClientJobDescription ()

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

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: TGenericClientJobDescription::GetCoverPage

virtual TClientJobDescription::EBannerPage GetCoverPage () const

Interface Category:

API.

Purpose:

Returns the cover page choice for this print job.

Calling Context:

Call this function directly.

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: TGenericClientJobDescription::GetEndPage

virtual TClientJobDescription::EBannerPage GetEndPage () const

Interface Category:

API.

Purpose:

Returns the end page choice for this print job.

Calling Context:

Call this function directly.

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: TGenericClientJobDescription::CopyPageRange

virtual TPageRange * CopyPageRange () const

Interface Category:

API.

Purpose:

Returns the page range for this print job.

Calling Context:

Call this function directly.

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

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: TGenericClientJobDescription::SetCopies

virtual void SetCopies (unsigned long numberCopies)

Interface Category:

API.

Purpose:

Sets the number of copies for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGenericClientJobDescription::SetCoverPage

virtual void SetCoverPage (TClientJobDescription :: EBannerPage coverPage)

Interface Category:

API.

Purpose:

Sets the cover page option for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGenericClientJobDescription::SetEndPage

virtual void SetEndPage (TClientJobDescription :: EBannerPage endPage)

Interface Category:

API.

Purpose:

Sets the end page option for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGenericClientJobDescription::AdoptPageRange

virtual void AdoptPageRange (TPageRange * adoptRange)

Interface Category:

API.

Purpose:

Sets the page range for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGenericClientJobDescription::SetPageMismatchChoice

virtual void SetPageMismatchChoice (TPageDescription :: EPageMismatchOption choice)

Interface Category:

API.

Purpose:

Sets the page mismatch choice for this print job.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGenericClientJobDescription::operator=

TGenericClientJobDescription & operator =(const TGenericClientJobDescription &)

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: TGenericClientJobDescription::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: TGenericClientJobDescription::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: TGenericClientJobDescription::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: TGenericClientJobDescription::SetJobName

virtual void SetJobName (const TText & jobName)

Interface Category:

API.

Purpose:

A print job is named by the Document Framework or other clients who create print jobs. This function is used to set the name.

Calling Context:

Called to set the name of the job by the client who created this object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGenericClientJobDescription::GetJobName

virtual const TText * GetJobName () const

Interface Category:

API.

Purpose:

This function is used to retrieve the name of the print job as set by the job creator.

Calling Context:

Called to obtain the name of the job.

Parameters:

Return Value:

Returns a pointer to the name of the job which must not be altered or deleted. If a client calls SetJobName after this value is retrieved (which shouldn't happen under normal circumstances), this value becomes invalid and should be refreshed by calling GetJobName again.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The name of the job must not be altered or deleted. If a client calls SetJobName after this function returns its information (which shouldn't happen under normal circumstances), its return value becomes invalid and should be refreshed by calling GetJobName again.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.