Function

Summary

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

Package

capi

Signature

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

Arguments

self

A simple-pane.

min-range , max-range , slug-position , slug-size , page-size , step-size

Reals or nil.

Description

The function set-horizontal-scroll-parameters sets the specified parameters of the horizontal 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.

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

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

Compatibility note

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

The call

(set-horizontal-scroll-parameters pane 

                                  :min-range 0

                                  :max-range 42)

is equivalent to

(set-scroll-range pane 42 nil)

Example

(example-edit-file "capi/output-panes/fixed-origin-scrolling") (example-edit-file "capi/output-panes/scroll-test") (example-edit-file "capi/output-panes/scrolling-without-bar")

See also

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