MOUSE POSITION
MOUSE POSITION ( mouseX : Real ; mouseY : Real ; mouseButton : Integer {; *} )
| Parameter | Type | Description | |
|---|---|---|---|
| mouseX | Real | ← | Horizontal coordinate of mouse |
| mouseY | Real | ← | Vertical coordinate of mouse |
| mouseButton | Integer | ← | Mouse button state: 0 = Button up 1 = Button down 2 = Right button down 3 = Both buttons down |
| * | Operator | → | If specified, global coordinate system is usedIf omitted, local coordinate system is used |
Description
The MOUSE POSITION command returns the current state of the mouse.
The horizontal and vertical coordinates are returned in mouseX and mouseY. If you pass the * parameter, the coordinates are expressed relative to the main screen (macOS and Windows SDI mode) or to the application window (Windows MDI mode). If you omit the * parameter, they are expressed relative to the current form window (if any) of the current process.
The parameter mouseButton returns the state of the buttons, as listed previously.
Note: The values 2 and 3 can be returned under macOS starting with version 10.2.5 only.
Example
See the example for the Pop up menu command.
See also
Caps lock down
Macintosh command down
Macintosh control down
Macintosh option down
ON EVENT CALL
Shift down
Windows Alt down
Windows Ctrl down
Properties
| Command number | 468 |
| Thread safe | no |