Herror ::get_mbutton (
    const HTuple &WindowHandle,
    long *Row,
    long *Column,
    long *Button
)
HTuple HWindow::GetMbutton (
    HTuple *Column,
    HTuple *Button
) const

Wait until a mouse button is pressed.

::get_mbutton returns the coordinates of the mouse pointer in the output window and the mouse button pressed (Button):

                  Button = 1: Left button,
                           2: Middle button,
                           4: Right button.
The operator waits until a button is pressed in the output window. If more than one button is pressed, the sum of the individual buttons' values is returned. The origin of the coordinate system is located in the left upper corner of the window. The row coordinates increase towards the bottom, while the column coordinates increase towards the right. For graphics windows, the coordinates of the lower right corner are (image height-1,image width-1) (see ::open_window, ::reset_obj_db), while for text windows they are (window height-1,window width-1) (see ::open_textwindow).


Attention

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


Parameters

WindowHandle (input_control)
window -> HTuple.long
Window identifier.

Row (output_control)
point.y -> long *
Row coordinate of the mouse position in the window.

Column (output_control)
point.x -> long *
Column coordinate of the mouse position in the window.

Button (output_control)
integer -> long *
Mouse button(s) pressed.


Result

::get_mbutton returns the value H_MSG_TRUE.


Possible Predecessors

::open_window, ::open_textwindow


Alternatives

::get_mposition


See also

::open_window, ::open_textwindow


Module

System



Copyright © 1996-2002 MVTec Software GmbH