scroll-parent-section-while-dragging

Arguments: grid-widget

Returns whether any scrollable grid-section of the specified grid-widget will automatically scroll as needed when the user drags a grid-subsection past a boundary of its parent grid-section. (A grid-subsection is either a grid-column or a grid-row.) The setf of this function may be called to modify the value for a particular grid-widget, or the value can be specified at creation time by passing a scroll-parent-section-while-dragging initarg to make-instance.

When enabled, this option will scroll additional subsections of the parent section into view as the user drags a subsection, so that they can drop the subsection between siblings that were not initially visible.

The value can be one of the following:

• nil, meaning no automatic scrolling is done. The user can still drag a subsection outside of the boundaries of the parent section and then drop it, but they won't be able to see where the subsection is being dropped amoung its siblings until the drop is done.
• An integer, which indicates a number of milliseconds. Each time that number of milliseconds elapses, the parent section will scroll farther (if possible) by the scroll-parent-section-distance of the grid-widget. If the value is less than 10, then 10 will be used due to the minimum resolution of timers. The default value is 20, to scroll farther every 20 milliseconds.
• Any other true value, then the parent section will be scrolled by the distance that user has dragged past the section's boundary, multiplied by the scroll-parent-section-distance of the grid-widget.

Copyright (c) 1998-2022, Franz Inc. Lafayette, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2019.8.20.