ClassesClassesClassesClasses | | | | Operators

get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton (Operator)

Name

get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton — Wait until a mouse button is pressed.

Signature

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

Herror get_mbutton(const Hlong WindowHandle, Hlong* Row, Hlong* Column, Hlong* Button)

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

Herror get_mbutton(const HTuple& WindowHandle, Hlong* Row, Hlong* Column, Hlong* Button)

Hlong HWindow::GetMbutton(HTuple* Column, HTuple* Button) const

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

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

void HOperatorSetX.GetMbutton(
[in] VARIANT WindowHandle, [out] VARIANT* Row, [out] VARIANT* Column, [out] VARIANT* Button)

Hlong HWindowX.GetMbutton(
[out] Hlong* Column, [out] Hlong* Button)

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_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton 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 ButtonButtonButtonButtonButtonbutton.

The operator waits until a mouse button is pressed in the output 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_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix.

Attention

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

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window HWindow, HTupleHTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Window handle.

RowRowRowRowRowrow (output_control)  point.y HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Row coordinate of the mouse position in the window.

ColumnColumnColumnColumnColumncolumn (output_control)  point.x HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Column coordinate of the mouse position in the window.

ButtonButtonButtonButtonButtonbutton (output_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Mouse button(s) pressed.

Result

get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton returns the value 2 (H_MSG_TRUE).

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow

Alternatives

get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix

See also

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow

Module

Foundation


ClassesClassesClassesClasses | | | | Operators