.. 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
Inheritance diagram for class FileDialogCheckBox:
| |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) Check or uncheck the checkbox. :param `value`: :type `value`: bool .. attribute:: Value See :meth:`~wx.FileDialogCheckBox.GetValue` and :meth:`~wx.FileDialogCheckBox.SetValue`