Class: TPlacePresentationRegistry

Declaration: BasicPlaces.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

The TPlacePresentationRegistry family of classes provides the means by which document presentations can communicate state changes with the user environment in which they live.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Derive from this class to provide a concrete implementation of a place registry. Derived classes must override the pure virtual functions: RegisterDocumentPresentationOpened, RegisterDocumentPresentationClosed, CreateDocumentOpenedInterest, and CreateDocumentClosedInterest.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPlacePresentationRegistry::~TPlacePresentationRegistry

~ TPlacePresentationRegistry ()

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: TPlacePresentationRegistry::CopyPresentationRegistryFor

static TPlacePresentationRegistry * CopyPresentationRegistryFor (const TPlaceReference &)

Interface Category:

API.

Purpose:

Creates and returns a copy of the specified place's presentation registry.

Calling Context:

You can call this function directly.

Parameters:

const TPlaceReference & -The place whose presentation registry to copy.

Return Value:

Returns the copy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlacePresentationRegistry::RegisterDocumentPresentationOpened

virtual void RegisterDocumentPresentationOpened (const TDocumentPresenterReference &)

Interface Category:

API.

Purpose:

Registers interest in the event of the specified document presenter being opened.

Calling Context:

You can call this function directly.

Parameters:

const TDocumentPresenterReference & -The document presenter in which this object is registering interest.

Return Value:

None.

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

Member Function: TPlacePresentationRegistry::RegisterDocumentPresentationClosed

virtual void RegisterDocumentPresentationClosed (const TDocumentPresenterReference &)

Interface Category:

API.

Purpose:

Registers interest in the event of the specified document presenter being closed.

Calling Context:

You can call this function directly.

Parameters:

const TDocumentPresenterReference & -The document presenter in which this object is registering interest.

Return Value:

None.

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

Member Function: TPlacePresentationRegistry::CreateDocumentOpenedInterest

virtual TInterest * CreateDocumentOpenedInterest () const

Interface Category:

API.

Purpose:

Creates and returns an interest object which is used to register interest in the event of a document being opened.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the new interest object.

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

Member Function: TPlacePresentationRegistry::CreateDocumentClosedInterest

virtual TInterest * CreateDocumentClosedInterest () const

Interface Category:

API.

Purpose:

Creates and returns an interest object which is used to register interest in the event of a document being closed.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the new interest object.

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

Member Function: TPlacePresentationRegistry::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: TPlacePresentationRegistry::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.

Member Function: TPlacePresentationRegistry::TPlacePresentationRegistry

TPlacePresentationRegistry ()
TPlacePresentationRegistry (const TPlaceReference &)

Interface Category:

API.

Purpose:

Default constructor.
Create a polymorphic registry object for registering presentation events for the specified place.

Calling Context:

Called by the stream-in operators.
Derived class constructors can call this function directly.

Parameters:

Takes no parameters.
const TPlaceReference & -The place for which the new registry object will register presentation events.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

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

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