BUTTONDOWN event [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== BUTTONDOWN event ======


 
==== 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.

^Parameter^Description^
|//ctrlentID//|Has 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.|
|//ctrlclassID//|The type of control that recognizes the event. The window control type is the only valid entry.|
|//xdown//|The x coordinate when the mouse button was pressed.|
|//ydown//|The y coordinate when the mouse button was pressed.|
|//xup//|The x coordinate when the mouse button was last released. A "-1" indicates that the //xup// value has no meaning.|
|//yup//|The previous y coordinate, when the mouse button last went up. A "-1" indicates that the //yup// value has no meaning.|
|//ctrlkey//|A "1" indicates that the control key was pressed when the mouse button was pressed. A "0" indicates that the control key was not pressed.|
|//shiftkey//|A "1" indicates that the shift key was pressed when the mouse button was pressed. A "0" indicates that the shift key was not pressed.|
|//mousebutton//|A "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|BUTTONUP event]]