Class: TGUIPresenterState

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TModelPresenterState

Inherited By:

TTextPresenterState TGUIPresenterStateFor

Purpose:

A presenter state that defines the protocol for creating a document component presenter. This class is the base class for the TGUIPresenterStateFor<APresenter> template.

Instantiation:

Abstract base class. Derived classes are usually allocated on the heap.

Deriving Classes:

Deriving classes must override the pure virtual function HandleCreatePresenter to create a presenter.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIPresenterState::LookupForWriting

static TGUIPresenterState * LookupForWriting (const TPresenterStateReference &)

Interface Category:

API.

Purpose:

Type-safe way of looking up the TGUIPresenterState that corresponds to a particular presenter state reference.

Calling Context:

Call this function directly.

Parameters:

const TPresenterStateReference & -A reference to the desired presenter state.

Return Value:

Returns a pointer to the desired TGUIPresenterState.

Exceptions:

Throws TCompoundDocumentException::kPresenterStateDoesNotExist if the argument isn't a reference to a TGUIPresenterState. Passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIPresenterState::LookupForReading

static const TGUIPresenterState * LookupForReading (const TPresenterStateReference &)

Interface Category:

API.

Purpose:

Type-safe way of looking up the TGUIPresenterState that corresponds to a particular presenter state reference.

Calling Context:

Call this function directly.

Parameters:

const TPresenterStateReference & -A reference to the desired presenter state.

Return Value:

Returns a pointer to the desired TGUIPresenterState.

Exceptions:

Throws TCompoundDocumentException::kPresenterStateDoesNotExist if the argument isn't a reference to a TGUIPresenterState. Passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIPresenterState::~TGUIPresenterState

~ TGUIPresenterState ()

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: TGUIPresenterState::CreatePresenter

TGUIPresenter * CreatePresenter (const TGUIBundle & theParentBundle, bool isRoot) const

Interface Category:

API.

Purpose:

Creates a presenter using the specified bundle. isRoot is used to tell whether or not the presenter is going to be a root presenter (e.g. in its own window) or a child presenter (e.g. in a frame). The UI is different for these two cases. For example, the root presenter might have scroll bars, while the child presenter would not.

Calling Context:

Call this function directly.

Parameters:

const TGUIBundle & theParentBundle -The GUIBundle from the parent.
bool isRoot -true if the presenter is a root presenter.

Return Value:

Returns the new presenter. The caller owns the storage.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIPresenterState::CreateDocumentPresenter

virtual TDocumentPresenter * CreateDocumentPresenter (const TPlaceReference &) const

Interface Category:

API.

Purpose:

Creates and returns a new TDocumentPresenter.

Calling Context:

Called by the Compound Document framework during document open.

Parameters:

const TPlaceReference & -The place to use.

Return Value:

Returns the new document presenter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

TGUIPresenterState (const TModelReference &)
TGUIPresenterState (const TGUIPresenterState &)
TGUIPresenterState ()

Interface Category:

API.

Purpose:

Creates a presenter state associated with a particular model.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Called to copy an object.
Called by the stream-in operators and stationery.

Parameters:

const TModelReference & -The model to be a presenter state for.
const TGUIPresenterState & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

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

Member Function: TGUIPresenterState::operator=

TGUIPresenterState & operator =(const TGUIPresenterState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TGUIPresenterState & -object to copy.

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:

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

Member Function: TGUIPresenterState::FixupDataReferences

void FixupDataReferences (TGUIBundle & tmp) const

Interface Category:

API.

Purpose:

Inserts the TGUIPresenterState's model and presenter state references into the specified GUI bundle.

Calling Context:

Called by TGUIPresenterState as part of creating a bundle for a new presentation.

Parameters:

TGUIBundle & tmp -The bundle to fix up.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIPresenterState::HandleCreatePresenter

virtual TGUIPresenter * HandleCreatePresenter (const TGUIBundle & theParBdl) const

Interface Category:

API.

Purpose:

Creates and returns a new TGUIPresenter of the correct class. This is the function derived classes override to specify which TGUIPresenter should be created.

Calling Context:

Called by TGUIPresenterState::CreatePresenter.

Parameters:

const TGUIBundle & theParBdl -The bundle to copy.

Return Value:

Returns the new GUI presenter.

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.