Class: TPageLevelStatus

Declaration: PrintJobStatus.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRenderingStatus

Inherited By:

TPrintJobStatus

Purpose:

Reports the status at the page level. It provides information about the current page being processed and possibly an indication of how long will it take to finish printing.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Deriving classes can override HandleCurrentPageNumberChanged, HandleNumberOfPagesChanged, and HandleProgressChanged to handle the change in status appropriately.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPageLevelStatus::TPageLevelStatus

TPageLevelStatus ()
TPageLevelStatus (const TPageLevelStatus &)

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 TPageLevelStatus & -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: TPageLevelStatus::~TPageLevelStatus

virtual ~ TPageLevelStatus ()

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: TPageLevelStatus::SetCurrentPageNumber

virtual void SetCurrentPageNumber (unsigned long)

Interface Category:

API.

Purpose:

Sets the current page number.

Calling Context:

Call this function directly.

Parameters:

unsigned long -The current page number.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::GetCurrentPageNumber

virtual bool GetCurrentPageNumber (unsigned long &) const

Interface Category:

API.

Purpose:

Gets the current page number being printed.

Calling Context:

Call this function directly.

Parameters:

unsigned long & -The current page number.

Return Value:

Returns true if the current page number is known.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::GetNumberOfPages

virtual bool GetNumberOfPages (unsigned long &) const

Interface Category:

API.

Purpose:

Returns the number of pages in this print job.

Calling Context:

Call this function directly.

Parameters:

unsigned long & -The location where the total number of pages is returned.

Return Value:

Returns true if the total number of pages is known.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::SetNumberOfPages

virtual void SetNumberOfPages (unsigned long)

Interface Category:

API.

Purpose:

Sets the total number of pages in the job.

Calling Context:

Call this function directly.

Parameters:

unsigned long -The total number of pages.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::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: TPageLevelStatus::operator=

TPageLevelStatus & operator =(const TPageLevelStatus & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPageLevelStatus & -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: TPageLevelStatus::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: TPageLevelStatus::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: TPageLevelStatus::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: TPageLevelStatus::HandleCurrentPageNumberChanged

virtual void HandleCurrentPageNumberChanged ()

Interface Category:

API.

Purpose:

Does the appropriate thing when the current page number is changed.

Calling Context:

Called by SetCurrentPageNumber.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::HandleNumberOfPagesChanged

virtual void HandleNumberOfPagesChanged ()

Interface Category:

API.

Purpose:

Does the appropriate thing when the total number of pages is changed.

Calling Context:

Called by SetNumberOf pages.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::HandleProgressChanged

virtual void HandleProgressChanged ()

Interface Category:

API.

Purpose:

Does the appropriate thing when the progress indicator is changed.

Calling Context:

Called by SetProgress.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::GetProgress

virtual Progress GetProgress () const

Interface Category:

API.

Purpose:

Provides page level status for user reporting.

Calling Context:

Called to get progress of page level status.

Parameters:

Takes no parameters.

Return Value:

Returns a value signifying progress.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageLevelStatus::SetProgress

virtual void SetProgress (Progress value)

Interface Category:

API.

Purpose:

Used by Printer Handler to report status to clients.

Calling Context:

Called to set a change in status at the page level.

Parameters:

Progress value -Sets the progress to this value.

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.