Generic Function

Summary

Allows programmatic control of the parameters of a vertical scroll bar.

Package

capi

Signature

set-vertical-scroll-parameters self &key min-range
max-range slug-position
slug-size page-size step-size

Description

The function set-vertical-scroll-parameters sets the specified parameters of the vertical scroll bar of self , which should be a displayed instance of a subclass of output-pane (such as editor-pane) or layout.

The other arguments are:

min-range

The minimum data coordinate.

max-range

The maximum data coordinate.

slug-position

The current scroll position.

slug-size

The length of the scroll bar slug.

page-size

The scroll page size.

step-size

The scroll step size.

Compatibility note

The function set-vertical-scroll-parameters supersedes the function set-scroll-range , which is deprecated and no longer exported.

The call

(set-vertical-scroll-parameters pane 

                                :min-range 0

                                :max-range 42)

is equivalent to

(set-scroll-range pane nil 42)

Example

See the following CAPI example files:

examples/capi/output-panes/scroll-test.lisp

examples/capi/output-panes/scrolling-without-bar.lisp

See also

scroll
set-horizontal-scroll-parameters
simple-pane