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



.. _wx.dataview.DataViewCheckIconTextRenderer:

==========================================================================================================================================
|phoenix_title|  **wx.dataview.DataViewCheckIconTextRenderer**
==========================================================================================================================================

This renderer class shows a checkbox in addition to the icon and text shown by the base class and also allows the user to toggle this checkbox.          

By default this class doesn't allow the user to put the checkbox into the third, i.e. indeterminate, state, even though it can display the state if the program returns the corresponding value from the associated model. Call :meth:`~wx.dataview.DataViewCheckIconTextRenderer.Allow3rdStateForUser`  explicitly if the user should be able to select the 3rd state interactively too. 

This class is used internally by :ref:`wx.dataview.TreeListCtrl`, and can be seen in action in the corresponding sample. 

`Core`       ^^<>< =''>:</>&;&;< =''>\\ </></>           



.. versionadded:: 4.1/wxWidgets-3.1.1  
     







.. seealso:: :ref:`wx.dataview.DataViewIconTextRenderer`, :ref:`wx.dataview.DataViewToggleRenderer`    







|

|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>DataViewCheckIconTextRenderer</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.dataview.DataViewCheckIconTextRenderer_inheritance.png" alt="Inheritance diagram of DataViewCheckIconTextRenderer" 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.dataview.DataViewCheckIconTextRenderer.html" title="This renderer class shows a checkbox in addition to the icon and text shown by the base class and also allows the user to toggle this checkbox." alt="" coords="5,160,317,189"/> <area shape="rect" id="node2" href="wx.dataview.DataViewRenderer.html" title="This class is used by wx.dataview.DataViewCtrl  to render the individual cells." alt="" coords="51,83,271,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="120,5,203,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.dataview.DataViewCheckIconTextRenderer.__init__`                      Create a new renderer.
:meth:`~wx.dataview.DataViewCheckIconTextRenderer.Allow3rdStateForUser`          Allow the user to interactively select the 3rd state for the items rendered by this object.
:meth:`~wx.dataview.DataViewCheckIconTextRenderer.GetDefaultType`                
================================================================================ ================================================================================


|


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


.. class:: wx.dataview.DataViewCheckIconTextRenderer(DataViewRenderer)

   **Possible constructors**::

       DataViewCheckIconTextRenderer(mode=DATAVIEW_CELL_ACTIVATABLE,
                                     align=DVR_DEFAULT_ALIGNMENT)
       
   
   This renderer class shows a checkbox in addition to the icon and text
   shown by the base class and also allows the user to toggle this
   checkbox.



   .. method:: __init__(self, mode=DATAVIEW_CELL_ACTIVATABLE, align=DVR_DEFAULT_ALIGNMENT)

      Create a new renderer.                  

      By default the renderer is activatable, i.e. allows the user to toggle the checkbox.                  


      :param `mode`: 
      :type `mode`: wx.dataview.DataViewCellMode
      :param `align`: 
      :type `align`: int







   .. method:: Allow3rdStateForUser(self, allow=True)

      Allow the user to interactively select the 3rd state for the items rendered by this object.                  

      As described in the class overview, this renderer can always display the 3rd ("indeterminate") checkbox state if the model contains cells with ``wx.CHK_UNDETERMINED`` value, but it doesn't allow the user to set it by default. Call this method to allow this to happen. 




      :param `allow`: If ``True``, interactively clicking a checked cell switches it to the indeterminate value and clicking it again unchecks it. If ``False``, clicking a checked cell switches to the unchecked value, skipping the indeterminate one.   
      :type `allow`: bool




                  





   .. staticmethod:: GetDefaultType()



      :rtype: `string`