wx.grid.GridTableBase¶

The almost abstract base class for grid tables.

A grid table is responsible for storing the grid data and, indirectly, grid cell attributes. The data can be stored in the way most convenient for the application but has to be provided in string form to wx.grid.Grid. It is also possible to provide cells values in other formats if appropriate, e.g. as numbers.

This base class is not quite abstract as it implements a trivial strategy for storing the attributes by forwarding it to wx.grid.GridCellAttrProvider and also provides stubs for some other functions. However it does have a number of pure virtual methods which must be implemented in the derived classes.

Class Hierarchy¶

Inheritance diagram for class GridTableBase:

Known Subclasses¶

wx.grid.GridStringTable

Methods Summary¶

`__init__`	Default constructor.
`AppendCols`	Exactly the same as `AppendRows` but for columns.
`AppendRows`	Append additional rows at the end of the table.
`CanGetValueAs`	Returns `True` if the value of the given cell can be accessed as if it were of the specified type.
`CanHaveAttributes`	Returns `True` if this table supports attributes or `False` otherwise.
`CanMeasureColUsingSameAttr`	Override to return `True` if the same attribute can be used for measuring all cells in the given column.
`CanSetValueAs`	Returns `True` if the value of the given cell can be set as if it were of the specified type.
`Clear`	Clear the table contents.
`DeleteCols`	Exactly the same as `DeleteRows` but for columns.
`DeleteRows`	Delete rows from the table.
`GetAttr`	Return the attribute for the given cell.
`GetAttrProvider`	Returns the attribute provider currently being used.
`GetAttrPtr`	Return the attribute for the given cell.
`GetColLabelValue`	Return the label of the specified column.
`GetColsCount`	Return the number of columns in the table.
`GetCornerLabelValue`	Return the label of the grid’s corner.
`GetNumberCols`	Must be overridden to return the number of columns in the table.
`GetNumberRows`	Must be overridden to return the number of rows in the table.
`GetRowLabelValue`	Return the label of the specified row.
`GetRowsCount`	Return the number of rows in the table.
`GetTypeName`	Returns the type of the value in the given cell.
`GetValue`	Must be overridden to implement accessing the table values as text.
`GetValueAsBool`	Returns the value of the given cell as a boolean.
`GetValueAsDouble`	Returns the value of the given cell as a double.
`GetValueAsLong`	Returns the value of the given cell as a long.
`GetView`	Returns the last grid passed to `SetView` .
`InsertCols`	Exactly the same as `InsertRows` but for columns.
`InsertRows`	Insert additional rows into the table.
`IsEmpty`	Same as `IsEmptyCell` but taking wx.grid.GridCellCoords.
`IsEmptyCell`	May be overridden to implement testing for empty cells.
`SetAttr`	Set attribute of the specified cell.
`SetAttrProvider`	Associate this attributes provider with the table.
`SetColAttr`	Set attribute of the specified column.
`SetColLabelValue`	Exactly the same as `SetRowLabelValue` but for columns.
`SetCornerLabelValue`	Set the given label for the grid’s corner.
`SetRowAttr`	Set attribute of the specified row.
`SetRowLabelValue`	Set the given label for the specified row.
`SetValue`	Must be overridden to implement setting the table values as text.
`SetValueAsBool`	Sets the value of the given cell as a boolean.
`SetValueAsDouble`	Sets the value of the given cell as a double.
`SetValueAsLong`	Sets the value of the given cell as a long.
`SetView`	Called by the grid when the table is associated with it.

Properties Summary¶

`AttrProvider`	See `GetAttrProvider` and `SetAttrProvider`
`ColsCount`	See `GetColsCount`
`CornerLabelValue`	See `GetCornerLabelValue` and `SetCornerLabelValue`
`NumberCols`	See `GetNumberCols`
`NumberRows`	See `GetNumberRows`
`RowsCount`	See `GetRowsCount`
`View`	See `GetView` and `SetView`

Class API¶

class wx.grid.GridTableBase(Object)¶

Possible constructors:

GridTableBase() -> None

The almost abstract base class for grid tables.

Methods¶

__init__(self)¶

Default constructor.

Return type:: None

AppendCols(self, numCols=1)¶

Exactly the same as AppendRows but for columns.

Parameters:: numCols (int)
Return type:: bool

AppendRows(self, numRows=1)¶

Append additional rows at the end of the table.

This method is provided in addition to InsertRows as some data models may only support appending rows to them but not inserting them at arbitrary locations. In such case you may implement this method only and leave InsertRows unimplemented.

Parameters:: numRows (int) – The number of rows to add.
Return type:: bool

CanGetValueAs(self, row, col, typeName)¶

Returns True if the value of the given cell can be accessed as if it were of the specified type.

By default the cells can only be accessed as strings. Note that a cell could be accessible in different ways, e.g. a numeric cell may return True for GRID_VALUE_NUMBER but also for GRID_VALUE_STRING indicating that the value can be coerced to a string form.

Parameters:

row (int)
col (int)
typeName (string)

Return type:

bool

CanHaveAttributes(self)¶

Returns True if this table supports attributes or False otherwise.

By default, the table automatically creates a wx.grid.GridCellAttrProvider when this function is called if it had no attribute provider before and returns True.

Return type:: bool

CanMeasureColUsingSameAttr(self, col)¶

Override to return True if the same attribute can be used for measuring all cells in the given column.

This function is provided for optimization purposes: it returns False by default, but can be overridden to return True when all the cells in the same grid column use sensibly the same attribute, i.e. they use the same renderer (either explicitly, or implicitly, due to their type as returned by GetTypeName ) and the font of the same size.

Returning True from this function allows AutoSizeColumns() to skip looking up the attribute and the renderer for each individual cell, which results in very noticeable performance improvements for the grids with many rows.