Class: TDocumentPrinter

Declaration: BasicDocumentPrinter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

TDocumentPrinter is a utility class to print a document from within a specified place to a specified printer. Ultimately it will also provide the ability to cancel, pause, and resume printing, and so on. The document to be printed does not need to be open or running. It will be started automatically if necessary.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentPrinter::TDocumentPrinter

TDocumentPrinter (const TDocumentReference &, const TPlaceReference &, const TPrinter &)
TDocumentPrinter (const TDocumentPrinter &)
TDocumentPrinter ()

Interface Category:

API.

Purpose:

Creates a new TDocumentPrinter object to print the specified document from within the specified place to the specified printer.
Copy constructor.
Default constructor.

Calling Context:

You can call this function directly.
Called to copy an object.
Called by the stream-in operators.

Parameters:

const TDocumentReference & -The document to print.
const TPlaceReference & -The place from which to print the document.
const TPrinter & -The printer to which to print the document. This object is adopted by the new TDocumentPrinter object.
const TDocumentPrinter & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentPrinter::~TDocumentPrinter

~ TDocumentPrinter ()

Interface Category:

API.

Purpose:

Destructor. This function deletes the printer provided to the document printer at construction time.

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: TDocumentPrinter::PrintDocument

virtual void PrintDocument () const

Interface Category:

API.

Purpose:

Prints the document.

Calling Context:

You can 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:

None.

Member Function: TDocumentPrinter::operator=

TDocumentPrinter & operator =(const TDocumentPrinter &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TDocumentPrinter & -The object to be copied.

Return Value:

Returns a 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: TDocumentPrinter::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 to which the object streams itself out.

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: TDocumentPrinter::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 from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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