Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • tk/lib/tkextlib/treectrl/tktreectrl.rb

Parent

Methods

Included Modules

Class/Module Index [+]

Quicksearch

Tk::TreeCtrl_Widget

Public Class Methods

image_tint(img, color, alpha) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 61
def self.image_tint(img, color, alpha)
  Tk.tk_call_without_enc('imagetint', img, color, alpha)
end
            
loupe(img, x, y, w, h, zoom) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 47
def self.loupe(img, x, y, w, h, zoom)
  # NOTE: platform == 'unix' only

  # img  => TkPhotoImage
  # x, y => screen coords
  # w, h => magnifier width and height
  # zoom => zooming rate
  Tk.tk_call_without_enc('loupe', img, x, y, w, h, zoom)
end
            
package_name() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 23
def self.package_name
  PACKAGE_NAME
end
            
package_version() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 27
def self.package_version
  begin
    TkPackage.require('treectrl')
  rescue
    ''
  end
end
            
text_layout(font, text, keys={}) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 57
def self.text_layout(font, text, keys={})
  TkComm.list(Tk.tk_call_without_enc('textlayout', font, text, keys))
end
            

Public Instance Methods

__destroy_hook__() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 652
def __destroy_hook__
  Tk::TreeCtrl::Column::TreeCtrlColumnID_TBL.mutex.synchronize{
    Tk::TreeCtrl::Column::TreeCtrlColumnID_TBL.delete(@path)
  }
  Tk::TreeCtrl::Element::TreeCtrlElementID_TBL.mutex.synchronize{
    Tk::TreeCtrl::Element::TreeCtrlElementID_TBL.delete(@path)
  }
  Tk::TreeCtrl::Item::TreeCtrlItemID_TBL.mutex.synchronize{
    Tk::TreeCtrl::Item::TreeCtrlItemID_TBL.delete(@path)
  }
  Tk::TreeCtrl::Style::TreeCtrlStyleID_TBL.mutex.synchronize{
    Tk::TreeCtrl::Style::TreeCtrlStyleID_TBL.delete(@path)
  }
end
            
activate(desc) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 710
def activate(desc)
  tk_send('activate', desc)
  self
end
            
canvasx(x) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 715
def canvasx(x)
  number(tk_send('canvasx', x))
end
            
canvasy(y) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 719
def canvasy(y)
  number(tk_send('canvasy', y))
end
            
collapse(*dsc) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 723
def collapse(*dsc)
  tk_send_without_enc('collapse', *(dsc.map!{|d| _get_eval_string(d, true)}))
  self
end
            
collapse_recurse(*dsc) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 728
def collapse_recurse(*dsc)
  tk_send_without_enc('collapse', '-recurse',
                      *(dsc.map!{|d| _get_eval_string(d, true)}))
  self
end
            
