Contents Up Previous Next

Mouse event

A mouse event identifier is passed to the canvas OnEvent callback. The state of the mouse buttons (and some keys) can be examined by calling the following functions.

mouse-event-button
mouse-event-button-down
mouse-event-control-down
mouse-event-dragging
mouse-event-left-down
mouse-event-left-up
mouse-event-is-button
mouse-event-middle-down
mouse-event-middle-up
mouse-event-position-x
mouse-event-position-y
mouse-event-right-down
mouse-event-right-up
mouse-event-shift-down


mouse-event-button

long ( mouse-event-button long event-id long button)

Returns 1 if the given button is changing state. button may be 1, 2 or 3 (left, middle and right buttons respectively).


mouse-event-button-down

long ( mouse-event-button-down long event-id)

Returns 1 if the event is a mouse button down event.


mouse-event-control-down

long ( mouse-event-control-down long event-id)

Returns 1 if the control key is down.


mouse-event-dragging

long ( mouse-event-dragging long event-id)

Returns 1 if the event is a dragging event (holding a mouse button down and moving).


mouse-event-left-down

long ( mouse-event-left-down long event-id)

Returns 1 if the left mouse button is down.


mouse-event-left-up

long ( mouse-event-left-up long event-id)

Returns 1 if the left mouse button is up.


mouse-event-is-button

long ( mouse-event-is-button long event-id)

Returns 1 if the event is a button press or release.


mouse-event-middle-down

long ( mouse-event-middle-down long event-id)

Returns 1 if the middle mouse button is down.


mouse-event-middle-up

long ( mouse-event-middle-up long event-id)

Returns 1 if the middle mouse button is up.


mouse-event-position-x

double ( mouse-event-position-x long event-id)

Returns the mouse x-position.


mouse-event-position-y

double ( mouse-event-position-y long event-id)

Returns the mouse y-position.


mouse-event-right-down

long ( mouse-event-right-down long event-id)

Returns 1 if the right mouse button is down.


mouse-event-right-up

long ( mouse-event-right-up long event-id)

Returns 1 if the right mouse button is up.


mouse-event-shift-down

long ( mouse-event-shift-down long event-id)

Returns 1 if the shift key is down.