Inherits from
- HasPrivateTraits: enthought.traits.has_traits.HasPrivateTraits
Attributes
- column_sorted
Column model is currently sorted on.
column_sorted = Instance(SheetSortData)
- columns_added
A column was inserted or appended to this model
columns_added = Event
- content_changed
Fire when the content of the underlying sheet model has changed.
content_changed = Event
- row_sorted
A row sort took place
row_sorted = Event
- rows_added
A row was inserted or appended to this model
rows_added = Event
- structure_changed
Fire when the structure of the underlying sheet model has changed.
structure_changed = Event
Inherited from base classes
Method summary
- __init__(self, **traits)
- delete_columns(self, pos, num_cols)
- delete_rows(self, pos, num_rows)
- fire_content_changed(self)
- fire_structure_changed(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_context_menu(self, col)
- get_column_count(self)
- get_column_name(self, index)
- get_column_size(self, col)
- get_row_context_menu(self, row)
- get_row_count(self)
- get_row_name(self, index)
- get_row_size(self, row)
- get_rows_drag_value(self, rows)
- get_rows_selection_value(self, rows)
- get_type(self, row, col)
- get_value(self, row, col)
- insert_columns(self, pos, num_cols)
- insert_rows(self, pos, num_rows)
- 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)
- no_row_sort(self)
- resolve_selection(self, selection_list)
- set_value(self, row, col, value)
- sort_by_column(self, col, reverse = False)
- sort_by_row(self, row, reverse = False)
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)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- 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)
- 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
- __init__(self, **traits)
Creates a new sheet model.
- delete_columns(self, pos, num_cols)
Removes columns pos through pos + num_cols from the model. Subclasses should not override this method, but should override _delete_columns instead.
- delete_rows(self, pos, num_rows)
Removes rows pos through pos + num_rows from the model. Subclasses should not override this method, but should override _delete_rows instead.
- fire_content_changed(self)
Fires the appearance changed event.
- fire_structure_changed(self)
Fires the appearance changed event.
- get_cell_bg_color(self, row, col)
Return a wxColour object specifying what the background color of the specified cell should be.
- get_cell_drag_value(self, row, col)
Return the value to use when the specified cell is dragged or copied and pasted.
- get_cell_editor(self, row, col)
Return the editor for the specified cell.
- get_cell_font(self, row, col)
Return a wxFont object specifying what the font of the specified cell should be.
- get_cell_halignment(self, row, col)
Return a string specifying what the horizontal alignment of the specified cell should be.
Return 'left' for left alignment, 'right' for right alignment, or 'center' for center alignment.
- get_cell_renderer(self, row, col)
Return the renderer for the specified cell.
- get_cell_selection_value(self, row, col)
Return the value stored in the table at (row, col).
- get_cell_text_color(self, row, col)
Return a wxColour object specifying what the text color of the specified cell should be.
- get_cell_valignment(self, row, col)
Return a string specifying what the vertical alignment of the specified cell should be.
Return 'top' for top alignment, 'bottom' for bottom alignment, or 'center' for center alignment.
- get_cols_drag_value(self, cols)
Return the value to use when the specified columns are dragged or copied and pasted. cols is a list of column indexes.
- get_cols_selection_value(self, cols)
Return the value to use when the specified cols are selected. This value should be enough to specify to other listeners what is going on in the sheet. rows is a list of row indexes.
- get_column_count(self)
Return the number of columns for this table.
- get_column_name(self, index)
Return the name of the column specified by the (zero-based) index.
- get_column_size(self, col)
Return the size in pixels of the column indexed by col. A value of -1 or None means use the default.
- 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_row_size(self, row)
Return the size in pixels of the row indexed by 'row'. A value of -1 or None means use the default.
- get_rows_drag_value(self, rows)
Return the value to use when the specified rows are dragged or copied and pasted. rows is a list of row indexes.
- get_rows_selection_value(self, rows)
Return the value to use when the specified rows are selected. This value should be enough to specify to other listeners what is going on in the sheet. rows is a list of row indexes.
- get_type(self, row, col)
Return the value stored in the table at (row, col).
- get_value(self, row, col)
Return the value stored in the table at (row, col).
- insert_columns(self, pos, num_cols)
Inserts columns at pos through pos + num_cols into the model. Subclasses should not override this method, but should override _insert_columns instead.
- insert_rows(self, pos, num_rows)
Inserts rows at pos through pos + num_rows into the model. Subclasses should not override this method, but should override _insert_rows instead.
- is_cell_empty(self, row, col)
Returns True if the cell at (row, col) has a None value, False otherwise.
- is_cell_read_only(self, row, col)
Returns True if the cell at (row, col) is not editable, False otherwise.
- is_column_read_only(self, index)
Return True if the column specified by the zero-based index is read-only.
- is_row_read_only(self, index)
Return 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, False otherwise.
- no_column_sort(self)
Turn off any column sorting of the model data.
- no_row_sort(self)
Turn off any row sorting of the model data.
- resolve_selection(self, selection_list)
Returns a list of (row, col) sheet-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. Note that the objects in selection_list are model-specific.
- set_value(self, row, col, value)
Sets the value of the cell at (row, col) to value.
Raises a ValueError if the value is vetoed.
Note that subclasses should not override this method, but should override the _set_value method instead.
- sort_by_column(self, col, reverse = False)
Sort model data by the column indexed by col. The reverse flag indicates that the sort should be done in reverse.
- sort_by_row(self, row, reverse = False)
Sort model data by the data row indexed by row. The reverse flag indicates that the sort should be done in reverse.