FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 10.0
Unrevised from 9.0 to 10.0.
9.0 version

focus-cell

Arguments: grid-widget

Returns multiple values to indicate where the keyboard focus currently is within the grid-widget passed as the single argument. The values returned are

  1. row-section
  2. column-section
  3. row
  4. column
  5. row-index
  6. column-index

If the row-section that contains the grid's focus has no subsections, then the returned row and row-index will each be nil. Similarly, if the column-section that contains the grid's focus has no subsections, then the returned column and column-index will each be nil.

Otherwise, the row-section, column-section, row, and column will always be instances of the grid-row-section, grid-column-section, grid-row, and grid-column classes (respectively) or their subclasses, and the row-index and column-index will each always be a non-negative integer indicating which replication of the row or column has the grid's focus (this is always 0 for a non-replicated row or column).

The above values are returned even when the grid-widget itself does not have the keyboard focus, indicating to where the keyboard focus will return if and when it returns to the grid-widget. If the grid-widget has not yet had the keyboard focus, then the first replications of the first subsections of the first row-section and column-section will be returned.

To move the focus to a different grid-widget cell programmatically, call set-focus-cell.


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

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 10.0
Unrevised from 9.0 to 10.0.
9.0 version