Part of kiwi.ui.objectlist View In Hierarchy
Known subclasses: kiwi.ui.objectlist.ObjectTree, kiwi.ui.search.SearchResults, kiwi.ui.widgets.list.List
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)
Method | __init__ | Create a new ObjectList object. |
Method | __len__ | len(list) |
Method | __nonzero__ | if list |
Method | __contains__ | item in list |
Method | __iter__ | for item in list |
Method | __getitem__ | list[n] |
Method | __setitem__ | list[n] = m |
Method | extend | Extend list by appending elements from the iterable |
Method | index | Return first index of value |
Method | count | L.count(item) -> integer -- return number of occurrences of value |
Method | insert | Inserts an instance to the list |
Method | pop | Remove and return item at index (default last) |
Method | reverse | L.reverse() -- reverse *IN PLACE* |
Method | sort | L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; |
Method | sort_by_attribute | Sort by an attribute in the object model. |
Method | set_context_menu | Sets a context-menu (eg, when you right click) for the list. |
Method | prop_set_selection_mode | Undocumented |
Method | prop_get_selection_mode | Undocumented |
Method | get_model | Return treemodel of the current list |
Method | get_treeview | Return treeview of the current list |
Method | get_columns | Undocumented |
Method | get_column_by_name | Returns the name of a column |
Method | get_treeview_column | Get the treeview column given an objectlist column |
Method | set_spinbutton_digits | Set the number of precision digits used by the spinbutton in |
Method | grab_focus | Grabs the focus of the ObjectList |
Method | set_columns | Set columns. |
Method | append | Adds an instance to the list. |
Method | remove | Remove an instance from the list. |
Method | update | Undocumented |
Method | refresh | Reloads the values from all objects. |
Method | set_column_visibility | Undocumented |
Method | get_selection_mode | Undocumented |
Method | set_selection_mode | Undocumented |
Method | unselect_all | Undocumented |
Method | select_paths | Selects a number of rows corresponding to paths |
Method | select | Undocumented |
Method | get_selected | Returns the currently selected object |
Method | get_selected_rows | Returns a list of currently selected objects |
Method | add_list | Allows a list to be loaded, by default clearing it first. |
Method | clear | Removes all the instances of the list |
Method | get_next | Returns the item after instance in the list. |
Method | get_previous | Returns the item before instance in the list. |
Method | get_selected_row_number | Get the selected row number or None if no rows were selected |
Method | double_click | Same as double clicking on the row rowno |
Method | set_headers_visible | Show or hide the headers. |
Method | set_visible_rows | Sets the number of visible rows of the treeview. This is useful to use |
Method | enable_dnd | Enables Drag and Drop from this object list |
Method | get_dnd_targets | Get a list of dnd targets ObjectList supports |
Method | _load | Undocumented |
Method | _setup_columns | Undocumented |
Method | _attach_column | Undocumented |
Method | _select_and_focus_row | Undocumented |
Method | _on_model__row_inserted | Undocumented |
Method | _on_model__row_deleted | Undocumented |
Method | _model_sort_func | This method is used to sort the GtkTreeModel |
Method | _on_selection__changed | This method is used to proxy selection::changed to selection-changed |
Method | _on_scrolled_window__realize | Undocumented |
Method | _on_scrolled_window__size_allocate | Resize the Vertical Scrollbar to make it smaller and let space |
Method | _treeview_search_equal_func | for searching inside the treeview, case-insensitive by default |
Method | _on_treeview_header__button_release_event | Undocumented |
Method | _after_treeview__row_activated | After activated (double clicked or pressed enter) on a row |
Method | _get_selection_or_selected_rows | Undocumented |
Method | _emit_button_press_signal | Undocumented |
Method | _on_treeview__button_press_event | Generic button-press-event handler to be able to catch double clicks |
Method | _on_treeview__source_drag_data_get | Undocumented |
Method | _get_column_button | Return the button widget of a particular TreeViewColumn. |
Method | _setup_popup_button | Put a button on top of the vertical scrollbar to show the popup |
Method | _find_vertical_scrollbar | This method is called from a .forall() method in the ScrolledWindow. |
Method | _get_header_height | Undocumented |
Method | _clear_columns | Undocumented |
Method | _remove | Undocumented |
Inherited from PropertyObject:
Class Method | __class_init__ | Undocumented |
Method | __post_init__ | A hook which is called after the constructor is called. |
Method | get_attribute_names | Undocumented |
Method | is_default_value | Undocumented |
Method | do_set_property | Undocumented |
Method | do_get_property | Undocumented |
Method | _set | Undocumented |
Method | _get | Undocumented |
Parameters | columns | a list of Column s
|
objects | a list of objects to be inserted or None | |
mode | selection mode | |
sortable | whether the user can sort the list | |
model | gtk.TreeModel to use or None to create one |
Parameters | item | |
start | @param stop |
Parameters | index | position to insert the instance at |
instance | the instance to be added (according to the columns spec) | |
select | whether or not the new item should appear selected. |
Parameters | attribute | attribute to sort on (type: string ) |
order | one of gtk.SORT_ASCENDING, gtk.SORT_DESCENDING (type: gtk.SortType ) |
Parameters | menu | context menu (type: ContextMenu ) |
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
Parameters | column | a @Column |
Parameters | column_name | the column name which has the spinbutton (type: str ) |
digits | a number specifying the precision digits (type: int ) |
Parameters | instance | the instance to be added (according to the columns spec) |
select | whether or not the new item should appear selected. |
Parameters | instance | |
select | if true, the previous item will be selected if there is one. |
Parameters | view_only | if True, only force a refresh of the visible part of this objectlist's Treeview. |
Parameters | paths | rows to be selected |
Parameters | instances | a list to be added |
clear | a boolean that specifies whether or not to clear the list |
Parameters | instance | the instance |
Parameters | instance | the instance |
Parameters | value | if true, shows the headers, if false hide then |