LOCATE_MOUSE

    Returns information on the window position of the pointer at the time
    the built-in is invoked.  Optionally returns a status integer
    indicating whether the pointer was found in a window.

 Syntax

    [integer3 := ] LOCATE_MOUSE (window, integer1, integer2)

 Parameters

    window               A parameter to which LOCATE_MOUSE returns the
                         window in which the pointer is located.  If the
                         pointer is not found, the built-in assigns the
                         type UNSPECIFIED to this parameter.

    integer1             A parameter to which LOCATE_MOUSE returns the
                         window-relative column position of the pointer.
                         If the pointer is not found, the built-in assigns
                         the type UNSPECIFIED to this parameter.

    integer2             A parameter to which LOCATE_MOUSE returns the
                         window-relative row position of the pointer.  You
                         can specify the status line using integer2.  If
                         the pointer is not found, the built-in assigns the
                         type UNSPECIFIED to this parameter.

    ingeter3             If you specify a return variable, LOCATE_MOUSE
                         returns 1 if the pointer was found, 0 otherwise.

 Comments

    This built-in can only be used in programs, procedures, or learn
    sequences bound to mouse keys.

 Example

    The following statement assigns to the parameter 'window_1' the window
    in which the pointer for the current mouse key is located.  The
    statement assigns to the parameter 'window_column' the column where the
    pointer is located.  the pointer.  The statement assigns to the
    parameter 'window_row' the row where the pointer is located.

    LOCATE_MOUSE (window_1, window_column, window_row);

 Related Topics

    POSITION