known subclasses: kiwi.ui.search.SearchResults, kiwi.ui.widgets.list.List, kiwi.ui.objectlist.ObjectTree
An enhanced version of GtkTreeView, which provides pythonic wrappers for accessing rows, and optional facilities for column sorting (with types) and column selection.
Items in an ObjectList is stored in objects. Each row represents an object and each column represents an attribute in the object. The column description object must be a subclass of Column. Simple example>>> class Fruit: >>> pass
>>> apple = Fruit() >>> apple.name = 'Apple' >>> apple.description = 'Worm house'
>>> banana = Fruit() >>> banana.name = 'Banana' >>> banana.description = 'Monkey food'
>>> fruits = ObjectList([Column('name'), >>> Column('description')]) >>> fruits.append(apple) >>> fruits.append(banana)
Function | __init__ | Create a new ObjectList object.
|
Function | __len__ | len(list)
|
Function | __nonzero__ | if list
|
Function | __contains__ | item in list
|
Function | __iter__ | for item in list
|
Function | __getitem__ | list[n]
|
Function | __setitem__ | list[n] = m
|
Function | extend | Extend list by appending elements from the iterable
|
Function | index | Return first index of value
|
Function | count | L.count(item) -> integer -- return number of occurrences of value
|
Function | insert | Inserts an instance to the list
|
Function | pop | Remove and return item at index (default last)
|
Function | reverse | L.reverse() -- reverse *IN PLACE*
|
Function | sort | L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*;
|
Function | sort_by_attribute | Sort by an attribute in the object model.
|
Function | prop_set_selection_mode | Undocumented |
Function | prop_get_selection_mode | Undocumented |
Function | _load | Undocumented |
Function | _setup_columns | Undocumented |
Function | _attach_column | Undocumented |
Function | _select_and_focus_row | Undocumented |
Function | _on_model__row_inserted | Undocumented |
Function | _on_model__row_deleted | Undocumented |
Function | _model_sort_func | This method is used to sort the GtkTreeModel
|
Function | _on_selection__changed | This method is used to proxy selection::changed to selection-changed
|
Function | _on_scrolled_window__realize | Undocumented |
Function | _on_scrolled_window__size_allocate | Resize the Vertical Scrollbar to make it smaller and let space
|
Function | _treeview_search_equal_func | for searching inside the treeview, case-insensitive by default
|
Function | _on_treeview_header__button_release_event | Undocumented |
Function | _after_treeview__row_activated | After activated (double clicked or pressed enter) on a row
|
Function | _get_selection_or_selected_rows | Undocumented |
Function | _emit_button_press_signal | Undocumented |
Function | _on_treeview__button_press_event | Generic button-press-event handler to be able to catch double clicks
|
Function | _on_treeview__source_drag_data_get | Undocumented |
Function | _get_column_button | Return the button widget of a particular TreeViewColumn.
|
Function | _setup_popup_button | Put a button on top of the vertical scrollbar to show the popup
|
Function | _find_vertical_scrollbar | This method is called from a .forall() method in the ScrolledWindow.
|
Function | _get_header_height | Undocumented |
Function | get_model | Return treemodel of the current list
|
Function | get_treeview | Return treeview of the current list
|
Function | get_columns | Undocumented |
Function | get_column_by_name | Returns the name of a column
|
Function | get_treeview_column | Get the treeview column given an objectlist column
|
Function | grab_focus | Grabs the focus of the ObjectList
|
Function | _clear_columns | Undocumented |
Function | set_columns | Set columns.
|
Function | append | Adds an instance to the list.
|
Function | _remove | Undocumented |
Function | remove | Remove an instance from the list.
|
Function | update | Undocumented |
Function | refresh | Reloads the values from all objects.
|
Function | set_column_visibility | Undocumented |
Function | get_selection_mode | Undocumented |
Function | set_selection_mode | Undocumented |
Function | unselect_all | Undocumented |
Function | select_paths | Selects a number of rows corresponding to paths
|
Function | select | Undocumented |
Function | get_selected | Returns the currently selected object
|
Function | get_selected_rows | Returns a list of currently selected objects
|
Function | add_list | Allows a list to be loaded, by default clearing it first.
|
Function | clear | Removes all the instances of the list
|
Function | get_next | Returns the item after instance in the list.
|
Function | get_previous | Returns the item before instance in the list.
|
Function | get_selected_row_number | Get the selected row number or None if no rows were selected
|
Function | double_click | Same as double clicking on the row rowno
|
Function | set_headers_visible | Show or hide the headers.
|
Function | set_visible_rows | Sets the number of visible rows of the treeview. This is useful to
use
|
Function | enable_dnd | Enables Drag and Drop from this object list
|
Function | get_dnd_targets | Get a list of dnd targets ObjectList supports
|
Return the button widget of a particular TreeViewColumn.
This hack is needed since that widget is private of the TreeView but we need access to them for Tooltips, right click menus, ...
Use this function at your own risk