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

==========================================================================================================================================
|phoenix_title|  **wx.dataview.DataViewCheckIconText**
==========================================================================================================================================

:ref:`wx.dataview.DataViewCheckIconText`  is used by :ref:`wx.dataview.DataViewCheckIconTextRenderer`  for data transfer. 
         

This class can be converted to and from a `Variant`     . 









|

|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>DataViewCheckIconText</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.DataViewCheckIconText_inheritance.svg" alt="Inheritance diagram of DataViewCheckIconText" 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.DataViewCheckIconText.html" title="wx.dataview.DataViewCheckIconText  is used by wx.dataview.DataViewCheckIconTextRenderer  for data transfer." alt="" coords="5,159,299,188"/> <area shape="rect" id="node2" href="wx.dataview.DataViewIconText.html" title="wx.dataview.DataViewIconText  is used by wx.dataview.DataViewIconTextRenderer  for data transfer." alt="" coords="28,82,276,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="103,5,202,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.dataview.DataViewCheckIconText.__init__`                              Constructor.
:meth:`~wx.dataview.DataViewCheckIconText.GetCheckedState`                       Gets the checked state.
:meth:`~wx.dataview.DataViewCheckIconText.SetCheckedState`                       Sets the checked state.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.dataview.DataViewCheckIconText.CheckedState`                          See :meth:`~wx.dataview.DataViewCheckIconText.GetCheckedState` and :meth:`~wx.dataview.DataViewCheckIconText.SetCheckedState`
================================================================================ ================================================================================


|


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


.. class:: wx.dataview.DataViewCheckIconText(DataViewIconText)

   **Possible constructors**::

       DataViewCheckIconText(text: str='', icon: BitmapBundle=BitmapBundle(),
                             checkedState: CheckBoxState=CHK_UNDETERMINED) -> None
       
       DataViewCheckIconText(other : DataViewCheckIconText) -> None
       
   
   DataViewCheckIconText is used by DataViewCheckIconTextRenderer for
   data transfer.



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, text: str='', icon: BitmapBundle=BitmapBundle(), checkedState: CheckBoxState=CHK_UNDETERMINED)`
      
      Constructor. 
                       
      
      
      :param `text`: 
      :type `text`: string
      :param `icon`: 
      :type `icon`: wx.BitmapBundle
      :param `checkedState`: 
      :type `checkedState`: wx.CheckBoxState
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, other : DataViewCheckIconText)`
      
      
      
      
      :param `other`: 
      :type `other`: wx.dataview.DataViewCheckIconText
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: GetCheckedState(self)

      Gets the checked state. 
                 

      :rtype: `CheckBoxState`     








   .. method:: SetCheckedState(self, state : CheckBoxState)

      Sets the checked state. 
                 


      :param `state`: 
      :type `state`: wx.CheckBoxState




      :rtype: `None`     








   .. attribute:: CheckedState

      See :meth:`~wx.dataview.DataViewCheckIconText.GetCheckedState` and :meth:`~wx.dataview.DataViewCheckIconText.SetCheckedState`