with-mouse-confined

Arguments: (window &optional box) &body body

Confines the mouse-cursor to the region of window specified by box while the body of the macro is executed. When you use this macro, you are guaranteed that the cursor will be freed even if an error occurs in body. Note that confining the mouse is considered by some to be an unfriendly technique (because it prevents using other Windows programs).

The window argument denotes the window within which to confine the mouse cursor. The box argument denotes a region with respect to the exterior of window, and will default to the exterior region of window. Therefore, not passing the box argument will confine the mouse to within the exterior edge of window.

The box argument, if supplied, may be modified by this macro. If you wish to reuse box, copy it before passing it to this macro.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.