column_bbox(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 734
def column_bbox(idx)
  list(tk_send('column', 'bbox', idx))
end
            
column_compare(column1, op, column2) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 738
def column_compare(column1, op, column2)
  bool(tk_send('column', 'compare', column1, op, column2))
end
            
column_count() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 742
def column_count
  num_or_str(tk_send('column', 'count'))
end
            
column_create(keys=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 746
def column_create(keys=nil)
  if keys && keys.kind_of?(Hash)
    num_or_str(tk_send('column', 'create', *hash_kv(keys)))
  else
    num_or_str(tk_send('column', 'create'))
  end
end
            
column_delete(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 754
def column_delete(idx)
  Tk::TreeCtrl::Column::TreeCtrlColumnID_TBL.mutex.synchronize{
    if Tk::TreeCtrl::Column::TreeCtrlColumnID_TBL[self.path]
      Tk::TreeCtrl::Column::TreeCtrlColumnID_TBL[self.path].delete(idx)
    end
  }
  tk_send('column', 'delete', idx)
  self
end
            
column_id(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 768
def column_id(idx)
  tk_send('column', 'id', idx)
end
            
column_index(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 764
def column_index(idx)
  num_or_str(tk_send('column', 'index', idx))
end
            
column_list(visible=false) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 772
def column_list(visible=false)
  if visible
    simplelist(tk_send('column', 'list', '-visible'))
  else
    simplelist(tk_send('column', 'list'))
  end
end
            
column_move(idx, before) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 783
def column_move(idx, before)
  tk_send('column', 'move', idx, before)
  self
end
            
column_needed_width(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 788
def column_needed_width(idx)
  num_or_str(tk_send('column', 'neededwidth', idx))
end
            
Also aliased as: column_neededwidth
column_neededwidth(idx) click to toggle source
Alias for: column_needed_width
column_order(column, visible=false) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 793
def column_order(column, visible=false)
  if visible
    num_or_str(tk_send('column', 'order', column, '-visible'))
  else
    num_or_str(tk_send('column', 'order', column))
  end
end
            
column_visible_list() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 779
def column_visible_list
  column_list(true)
end
            
column_visible_order(column) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 800
def column_visible_order(column)
  column_order(column, true)
end
            
column_width(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 804
def column_width(idx)
  num_or_str(tk_send('column', 'width', idx))
end
            
columns_size() click to toggle source
Alias for: numcolumns
compare(item1, op, item2) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 808
def compare(item1, op, item2)
  bool(tk_send('compare', item1, op, item2))
end
            
contentbox() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 812
def contentbox()
  list(tk_send('contentbox'))
end
            
debug_dinfo() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 851
def debug_dinfo
  tk_send('debug', 'dinfo')
  self
end
            
debug_scroll() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 856
def debug_scroll
  tk_send('debug', 'scroll')
end
            
depth(item=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 816
def depth(item=None)
  num_or_str(tk_send_without_enc('depth', _get_eval_string(item, true)))
end
            
dragimage_add(item, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 820
def dragimage_add(item, *args)
  tk_send('dragimage', 'add', item, *args)
  self
end
            
dragimage_clear() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 825
def dragimage_clear()
  tk_send('dragimage', 'clear')
  self
end
            
dragimage_offset(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 830
def dragimage_offset(*args) # x, y
  if args.empty?
    list(tk_send('dragimage', 'offset'))
  else
    tk_send('dragimage', 'offset', *args)
    self
  end
end
            
dragimage_visible(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 839
def dragimage_visible(*args) # mode
  if args..empty?
    bool(tk_send('dragimage', 'visible'))
  else
    tk_send('dragimage', 'visible', *args)
    self
  end
end
            
dragimage_visible?() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 847
def dragimage_visible?
  dragimage_visible()
end
            
element_class(elem) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 906
def element_class(elem)
  Tk::TreeCtrl::Element.type2class(element_type(elem))
end
            
element_create(elem, type, keys=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 860
def element_create(elem, type, keys=nil)
  if keys && keys.kind_of?(Hash)
    tk_send('element', 'create', elem, type, *hash_kv(keys))
  else
    tk_send('element', 'create', elem, type)
  end
end
            
element_delete(*elems) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 868
def element_delete(*elems)
  Tk::TreeCtrl::Element::TreeCtrlElementID_TBL.mutex.synchronize{
    if Tk::TreeCtrl::Element::TreeCtrlElementID_TBL[self.path]
      elems.each{|elem|
        Tk::TreeCtrl::Element::TreeCtrlElementID_TBL[self.path].delete(elem)
      }
    end
  }
  tk_send('element', 'delete', *elems)
  self
end
            
element_names() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 880
def element_names()
  list(tk_send('element', 'names')).collect!{|elem|
    Tk::TreeCtrl::Element.id2obj(self, elem)
  }
end
            
element_perstate(elem, opt, st_list) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 898
def element_perstate(elem, opt, st_list)
  tk_send('element', 'perstate', elem, "-{opt}", st_list)
end
            
element_type(elem) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 902
def element_type(elem)
  tk_send('element', 'type', elem)
end
            
expand(*dsc) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 910
def expand(*dsc)
  tk_send('expand', *dsc)
  self
end
            
expand_recurse(*dsc) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 915
def expand_recurse(*dsc)
  tk_send('expand', '-recurse', *dsc)
  self
end
            
get_item_image(item, column=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1106
def get_item_image(item, column=nil)
  item_image(item, column)
end
            
get_item_span(item, column=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1282
def get_item_span(item, column=nil)
  item_span(item, column)
end
            
get_style_layout(style, elem, opt=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1702
def get_style_layout(style, elem, opt=None)
  style_layout(style, elem, opt)
end
            
identify(x, y) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 920
def identify(x, y)
  lst = list(tk_send('identify', x, y))

  if lst[0] == 'item'
    lst[1] = Tk::TreeCtrl::Item.id2obj(self, lst[1])
    size = lst.size
    i = 2
    while i < size
      case lst[i]
      when 'line'
        i += 1
        lst[i] = Tk::TreeCtrl::Item.id2obj(self, lst[i])
        i += 1

      when 'button'
        i += 1

      when 'column'
        i += 2

      when 'elem'
        i += 1
        lst[i] = Tk::TreeCtrl::Element.id2obj(self, lst[i])
        i += 1

      else
        i += 1
      end
    end
  end

  lst
end
            
index(idx) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 954
def index(idx)
  num_or_str(tk_send('index', idx))
end
            
install_bind(cmd, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 692
def install_bind(cmd, *args)
  install_bind_for_event_class(Tk::TreeCtrl::NotifyEvent, cmd, *args)
end
            
item_ancestors(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 958
def item_ancestors(item)
  list(tk_send('item', 'ancestors', item)).collect!{|id|
    Tk::TreeCtrl::Item.id2obj(self, id)
  }
end
            
item_bbox(item, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 964
def item_bbox(item, *args)
  list(tk_send('item', 'bbox', item, *args))
end
            
item_children(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 968
def item_children(item)
  list(tk_send('item', 'children', item)).collect!{|id|
    Tk::TreeCtrl::Item.id2obj(self, id)
  }
end
            
item_children_size(item) click to toggle source
Alias for: item_numchildren
item_collapse(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 974
def item_collapse(item)
  tk_send_without_enc('item', 'collapse', _get_eval_string(item, true))
  self
end
            
item_collapse_recurse(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 979
def item_collapse_recurse(item)
  tk_send_without_enc('item', 'collapse',
                      _get_eval_string(item, true), '-recurse')
  self
end
            
item_compare(item1, op, item2) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 985
def item_compare(item1, op, item2)
  bool(tk_send('item', 'compare', item1, op, item2))
end
            
item_complex(item, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 989
def item_complex(item, *args)
  tk_send_without_enc('item', 'complex',
                      _get_eval_string(item, true),
                      *(args.map!{|arg| _get_eval_string(arg, true)}))
  self
end
            
item_count() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 996
def item_count
  num_or_str(tk_send('item', 'count'))
end
            
item_create(keys={}) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1000
def item_create(keys={})
  num_or_str(tk_send_without_enc('item', 'create', *hash_kv(keys, true)))
end
            
item_delete(first, last=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1011
def item_delete(first, last=None)
  Tk::TreeCtrl::Item::TreeCtrlItemID_TBL.mutex.synchronize{
    if Tk::TreeCtrl::Item::TreeCtrlItemID_TBL[self.path]
      if first == 'all' || first == :all || last == 'all' || last == :all
        Tk::TreeCtrl::Item::TreeCtrlItemID_TBL[self.path].clear
      elsif last == None
        _erase_children(first)
      else
        self.range(first, last).each{|id|
          _erase_children(id)
        }
      end
    end
  }
  tk_send('item', 'delete', first, last)
  self
end
            
item_dump(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1029
def item_dump(item)
  list(tk_send('item', 'dump', item))
end
            
item_dump_hash(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1033
def item_dump_hash(item)
  Hash[*list(tk_send('item', 'dump', item))]
end
            
item_element_actual(item, column, elem, key) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1037
def item_element_actual(item, column, elem, key)
  tk_send('item', 'element', 'actual', item, column, elem, "-#{key}")
end
            
item_element_perstate(elem, opt, st_list) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1041
def item_element_perstate(elem, opt, st_list)
  tk_send('item', 'element', 'perstate', elem, "-{opt}", st_list)
end
            
item_expand(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1045
def item_expand(item)
  tk_send('item', 'expand', item)
  self
end
            
item_expand_recurse(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1050
def item_expand_recurse(item)
  tk_send('item', 'expand', item, '-recurse')
  self
end
            
item_first_child(parent, child=nil) click to toggle source
Alias for: item_firstchild
item_firstchild(parent, child=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1055
def item_firstchild(parent, child=nil)
  if child
    tk_send_without_enc('item', 'firstchild',
                        _get_eval_string(parent, true),
                        _get_eval_string(child, true))
    self
  else
    id = num_or_str(tk_send_without_enc('item', 'firstchild',
                                        _get_eval_string(parent, true)))
    Tk::TreeCtrl::Item.id2obj(self, id)
  end
end
            
Also aliased as: item_first_child
item_has_button(item, st=None) click to toggle source
Alias for: item_hasbutton
item_has_button?(item) click to toggle source
Alias for: item_hasbutton?
item_hasbutton(item, st=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1069
def item_hasbutton(item, st=None)
  if st == None
    bool(tk_send_without_enc('item', 'hasbutton',
                             _get_eval_string(item, true)))
  else
    tk_send_without_enc('item', 'hasbutton',
                        _get_eval_string(item, true),
                        _get_eval_string(st))
    self
  end
end
            
Also aliased as: item_has_button
item_hasbutton?(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1082
def item_hasbutton?(item)
  item_hasbutton(item)
end
            
Also aliased as: item_has_button?
item_id(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1087
def item_id(item)
  tk_send('item', 'id', item)
end
            
item_image(item, column=nil, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1091
def item_image(item, column=nil, *args)
  if args.empty?
    if column
      img = tk_send('item', 'image', item, column)
      TkImage::Tk_IMGTBL[img]? TkImage::Tk_IMGTBL[img] : img
    else
      simplelist(tk_send('item', 'image', item)).collect!{|img|
        TkImage::Tk_IMGTBL[img]? TkImage::Tk_IMGTBL[img] : img
      }
    end
  else
    tk_send('item', 'image', item, column, *args)
    self
  end
end
            
item_index(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1113
def item_index(item)
  list(tk_send('item', 'index', item))
end
            
item_is_ancestor(item, des) click to toggle source
Alias for: item_isancestor
item_is_ancestor?(item, des) click to toggle source
Alias for: item_isancestor
item_is_open(item) click to toggle source
Alias for: item_isopen
item_is_open?(item) click to toggle source
Alias for: item_isopen
item_is_opened?(item) click to toggle source
Alias for: item_isopen
item_isancestor(item, des) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1117
def item_isancestor(item, des)
  bool(tk_send('item', 'isancestor', item, des))
end
            
item_isancestor?(item, des) click to toggle source
Alias for: item_isancestor
item_isopen(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1124
def item_isopen(item)
  bool(tk_send('item', 'isopen', item))
end
            
item_isopen?(item) click to toggle source
Alias for: item_isopen
item_isopened?(item) click to toggle source
Alias for: item_isopen
item_last_child(parent, child=nil) click to toggle source
Alias for: item_lastchild
item_lastchild(parent, child=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1133
def item_lastchild(parent, child=nil)
  if child
    tk_send_without_enc('item', 'lastchild',
                        _get_eval_string(parent, true),
                        _get_eval_string(child, true))
    self
  else
    id = num_or_str(tk_send_without_enc('item', 'lastchild',
                                        _get_eval_string(parent, true)))
    Tk::TreeCtrl::Item.id2obj(self, id)
  end
end
            
Also aliased as: item_last_child
item_next_sibling(sibling, nxt=nil) click to toggle source
Alias for: item_nextsibling
item_nextsibling(sibling, nxt=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1147
def item_nextsibling(sibling, nxt=nil)
  if nxt
    tk_send('item', 'nextsibling', sibling, nxt)
    self
  else
    id = num_or_str(tk_send('item', 'nextsibling', sibling))
    Tk::TreeCtrl::Item.id2obj(self, id)
  end
end
            
Also aliased as: item_next_sibling
item_num_children(item) click to toggle source
Alias for: item_numchildren
item_numchildren(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1158
def item_numchildren(item)
  number(tk_send_without_enc('item', 'numchildren',
                             _get_eval_string(item, true)))
end
            
item_order(item, visible=false) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1165
def item_order(item, visible=false)
  if visible
    ret = num_or_str(tk_send('item', 'order', item, '-visible'))
  else
    ret = num_or_str(tk_send('item', 'order', item))
  end

  (ret.kind_of?(Fixnum) && ret < 0)? nil: ret
end
            
item_parent(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1178
def item_parent(item)
  id = num_or_str(tk_send('item', 'parent', item))
  Tk::TreeCtrl::Item.id2obj(self, id)
end
            
item_prev_sibling(sibling, prev=nil) click to toggle source
Alias for: item_prevsibling
item_prevsibling(sibling, prev=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1183
def item_prevsibling(sibling, prev=nil)
  if prev
    tk_send('item', 'prevsibling', sibling, prev)
    self
  else
    id = num_or_str(tk_send('item', 'prevsibling', sibling))
    Tk::TreeCtrl::Item.id2obj(self, id)
  end
end
            
Also aliased as: item_prev_sibling
item_range(first, last) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1194
def item_range(first, last)
  simplelist(tk_send('item', 'range', first, last))
end
            
item_remove(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1198
def item_remove(item)
  tk_send('item', 'remove', item)
  self
end
            
item_rnc(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1203
def item_rnc(item)
  list(tk_send('item', 'rnc', item))
end
            
item_sort(item, *opts) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1263
def item_sort(item, *opts)
  _item_sort_core(true, item, *opts)
end
            
item_sort_not_really(item, *opts) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1266
def item_sort_not_really(item, *opts)
  _item_sort_core(false, item, *opts)
end
            
item_span(item, column=nil, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1270
def item_span(item, column=nil, *args)
  if args.empty?
    if column
      list(tk_send('item', 'span', item, column))
    else
      simplelist(tk_send('item', 'span', item)).collect!{|elem| list(elem)}
    end
  else
    tk_send('item', 'span', item, column, *args)
    self
  end
end
            
item_state_for_column(item, column, *args) click to toggle source
item_state_forcolumn(item, column, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1289
def item_state_forcolumn(item, column, *args)
  tk_send('item', 'state', 'forcolumn', item, column, *args)
end
            
Also aliased as: item_state_for_column
item_state_get(item, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1294
def item_state_get(item, *args)
  if args.empty?
    list(tk_send('item', 'state', 'get', item *args))
  else
    bool(tk_send('item', 'state', 'get', item))
  end
end
            
item_state_set(item, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1302
def item_state_set(item, *args)
  tk_send('item', 'state', 'set', item, *args)
end
            
item_style_elements(item, column) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1306
def item_style_elements(item, column)
  list(tk_send('item', 'style', 'elements', item, column)).collect!{|id|
    Tk::TreeCtrl::Style.id2obj(self, id)
  }
end
            
item_style_map(item, column, style, map) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1312
def item_style_map(item, column, style, map)
  tk_send('item', 'style', 'map', item, column, style, map)
  self
end
            
item_style_set(item, column=nil, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1317
def item_style_set(item, column=nil, *args)
  if args.empty?
    if column
      id = tk_send_without_enc('item', 'style', 'set',
                               _get_eval_string(item, true),
                               _get_eval_string(column, true))
      Tk::TreeCtrl::Style.id2obj(self, id)
    else
      list(tk_send_without_enc('item', 'style', 'set',
                               _get_eval_string(item, true))).collect!{|id|
        Tk::TreeCtrl::Style.id2obj(self, id)
      }
    end
  else
    tk_send_without_enc('item', 'style', 'set',
                        _get_eval_string(item, true),
                        _get_eval_string(column, true),
                        *(args.flatten.map!{|arg|
                            _get_eval_string(arg, true)
                          }))
    self
  end
end
            
item_text(item, column, txt=nil, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1341
def item_text(item, column, txt=nil, *args)
  if args.empty?
    if txt
      tk_send('item', 'text', item, column, txt)
      self
    else
      tk_send('item', 'text', item, column)
    end
  else
    tk_send('item', 'text', item, column, txt, *args)
    self
  end
end
            
item_toggle(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1355
def item_toggle(item)
  tk_send('item', 'toggle', item)
  self
end
            
item_toggle_recurse(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1360
def item_toggle_recurse(item)
  tk_send('item', 'toggle', item, '-recurse')
  self
end
            
item_visible(item, st=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1365
def item_visible(item, st=None)
  if st == None
    bool(tk_send('item', 'visible', item))
  else
    tk_send('item', 'visible', item, st)
    self
  end
end
            
item_visible?(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1373
def item_visible?(item)
  item_visible(item)
end
            
item_visible_order(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1174
def item_visible_order(item)
  item_order(item, true)
end
            
items_size() click to toggle source
Alias for: numitems
marquee_anchor(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1377
def marquee_anchor(*args)
  if args.empty?
    list(tk_send('marquee', 'anchor'))
  else
    tk_send('marquee', 'anchor', *args)
    self
  end
end
            
marquee_coords(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1386
def marquee_coords(*args)
  if args.empty?
    list(tk_send('marquee', 'coords'))
  else
    tk_send('marquee', 'coords', *args)
    self
  end
end
            
marquee_corner(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1395
def marquee_corner(*args)
  if args.empty?
    tk_send('marquee', 'corner')
  else
    tk_send('marquee', 'corner', *args)
    self
  end
end
            
marquee_identify() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1404
def marquee_identify()
  list(tk_send('marquee', 'identify')).collect!{|id|
    Tk::TreeCtrl::Item.id2obj(self, id)
  }
end
            
marquee_visible(st=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1410
def marquee_visible(st=None)
  if st == None
    bool(tk_send('marquee', 'visible'))
  else
    tk_send('marquee', 'visible', st)
    self
  end
end
            
marquee_visible?() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1418
def marquee_visible?()
  marquee_visible()
end
            
notify_bind(obj, event, *args) click to toggle source

def #notify_bind(obj, event, cmd=Proc.new, *args)

_bind([@path, 'notify', 'bind', obj], event, cmd, *args)
self

end

 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1426
def notify_bind(obj, event, *args)
  # if args[0].kind_of?(Proc) || args[0].kind_of?(Method)
  if TkComm._callback_entry?(args[0]) || !block_given?
    cmd = args.shift
  else
    cmd = Proc.new
  end
  _bind([@path, 'notify', 'bind', obj], event, cmd, *args)
  self
end
            
notify_bind_append(obj, event, *args) click to toggle source

def #notify_bind_append(obj, event, cmd=Proc.new, *args)

_bind_append([@path, 'notify', 'bind', obj], event, cmd, *args)
self

end

 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1441
def notify_bind_append(obj, event, *args)
  # if args[0].kind_of?(Proc) || args[0].kind_of?(Method)
  if TkComm._callback_entry?(args[0]) || !block_given?
    cmd = args.shift
  else
    cmd = Proc.new
  end
  _bind_append([@path, 'notify', 'bind', obj], event, cmd, *args)
  self
end
            
notify_bind_remove(obj, event) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1452
def notify_bind_remove(obj, event)
  _bind_remove([@path, 'notify', 'bind', obj], event)
  self
end
            
notify_bindinfo(obj, event=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1457
def notify_bindinfo(obj, event=nil)
  _bindinfo([@path, 'notify', 'bind', obj], event)
end
            
notify_detailnames(event) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1461
def notify_detailnames(event)
  list(tk_send('notify', 'detailnames', event))
end
            
notify_eventnames() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1465
def notify_eventnames()
  list(tk_send('notify', 'eventnames'))
end
            
notify_generate(pattern, char_map=None, percents_cmd=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1469
def notify_generate(pattern, char_map=None, percents_cmd=None)
  pattern = "<#{pattern}>"
  tk_send('notify', 'generate', pattern, char_map, percents_cmd)
  self
end
            
notify_install(pattern, percents_cmd=nil, &b) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1475
def notify_install(pattern, percents_cmd=nil, &b)
  pattern = "<#{pattern}>"
  percents_cmd = Proc.new(&b) if !percents_cmd && b
  if percents_cmd
    procedure(tk_send('notify', 'install', pattern, percents_cmd))
  else
    procedure(tk_send('notify', 'install', pattern))
  end
end
            
notify_install_detail(event, detail, percents_cmd=nil, &b) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1485
def notify_install_detail(event, detail, percents_cmd=nil, &b)
  percents_cmd = Proc.new(&b) if !percents_cmd && b
  if percents_cmd
    tk_send('notify', 'install', 'detail', event, detail, percents_cmd)
  else
    tk_send('notify', 'install', 'detail', event, detail)
  end
end
            
notify_install_event(event, percents_cmd=nil, &b) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1494
def notify_install_event(event, percents_cmd=nil, &b)
  percents_cmd = Proc.new(&b) if !percents_cmd && b
  if percents_cmd
    tk_send('notify', 'install', 'event', event, percents_cmd)
  else
    tk_send('notify', 'install', 'event', event)
  end
end
            
notify_linkage(pattern, detail=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1503
def notify_linkage(pattern, detail=None)
  if detail != None
    tk_send('notify', 'linkage', pattern, detail)
  else
    begin
      if pattern.to_s.index(?-)
        # TreeCtrl 1.1 format?
        begin
          tk_send('notify', 'linkage', "<#{pattern}>")
        rescue
          # TreeCtrl 1.0?
          tk_send('notify', 'linkage', pattern)
        end
      else
        # TreeCtrl 1.0 format?
        begin
          tk_send('notify', 'linkage', pattern)
        rescue
          # TreeCtrl 1.1?
          tk_send('notify', 'linkage', "<#{pattern}>")
        end
      end
    end
  end
end
            
notify_unbind(pattern=nil) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1529
def notify_unbind(pattern=nil)
  if pattern
    tk_send('notify', 'unbind', "<#{pattern}>")
  else
    tk_send('notify', 'unbind')
  end
  self
end
            
notify_uninstall(pattern) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1538
def notify_uninstall(pattern)
  pattern = "<#{pattern}>"
  tk_send('notify', 'uninstall', pattern)
  self
end
            
notify_uninstall_detail(event, detail) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1544
def notify_uninstall_detail(event, detail)
  tk_send('notify', 'uninstall', 'detail', event, detail)
  self
end
            
notify_uninstall_event(event) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1549
def notify_uninstall_event(event)
  tk_send('notify', 'uninstall', 'event', event)
  self
end
            
num_columns() click to toggle source
Alias for: numcolumns
num_items() click to toggle source
Alias for: numitems
numcolumns() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1554
def numcolumns()
  num_or_str(tk_send('numcolumns'))
end
            
Also aliased as: num_columns, columns_size
numitems() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1560
def numitems()
  num_or_str(tk_send('numitems'))
end
            
Also aliased as: num_items, items_size
orphans() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1566
def orphans()
  list(tk_send('orphans')).collect!{|id|
    Tk::TreeCtrl::Item.id2obj(self, id)
  }
end
            
range(first, last) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1572
def range(first, last)
  list(tk_send('range', first, last)).collect!{|id|
    Tk::TreeCtrl::Item.id2obj(self, id)
  }
end
            
see(item, column=None, keys={}) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1596
def see(item, column=None, keys={})
  tk_send('see', item, column, *hash_kv(keys))
  self
end
            
selection_add(first, last=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1601
def selection_add(first, last=None)
  tk_send('selection', 'add', first, last)
  self
end
            
selection_anchor(item=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1606
def selection_anchor(item=None)
  id = num_or_str(tk_send('selection', 'anchor', item))
  Tk::TreeCtrl::Item.id2obj(self, id)
end
            
selection_clear(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1611
def selection_clear(*args) # first, last
  tk_send('selection', 'clear', *args)
  self
end
            
selection_count() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1616
def selection_count()
  number(tk_send('selection', 'count'))
end
            
selection_get() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1620
def selection_get()
  list(tk_send('selection', 'get')).collect!{|id|
    Tk::TreeCtrl::Item.id2obj(self, id)
  }
end
            
selection_includes(item) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1626
def selection_includes(item)
  bool(tk_send('selection', 'includes', item))
end
            
selection_modify(sel, desel) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1630
def selection_modify(sel, desel)
  tk_send('selection', 'modify', sel, desel)
  self
end
            
set_item_image(item, col, img, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1109
def set_item_image(item, col, img, *args)
  item_image(item, col, img, *args)
end
            
set_item_span(item, col, num, *args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1285
def set_item_span(item, col, num, *args)
  item_span(item, col, num, *args)
end
            
set_style_layout(style, elem, slot, value=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1705
def set_style_layout(style, elem, slot, value=None)
  if slot.kind_of?(Hash)
    style_layout(style, elem, slot)
  else
    style_layout(style, elem, {slot=>value})
  end
end
            
state_define(name) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1578
def state_define(name)
  tk_send('state', 'define', name)
  self
end
            
state_linkage(name) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1583
def state_linkage(name)
  tk_send('state', 'linkage', name)
end
            
state_names() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1587
def state_names()
  list(tk_send('state', 'names'))
end
            
state_undefine(*names) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1591
def state_undefine(*names)
  tk_send('state', 'undefine', *names)
  self
end
            
style_create(style, keys=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1635
def style_create(style, keys=None)
  if keys && keys != None
    tk_send('style', 'create', style, *hash_kv(keys))
  else
    tk_send('style', 'create', style)
  end
end
            
style_delete(*args) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1643
def style_delete(*args)
  Tk::TreeCtrl::Style::TreeCtrlStyleID_TBL.mutex.synchronize{
    if Tk::TreeCtrl::Style::TreeCtrlStyleID_TBL[self.path]
      args.each{|sty|
        Tk::TreeCtrl::Style::TreeCtrlStyleID_TBL[self.path].delete(sty)
      }
    end
  }
  tk_send('style', 'delete', *args)
  self
end
            
style_elements(style, *elems) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1655
def style_elements(style, *elems)
  if elems.empty?
    list(tk_send('style', 'elements', style)).collect!{|id|
      Tk::TreeCtrl::Element.id2obj(self, id)
    }
  else
    tk_send('style', 'elements', style, elems.flatten)
    self
  end
end
            
style_layout(style, elem, keys=None) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1683
def style_layout(style, elem, keys=None)
  if keys && keys != None
    if keys.kind_of?(Hash)
      tk_send('style', 'layout', style, elem, *hash_kv(keys))
      self
    else
      _conv_style_layout_val(keys,
                             tk_send('style', 'layout',
                                     style, elem, "-#{keys}"))
    end
  else
    ret = Hash.new
    Hash[*simplelist(tk_send('style', 'layout', style, elem))].each{|k, v|
      k = k[1..-1]
      ret[k] = _conv_style_layout_val(k, v)
    }
    ret
  end
end
            
style_names() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1713
def style_names()
  list(tk_send('style', 'names')).collect!{|id|
    Tk::TreeCtrl::Style.id2obj(self, id)
  }
end
            
toggle(*items) click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1719
def toggle(*items)
  tk_send('toggle', *items)
  self
end
            
toggle_recurse() click to toggle source
 
               # File tk/lib/tkextlib/treectrl/tktreectrl.rb, line 1724
def toggle_recurse()
  tk_send('toggle', '-recurse', *items)
  self
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.