nget-box

Generic Function

Package: common-graphics

Arguments: stream old-box &optional scroll-p cursor first-corner

A destructive version of get-boxget-box. The old-box argument is modified to be the box chosen by the user and returned. Like get-box, this function waits for the user to press a mouse button down and then waits for the mouse button to be released. Old-box is then modified to be the box that has two corners at the mouse cursor positions of the button press and the button release. Old-box is then returned. 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.

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 stream 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).

Note: incompatible change in release 6.0: in releases prior to 6.0, when a frame-with-single-child instance was passed to this operator, the operator was actually applied to the child (the result of applying frame-child to the frame-with-single-child instance). In release 6.0, this redirection no longer occurs. If you intend this operator to apply to the frame-child, pass that to this operator rather than the parent. This is a non-backward-compatible-change. See the release notes for more information.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Copyright (c) 1998-2000, Franz Inc. Berkeley, CA., USA. All rights reserved.

Created 2000.10.5.