Queries the scroll parameters of a horizontal or vertical scroll bar.
capi
get-horizontal-scroll-parameters self &rest keys => parameter*
get-vertical-scroll-parameters self &rest keys => parameter*
self⇩ |
A displayed output-pane or layout. |
keys⇩ |
Keywords as below. |
parameter* |
The parameters are returned as multiple values, one for each key passed in keys and in the same order as the arguments. |
The functions get-horizontal-scroll-parameters
and get-vertical-scroll-parameters
retrieve 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.
: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. |
For the other pane classes, such as list-panel, the underlying widget determines what the scroll range and units are.
See the following CAPI example files:
(example-edit-file "capi/output-panes/scrolling-without-bar")
(example-edit-file "capi/output-panes/fixed-origin-scrolling")
(example-edit-file "capi/output-panes/coordinate-origin-fixed")
get-scroll-position
scroll
set-horizontal-scroll-parameters
set-vertical-scroll-parameters
simple-pane
12.4 output-pane scrolling
CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42