get_mbuttonT_get_mbuttonGetMbuttonGetMbutton (Operator)

Name

get_mbuttonT_get_mbuttonGetMbuttonGetMbutton — Wait until a mouse button is pressed.

Signature

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

Herror T_get_mbutton(const Htuple WindowHandle, Htuple* Row, Htuple* Column, Htuple* Button)

void GetMbutton(const HTuple& WindowHandle, HTuple* Row, HTuple* Column, HTuple* Button)

void HWindow::GetMbutton(Hlong* Row, Hlong* Column, Hlong* Button) const

static void HOperatorSet.GetMbutton(HTuple windowHandle, out HTuple row, out HTuple column, out HTuple button)

void HWindow.GetMbutton(out int row, out int column, out int button)

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

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RowRowRowRowrow (output_control)  point.y HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row coordinate of the mouse cursor in the image coordinate system.

ColumnColumnColumnColumncolumn (output_control)  point.x HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column coordinate of the mouse cursor in the image coordinate system.

ButtonButtonButtonButtonbutton (output_control)  integer HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Mouse button(s) pressed.

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