section-box

Arguments: grid-widget section &optional include-border-p box

Returns a box or nil indicating where a grid section lies on the grid widget window, clipped according to grid boundaries and section boundaries.

When the specified section or subsection is scrolled completely out of view, this function returns nil. Otherwise it returns a box that reflects the visible part of the specified grid section.

grid-widget is the grid-widget containing the section.

section is the section whose box is being returned. This should be either a grid-row-section, grid-column-section, grid-row, or grid-column.

If include-border-p is true, then the area occupied by the border line at the right or bottom edge of the section is included in the returned box. Otherwise it is excluded.

box may be either a box (see make-box) or nil. If a box, then that box is modified and returned. If nil, a new box object is created and returned. Passing a scratch box avoids consing one that must be garbage collected.

See also cross-section-box and invalidate-whole-section.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
The object described on this page has been modified in the 8.2 release; see the Release Notes.
Created 2016.6.21.