All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

set-horizontal-scroll-parameters

set-vertical-scroll-parameters Functions

Summary

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

Package

capi

Signatures

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

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

Arguments
self
A displayed output-pane or layout.
min-range, max-range, slug-position, slug-size, page-size, step-size
Reals or nil.
Description

The functions set-horizontal-scroll-parameters and set-vertical-scroll-parameters set the specified parameters of the horizontal or vertical scroll bar of self.

self should be a displayed instance of a subclass of output-pane (such as editor-pane) or layout and have a scroll bar.

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.

When one of these keyword arguments is not supplied, the value of the corresponding scroll parameter in self is not modified.

See 7.4.2 Scroll values and initialization keywords for a description of these scroll parameters.

Examples
(example-edit-file "capi/output-panes/fixed-origin-scrolling")
(example-edit-file "capi/output-panes/scrolling-without-bar")
(example-edit-file "capi/output-panes/coordinate-origin-fixed")
See also

scroll
get-horizontal-scroll-parameters
get-vertical-scroll-parameters
simple-pane
7 Programming with CAPI Windows
12.4 output-pane scrolling
7.4.2 Scroll values and initialization keywords


CAPI User Guide and Reference Manual (Macintosh version) - 01 Dec 2021 19:31:27