.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.grid.GridCellRenderer:

==========================================================================================================================================
|phoenix_title|  **wx.grid.GridCellRenderer**
==========================================================================================================================================

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

You may pass it to the :ref:`wx.grid.GridCellAttr`  (below) to change the format of one given cell or to :meth:`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. 







         



.. seealso:: :ref:`wx.grid.GridCellAutoWrapStringRenderer`, :ref:`wx.grid.GridCellBoolRenderer`, :ref:`wx.grid.GridCellDateTimeRenderer`, :ref:`wx.grid.GridCellEnumRenderer`, :ref:`wx.grid.GridCellFloatRenderer`, :ref:`wx.grid.GridCellNumberRenderer`, :ref:`wx.grid.GridCellStringRenderer`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>GridCellRenderer</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.grid.GridCellRenderer_inheritance.png" alt="Inheritance diagram of GridCellRenderer" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.ClientDataContainer.html" title="This class is a mixin that provides storage and management of 'client data'." alt="" coords="5,5,176,35"/> <area shape="rect" id="node3" href="wx.grid.GridCellRenderer.html" title="This class is responsible for actually drawing the cell in the grid." alt="" coords="85,83,262,112"/> <area shape="rect" id="node2" href="wx.RefCounter.html" title="This class is used to manage reference-counting providing a simple interface and a counter." alt="" coords="201,5,314,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:ref:`wx.grid.GridCellBoolRenderer`, :ref:`wx.grid.GridCellStringRenderer`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.grid.GridCellRenderer.__init__`                                       
:meth:`~wx.grid.GridCellRenderer.Clone`                                          This function must be implemented in derived classes to return a copy of itself.
:meth:`~wx.grid.GridCellRenderer.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.
:meth:`~wx.grid.GridCellRenderer.GetBestSize`                                    Get the preferred size of the cell for its contents.
:meth:`~wx.grid.GridCellRenderer.~wxGridCellRenderer`                            The destructor is private because only :meth:`~GridCellRenderer.DecRef`   can delete us.
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.grid.GridCellRenderer(ClientDataContainer, RefCounter)

   **Possible constructors**::

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



   .. method:: __init__(self)






   .. method:: Clone(self)

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

      :rtype: :ref:`wx.grid.GridCellRenderer`








   .. method:: 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.                  


      :param `grid`: 
      :type `grid`: wx.grid.Grid
      :param `attr`: 
      :type `attr`: wx.grid.GridCellAttr
      :param `dc`: 
      :type `dc`: wx.DC
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `row`: 
      :type `row`: int
      :param `col`: 
      :type `col`: int
      :param `isSelected`: 
      :type `isSelected`: bool







   .. method:: GetBestSize(self, grid, attr, dc, row, col)

      Get the preferred size of the cell for its contents.                  


      :param `grid`: 
      :type `grid`: wx.grid.Grid
      :param `attr`: 
      :type `attr`: wx.grid.GridCellAttr
      :param `dc`: 
      :type `dc`: wx.DC
      :param `row`: 
      :type `row`: int
      :param `col`: 
      :type `col`: int




      :rtype: `Size`     








   .. method:: ~wxGridCellRenderer(self)

      The destructor is private because only :meth:`~wx.RefCounter.DecRef`   can delete us.