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

==========================================================================================================================================
|phoenix_title|  **wx.propgrid.BoolProperty**
==========================================================================================================================================

Basic property with boolean value. 
         

**Supported special attributes:**

- ``PG_BOOL_USE_CHECKBOX``: Set to ``True`` to use check box editor instead of combo box. 
- ``PG_BOOL_USE_DOUBLE_CLICK_CYCLING``: Set to ``True`` to cycle combo box instead showing the list.  



          




|

|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>BoolProperty</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.BoolProperty_inheritance.svg" alt="Inheritance diagram of BoolProperty" 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.BoolProperty.html" title="Basic property with boolean value." alt="" coords="5,159,214,188"/> <area shape="rect" id="node2" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty  is base class for all wx.propgrid.PropertyGrid  properties and as such it is not intended to be instantiated directly." alt="" coords="10,82,209,111"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="60,5,159,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.propgrid.BoolProperty.__init__`                                       
:meth:`~wx.propgrid.BoolProperty.DoSetAttribute`                                 Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.BoolProperty.IntToValue`                                     Converts integer (possibly a choice selection) into `Variant`       value appropriate for this property.
:meth:`~wx.propgrid.BoolProperty.StringToValue`                                  Converts text into `Variant`       value appropriate for this property.
:meth:`~wx.propgrid.BoolProperty.ValueToString`                                  Converts property value into a text representation.
================================================================================ ================================================================================


|


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


.. class:: wx.propgrid.BoolProperty(PGProperty)

   **Possible constructors**::

       BoolProperty(label: str=PG_LABEL, name: str=PG_LABEL, value: bool=False)
                    -> None
       
   
   Basic property with boolean value.



   .. method:: __init__(self, label: str=PG_LABEL, name: str=PG_LABEL, value: bool=False)




      :param `label`: 
      :type `label`: string
      :param `name`: 
      :type `name`: string
      :param `value`: 
      :type `value`: bool




      :rtype: `None`     








   .. method:: DoSetAttribute(self, name : str, value : PGVariant)

      Reimplement this member function to add special handling for attributes of this property. 
                 


                


      :param `name`: 
      :type `name`: string
      :param `value`: 
      :type `value`: PGVariant




      :rtype: `bool`







      :returns: 

         Return ``False`` to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.  







      .. note:: 

         To actually set property attribute values from the application, use :meth:`wx.propgrid.PGProperty.SetAttribute`   instead.   








   .. method:: IntToValue(self, number : int, argFlags: int=0)

      Converts integer (possibly a choice selection) into `Variant`       value appropriate for this property. 
                 




      :param `number`: Integer to be translated into variant.   
      :type `number`: int
      :param `argFlags`: If ``PG_FULL_VALUE``  is set, returns complete, storable value instead of displayable one.  
      :type `argFlags`: int










      :rtype: :ref:`Tuple[bool, PGVariant]`




                  



      :returns: 

         Returns ``True`` if resulting `Variant`       value was different.  







      .. note:: 

   

         - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method. 
         - Default implementation simply assign given int to m_value. 
         - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent. 
         - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).  











   .. method:: StringToValue(self, text : str, argFlags: int=0)

      Converts text into `Variant`       value appropriate for this property. 
                 




      :param `text`: Text to be translated into variant.  
      :type `text`: string
      :param `argFlags`: If ``PG_FULL_VALUE``  is set, returns complete, storable value instead of displayable one (they may be different). If ``PG_COMPOSITE_FRAGMENT``  is set, text is interpreted as a part of composite property string value (as generated by :meth:`ValueToString`   called with this same flag).  
      :type `argFlags`: int










      :rtype: :ref:`Tuple[bool, PGVariant]`




      You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).  
                  



      :returns: 

         Returns ``True`` if resulting `Variant`       value was different.  







      .. note:: 

         Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.  








   .. method:: ValueToString(self, value : PGVariant, argFlags: int=0)

      Converts property value into a text representation. 
                 




      :param `value`: Value to be converted.   
      :type `value`: PGVariant
      :param `argFlags`: If 0 (default value), then displayed string is returned. If ``PG_FULL_VALUE``  is set, returns complete, storable string value instead of displayable. If ``PG_EDITABLE_VALUE``  is set, returns string value that must be editable in textctrl. If ``PG_COMPOSITE_FRAGMENT``  is set, returns text that is appropriate to display as a part of string property's composite text representation.  
      :type `argFlags`: int








      :rtype: `str`




                  



      .. note:: 

         Default implementation calls :meth:`~wx.propgrid.PGProperty.GenerateComposedValue` .