Class: TGUIPresenterStateFor

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TGUIPresenterState

Inherited By:

None.

Purpose:

This is a convenience template. It overrides HandleCreatePresenter to return a new presenter of type APresenter.

Instantiation:

Allocate on the heap or the stack. Usually allocated on the heap.

Deriving Classes:

Probably simpler to derive from the base class TGUIPresenterState.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIPresenterStateFor::TGUIPresenterStateFor

TGUIPresenterStateFor ()
TGUIPresenterStateFor (const TGUIPresenterStateFor < APresenter > &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and stationery.
Called to copy the presenter state.

Parameters:

Takes no parameters.
const TGUIPresenterStateFor < APresenter > & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIPresenterStateFor::~TGUIPresenterStateFor

virtual ~ TGUIPresenterStateFor ()

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: TGUIPresenterStateFor::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -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: TGUIPresenterStateFor::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TGUIPresenterStateFor::HandleCreatePresenter

virtual TGUIPresenter * HandleCreatePresenter (const TGUIBundle & theParBdl) const

Interface Category:

API.

Purpose:

Creates and returns a new presenter of type APresenter.

Calling Context:

Call this function directly.

Parameters:

const TGUIBundle & theParBdl -The bundle to copy.

Return Value:

Returns a new presenter of type APresenter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIPresenterStateFor::operator=

TGUIPresenterStateFor < APresenter > & operator =(const TGUIPresenterStateFor < APresenter > & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const const TGUIPresenterStateFor < APresenter > & copy -The object to be copied.

Return Value:

Returns a const reference to the left-hand side object.

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.