class Fox::FXFoldingList

An FXFoldingList widget resembles an FXTreeList, but it supports a header control to provide each item with multiple columns of text. Subtrees can be collapsed or expanded by double-clicking on an item or by clicking on the optional plus button in front of the item. Each item may have a text and optional open-icon as well as a closed-icon. The items may be connected by optional lines to show the hierarchical relationship. When an item’s selected state changes, the folding list emits a SEL_SELECTED or SEL_DESELECTED message. If an item is opened or closed, a message of type SEL_OPENED or SEL_CLOSED is sent. When the subtree under an item is expanded, a SEL_EXPANDED or SEL_COLLAPSED message is issued. A change of the current item is signified by the SEL_CHANGED message. In addition, the folding list sends SEL_COMMAND messages when the user clicks on an item, and SEL_CLICKED, SEL_DOUBLECLICKED, and SEL_TRIPLECLICKED when the user clicks once, twice, or thrice, respectively. When items are added or removed, the folding list sends messages of the type SEL_INSERTED or SEL_DELETED. In each of these cases, a pointer to the item, if any, is passed in the 3rd argument of the message.

Events

The following messages are sent by FXFoldingList to its target:

SEL_KEYPRESS

sent when a key goes down; the message data is an FXEvent instance.

SEL_KEYRELEASE

sent when a key goes up; the message data is an FXEvent instance.

SEL_LEFTBUTTONPRESS

sent when the left mouse button goes down; the message data is an FXEvent instance.

SEL_LEFTBUTTONRELEASE

sent when the left mouse button goes up; the message data is an FXEvent instance.

SEL_RIGHTBUTTONPRESS

sent when the right mouse button goes down; the message data is an FXEvent instance.

SEL_RIGHTBUTTONRELEASE

sent when the right mouse button goes up; the message data is an FXEvent instance.

SEL_COMMAND

sent when a list item is clicked on; the message data is a reference to the item (an FXFoldingItem instance).

SEL_CLICKED

sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or nil if no item was clicked.

SEL_DOUBLECLICKED

sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or nil if no item was clicked.

SEL_TRIPLECLICKED

sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXFoldingItem instance) or nil if no item was clicked.

SEL_OPENED

sent when an item is opened; the message data is a reference to the item (an FXFoldingItem instance).

SEL_CLOSED

sent when an item is closed; the message data is a reference to the item (an FXFoldingItem instance).

SEL_EXPANDED

sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance).

SEL_COLLAPSED

sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance).

SEL_SELECTED

sent when an item is selected; the message data is a reference to the item (an FXFoldingItem instance).

SEL_DESELECTED

sent when an item is deselected; the message data is a reference to the item (an FXFoldingItem instance).

SEL_CHANGED

sent when the current item changes; the message data is a reference to the current item (an FXFoldingItem instance).

SEL_INSERTED

sent after an item is added to the list; the message data is a reference to the item (an FXFoldingItem instance).

SEL_DELETED

sent before an item is removed from the list; the message data is a reference to the item (an FXFoldingItem instance).

Folding list styles

FOLDINGLIST_EXTENDEDSELECT

Extended selection mode allows for drag-selection of ranges of items

FOLDINGLIST_SINGLESELECT

Single selection mode allows up to one item to be selected

FOLDINGLIST_BROWSESELECT

Browse selection mode enforces one single item to be selected at all times

FOLDINGLIST_MULTIPLESELECT

Multiple selection mode is used for selection of individual items

FOLDINGLIST_AUTOSELECT

Automatically select under cursor

FOLDINGLIST_SHOWS_LINES

Lines shown

FOLDINGLIST_SHOWS_BOXES

Boxes to expand shown

FOLDINGLIST_ROOT_BOXES

Display root boxes also

FOLDINGLIST_NORMAL

same as FOLDINGLIST_EXTENDEDSELECT