Class: TMoveFrameInteractor

Declaration: FrameInteractors.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TFrameInteractor

Inherited By:

None.

Purpose:

TMoveFrameInteractor provides the protocol for interactively moving a frame.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TMoveFrameInteractor is not normally used to derive other classes.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

This class may not be copied or streamed.

Member Function: TMoveFrameInteractor::TMoveFrameInteractor

TMoveFrameInteractor (MFrameInteractionPolicy *, const TGRect & initialBounds, TPrimitiveFrameView :: ERegion, TView * theView)
TMoveFrameInteractor ()

Interface Category:

API.

Purpose:

Creates a TMoveFrameInteractor with the specified interaction policy, initial size, border and view.
Default constructor.

Calling Context:

Called to a TMoveFrameInteractor with the specified interaction policy, initial size, border and view.
Not used.

Parameters:

MFrameInteractionPolicy * -The interaction policy.
const TGRect & initialBounds -The initial frame size.
TPrimitiveFrameView :: ERegion -Defines where the mouseDown event occurred.
TView * theView -The view associated with this interactor.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMoveFrameInteractor::~TMoveFrameInteractor

virtual ~ TMoveFrameInteractor ()

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: TMoveFrameInteractor::MouseMoved

virtual bool MouseMoved (TMouseMovedEvent &)

Interface Category:

API.

Purpose:

Responds to a mouse-moved event during a frame interaction and determines when to provide interaction feedback. This is an overridden member function.

Calling Context:

Called when the mouse is moved after a mouseDown event. This function is not normally called directly.

Parameters:

TMouseMovedEvent & -The mouse event.

Return Value:

Returns true to indicate the event was handled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMoveFrameInteractor::MouseUp

virtual bool MouseUp (TMouseUpEvent &)

Interface Category:

API.

Purpose:

Responds to a mouse-moved event during a frame interaction and computes the final frame location, based on the initial location and the new mouse position, and moves the frame to that location. Calls EndFrameMove in the interactor's interaction policy object. This is an overridden member function.

Calling Context:

Called when the mouse button is released. This function is not normally called directly.

Parameters:

TMouseUpEvent & -The mouse event.

Return Value:

Returns true to indicate the event was handled.

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.