simple-pane-show-scroll-bars Function

Summary

Sets the visibility of the scroll bars of the pane.

Package

capi

Signature

simple-pane-show-scroll-bars pane &key horizontal vertical => success-p, horizontal-visible-p, vertical-visible-p

Arguments

pane⇩	A simple-pane.
horizontal⇩, vertical⇩
	Booleans.

Values

success-p⇩, horizontal-visible-p⇩, vertical-visible-p⇩
	Booleans.

Description

The function simple-pane-show-scroll-bars can be used to set or query the visibility of the scroll-bars of pane.

horizontal and vertical specify the visibility of the horizontal and vertical scroll bars respectively. If either of them is not supplied, the visibility of the corresponding scroll bar does not change.

simple-pane-show-scroll-bars works only if pane was created with scrolling and has been displayed. In all other cases, it does nothing and all three return values are nil. To make scroll bars invisible when the pane first appears, use simple-pane-show-scroll-bars in the interface-display method of the enclosing interface.

The first return value, success-p, indicates whether the call was successful, that is meeting the conditions in the previous paragraph. For a successful call, horizontal-visible-p and vertical-visible-p indicate whether the respective scroll bar is visible after the call to simple-pane-show-scroll-bars.

Notes

On Microsoft Windows, there are some situations where the scroll bars may become visible again after being hidden for panes that are not of type output-pane, for example when using the arrow keys to change the selected item in a list-panel. In addition, for such panes that have both scroll bars, you cannot hide both scroll bars.

See also

simple-pane