outline-item

The class of an outline-item, which denotes a single entry in an outline control.

Outline-items consist of a value to be displayed, an arbitrary "type", a state (:open or :closed or :partially-open) indicating whether its subitems are currently displayed, a list of subitems, and a plist that may contain other item-specific attributes. The range of an outline control is a Lisp tree of these items. A range-on-open method can be used to supply the range in a lazy fashion (determining it when the item is opened).

Outline-items can be displayed above their parents when above-parent is true and the outline's handle-above-parent property is also true.

Outlines may be opened or closed programmatically with open-outline-item-value and close-outline-item-value or using (setf state). For the latter, see the discussion under the heading State on outline-items on the page for state.

There are various functions for manipulating outline-items. Among them are outline-item-mouse-in, outline-item-mouse-out, select-on-typing, move-up-one-outline-item, move-down-one-outline-item, hide-outline-item-children, show-outline-item-children, outline-item-removed, outline-item-added, outline-items-reordered, remove-outline-item, add-sibling-outline-item, add-child-outline-item, and shift-outline-item.

Outline items can be selected. The select-on-right-click property, if true, cause right-clicking on an outline-item to select that item as well as displaying a right button menu.

See About how to get sample code for creating controls in cgide.htm, which explains how to use the IDE to create such code.

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.