get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition (Operator)

Name

get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition — Query the mouse position.

Signature

get_mposition( : : WindowHandle : Row, Column, Button)

get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition returns the pixel accurate image coordinates of the mouse pointer in the output window and the mouse button pressed. These values are returned regardless of the state of the mouse buttons (pressed or not pressed). If at least one mouse button is pressed, the state of the modfier keys is returned as well. If no mouse button is pressed, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition returns 0 in ButtonButtonButtonButtonButtonbutton, even if a modifier key is pressed. The following values are assigned to the individual buttons and keys:

0:: No button,
1:: Left button,
2:: Middle button,
4:: Right button,
8:: Shift key,
16:: Ctrl key,
32:: Alt key.

The sum of the values for all pressed buttons/keys is returned in ButtonButtonButtonButtonButtonbutton.

The origin of the coordinate system is located in the left upper corner of the window. For graphics windows the coordinates RowRowRowRowRowrow and ColumnColumnColumnColumnColumncolumn are expressed with consideration of the current image part (see set_partset_partSetPartset_partSetPartSetPart).

If subpixel accurate image coordinates are required, you can use the operator get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix.

Attention

get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition fails (returns FAIL) if the mouse pointer is not located within the window. In this case, no values are returned.