Class Fox::FXTreeListBox
In: rdoc-sources/FXTreeListBox.rb
lib/fox12/iterators.rb
Parent: FXPacker

Tree list box.

Tree list box styles

TREELISTBOX_NORMAL:Normal style

Message identifiers

ID_TREE:x
ID_FIELD:x

Methods

Included Modules

Enumerable

Attributes

currentItem  [RW]  Current item, if any [FXTreeItem]
firstItem  [R]  First root-level item [FXTreeItem]
font  [RW]  Text font [FXFont]
helpText  [RW]  Status line help text for this tree list box [String]
lastItem  [R]  Last root-level item [FXTreeItem]
listStyle  [RW]  Tree list box style
numItems  [R]  Number of items [Integer]
numVisible  [RW]  Number of visible items [Integer]
tipText  [RW]  Tool tip text for this tree list box [String]

Public Class methods

Return an initially empty FXTreeListBox.

Parameters:

p:the parent window for this tree list box [FXComposite]
tgt:the message target, if any, for this tree list box [FXObject]
sel:the message identifier for this tree list box [Integer]
opts:tree list options [Integer]
x:initial x-position [Integer]
y:initial y-position [Integer]
w:initial width [Integer]
h:initial height [Integer]
pl:internal padding on the left side, in pixels [Integer]
pr:internal padding on the right side, in pixels [Integer]
pt:internal padding on the top side, in pixels [Integer]
pb:internal padding on the bottom side, in pixels [Integer]

Public Instance methods

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.

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.

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.

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.

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.

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.

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.

Calls block once for each root-level tree item, passing a reference to that item as a parameter.

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.

Return item’s closed icon

Return item’s user data

Return item’s open icon

Return item’s text

Return true if item is current

Return true if item is a leaf-item, i.e. has no children

Return true if the pane is shown.

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.

Change current item. If notify is true, a SEL_CHANGED message is sent to the tree list box’s message target.

Change item’s closed icon

Change item’s user data

Change item’s open icon

Change item’s text

Sort children of item

Sort all items recursively.

Sort root items

[Validate]