Package kiwi :: Package ui :: Module objectlist :: Class ObjectTree
[frames | no frames]

Type ObjectTree

    object --+        
             |        
PropertyObject --+    
                 |    
    object --+   |    
             |   |    
      _GObject --+    
                 |    
        ObjectList --+
                     |
                    ObjectTree


Method Summary
  append(self, parent, instance, select)
Return the appended object
  collapse(self, instance)
This method collapses the row specified by path (hides its child rows, if they exist).
  expand(self, instance, open_all)
This method opens the row specified by path so its children are visible.
  prepend(self, parent, instance, select)
Return the prepended object
    Inherited from ObjectList
  add_list(self, instances, clear)
Allows a list to be loaded, by default clearing it first.
  clear(self)
Removes all the instances of the list
  count(self, item)
L.count(item) -> integer -- return number of occurrences of value
  double_click(self, rowno)
Same as double clicking on the row rowno
  extend(self, iterable)
Extend list by appending elements from the iterable
  get_column_by_name(self, name)
Returns the name of a column
  get_columns(self)
  get_model(self)
Return treemodel of the current list
  get_next(self, instance)
Returns the item after instance in the list.
  get_previous(self, instance)
Returns the item before instance in the list.
  get_selected(self)
Returns the currently selected object If an object is not selected, None is returned
  get_selected_row_number(self)
Return the selected row number or None if no rows were selected
  get_selected_rows(self)
Returns a list of currently selected objects If no objects are selected an empty list is returned
  get_selection_mode(self)
  get_treeview(self)
Return treeview of the current list
  get_treeview_column(self, column)
  index(self, item, start, stop)
Return first index of value
  insert(self, index, item)
L.insert(index, item) -- insert object before index
  pop(self, index)
Remove and return item at index (default last)
  prop_get_selection_mode(self)
  prop_set_selection_mode(self, mode)
  refresh(self, view_only)
Reloads the values from all objects.
  remove(self, instance, select)
Remove an instance from the list.
  reverse(self, pos, item)
L.reverse() -- reverse *IN PLACE*
  select(self, instance, scroll)
  select_paths(self, paths)
Selects a number of rows corresponding to paths
  set_column_visibility(self, column_index, visibility)
  set_columns(self, columns)
  set_headers_visible(self, value)
  set_selection_mode(self, mode)
  set_visible_rows(self, rows)
Sets the number of visible rows of the treeview.
  sort(self, pos, item)
L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1
  unselect_all(self)
  update(self, instance)
    Inherited from PropertyObject
  do_get_property(self, pspec)
  do_set_property(self, pspec, value)
  get_attribute_names(self)
  is_default_value(self, attr, value)

Instance Method Details

append(self, parent, instance, select=False)

Parameters:
parent - Object or None, representing the parent
instance - the instance to be added
select - select the row
Returns:
the appended object
Overrides:
kiwi.ui.objectlist.ObjectList.append

collapse(self, instance)

This method collapses the row specified by path (hides its child rows, if they exist).
Parameters:
instance - an instance to collapse

expand(self, instance, open_all=True)

This method opens the row specified by path so its children are visible.
Parameters:
instance - an instance to expand at
open_all - If True, expand all rows, otherwise just the immediate children

prepend(self, parent, instance, select=False)

Parameters:
parent - Object or None, representing the parent
instance - the instance to be added
select - select the row
Returns:
the prepended object

Generated by Epydoc 2.1 on Mon Jan 29 16:42:58 2007 http://epydoc.sf.net