Class: TMouseUpEvent

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 button being released. This class is now multibutton aware and returns the button which caused the event. Mouse button numbering is one-based and starts with 1, not 0.

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: TMouseUpEvent::TMouseUpEvent

TMouseUpEvent (short clickCount, const TGPoint & position, TMouseInputDevice * device, TStandardEventReceiver * receiver, short button =1);
TMouseUpEvent (const TMouseUpEvent & copy)

Interface Category:

API.

Purpose:

Creates a mouse-up event from the specified position, device, and receiver. The constructor is aware of the multibutton mouse. The mouse button number defaults to 1. Mouse button numbering is one-based and starts with 1, not 0.
Copy constructor.

Calling Context:

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

Parameters:

short clickCount -The number of clicks with which to initialize the new event.
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.
short button =1 -Sets the mouse button number to 1. Mouse button numbering is one-based and starts with 1, not 0.
const TMouseUpEvent & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TMouseUpEvent is not streamable.

Member Function: TMouseUpEvent::~TMouseUpEvent

virtual ~ TMouseUpEvent ()

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

TMouseUpEvent & operator =(const TMouseUpEvent & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TMouseUpEvent & 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: TMouseUpEvent::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 this 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.

Member Function: TMouseUpEvent::GetClickCount

short GetClickCount () const

Interface Category:

API.

Purpose:

Returns the number of mouse-up events that occurred within GetMultiClickTime time or less; that is, within the current grouping of mouse clicks.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an integer value that indicates the number of mouse-up events that occurred.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

See TMouseDownEvent::GetClickCount() for more information.

Member Function: TMouseUpEvent::GetButtonNumber

short GetButtonNumber() const;

Interface Category:

API.

Purpose:

Returns the mouse button number that caused the button-up event. Mouse button numbering starts with 1, not 0.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the mouse button number that caused the button-up event.

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.