#------------------------------------------------------------------------------
# Copyright (c) 2011, Enthought, Inc.
# All rights reserved.
#------------------------------------------------------------------------------
import wx
import wx.lib.newevent
from .wx_abstract_button import WxAbstractButton
#: A check box event emitted when the button is clicked.
wxCheckBoxClicked, EVT_CHECKBOX_CLICKED = wx.lib.newevent.NewEvent()
#: A check event emitted when the button value is changed.
wxCheckBoxToggled, EVT_CHECKBOX_TOGGLED = wx.lib.newevent.NewEvent()
class wxProperCheckBox(wx.CheckBox):
""" A custom subclass of wx.CheckBox.
This checkbox emits an EVT_CHECKBOX_CLICKED event whenever the
button is clicked. It also emits an EVT_CHECKBOX_TOGGLED whenever
the checkbox changes state.
"""
def __init__(self, *args, **kwargs):
""" Initialize a wxProperCheckBox.
*args, **kwargs
The positional and keyword arguments required to initialize
a wx.RadioButton.
"""
super(wxProperCheckBox, self).__init__(*args, **kwargs)
self._in_click = False
self.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDown)
self.Bind(wx.EVT_LEFT_UP, self.OnLeftUp)
self.Bind(wx.EVT_CHECKBOX, self.OnToggled)
def OnLeftDown(self, event):
""" Handles the left down mouse event for the check box.
This is first part of generating a click event.
"""
event.Skip()
self._in_click = True
def OnLeftUp(self, event):
""" Handles the left up mouse event for the check box.
This is the second part of generating a click event.
"""
event.Skip()
if self._in_click:
self._in_click = False
event = wxCheckBoxClicked()
wx.PostEvent(self, event)
def OnToggled(self, event):
""" Handles the standard toggle event and emits the custom
toggle event for the check box.
"""
event = wxCheckBoxToggled()
wx.PostEvent(self, event)
def SetValue(self, val):
""" Overrides the default SetValue method to emit proper events.
"""
old = self.GetValue()
if old != val:
super(wxProperCheckBox, self).SetValue(val)
self._last = val
event = wxCheckBoxToggled()
wx.PostEvent(self, event)
[docs]class WxCheckBox(WxAbstractButton):
""" A Wx implementation of an Enaml CheckBox.
"""
#--------------------------------------------------------------------------
# Setup methods
#--------------------------------------------------------------------------
[docs] def create_widget(self, parent, tree):
""" Creates the underlying wxProperCheckBox.
"""
return wxProperCheckBox(parent)
[docs] def create(self, tree):
""" Create and initialize the check box control.
"""
super(WxCheckBox, self).create(tree)
widget = self.widget()
widget.Bind(EVT_CHECKBOX_CLICKED, self.on_clicked)
widget.Bind(EVT_CHECKBOX_TOGGLED, self.on_toggled)
#--------------------------------------------------------------------------
# Abstract API Implementation
#--------------------------------------------------------------------------
[docs] def set_checkable(self, checkable):
""" Sets whether or not the widget is checkable.
"""
# wx doesn't support changing the checkability of a check box
pass
[docs] def get_checked(self):
""" Returns the checked state of the widget.
"""
return self.widget().GetValue()
[docs] def set_checked(self, checked):
""" Sets the widget's checked state with the provided value.
"""
self.widget().SetValue(checked)