Generic Function | Package: cg | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version

## 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 usually be displayed with a check mark next to its title when the menu is displayed. (On GTK, the checkable property of the menu-item must also be true.) 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 of `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, selected-reader, and deselect-all-subsections.

selected may also be called on an `outline-item` or a `list-view-item`, in which case it will return true if and only if 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.

selected is a property of the `grid-subsection`, `grid-column`, `row-header-column`, `grid-row`, `column-header-row`, `outline`, `list-view`, and `menu-item` classes.

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.

|  | ToC | DocOverview | CGDoc | RelNotes | FAQ | Index | PermutedIndex
| Allegro CL version 10.1 Unrevised from 10.0 to 10.1. 10.0 version