Inherits from
- GridModel: enthought.pyface.grid.grid_model.GridModel
Attributes
- alt_theme
The theme to use for alternate row cells (defaults to 'cell_theme):
alt_theme = ATheme
- auto_add_row
The current 'auto_add' row
auto_add_row = Any
- cell_theme
The theme to use for normal cells:
cell_theme = ATheme
- editor
The editor that created this model
editor = Instance(Editor)
- filter
The current filter
filter = Instance(TableFilter, allow_none = True)
- filter_summary
Current filter summary message
filter_summary = Str('All items')
- reverse
Display the table items in reverse order?
reverse = Bool(False)
- selected_theme
The theme to use for selected cells:
selected_theme = ATheme
- sorted
Event fired when the table has been sorted
sorted = Event
Inherited from base classes
Method summary
- __filtered_items(self)
- __get_column(self, col)
- __get_column_formats(self, col)
- __get_column_name(self, col)
- __get_columns(self)
- __get_data_column(self, col)
- __init__(self, **traits)
- __items(self, ordered = True)
- delete_filtered_item_at(self, index)
- dispose(self)
- get_cell_bg_color(self, row, col)
- get_cell_context_menu(self, row, col)
- get_cell_drag_value(self, row, col)
- get_cell_editor(self, row, col)
- get_cell_font(self, row, col)
- get_cell_halignment(self, row, col)
- get_cell_renderer(self, row, col)
- get_cell_selection_value(self, row, col)
- get_cell_text_color(self, row, col)
- get_cell_valignment(self, row, col)
- get_cols_drag_value(self, cols)
- get_cols_selection_value(self, cols)
- get_column_count(self)
- get_column_name(self, index)
- get_column_size(self, index)
- get_filtered_item(self, index = 0)
- get_filtered_items(self)
- get_row_count(self)
- get_row_name(self, index)
- get_rows_drag_value(self, rows)
- get_rows_selection_value(self, rows)
- get_value(self, row, col)
- insert_filtered_item_after(self, index, item)
- is_cell_empty(self, row, col)
- is_cell_read_only(self, row, col)
- is_column_read_only(self, index)
- is_row_read_only(self, index)
- is_valid_cell_value(self, row, col, value)
- no_column_sort(self)
- on_auto_add_row(self)
- raw_index_of(self, row)
- resolve_selection(self, selection_list)
- sort_by_column(self, col, reverse = False)
- update_columns(self)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- delete_columns(self, pos, num_cols)
- delete_rows(self, pos, num_rows)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- fire_content_changed(self)
- fire_structure_changed(self)
- get_column_context_menu(self, col)
- get_row_context_menu(self, row)
- get_row_size(self, row)
- get_type(self, row, col)
- has_traits_interface(self, *interfaces)
- insert_columns(self, pos, num_cols)
- insert_rows(self, pos, num_rows)
- no_row_sort(self)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- set_value(self, row, col, value)
- sort_by_row(self, row, reverse = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __filtered_items(self)
Returns the list of all model objects that pass the current filter.
- __get_column(self, col)
- __get_column_formats(self, col)
- __get_column_name(self, col)
- __get_columns(self)
- __get_data_column(self, col)
Returns a list of model data from the column indexed by col.
- __init__(self, **traits)
Initializes the object.
- __items(self, ordered = True)
Returns the raw list of model objects.
- delete_filtered_item_at(self, index)
Deletes the object at the specified filtered index.
- dispose(self)
Disposes of the model when it is no longer needed.
- get_cell_bg_color(self, row, col)
Returns a wxColour object specifying the background color of the specified cell.
- get_cell_drag_value(self, row, col)
Returns the value to use when the specified cell is dragged or copied and pasted.
- get_cell_editor(self, row, col)
Returns the editor for the specified cell.
- get_cell_font(self, row, col)
Returns a wxFont object specifying the font of the specified cell.
- get_cell_halignment(self, row, col)
Returns a string specifying the horizontal alignment of the specified cell.
Returns 'left' for left alignment, 'right' for right alignment, or 'center' for center alignment.
- get_cell_renderer(self, row, col)
Returns the renderer for the specified cell.
- get_cell_selection_value(self, row, col)
Returns a TraitGridSelection object specifying the data stored in the table at (row, col).
- get_cell_text_color(self, row, col)
Returns a wxColour object specifying the text color of the specified cell.
- get_cell_valignment(self, row, col)
Returns a string specifying the vertical alignment of the specified cell.
Returns 'top' for top alignment, 'bottom' for bottom alignment, or 'center' for center alignment.
- get_cols_drag_value(self, cols)
Returns the value to use when the specified columns are dragged or copied and pasted. The parameter cols is a list of column indexes.
- get_cols_selection_value(self, cols)
Returns a list of TraitGridSelection objects containing the objects corresponding to the grid rows and the traits corresponding to the specified columns.
- get_column_count(self)
Returns the number of columns for this table.
- get_column_name(self, index)
Returns the label of the column specified by the (zero-based) index.
- get_column_size(self, index)
Returns the size in pixels of the column indexed by index. A value of -1 or None means to use the default.
- get_filtered_item(self, index = 0)
Returns a single specified item from those items matching the current filter.
- get_filtered_items(self)
Returns all model items matching the current filter.
- get_row_count(self)
Return the number of rows for this table.
- get_row_name(self, index)
Return the name of the row specified by the (zero-based) index.
- get_rows_drag_value(self, rows)
Returns the value to use when the specified rows are dragged or copied and pasted. The parameter rows is a list of row indexes. If there is only one row listed, then return the corresponding trait object. If more than one row is listed, then return a list of objects.
- get_rows_selection_value(self, rows)
Returns a list of TraitGridSelection objects containing the object corresponding to the selected rows.
- get_value(self, row, col)
Returns the value stored in the table at (row, col).
- insert_filtered_item_after(self, index, item)
Inserts an object after a specified filtered index.
- is_cell_empty(self, row, col)
Returns True if the cell at (row, col) has a None value, and False otherwise.
- is_cell_read_only(self, row, col)
Returns True if the cell at (row, col) is read-only, and False otherwise.
- is_column_read_only(self, index)
Returns True if the column specified by the zero-based index is read-only.
- is_row_read_only(self, index)
Returns True if the row specified by the zero-based index is read-only.
- is_valid_cell_value(self, row, col, value)
Tests whether value is valid for the cell at (row, col). Returns True if value is acceptable, and False otherwise.
- no_column_sort(self)
Resets any sorting being performed on the underlying model.
- on_auto_add_row(self)
Handles the user modifying the current 'auto_add' mode row.
- raw_index_of(self, row)
Returns the raw, unfiltered index corresponding to a specified filtered index.
- resolve_selection(self, selection_list)
Returns a list of (row, col) grid-cell coordinates that correspond to the objects in selection_list. For each coordinate, if the row is -1, it indicates that the entire column is selected. Likewise coordinates with a column of -1 indicate an entire row that is selected. For the TableModel, the objects in selection_list must be TraitGridSelection objects.
- sort_by_column(self, col, reverse = False)
Sorts the model data by the column indexed by col.
- update_columns(self)
Updates the table view when columns have been changed.