ClassesClassesClassesClasses | | | | Operators

get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix (Operator)

Name

get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix — Query the subpixel mouse position.

Signature

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

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

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

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

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

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

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

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

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

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

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

Description

get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPix returns the subpixel 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.

For graphics windows the coordinates RowRowRowRowRowrow and ColumnColumnColumnColumnColumncolumn are expressed with consideration of the current image part (see set_partset_partSetPartset_partSetPartSetPart).

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

Attention

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

Parallelization

Parameters

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

Window handle.

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 or 0.

Result

If the mouse pointer is not located within the window, 5 (H_MSG_FAIL) is returned.

Possible Predecessors

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow

Alternatives

get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPix

See also

open_windowopen_windowOpenWindowopen_windowOpenWindowOpenWindow

Module

Foundation


ClassesClassesClassesClasses | | | | Operators