Class Fox::FXTreeItem
In: rdoc-sources/FXTreeList.rb
lib/fox12/core.rb
lib/fox12/iterators.rb
Parent: FXObject

Each item in an FXTreeList is an instance of FXTreeItem.

A tree item can contain zero or more child items, and those items are arranged as a linked list. The FXTreeItem#first method returns the a reference to the first child item, if any, and the FXTreeItem#last method returns a reference to the last child item.

Methods

<=>   above   below   childOf?   closedIcon   closedIcon=   create   data   data=   destroy   detach   draggable=   draggable?   each   enabled=   enabled?   expanded=   expanded?   first   getHeight   getWidth   hasFocus?   hasItems=   hasItems?   iconOwned?   last   new   next   numChildren   openIcon   openIcon=   opened=   opened?   parent   parentOf?   prev   selected=   selected?   setFocus   text   text=   to_s  

Included Modules

Enumerable

Public Class methods

new(text, openIcon=nil, closedIcon=nil, data=nil) {|theItem| ...}

Return a new FXTreeItem instance, initialized with the specified text, open-state icon, closed-state icon and user data.

Public Instance methods

above()

Return a reference to the item that is "logically" above this item.

below()

Return a reference to the item that is "logically" below this item.

childOf?(item)

Return true if this item is a descendant of item.

closedIcon()

Return a reference to the closed-state icon (an FXIcon instance) for this tree item, or nil if none was specified.

closedIcon=(ci)

Set the closed-state icon (an FXIcon instance) for this tree item, or nil if no icon should be used.

create()

Create this tree item

data()

Return a reference to the user data for this tree item, or nil if no user data has been associated with this tree item.

data=(dt)

Set the user data (a reference to any kind of object) for this tree item, or nil if no user data needs to be associated with this item.

destroy()

Destroy this tree item

detach()

Detach this tree item

draggable=(dr)

Set this item’s "draggable" state to true or false.

draggable?()

Returns true if this item is draggable

each( {|aTreeItem| ...}

Calls block once for each child of this tree item, passing a reference to that child item as a parameter.

enabled=(en)

Set this item’s enabled state to true or false.

enabled?()

Returns true if this item is enabled

expanded=(ex)

Set this item’s expanded state to true or false.

expanded?()

Returns true if this item is expanded

first()

Return a reference to the first child item for this tree item, or nil if this tree item has no child items.

getHeight(treeList)

Get the height of this item

getWidth(treeList)

Get the width of this item

hasFocus?()

Returns true if this item has the focus

hasItems=(flag)

Change has items flag to true or false.

hasItems?()

Return true if this items has subitems, real or imagined.

iconOwned?()

Returns true if this item owns its icons

last()

Return a reference to the last child item for this tree item, or nil if this tree item has no child items.

next()

Return a reference to the next sibling item for this tree item, or nil if this is the last item in the parent item’s list of child items.

numChildren()

Return the number of child items for this tree item.

openIcon()

Return a reference to the opened-state icon (an FXIcon instance) for this tree item, or nil if none was specified.

openIcon=(oi)

Set the opened-state icon (an FXIcon instance) for this tree item, or nil if no icon should be used.

opened=(op)

Set this item’s "opened" state to true or false.

opened?()

Returns true if this item is opened

parent()

Return a reference to the parent item for this tree item, or nil if this is a root-level item.

parentOf?(item)

Return true if this item is an ancestor of item.

prev()

Return a reference to the previous sibling item for this tree item, or nil if this is the first item in the parent item’s list of child items.

selected=(sel)

Set this item’s selected state to true or false.

selected?()

Returns true if this item is selected

setFocus(focus)

Set the focus on this tree item (focus is either true or false)

text()

Return the item text (a string) for this tree item.

text=(txt)

Set the item text for this tree item.

to_s()

Returns the item’s text

[Validate]