Event XbpCrt():leave Foundation

Mouse moved out of the Crt object.

:leave := {| uNIL1, uNIL2, self | ... }
:leave() --> self
xbeM_Leave (1048582)

This method returns the object executing the method (self).


The xbeM_Leave event is generated when the mouse pointer is moved out of the display rectangle of an XbpCrt object. Together with its counterpart xbeM_Enter, xbeM_Leave can be used to detect when the mouse is positioned over the object. This can be used to give visual feedback as to which control would be activated if the mouse was clicked at a certain position.

In order to receive the xbeM_Leave notification, an XbpCrt object must be configured to track mouse pointer movement. This is done automatically when a code block is assigned to the :leave callback slot. If xbeM_Leave is to be processed via the callback method :enter(), the method must be overloaded in a derived class. Furthermore, :setTrackPointer() must be called explicitly. This may be done in the :create() method of the derived class.

The xbeM_Leave event is sent synchronously via the :handleEvent() method of a Crt object. This means that xbeM_Leave is not retrieved by the AppEvent() function. As it is generated while the user moves the mouse, we strongly discourage to perform lengthy operations while processing the event.

In order to receive the xbeM_Leave notification, mouse notifications must be enabled using SetMouse(.T.).


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.