get-shape-fixed-box

Arguments: window-or-screen box draw-fn erase-fn &optional scroll-p cursor

Similar to get-fixed-box, (returns a box of specific size with the user specifying the location with the mouse) except that draw-fn is called each time the shape is to be drawn and erase-fn each time it is to be erased. draw-fn and erase-fn should each be functions (function objects or function names, typically symbols) that accept two arguments: the stream and the current box. When they are called, the stream brush will be set to one pixel-width black, the stream paint operation to po-xor. Thus, drawing the shape twice will suffice.

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

(get-fixed-box s box) is equivalent to (get-shape-fixed-box s box #'draw-box #'draw-box).

If scroll-p is true, the window (identified by window-or-screen) will be scrolled if the cursor moves outside it.

Note that the resulting box may be destructively modified later by the system, so if you want to keep it around, you should make a copy of it with copy-box.

See also nget-shape-fixed-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.