FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Unrevised from 8.2 to 9.0.
8.2 version

get-screen-box

Arguments: &key prompt title no-dialog no-draw

Waits for the user to specify two corner positions on the screen, and returns a box made from those positions. To allow the specification of any screen positions without affecting whatever windows are at those positions (as might happen with a mouse click), the user must specify each position by placing the mouse cursor at the desired position and then pressing the control key.

If no-dialog is nil then a modal dialog first appears to explain the specification procedure to the user; if no-dialog is true then the dialog is skipped. If prompt is nil, then a general explanation appears in the dialog; otherwise prompt should be a similar string that may be customized to the particular application. title is either a string to serve as the title of the modal dialog or nil (the default) for no title.

If no-draw is nil (the default), then a rubber-banding box is drawn during the time between the two presses of the control key to indicate the region that is being selected. If no-draw is true, then this box is not drawn. Drawing the box could leave screen droppings if the area being copied is being updated as the user is specifying the box.

The return value is a box (see the box class) unless the user presses the Escape key to cancel the interactive specification of the box, in which case nil is returned.


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

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 9.0
Unrevised from 8.2 to 9.0.
8.2 version