Class: TBasicFrameView

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPrimitiveFrameView

Inherited By:

TFrameView

Purpose:

A simple view for use with subpresenters. It actually causes the presenter to create a view and this view is placed in the view hierarchy underneath the presenter view. The Basic Frame takes a TRectControlState that is called when the Frame's resize/move controls are manipulated. The default control state just modifies the position of the frame. Any linking feedback is displayed in this view.

Instantiation:

Always allocate on the heap.

Deriving Classes:

Deriving classes typically provide new constructors that specialize the control state.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TBasicFrameView::TBasicFrameView

TBasicFrameView (TGUIPresenter * thePresenterToAdopt)
TBasicFrameView (TGUIPresenter * thePresenterToAdopt, TRectControlState * theControlStateToAdopt)
TBasicFrameView ()
TBasicFrameView (const TBasicFrameView &)

Interface Category:

API.

Purpose:

Creates a new basic frame view for the specified presenter. This constructor adopts the presenter and sets the control state to NIL.
Creates a new basic frame view for the specified presenter with the specified control state. This constructor adopts the presenter and the control state.
Default constructor.
Copy constructor.

Calling Context:

Called from a derived class constructor which will later set the control state.
Called from a derived class constructor.
Called by the stream-in operators.
Called to copy an object.

Parameters:

TGUIPresenter * thePresenterToAdopt -The presenter to adopt.
TGUIPresenter * thePresenterToAdopt -The presenter to adopt.
TRectControlState * theControlStateToAdopt -The control state to adopt.
Takes no parameters.
const TBasicFrameView & -The view to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBasicFrameView::~TBasicFrameView

virtual ~ TBasicFrameView ()

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: TBasicFrameView::AdoptState

void AdoptState (TRectControlState *)

Interface Category:

API.

Purpose:

Allows changing the control state associated with a Basic Frame View. The old control state is deleted.

Calling Context:

Call this function directly.

Parameters:

TRectControlState * -The control state to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBasicFrameView::HandleNotification

virtual void HandleNotification (const TNotification &)

Interface Category:

API.

Purpose:

Internal function used to manage selection feedback on the frame.

Calling Context:

Called by framework.

Parameters:

const TNotification & -The notification to handle.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBasicFrameView::HandleChildActivate

virtual void HandleChildActivate ()

Interface Category:

API.

Purpose:

Internal function overridden to forward activation information to the presenter.

Calling Context:

Called by activation framework.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBasicFrameView::HandleChildDeactivate

virtual void HandleChildDeactivate ()

Interface Category:

API.

Purpose:

Internal function overridden to forward activation information to the presenter.

Calling Context:

Called by activation framework.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBasicFrameView::HandleRequestMoveResizeInParent

virtual void HandleRequestMoveResizeInParent (const TGRect &, bool isLastRequest)

Interface Category:

API.

Purpose:

Internal function used to implement dragging and resizing basic frames.

Calling Context:

Called by frame interactor.

Parameters:

const TGRect & -The new size and position.
bool isLastRequest -true if this is the last request.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBasicFrameView::HandleBeforeDisconnectionFromViewRoot

virtual void HandleBeforeDisconnectionFromViewRoot ()

Interface Category:

API.

Purpose:

Called by the View system when a view is about to be disconnected from a rooted view hierarchy. The connection has not yet taken place, so you can take whatever housekeeping actions you need to before the connection to the view root is severed. All views from the point of connection on down have this function called on them, with parent views getting called before child views.

Calling Context:

Called by the View system before the view is disconnected (directly or indirectly) from the view root.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is useful for anyone using input in views.

Member Function: TBasicFrameView::HandleAfterConnectionToViewRoot

virtual void HandleAfterConnectionToViewRoot ()

Interface Category:

API.

Purpose:

Called by the View system after a view is connected to a rooted view hierarchy. The connection has occurred by the time this function is called. As such, you can get things like the request processor, the direct drawing GrafPort, and the event receiver. All views from the point of connection on down have this function called on them, with parent views getting called before child views.

Calling Context:

Called by the View system after the view is connected (directly or indirectly) to the view root.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is useful for anyone using input in views.

Member Function: TBasicFrameView::GetDefaultActiveChild

virtual TActivatibleView * GetDefaultActiveChild ()

Interface Category:

API.

Purpose:

Returns the child view that should be activated by default.

Calling Context:

Called by the Activation framework.

Parameters:

Takes no parameters.

Return Value:

Returns the child view that should be activated by default.

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.