Class: TAbstractDocumentStationery

Declaration: BasicDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TCompoundDocumentStationery TDocumentStationery

Purpose:

The TDocumentStationery family of classes provides for easy creation of documents. The stationery classes have a CreateDocument member function that creates a new document and returns a reference to it.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Any stationery class that produces basic documents. Derived classes must override CreateDocument, to create the persistent instance of a document.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TAbstractDocumentStationery::~TAbstractDocumentStationery

virtual ~ TAbstractDocumentStationery ()

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: TAbstractDocumentStationery::CreateDocument

virtual TDocumentReference CreateDocument ( const TMultiBinStorageMechanism & theStoreMechanism ) =0 ;

Interface Category:

API.

Purpose:

Creates an instance of a document on disk from the stationery and returns a reference to the document.

Calling Context:

Call this function directly.

Parameters:

const const TMultiBinStorageMechanism & theStoreMechanism -The storage mechanism for the document created.

Return Value:

Returns a reference to the document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is a pure virtual function and must be overridden by classes deriving from TAbstractDocumentStationery.

Member Function: TAbstractDocumentStationery::TAbstractDocumentStationery

TAbstractDocumentStationery ()
TAbstractDocumentStationery ( const TAbstractDocumentStationery& );

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called only by derived classes.

Parameters:

Takes no parameters.
const TAbstractDocumentStationery & -The stationery to copy.

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.