Description

Occurs when the mouse button is pressed.

Syntax

bforward = BUTTONDOWN (ctrlentID, ctrlclassID, xdown, ydown, xup, yup, ctrlkey, shiftkey, mousebutton)

Parameters

BUTTONDOWN accepts arguments for the following parameters.

ParameterDescription
ctrlentIDHas the format WindowName.ControlName, where WindowName is the identifier of the window that contains the affected control, and ControlName is the identifier of the control. Notice that a period separates the two values.
ctrlclassIDThe type of control that recognizes the event. The window control type is the only valid entry.
xdownThe x coordinate when the mouse button was pressed.
ydownThe y coordinate when the mouse button was pressed.
xupThe x coordinate when the mouse button was last released. A "-1" indicates that the xup value has no meaning.
yupThe previous y coordinate, when the mouse button last went up. A "-1" indicates that the yup value has no meaning.
ctrlkeyA "1" indicates that the control key was pressed when the mouse button was pressed. A "0" indicates that the control key was not pressed.
shiftkeyA "1" indicates that the shift key was pressed when the mouse button was pressed. A "0" indicates that the shift key was not pressed.
mousebuttonA "0" indicates that the left or center mouse button was pressed. A "1" indicates that the right button was pressed.

Returns

True or false. If false, the program execution returns to the calling procedure. If true, the event processing goes to the next level.

See also

BUTTONUP event

  • No labels