HbPushButton() > Methods

oHbPushButton:hitTest()

Tests if a push button is hit by the mouse cursor.

Syntax

:hitTest( <nMouseRow>, <nMouseCol> ) --> nHitCode

Arguments

<nMouseRow>

This is the numeric row position of the mouse cursor. It can be queried using function MRow().

<nMouseCol>

This is the numeric column position of the mouse cursor. It can be queried using function MCol().

Description

Method :hitTest() accepts the numeric row and column position of the mouse cursor and returns a numeric value indicating whether or not the mouse cursor is located within the HbPushButton object. #define constants are available in the BUTTON.CH file identifying the return value of :hitTest().

Return values of oHbPushButton:hitTest()

Constant	Value	Description
HTNOWHERE	0	Mouse cursor is outside the push button
HTTOPLEFT	-1	Mouse cursor is on the top left corner of the push button
HTTOP	-2	Mouse cursor is on the top border of the push button
HTTOPRIGHT	-3	Mouse cursor is on the top right corner of the push button
HTRIGHT	-4	Mouse cursor is on the right border of the push button
HTBOTTOMRIGHT	-5	Mouse cursor is on the bottom right corner of the push button
HTBOTTOM	-6	Mouse cursor is on the bottom border of the push button
HTBOTTOMLEFT	-7	Mouse cursor is on the bottom left corner of the push button
HTLEFT	-8	Mouse cursor is on left border of the push button
HTCLIENT	-2049	Mouse cursor is on the push button