retain-scrollbars

Arguments: window

Returns whether window will continue displaying each of its scrollbars when there is nothing for it to scroll. The value may be set either by calling (setf retain-scrollbars) or by passing the :retain-scrollbars initarg to make-window when creating the window.

The default value is nil, meaning that scrollbars will go away when they can. You might want to set the value to true, for example, if you would like the interior size of the window to always remain the same, since removing a scrollbar increases the interior size.

A window's horizontal scrollbar is not needed whenever the window's page-width is no larger than its interior-width, and its vertical scrollbar is not needed when its page-height is no larger than its interior-height. This typically changes when a user resizes a window, though an application may also change the page-width or page-height at any time.

A window scrollbar will still not be displayed if it was not requested. So if the scrollbars property of a window is :vertical and its retain-scrollbars property is true, then it will always display a vertical scrollbar and never a horizontal scrollbar.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.