Class: TPrintJobStatus

Declaration: PrintJobStatus.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPageLevelStatus

Inherited By:

TPersistentPrintJobStatus

Purpose:

The highest-level API status object. It provides document-level information. TPrintJobStatus also gives the text of the status that is the accumulation of the status for all levels.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Deriving classes can override HandleDocumentNameChanged and HandlePrintJobStateChanged to handle the change in the status appropriately.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TPrintJobStatus::TPrintJobStatus

TPrintJobStatus ()
TPrintJobStatus (const TPrintJobStatus &)

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 TPrintJobStatus & -The object to copy from.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::~TPrintJobStatus

virtual ~ TPrintJobStatus ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::SetDocumentName

virtual void SetDocumentName (const TStandardText & name)

Interface Category:

API.

Purpose:

Sets the name of the document.

Calling Context:

Call this function directly.

Parameters:

const TStandardText & name -The document name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::GetDocumentName

virtual void GetDocumentName (TStandardText & name) const

Interface Category:

API.

Purpose:

Returns the name of the document.

Calling Context:

Call this function directly.

Parameters:

TStandardText & name -The location where the name is returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::SetPrintJobState

virtual void SetPrintJobState (EPrintJobState)

Interface Category:

API.

Purpose:

Sets the state of the print job.

Calling Context:

Call this function directly.

Parameters:

EPrintJobState -One of the states of the print job.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::GetPrintJobState

virtual EPrintJobState GetPrintJobState () const

Interface Category:

API.

Purpose:

Gets the state of the print job.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

One of the states of the print job.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::GetShortStatusText

virtual void GetShortStatusText (TStandardText &) const

Interface Category:

API.

Purpose:

Gets the brief status text.

Calling Context:

Call this function directly.

Parameters:

TStandardText & -The location where the brief status is returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::GetFullStatusText

virtual void GetFullStatusText (TStandardText &) const

Interface Category:

API.

Purpose:

Gets the detailed status text.

Calling Context:

Call this function directly.

Parameters:

TStandardText & -The location where the detailed status is returned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::ClearStatus

virtual void ClearStatus ()

Interface Category:

API.

Purpose:

Clears the current value of the status.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Deriving classes must call the inherited function.

Member Function: TPrintJobStatus::operator=

TPrintJobStatus & operator =(const TPrintJobStatus & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPrintJobStatus & -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:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::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:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::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:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::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:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::ComposeFullStatusText

virtual void ComposeFullStatusText ()

Interface Category:

API.

Purpose:

Composes the status text from the status of various stages.

Calling Context:

Called by GetFullStatusText.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::HandleDocumentNameChanged

virtual void HandleDocumentNameChanged ()

Interface Category:

API.

Purpose:

Does the appropriate thing when the document name is changed.

Calling Context:

Called by SetDocumentName.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPrintJobStatus::HandlePrintJobStateChanged

virtual void HandlePrintJobStateChanged ()

Interface Category:

API.

Purpose:

Does the appropriate thing when the state of the job changes.

Calling Context:

Called by SetPrintJobState.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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