ClassesClassesClassesClasses | | | | Operators

get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix (Operator)

Name

get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix — Wait until a mouse button is pressed and get the subpixel mouse position.

Signature

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

Herror get_mbutton_sub_pix(const Hlong WindowHandle, double* Row, double* Column, Hlong* Button)

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

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

double HWindow::GetMbuttonSubPix(HTuple* Column, HTuple* Button) const

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

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

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

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

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

void HWindow.GetMbuttonSubPix(out double row, out double column, out int button)

Description

get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix returns the subpixel 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 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). For text windows the coordinates of the upper left corner are (-0.5,-0.5), while the coordinates of the lower right corner are (window height-0.5,window width-0.5) (see open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow).

If only pixel accurate image coordinates are required, you can use the operator get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton.

Attention

get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix 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 identifier.

RowRowRowRowRowrow (output_control)  point.y HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Row coordinate of the mouse position in the window.

ColumnColumnColumnColumnColumncolumn (output_control)  point.x HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

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_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix returns the value 2 (H_MSG_TRUE).

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow

Alternatives

get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix

See also

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow, open_textwindowopen_textwindowOpenTextwindowopen_textwindowOpenTextwindowOpenTextwindow

Module

Foundation


ClassesClassesClassesClasses | | | | Operators