Class: TRenderingStatus

Declaration: PrintJobStatus.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLowlevelStatus

Inherited By:

TPageLevelStatus

Purpose:

Used in the rendering phase of printing (spooling or despooling). This is typically used by printing graf devices to report their rendering status.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Deriving classes can override HandleRenderingStatusChanged to handle the change in status appropriately.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRenderingStatus::TRenderingStatus

TRenderingStatus ()
TRenderingStatus (const TRenderingStatus &)

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRenderingStatus::~TRenderingStatus

virtual ~ TRenderingStatus ()

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: TRenderingStatus::SetRenderingStatus

virtual void SetRenderingStatus (const TStandardText & status)

Interface Category:

API.

Purpose:

Sets the rendering status. Calls HandleRenderingStatusChanged.

Calling Context:

Call this function directly.

Parameters:

const TStandardText & status -The rendering status value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRenderingStatus::GetRenderingStatus

virtual void GetRenderingStatus (TStandardText & status) const

Interface Category:

API.

Purpose:

Returns the rendering status.

Calling Context:

Call this function directly.

Parameters:

TStandardText & status -The object to fill in the status with.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

Deriving classes must call the inherited function.

Member Function: TRenderingStatus::operator=

TRenderingStatus & operator =(const TRenderingStatus & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TRenderingStatus & -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: TRenderingStatus::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: TRenderingStatus::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: TRenderingStatus::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: TRenderingStatus::HandleRenderingStatusChanged

virtual void HandleRenderingStatusChanged ()

Interface Category:

API.

Purpose:

Does the appropriate thing when the status is changed.

Calling Context:

Called by SetRenderingStatus.

Parameters:

Takes no 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.