Class: Fox::FXTreeItem

Inherits:

FXObject

• Object
• FXObject
• Fox::FXTreeItem

show all

Includes:

Enumerable

Defined in:

rdoc-sources/FXTreeList.rb,
lib/fox16/core.rb,
lib/fox16/iterators.rb

Overview

Instance Method Summary (collapse)

• - (Object) <=>(otherItem)
• - (Object) above

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

• - (Object) below

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

• - (Boolean) childOf?(item)

  Return true if this item is a descendant of item.

• - (Object) closedIcon

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

• - (Object) create

  Create this tree item.

• - (Object) 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.

• - (Object) 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.

• - (Object) destroy

  Destroy this tree item.

• - (Object) detach

  Detach this tree item.

• - (Object) draggable=(dr)

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

• - (Boolean) draggable?

  Returns true if this item is draggable.

• - (Object) each

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

• - (Object) enabled=(en)

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

• - (Boolean) enabled?

  Returns true if this item is enabled.

• - (Object) expanded=(ex)

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

• - (Boolean) expanded?

  Returns true if this item is expanded.

• - (Object) first

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

• - (Object) getHeight(treeList)

  Get the height of this item.

• - (Object) getWidth(treeList)

  Get the width of this item.

• - (Boolean) hasFocus?

  Returns true if this item has the focus.

• - (Object) hasItems=(flag)

  Change has items flag to true or false.

• - (Boolean) hasItems?

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

• - (FXTreeItem) initialize(text, openIcon = nil, closedIcon = nil, data = nil) constructor

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

• - (Object) last

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

• - (Object) 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.

• - (Object) numChildren

  Return the number of child items for this tree item.

• - (Object) opened=(op)

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

• - (Boolean) opened?

  Returns true if this item is opened.

• - (Object) openIcon

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

• - (Object) parent

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

• - (Boolean) parentOf?(item)

  Return true if this item is an ancestor of item.

• - (Object) 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.

• - (Object) selected=(sel)

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

• - (Boolean) selected?

  Returns true if this item is selected.

• - (Object) setClosedIcon(ci, owned = false)

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

• - (Object) setFocus(focus)

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

• - (Object) setOpenIcon(oi, owned = false)

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

• - (Object) text

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

• - (Object) text=(txt)

  Set the item text for this tree item.

• - (Object) to_s

  Returns the item's text.

Methods inherited from FXObject

#bind, #handle, #load, #save, subclasses

16
17

# File 'rdoc-sources/FXTreeList.rb', line 16

def initialize(text, openIcon=nil, closedIcon=nil, data=nil) # :yields: theItem
end

16
17
18

# File 'lib/fox16/core.rb', line 16

def <=>(otherItem)
  text <=> otherItem.text
end

120

# File 'rdoc-sources/FXTreeList.rb', line 120

def above; end

117

# File 'rdoc-sources/FXTreeList.rb', line 117

def below; end

125

# File 'rdoc-sources/FXTreeList.rb', line 125

def childOf?(item); end

38

# File 'rdoc-sources/FXTreeList.rb', line 38

def closedIcon; end

144

# File 'rdoc-sources/FXTreeList.rb', line 144

def create; end

46

# File 'rdoc-sources/FXTreeList.rb', line 46

def data; end

50

# File 'rdoc-sources/FXTreeList.rb', line 50

def data=(dt); end

150

# File 'rdoc-sources/FXTreeList.rb', line 150

def destroy; end

147

# File 'rdoc-sources/FXTreeList.rb', line 147

def detach; end

83

# File 'rdoc-sources/FXTreeList.rb', line 83

def draggable=(dr); end

86

# File 'rdoc-sources/FXTreeList.rb', line 86

def draggable? ; end

201
202
203
204
205
206
207
208
209

# File 'lib/fox16/iterators.rb', line 201

def each # :yields: aTreeItem
  current = first
  while current != nil
    next_current = current.next
    yield current
    current = next_current
  end
  self
end

77

# File 'rdoc-sources/FXTreeList.rb', line 77

def enabled=(en); end

80

# File 'rdoc-sources/FXTreeList.rb', line 80

def enabled? ; end

71

# File 'rdoc-sources/FXTreeList.rb', line 71

def expanded=(ex); end

74

# File 'rdoc-sources/FXTreeList.rb', line 74

def expanded? ; end

100

# File 'rdoc-sources/FXTreeList.rb', line 100

def first; end

141

# File 'rdoc-sources/FXTreeList.rb', line 141

def getHeight(treeList) ; end

138

# File 'rdoc-sources/FXTreeList.rb', line 138

def getWidth(treeList) ; end

56

# File 'rdoc-sources/FXTreeList.rb', line 56

def hasFocus? ; end

92

# File 'rdoc-sources/FXTreeList.rb', line 92

def hasItems=(flag); end

89

# File 'rdoc-sources/FXTreeList.rb', line 89

def hasItems?; end

104

# File 'rdoc-sources/FXTreeList.rb', line 104

def last; end

109

# File 'rdoc-sources/FXTreeList.rb', line 109

def next; end

20

# File 'rdoc-sources/FXTreeList.rb', line 20

def numChildren; end

65

# File 'rdoc-sources/FXTreeList.rb', line 65

def opened=(op); end

68

# File 'rdoc-sources/FXTreeList.rb', line 68

def opened? ; end

30

# File 'rdoc-sources/FXTreeList.rb', line 30

def openIcon; end

96

# File 'rdoc-sources/FXTreeList.rb', line 96

def parent; end

130

# File 'rdoc-sources/FXTreeList.rb', line 130

def parentOf?(item); end

114

# File 'rdoc-sources/FXTreeList.rb', line 114

def prev; end

59

# File 'rdoc-sources/FXTreeList.rb', line 59

def selected=(sel); end

62

# File 'rdoc-sources/FXTreeList.rb', line 62

def selected? ; end

42

# File 'rdoc-sources/FXTreeList.rb', line 42

def setClosedIcon(ci, owned=false); end

53

# File 'rdoc-sources/FXTreeList.rb', line 53

def setFocus(focus) ; end

34

# File 'rdoc-sources/FXTreeList.rb', line 34

def setOpenIcon(oi, owned=false); end

23

# File 'rdoc-sources/FXTreeList.rb', line 23

def text; end

26

# File 'rdoc-sources/FXTreeList.rb', line 26

def text=(txt); end

133
134
135

# File 'rdoc-sources/FXTreeList.rb', line 133

def to_s
  text
end