scroll-range

Generic Function

Package: common-graphics

Arguments: stream

Returns two values indicating the width and height of the scrollable page of the window denoted by stream. The values exclude the area that is visible within the window (i.e. the visible-box-width and the visible-box-height). So a window that has exactly nothing scrolled out of view would have a scroll-range of zero, zero.

An application may override the default method of this and several other generic functions in order to implement a custom scrolling scheme that scrolls by logical picture objects rather than by pixels. See the source code of the Navigator example entitled 'Scrolling by arbitrary objects rather than pixels' for a complete example." More on this point and a list of the relevant generic functions can be found on the horizontal-scroll-bar and vertical-scroll-bar pages.

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.