Class: TGUIDocumentPresenter

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDocumentPresenter

Inherited By:

None.

Purpose:

The TDocumentPresenter family of classes support managing the presentation of the entire document. The document presenter must create a window, open up the presenter session store, create the window group, and talk to the place. The Document Presenter is generally not derived from by client developers. TGUIDocumentPresenter creates the main window and the initial presentation bundle.

Instantiation:

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

Deriving Classes:

Generally not derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::TGUIDocumentPresenter

TGUIDocumentPresenter (const TDocumentReference &, const TPlaceReference &)

Interface Category:

API.

Purpose:

Creates a new TGUIDocumentPresenter for the specified document reference at the specified place.

Calling Context:

Call this function directly.

Parameters:

const TDocumentReference & -The document for which the new object is a presenter.
const TPlaceReference & -The place at which to create the new presenter.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::~TGUIDocumentPresenter

virtual ~ TGUIDocumentPresenter ()

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: TGUIDocumentPresenter::HandleOpen

virtual void HandleOpen ()

Interface Category:

API.

Purpose:

Opens the presenter on its document.

Calling Context:

Derived classes can call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandleClose

virtual void HandleClose ()

Interface Category:

API.

Purpose:

Closes the presenter.

Calling Context:

Derived classes can call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandleCreateMainWindow

virtual TStandardWindow * HandleCreateMainWindow (const TDocumentReference & theDocRef)

Interface Category:

API.

Purpose:

Creates the presenter's main window for the specified document reference.

Calling Context:

Called by HandleOpen and derived classes.

Parameters:

const TDocumentReference & theDocRef -The document for which to create the main window.

Return Value:

Returns the new window.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandleCreateBundle

virtual TGUIBundle * HandleCreateBundle (const TPlaceReference &, const TDocumentReference &, const TDocumentPresenterReference &, const TPresenterReference &, TWindowGroup * theWindowGroupToAlias, TPresenterSessionStore * theStoreToAlias, TGUIMessageLog * theLogToAlias, TGUIWindowArranger * theWindowArrangerToAlias, TMenu * theMenuToAlias)

Interface Category:

API.

Purpose:

Create a new bundle for this presenter's main window.

Calling Context:

Called by HandleOpen, HandlePrint and derived classes.

Parameters:

const TPlaceReference & -The place reference for the new bundle.
const TDocumentReference & -A reference to the document for which this object is a presenter.
const TDocumentPresenterReference & -A reference to this document presenter.
const TPresenterReference & -A reference to the presenter state.
TWindowGroup * theWindowGroupToAlias -The window group to alias.
TPresenterSessionStore * theStoreToAlias -The store to alias.
TGUIMessageLog * theLogToAlias -The message log to alias.
TGUIWindowArranger * theWindowArrangerToAlias -The window arranger to alias.
TMenu * theMenuToAlias -The presentation's main menu.

Return Value:

Returns the new bundle.

Exceptions:

Throws TDocumentException::kDocumentNotFound if the document referred to by the specified document reference cannot be found.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandleCreateInitialSelection

virtual TDocumentComponentSelection * HandleCreateInitialSelection (const TPlaceReference &, const TDocumentReference &, const TDocumentPresenterReference &, const TPresenterReference &, TWindowGroup * theWindowGroupToAlias, TPresenterSessionStore * theStoreToAlias, TGUIMessageLog * theLogToAlias)

Interface Category:

API.

Purpose:

Creates the initial selection in the document component.

Calling Context:

Called from HandleCreateBundle and derived classes.

Parameters:

const TPlaceReference & -The place for the initial selection.
const TDocumentReference & -A reference to the document for which this object is a presenter.
const TDocumentPresenterReference & -A reference to this object.
const TPresenterReference & -A reference to the presenter state.
TWindowGroup * theWindowGroupToAlias -The window group to alias.
TPresenterSessionStore * theStoreToAlias -The store to alias.
TGUIMessageLog * theLogToAlias -The log to alias.

Return Value:

Returns the new selection.

Exceptions:

Throws TDocumentException::kDocumentNotFound if the document referred to by the specified document reference cannot be found

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandleCreateStatePresenter

virtual TGUIPresenter * HandleCreateStatePresenter (const TDocumentReference & theDocRef, const TGUIBundle &)

Interface Category:

API.

Purpose:

Creates a new state presenter for the specified document reference and bundle.

Calling Context:

Called by HandleOpen, HandlePrint and derived classes.

Parameters:

const TDocumentReference & theDocRef -A reference to the document for which this object is a presenter.
const TGUIBundle & -The bundle for the new state presenter.

Return Value:

Returns the new state presenter.

Exceptions:

Throws TDocumentException::kDocumentNotFound if the document referred to by the specified document reference cannot be found Throws TDocumentException:: kDocumentOpenFailed if the document referred to by the document reference could not be opened.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandleCreateRootFrame

virtual TBasicFrameView * HandleCreateRootFrame (TGUIPresenter *)

Interface Category:

API.

Purpose:

Creates a root frame for this presenter.

Calling Context:

Called by HandleOpen and derived classes.

Parameters:

TGUIPresenter * -The state presenter created by HandleCreateStatePresenter.

Return Value:

Returns the new root frame.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::GetGUIBundle

TGUIBundle * GetGUIBundle ()
const TGUIBundle * GetGUIBundle () const

Interface Category:

API.

Purpose:

Returns this presenter's current GUI bundle.
Returns a const pointer to this presenter's current GUI bundle.

Calling Context:

Derived classes can call this function directly.
Derived classes can call this function directly.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the current GUI bundle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::HandlePrint

virtual void HandlePrint (const TPrinter &)

Interface Category:

API.

Purpose:

Prints the document for which this object is a presenter.

Calling Context:

Derived classes can call this function directly.

Parameters:

const TPrinter & -The printer to which to print the document.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::SetShowLinks

virtual void SetShowLinks (bool isShowingLink =true)

Interface Category:

API.

Purpose:

Sets whether or not links are displayed in the presenter.

Calling Context:

Call this function directly.

Parameters:

bool isShowingLink =true -The flag indicating whether or not to turn on show links.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::GetShowLinks

virtual bool GetShowLinks () const

Interface Category:

API.

Purpose:

Returns whether or not links are displayed in the presenter.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if links are currently displayed in the presenter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIDocumentPresenter::CreateShowLinkChangedInterest

static TInterest CreateShowLinkChangedInterest ()

Interface Category:

API.

Purpose:

Creates an interest object used to register interest in, and notify clients of the event when the user changes the show links option.

Calling Context:

Called from SetShowLinks, or 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:

None.

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