xHarbour Reference Documentation > Function Reference

TBMouse()

Moves the browse cursor to the mouse pointer.

Syntax

TBMouse( <oTBrowse>, <nMouseRow>, <nMouseCol> ) --> nHandled

Arguments

<oTBrowse>

This parameter must be a TBrowse() object.

<nMouseRow>

A numeric value between 0 and MaxRow() specifying the row position of the mouse cursor. It can be queried using MRow().

<nMouseCol>

A numeric value between 0 and MaxCol() specifying the columnn position of the mouse cursor. It can be queried using MCol().

Return

The function returns 0 when the browse cursor was successfully moved to the screen coordinates passed for the mouse pointer. Otherwise, the return value is 1.

Description

TBMouse() is a utiliy function for implementing "mouse awareness" for TBrowse objects. When the mouse pointer is located within the data area of a TBrowse object, the function calls navigation methods of the object until the browse cursor is located underneath the screen coordinates specified with <nMouseRow> and <nMouseCol>.

A call to TBMouse() is standard behavior for TBrowse():applyKey().

Info

See also:	MCol(), MRow(), TBrowse()
Category:	Mouse functions , xHarbour extensions
Source:	rtl\tbrowse.prg
LIB:	xhb.lib
DLL:	xhbdll.dll