get-box

Arguments: window-or-screen &optional scroll-p cursor first-corner

Waits for the user to press a mouse button down, then waits for the mouse button to be released, and then returns a box that has two corners at the mouse cursor positions of the button press and the button release. Between the button press and the button release, a rubber-band box is drawn between the button press position and the current mouse cursor position.

window-or-screen should be a window or the screen. The screen is the value returned by (screen *system*). See screen and *system*.

If first-corner is true, it will be used for the button-down position rather than waiting for a button-down. In this case, either a button press or release will mark the second corner.

If scroll-p is true, the window identified by window-or-screen will be scrolled if the cursor moves outside it. Sets the stream cursor to cursor while running. If the cursor argument is t, a stream default is used (typically the cross-hair cursor).

You may wish to call wait-for-mouse-buttons-up prior to calling get-box to ensure that mouse button releases associated with other actions do not interfere with getting the desired box.

See also get-screen-box and nget-box.

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.