get_mbuttonget_mbuttonGetMbuttonGetMbutton (Operator)

Name

get_mbuttonget_mbuttonGetMbuttonGetMbutton — Wait until a mouse button is pressed.

Signature

Description

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton returns the pixel accurate image coordinates of the mouse pointer in the output window and the mouse button pressed. In addition the state of the modifier keys is returned. The following values are assigned to the individual buttons and keys:

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 ButtonButtonButtonButtonbutton.

The operator waits until a mouse button is pressed in the output window. For graphics windows the coordinates RowRowRowRowrow and ColumnColumnColumnColumncolumn are expressed with consideration of the current image part (see set_partset_partSetPartSetPartSetPart).

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

Attention

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton only returns if a mouse button is pressed in the window.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton returns the value 2 (H_MSG_TRUE).

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Alternatives

get_mpositionget_mpositionGetMpositionGetMpositionGetMposition, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixGetMbuttonSubPix, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixGetMpositionSubPix

See also

open_windowopen_windowOpenWindowOpenWindowOpenWindow

Module

Foundation