Attributes
numItems: | number of items [Integer]
|
numVisible: | number of visible items [Integer]
|
firstItem: | first root-level item [FXTreeItem]
|
lastItem: | last root-level item [FXTreeItem]
|
currentItem: | current item, if any [FXTreeItem]
|
anchorItem: | anchor item, if any [FXTreeItem]
|
cursorItem: | item under the cursor, if any [FXTreeItem]
|
font: | text font [FXFont]
|
indent: | parent-child indent amount, in pixels [Integer]
|
textColor: | normal text color [FXColor]
|
selBackColor: | selected text background color [FXColor]
|
selTextColor: | selected text color [FXColor]
|
lineColor: | line color [FXColor]
|
listStyle: | list style [Integer]
|
helpText: | status line help text for this list [String]
|
Events
The following messages are sent by FXTreeList
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 FXTreeItem 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 FXTreeItem 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 FXTreeItem 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 FXTreeItem 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 FXTreeItem instance).
|
SEL_CLOSED: | sent when an item is closed; the message data is a reference to the item
(an FXTreeItem 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 FXTreeItem
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 FXTreeItem
instance).
|
SEL_SELECTED: | sent when an item is selected; the message data is a reference to the item
(an FXTreeItem instance).
|
SEL_DESELECTED: | sent when an item is deselected; the message data is a reference to the
item (an FXTreeItem instance).
|
SEL_CHANGED: | sent when the current item changes; the message data is a reference to the
current item (an FXTreeItem instance).
|
SEL_INSERTED: | sent after an item is added to the list; the message data is a reference to
the item (an FXTreeItem instance).
|
SEL_DELETED: | sent before an item is removed from the list; the message data is a
reference to the item (an FXTreeItem
instance).
|
Tree list styles
TREELIST_EXTENDEDSELECT: | Extended selection mode allows for drag-selection of ranges of items
|
TREELIST_SINGLESELECT: | Single selection mode allows up to one item to be selected
|
TREELIST_BROWSESELECT: | Browse selection mode enforces one single item to be selected at all times
|
TREELIST_MULTIPLESELECT: | Multiple selection mode is used for selection of individual items
|
TREELIST_AUTOSELECT: | Automatically select under cursor
|
TREELIST_SHOWS_LINES: | Lines shown
|
TREELIST_SHOWS_BOXES: | Boxes to expand shown
|
TREELIST_ROOT_BOXES: | Display root boxes also
|
TREELIST_NORMAL: | same as TREELIST_EXTENDEDLIST
|
anchorItem |
[RW] |
|
currentItem |
[RW] |
|
cursorItem |
[R] |
|
firstItem |
[R] |
|
font |
[RW] |
|
helpText |
[RW] |
|
indent |
[RW] |
|
lastItem |
[R] |
|
lineColor |
[RW] |
|
listStyle |
[RW] |
|
numItems |
[R] |
|
numVisible |
[RW] |
|
selBackColor |
[RW] |
|
selTextColor |
[RW] |
|
textColor |
[RW] |
|
Enumerable
Construct a tree list with numVisible visible items; the tree list
is initially empty.
Prepend a new (possibly subclassed) item as first child of
parentItem. Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Prepend a new item with given text and optional openIcon,
closedIcon and user data, as first child of
parentItem. Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Append a new (possibly subclassed) item as last child of
parentItem. Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Append a new item with given text and optional openIcon,
closedIcon and user data, as last child of
parentItem. Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Append a new (possibly subclassed) item after otherItem.
Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Append a new item with given text and optional openIcon,
closedIcon and user data after otherItem.
Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Prepend a new (possibly subclassed) item prior to
otherItem. Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Prepend a new item with given text and optional openIcon,
closedIcon and user data prior to otherItem.
Returns a reference to the newly added item (an FXTreeItem instance). If notify is
true, a SEL_INSERTED message is sent to the list's
message target after the item is added.
Remove item. If notify is true, a SEL_DELETED
message is sent to the list's message target before the item is removed.
Remove items in range [fromItem, toItem] inclusively. If
notify is true, a SEL_DELETED message is sent to
the list's message target before each item is removed.
Remove all items from the list. If notify is true, a
SEL_DELETED message is sent to the list's message target before
each item is removed.
Search items for item by text, starting from startItem;
the flags argument controls the search direction, and case
sensitivity. Returns a reference to the matching item, or nil if
no match is found.
Scroll the list to make item visible
Change item's closed icon
Return item's closed icon
Return true if item is selected
Return true if item is current
Return true if item is visible
Return true if item opened
Return true if item expanded
Return true if item is a leaf-item, i.e. has no children
Return true if item is enabled
Return item hit code: 0 outside, 1 icon, 2 text, 3 box
Select item. If notify is true, a SEL_SELECTED
message is sent to the list's message target after the item is selected.
Deselect item. If notify is true, a
SEL_DESELECTED message is sent to the list's message target after
the item is deselected.
Toggle item selection. If notify is true, a
SEL_SELECTED or SEL_DESELECTED message is sent to the
list's message target to indicate the change.
Open item. If notify is true, a SEL_OPENED
message is sent to the list's message target after the item is opened.
Close item. If notify is true, a SEL_CLOSED
message is sent to the list's message target after the item is closed.
Collapse sub-tree rooted at tree. If notify is
true, a SEL_COLLAPSED message is sent to the list's
message target after the sub-tree is collapsed.
Expand sub-tree rooted at tree. If notify is
true, a SEL_EXPANDED message is sent to the list's
message target after the sub-tree is expanded.
Reparent item under parentItem.
Change current item. If notify is true, a
SEL_CHANGED message is sent to the list's message target after the
current item changes.
Extend selection from anchor item to item. If notify is
true, a series of SEL_SELECTED and
SEL_DESELECTED messages may be sent to the list's message target,
indicating the changes.
Deselect all items. If notify is true,
SEL_DESELECTED messages will be sent to the list's message target
indicating the affected items.
Calls block once for each root-level tree item, passing a reference to that
item as a parameter.