get_mbutton (Operator)

Name

get_mbutton — Wait until a mouse button is pressed.

Synopsis

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

Description

get_mbutton returns the pixel accurate image 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. For graphics windows the coordinates Row and Column are expressed with consideration of the current image part (see set_part). For text windows the coordinates of the upper left corner are (0,0), while the coordinates of the lower right corner are (window height-1,window width-1) (see open_textwindow).

If subpixel accurate image coordinates are required, you can use the operator get_mbutton_sub_pix.

Attention

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

Parameters

WindowHandle (input_control)	window → (integer)
Window identifier.

Row (output_control)	point.y → (integer)
Row coordinate of the mouse position in the window.

Column (output_control)	point.x → (integer)
Column coordinate of the mouse position in the window.

Button (output_control)	integer → (integer)
Mouse button(s) pressed.

Result

get_mbutton returns the value 2 (H_MSG_TRUE).

Parallelization Information

get_mbutton is reentrant, local, and processed without parallelization.

Possible Predecessors

open_window, open_textwindow

Alternatives

get_mposition, get_mbutton_sub_pix, get_mposition_sub_pix

See also

open_window, open_textwindow

Module

Foundation