Class: TDocumentComponentStationery

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TMediaStationery TGUIComponentStationeryFor TGUIDefaultModelStationery TGUIModelPresenterStationeryFor TGUIModelViewStationeryFor

Purpose:

A partial implementation of a stationery that creates a document component from a model and presenter state. Derived classes must override CreateModel and CreatePresenterState to provide the model and presenter state for the component.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Derive from this class to create custom component stationery. Derived classes must override the pure virtual functions: CreateModel, and CreatePresenterState.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentComponentStationery::~TDocumentComponentStationery

virtual ~ TDocumentComponentStationery ()

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: TDocumentComponentStationery::CreateComponent

virtual TDocumentComponent * CreateComponent ()

Interface Category:

API.

Purpose:

Creates a TDocumentComponent from this object's model and model presenter.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the new document component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStationery::TDocumentComponentStationery

TDocumentComponentStationery ()
TDocumentComponentStationery (const TDocumentComponentStationery &)

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TDocumentComponentStationery is an abstract base class--all the constructors are protected. Do not instantiate this class.

Member Function: TDocumentComponentStationery::CreateModel

virtual TModel * CreateModel ()

Interface Category:

API.

Purpose:

Creates a model for the document type represented by this stationery object. Derived classes override this function to create the appropriate model.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the newly created model.

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 TDocumentComponentStationery.

Member Function: TDocumentComponentStationery::CreateModelPresenterState

virtual TModelPresenterState * CreateModelPresenterState ()

Interface Category:

API.

Purpose:

Creates a model presenter state for the document type represented by this stationery object. Derived classes override this function to create the appropriate model presenter state.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the newly created model presenter state.

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 TDocumentComponentStationery.

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