Class: TGUIComponentStationeryFor

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TDocumentComponentStationery

Inherited By:

None.

Purpose:

This template takes a model class and a presenter state class as its arguments. The AModel class must have a public empty constructor (i.e. the AModel constructor will be called by CreateModel). The presenter state class must have a public empty constructor (i.e. the APresenterState constructor will be called by CreatePresenterState).

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class; rather, derive from the basic TCompoundDocumentStationery instead.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

This class has no dependencies on the rest of the presentation framework, and should be moved down into the document framework.

Member Function: TGUIComponentStationeryFor::TGUIComponentStationeryFor

  1. TGUIComponentStationeryFor ()
  2. TGUIComponentStationeryFor (const TGUIComponentStationeryFor < AModel, APresenterState >&)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Creates a component stationery object for the model and presenter state specified.

Calling Context:

  1. Called by the stream-in operators.
  2. Called by the Presentation framework.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIComponentStationeryFor::~TGUIComponentStationeryFor

virtual ~ TGUIComponentStationeryFor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIComponentStationeryFor::CreateComponent

  1. TDocumentComponent * CreateComponent ()
  2. TDocumentComponent * CreateComponent (AModel * theModelTemplateToAdopt, APresenterState * thePSTemplateToAdopt)

Interface Category:

API.

Purpose:

  1. Creates a document component appropriate for this object's model and view.
  2. Creates a document component appropriate for this object's model and view.

Calling Context:

  1. Called by the Presentation framework.
  2. Called by the Presentation framework.

Parameters:

Return Value:

Returns the new document component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIComponentStationeryFor::CreateModelPresenterState

virtual TModelPresenterState * CreateModelPresenterState ()

Interface Category:

API.

Purpose:

Creates a TModelPresenterState appropriate for this object's presenter.

Calling Context:

You can call this function directly.

Parameters:

Return Value:

Returns the new model presenter state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIComponentStationeryFor::CreateModel

virtual TModel * CreateModel ()

Interface Category:

API.

Purpose:

Creates the root model for documents created from this stationery.

Calling Context:

Called by TDocumentComponentStationery.

Parameters:

Return Value:

Returns the root model.

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.
Copyright©1995 Taligent,Inc. All rights reserved.