.. 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.propgrid.PGCheckBoxEditor:

==========================================================================================================================================
|phoenix_title|  **wx.propgrid.PGCheckBoxEditor**
==========================================================================================================================================





|

|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>PGCheckBoxEditor</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.propgrid.PGCheckBoxEditor_inheritance.svg" alt="Inheritance diagram of PGCheckBoxEditor" 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.propgrid.PGCheckBoxEditor.html" title="wx.propgrid.PGCheckBoxEditor" alt="" coords="5,159,260,188"/> <area shape="rect" id="node2" href="wx.propgrid.PGEditor.html" title="Base class for custom wx.propgrid.PropertyGrid  editors." alt="" coords="42,82,223,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="83,5,182,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.propgrid.PGCheckBoxEditor.__init__`                                   
:meth:`~wx.propgrid.PGCheckBoxEditor.CreateControls`                             Instantiates editor controls.
:meth:`~wx.propgrid.PGCheckBoxEditor.DrawValue`                                  Draws value for given property.
:meth:`~wx.propgrid.PGCheckBoxEditor.GetName`                                    Returns pointer to the name of the editor.
:meth:`~wx.propgrid.PGCheckBoxEditor.GetValueFromControl`                        Returns value from control, via parameter `variant`.
:meth:`~wx.propgrid.PGCheckBoxEditor.OnEvent`                                    Handles events.
:meth:`~wx.propgrid.PGCheckBoxEditor.SetControlIntValue`                         Sets control's value specifically from int (applies to choice etc.).
:meth:`~wx.propgrid.PGCheckBoxEditor.SetValueToUnspecified`                      Sets value in control to unspecified.
:meth:`~wx.propgrid.PGCheckBoxEditor.UpdateControl`                              Loads value from property to the control.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.propgrid.PGCheckBoxEditor.Name`                                       See :meth:`~wx.propgrid.PGCheckBoxEditor.GetName`
================================================================================ ================================================================================


|


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


.. class:: wx.propgrid.PGCheckBoxEditor(PGEditor)

   **Possible constructors**::

       PGCheckBoxEditor() -> None
       



   .. method:: __init__(self)



      :rtype: `None`     








   .. method:: CreateControls(self, propgrid : PropertyGrid, property : PGProperty, pos : Point, size : Size)

      Instantiates editor controls. 
                 




      :param `propgrid`: :ref:`wx.propgrid.PropertyGrid`  to which the property belongs (use as parent for control).  
      :type `propgrid`: wx.propgrid.PropertyGrid
      :param `property`: Property for which this method is called.  
      :type `property`: wx.propgrid.PGProperty
      :param `pos`: Position, inside :ref:`wx.propgrid.PropertyGrid`, to create control(s) to.  
      :type `pos`: wx.Point
      :param `size`: Initial size for control(s).  
      :type `size`: wx.Size












      :rtype: :ref:`wx.propgrid.PGWindowList`




                  



      .. note:: 

   

         - It is not necessary to call :meth:`wx.EvtHandler.Bind`   for interesting editor events. All events from controls are automatically forwarded to :meth:`wx.propgrid.PGEditor.OnEvent`   and :meth:`wx.propgrid.PGProperty.OnEvent` .  











   .. method:: DrawValue(self, dc : DC, rect : Rect, property : PGProperty, text : str)

      Draws value for given property. 
                 


      :param `dc`: 
      :type `dc`: wx.DC
      :param `rect`: 
      :type `rect`: wx.Rect
      :param `property`: 
      :type `property`: wx.propgrid.PGProperty
      :param `text`: 
      :type `text`: string




      :rtype: `None`     








   .. method:: GetName(self)

      Returns pointer to the name of the editor. 
                 

      For example, PGEditor_TextCtrl has name "TextCtrl". If you don't need to access your custom editor by string name, then you do not need to implement this function. 
                 

      :rtype: `str`








   .. method:: GetValueFromControl(self, variant : PGVariant, property : PGProperty, ctrl : Window)

      Returns value from control, via parameter `variant`. 
                 

      Usually ends up calling property's StringToValue() or IntToValue(). Returns ``True`` if value was different. 
                 


      :param `variant`: 
      :type `variant`: PGVariant
      :param `property`: 
      :type `property`: wx.propgrid.PGProperty
      :param `ctrl`: 
      :type `ctrl`: wx.Window




      :rtype: `bool`








   .. method:: OnEvent(self, propgrid : PropertyGrid, property : PGProperty, wnd_primary : Window, event : Event)

      Handles events. 
                 

      Returns ``True`` if value in control was modified (see :meth:`wx.propgrid.PGProperty.OnEvent`   for more information). 


                


      :param `propgrid`: 
      :type `propgrid`: wx.propgrid.PropertyGrid
      :param `property`: 
      :type `property`: wx.propgrid.PGProperty
      :param `wnd_primary`: 
      :type `wnd_primary`: wx.Window
      :param `event`: 
      :type `event`: wx.Event




      :rtype: `bool`







      .. note:: 

         :ref:`wx.propgrid.PropertyGrid`  will automatically unfocus the editor when  ``wxEVT_TEXT_ENTER``   is received and when it results in property value being modified. This happens regardless of editor type (i.e. behaviour is same for any  :ref:`wx.TextCtrl`  and :ref:`wx.ComboBox`  based editor).   








   .. method:: SetControlIntValue(self, property : PGProperty, ctrl : Window, value : int)

      Sets control's value specifically from int (applies to choice etc.). 
                 


      :param `property`: 
      :type `property`: wx.propgrid.PGProperty
      :param `ctrl`: 
      :type `ctrl`: wx.Window
      :param `value`: 
      :type `value`: int




      :rtype: `None`     








   .. method:: SetValueToUnspecified(self, property : PGProperty, ctrl : Window)

      Sets value in control to unspecified. 
                 


      :param `property`: 
      :type `property`: wx.propgrid.PGProperty
      :param `ctrl`: 
      :type `ctrl`: wx.Window




      :rtype: `None`     








   .. method:: UpdateControl(self, property : PGProperty, ctrl : Window)

      Loads value from property to the control. 
                 


      :param `property`: 
      :type `property`: wx.propgrid.PGProperty
      :param `ctrl`: 
      :type `ctrl`: wx.Window




      :rtype: `None`     








   .. attribute:: Name

      See :meth:`~wx.propgrid.PGCheckBoxEditor.GetName`