Class: TPlaceEnvironment

Declaration: BasicPlaces.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

The TPlaceEnvironment family of classes provides the means to open place associated document presentations.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Derive from this class to provide a concrete implementation of a place environment. Derived classes must override the pure virtual functions: OpenDocument, and CreatePresenterSessionStore.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPlaceEnvironment::~TPlaceEnvironment

~ TPlaceEnvironment ()

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: TPlaceEnvironment::CopyPlaceEnvironmentFor

static TPlaceEnvironment * CopyPlaceEnvironmentFor (const TPlaceReference &)

Interface Category:

API.

Purpose:

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

Calling Context:

You can call this function directly.

Parameters:

const TPlaceReference & -The place whose environment to copy.

Return Value:

Returns the copy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlaceEnvironment::OpenDocument

virtual void OpenDocument (const TDocumentReference &, TDocumentStore :: ESharingMode =TDocumentStore :: kNonShared) const

Interface Category:

API.

Purpose:

Open the specified document in this place in the specified sharing mode.

Calling Context:

You can call this function directly.

Parameters:

const TDocumentReference & -The document to open.
TDocumentStore :: ESharingMode =TDocumentStore :: kNonShared -The sharing mode in which to open the document.

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

Member Function: TPlaceEnvironment::CreatePresenterSessionStore

virtual TPresenterSessionStore * CreatePresenterSessionStore (const TDocumentReference &) const

Interface Category:

API.

Purpose:

Creates a presenter session store for the specified document.

Calling Context:

You can call this function directly.

Parameters:

const TDocumentReference & -The document for which to create the presenter session store.

Return Value:

Returns the new presenter session store.

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

Member Function: TPlaceEnvironment::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: TPlaceEnvironment::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: TPlaceEnvironment::TPlaceEnvironment

TPlaceEnvironment ()
TPlaceEnvironment (const TPlaceEnvironment &)

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

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