Generic Function

Summary

Queries the scroll parameters of a vertical scroll bar.

Package

capi

Signature

get-vertical-scroll-parameters self &rest keys => parameter, parameter,...

Arguments

self

A displayed output-pane or layout.

keys

Keywords as below.

Values

parameter

The parameters are returned as multiple values, one for each key passed in keys and in the same order as the arguments.

Description

The function get-vertical-scroll-parameters retrieves 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 valid keys 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.

Note: For the other pane classes, such as list-panel, the underlying widget decides what the scroll range and units are.

Example

See the following CAPI example files:

output-panes/scroll-test.lisp

output-panes/scrolling-without-bar.lisp

See also

get-scroll-position
scroll
get-horizontal-scroll-parameters
simple-pane