keep-focus-in-view

Arguments: grid-widget

Returns the value of the keep-focus-in-view property of grid-widget. That property determines whether a grid-widget will move its internal keyboard focus as needed so that it remains in view as grid sections are scrolled. The setf of this function may be called to set the value. The default is t.

If true, then whenever a section of the grid-widget is scrolled, and that section contains the current focus-cell of the grid, and the focus-cell is partly or completely scrolled out of view, then the focus-cell of the grid-widget is set to be a cell of that section that is entirely in view. (If no cell is entirely in view, then a cell that is partially in view is used instead.)

If nil, then no such action is taken.

This option facilitates navigating a grid-widget with the keyboard by first using the PageUp and PageDown keys to scroll a particular cell into view, and then using the arrow keys to move into that cell. If this option is turned off, then scrolling a grid section may leave the focus-cell scrolled far out of view, and then pressing an arrow key would scroll the grid section back to the current focus-cell. On the other hand, it may be distracting when this option is turned on to see the focus rectangle jumping around as a grid section is scrolled.

Side note: The PageUp and PageDown keys will scroll a grid section horizontally if the control key is held down.

keep-focus-in-view is a property of the grid-widget class.

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.