.. wxPython Phoenix documentation

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

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

.. include:: headings.inc

.. currentmodule:: wx.lib.mixins.gridlabelrenderer

.. highlight:: python



.. _wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin:

==========================================================================================================================================
|phoenix_title|  **wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin**
==========================================================================================================================================

This class can be mixed with wx.grid.Grid to add the ability to plugin
label renderer objects for the row, column and corner labels, similar to
how the cell renderers work in the main Grid class.



|

|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>GridWithLabelRenderersMixin</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.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin_inheritance.png" alt="Inheritance diagram of GridWithLabelRenderersMixin" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.html" title="This class can be mixed with wx.grid.Grid to add the ability to plugin" alt="" coords="5,5,408,35"/> </map> 
   </p>
   </div>

|


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

=============================================================================================== ================================================================================
:meth:`~wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.__init__`                   Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.SetColLabelRenderer`        Register a renderer to be used for drawing the label for the
:meth:`~wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.SetCornerLabelRenderer`     Sets the renderer that should be used for drawing the area in
:meth:`~wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.SetDefaultColLabelRenderer` Set the column label renderer that should be used for any
:meth:`~wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.SetDefaultRowLabelRenderer` Set the row label renderer that should be used for any row
:meth:`~wx.lib.mixins.gridlabelrenderer.GridWithLabelRenderersMixin.SetRowLabelRenderer`        Register a renderer to be used for drawing the label for the
=============================================================================================== ================================================================================


|


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


.. class:: GridWithLabelRenderersMixin(object)

   This class can be mixed with wx.grid.Grid to add the ability to plugin
   label renderer objects for the row, column and corner labels, similar to
   how the cell renderers work in the main Grid class.

   .. method:: __init__(self)

      Initialize self.  See help(type(self)) for accurate signature.


   .. method:: SetColLabelRenderer(self, col, renderer)

      Register a renderer to be used for drawing the label for the
      given column.


   .. method:: SetCornerLabelRenderer(self, renderer)

      Sets the renderer that should be used for drawing the area in
      the upper left corner of the Grid, between the row labels and
      the column labels.  Defaults to an instance of
      `GridDefaultCornerLabelRenderer`


   .. method:: SetDefaultColLabelRenderer(self, renderer)

      Set the column label renderer that should be used for any
      column that does not have an explicitly set renderer.
      Defaults to an instance of `GridDefaultColLabelRenderer`.


   .. method:: SetDefaultRowLabelRenderer(self, renderer)

      Set the row label renderer that should be used for any row
      that does not have an explicitly set renderer.  Defaults to
      an instance of `GridDefaultRowLabelRenderer`.


   .. method:: SetRowLabelRenderer(self, row, renderer)

      Register a renderer to be used for drawing the label for the
      given row.