# wx.grid.GridCellRenderer¶

This class is responsible for actually drawing the cell in the grid.

You may pass it to the wx.grid.GridCellAttr (below) to change the format of one given cell or to wx.grid.Grid.SetDefaultRenderer to change the view of all cells. This is an abstract class, and you will normally use one of the predefined derived classes or derive your own class from it.

## Class Hierarchy¶

Inheritance diagram for class GridCellRenderer:

## Methods Summary¶

 __init__ Clone This function must be implemented in derived classes to return a copy of itself. Draw Draw the given cell on the provided DC inside the given rectangle using the style specified by the attribute and the default or selected state corresponding to the isSelected value. GetBestHeight Get the preferred height of the cell at the given width. GetBestSize Get the preferred size of the cell for its contents. GetBestWidth Get the preferred width of the cell at the given height. GetMaxBestSize Get the maximum possible size for a cell using this renderer, if possible. ~wxGridCellRenderer The destructor is private because only DecRef can delete us.

## Class API¶

class wx.grid.GridCellRenderer(ClientDataContainer, RefCounter)

Possible constructors:

GridCellRenderer()


This class is responsible for actually drawing the cell in the grid.

### Methods¶

__init__(self)

Clone(self)

This function must be implemented in derived classes to return a copy of itself.

Return type

wx.grid.GridCellRenderer

Draw(self, grid, attr, dc, rect, row, col, isSelected)

Draw the given cell on the provided DC inside the given rectangle using the style specified by the attribute and the default or selected state corresponding to the isSelected value.

This pure virtual function has a default implementation which will prepare the DC using the given attribute: it will draw the rectangle with the background colour from attr and set the text colour and font.

Parameters

GetBestHeight(self, grid, attr, dc, row, col, width)

Get the preferred height of the cell at the given width.

Some renderers may not have a well-defined best size, but only be able to provide the best height at the given width, e.g. this is the case of the standard wx.grid.GridCellAutoWrapStringRenderer. In this case, they should override this method, in addition to GetBestSize .

Parameters
Return type

int

New in version 4.1/wxWidgets-3.1.0.

GetBestSize(self, grid, attr, dc, row, col)

Get the preferred size of the cell for its contents.

This method must be overridden in the derived classes to return the minimal fitting size for displaying the content of the given grid cell.

Parameters
Return type

Size

GetBestWidth(self, grid, attr, dc, row, col, height)

Get the preferred width of the cell at the given height.

See GetBestHeight , this method is symmetric to it.

Parameters
Return type

int

New in version 4.1/wxWidgets-3.1.0.

GetMaxBestSize(self, grid, attr, dc)

Get the maximum possible size for a cell using this renderer, if possible.

This function may be overridden in the derived class if it can return the maximum size needed for displaying the cells rendered it without iterating over all cells. The base class version simply returns wx.DefaultSize , indicating that this is infeasible and that GetBestSize should be called for each cell individually.

Note that this method will only be used if wx.grid.GridTableBase.CanMeasureColUsingSameAttr is overridden to return True.

Parameters
Return type

Size

New in version 4.1/wxWidgets-3.1.4.

~wxGridCellRenderer(self)

The destructor is private because only DecRef can delete us.