Class: TFrameEmbedderDragInteractor

Declaration: FrameTools.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInteractor, MMouseEventHandler

Inherited By:

None.

Purpose:

TFrameEmbedderDragInteractor derives from TInteractor and MMouseEventHandler and implements an interactor appropriate for dragging out embedded frames.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Should not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFrameEmbedderDragInteractor::TFrameEmbedderDragInteractor

TFrameEmbedderDragInteractor (MFrameToolSupporter * theView, TEmbedderModel * theAdoptedModel, TViewHandle aViewHandle)
TFrameEmbedderDragInteractor (const TFrameEmbedderDragInteractor &)
TFrameEmbedderDragInteractor ()

Interface Category:

API.

Purpose:

Creates an interactor to drag out an embedded frame in the specified view, to embed the specified model.
Copy constructor.
Default constructor.

Calling Context:

Called from TFrameCreationToolFor::CreateInteractor.
Called to copy an object.
Called by the stream-in operators.

Parameters:

MFrameToolSupporter * theView -The destination view.
TEmbedderModel * theAdoptedModel -The model to embed.
TViewHandle aViewHandle -The view of the model to embed.
const TFrameEmbedderDragInteractor & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::~TFrameEmbedderDragInteractor

virtual ~ TFrameEmbedderDragInteractor ()

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: TFrameEmbedderDragInteractor::SetFirstLocation

virtual void SetFirstLocation (const TGPoint & theLocation)

Interface Category:

API.

Purpose:

Sets the initial location of the drag operation.

Calling Context:

Called from MouseDown.

Parameters:

const TGPoint & theLocation -The initial location.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::SetLastLocation

virtual void SetLastLocation (const TGPoint & theLocation)

Interface Category:

API.

Purpose:

Sets the final location of the drag operation.

Calling Context:

Called from MouseUp.

Parameters:

const TGPoint & theLocation -The final location.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::GetFirstLocation

virtual TGPoint GetFirstLocation () const

Interface Category:

API.

Purpose:

Returns the first location of the drag interaction.

Calling Context:

Called from MouseUp.

Parameters:

Takes no parameters.

Return Value:

Returns the first location of the drag interaction.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::GetLastLocation

virtual TGPoint GetLastLocation () const

Interface Category:

API.

Purpose:

Returns the final location of the drag interaction.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the final location of the drag interaction.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::GetEmbedderModel

virtual TEmbedderModel * GetEmbedderModel () const

Interface Category:

API.

Purpose:

Returns the embedder model provided at construction time.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the embedder model provided at construction time.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::MouseDown

virtual bool MouseDown (TMouseDownEvent & mouseDown)

Interface Category:

API.

Purpose:

Processes a mouse-down event that occurs in the object for which this object is an interactor.

Calling Context:

Called from the Input Framework.

Parameters:

TMouseDownEvent & mouseDown -The mouse-down event.

Return Value:

Returns true if this function handled the event, or false if the event should be passed on to another object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::MouseUp

virtual bool MouseUp (TMouseUpEvent & mouseDown)

Interface Category:

API.

Purpose:

Processes a mouse-up event that follows a mouse-down event in the object for which this object is an interactor.

Calling Context:

Called from the Input Framework.

Parameters:

TMouseUpEvent & mouseDown-The mouse-up event.

Return Value:

Returns true if this function handled the event, or false if the event should be passed on to another object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::MouseMoved

virtual bool MouseMoved (TMouseMovedEvent & mouseDown)

Interface Category:

API.

Purpose:

Processes a mouse-moved event that follows a mouse-down event in the object for which this object is an interactor.

Calling Context:

Called from the Input Framework.

Parameters:

TMouseMovedEvent & mouseDown-The mouse-moved event.

Return Value:

Returns true if this function handled the event, or false if the event should be passed on to another object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameEmbedderDragInteractor::operator=

TFrameEmbedderDragInteractor & operator =(const TFrameEmbedderDragInteractor &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TFrameEmbedderDragInteractor & -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.

Member Function: TFrameEmbedderDragInteractor::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -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.

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