Class: TMouseMovedEvent

Declaration: MouseInput.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMouseEvent

Inherited By:

None.

Purpose:

Derives from TMouseEvent, this class represents a mouse changing position.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class will rarely be derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMouseMovedEvent::TMouseMovedEvent

TMouseMovedEvent (const TGPoint & position, TMouseInputDevice * device, TStandardEventReceiver * receiver)
TMouseMovedEvent (const TMouseMovedEvent & copy)

Interface Category:

API.

Purpose:

Creates a mouse-moved event from the specified position, device and receiver.
Copy constructor.

Calling Context:

Called to create an event.
Called to copy an object.

Parameters:

const TGPoint & position -The mouse position for the new event.
TMouseInputDevice * device -The input device for the new event.
TStandardEventReceiver * receiver -The receiver of mouse events.
const TMouseMovedEvent & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMouseMovedEvent::~TMouseMovedEvent

virtual ~ TMouseMovedEvent ()

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: TMouseMovedEvent::operator=

TMouseMovedEvent & operator =(const TMouseMovedEvent & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TMouseMovedEvent & assign -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: TMouseMovedEvent::DispatchToMouseEventHandler

virtual bool DispatchToMouseEventHandler (MMouseEventHandler & target)

Interface Category:

API.

Purpose:

Sends this event to the specified handler.

Calling Context:

Derived classes can call this function directly.

Parameters:

MMouseEventHandler & target. -The handler to which to send the event.

Return Value:

Returns true if successfully handled by target; false otherwise.

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.