selected

Generic Function

Package: common-graphics

ToC

DocOverview

CGDoc

RelNotes

Index

PermutedIndex

Allegro CL version 6.2
Moderately revised from 6.1

selected

Arguments: object

Returns or sets with setf the value of the selected property of the argument.

object may be a menu-item. A selected menu-item will be usually be displayed with a check mark next to its title when the menu is displayed. However, if its cluster property is true, then it will be displayed with a dot instead of check mark, and any other menu-items in the same cluster will be deselected automatically, making a set of menu-items act similar to a group of radio-button controls.

object may be a grid-row or grid-column (on a grid-widget) in which case the cells within in it are drawn using cell-selected-foreground-color and cell-selected-background-color rather than the usual cell-foreground-color and cell-background-color. The only other built-in behavior of a selected row or column is to be the object of delete-selected-subsections if it is called, but an application may choose to treat selected rows and columns in a custom way.

For a grid-row or grid-column (on a grid-widget), an application may call (setf selected) to programmatically select or deselect individual rows and columns; in addition, (setf selected) will be called automatically if the user left-clicks a cell whose grid-row or grid-column has a true selectable property and the intersecting column or row is an instance or row-selecting-column-mixin or column-selecting-row-mixin (respectively). (This is the default interactive behavior that could be overridden by a more specific cell-click method.) See also cell-selected, selectable, and selected-reader.

selected may also be called on an outline-item or a list-view-item, in which case it will return true iff the value of the associated outline or list-view currently is (or contains) the value of the outline-item or list-view-item. But an application should never call (setf selected) on an outline-item or list-view-item, and instead should call (setf value) on the associated outline or list-view control.