Generic Function

Summary

The generic function scroll moves the scrollbar and calls the scroll-callback .

Signature

scroll self scroll-dimension scroll-operation scroll-value
&rest options

Description

scroll moves the scrollbar of a scrollable pane according to scroll-dimension , scroll-operation and scroll-value . It then calls the scroll-callback (see output-pane) with these arguments and options :

scroll-dimension

:vertical or :horizontal, or :pan , meaning both dimensions.

scroll-operation

:move , :drag , :step or :page .

scroll-value

An integer, or a list of two integers if scroll-dimension is :pan .

options

Arbitrary user data.

Compatibility Note

scroll supersedes set-scroll-position , which is deprecated and no longer exported. The call

(capi:scroll pane :pan :move (list x y))

is equivalent to

(capi:set-scroll-position pane x y)

See also

output-pane
set-horizontal-scroll-parameters
set-vertical-scroll-parameters