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

==========================================================================================================================================
|phoenix_title|  **wx.FileDialogCheckBox**
==========================================================================================================================================

Represents a custom checkbox inside :ref:`wx.FileDialog`. 
         

Objects of this class can only be created by :meth:`wx.FileDialogCustomize.AddCheckBox` . 

It is possible to bind to wxEVT_CHECKBOX events on this object, which will be generated when the checkbox is clicked. 

See :ref:`wx.FileDialogCustomControl`  for more information. 


         



.. versionadded:: 4.1/wxWidgets-3.1.7  
     







|

|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>FileDialogCheckBox</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.FileDialogCheckBox_inheritance.svg" alt="Inheritance diagram of FileDialogCheckBox" 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.FileDialogCheckBox.html" title="Represents a custom checkbox inside wx.FileDialog." alt="" coords="22,236,223,265"/> <area shape="rect" id="node2" href="wx.FileDialogCustomControl.html" title="The base class for all wx.FileDialog  custom controls." alt="" coords="5,159,239,188"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="56,82,189,111"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="6,5,105,34"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="129,5,252,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.FileDialogCheckBox.GetValue`                                          Return ``True`` if the checkbox is checked.
:meth:`~wx.FileDialogCheckBox.SetValue`                                          Check or uncheck the checkbox.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.FileDialogCheckBox.Value`                                             See :meth:`~wx.FileDialogCheckBox.GetValue` and :meth:`~wx.FileDialogCheckBox.SetValue`
================================================================================ ================================================================================


|


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


.. class:: wx.FileDialogCheckBox(FileDialogCustomControl)

   Represents a custom checkbox inside FileDialog.



   .. method:: GetValue(self)

      Return ``True`` if the checkbox is checked. 
                 

      :rtype: `bool`








   .. method:: SetValue(self, value : bool)

      Check or uncheck the checkbox. 
                 


      :param `value`: 
      :type `value`: bool




      :rtype: `None`     








   .. attribute:: Value

      See :meth:`~wx.FileDialogCheckBox.GetValue` and :meth:`~wx.FileDialogCheckBox.SetValue`