cleanup

[wxWidgets.git] / wxPython / wx / lib / buttons.py

diff --git a/wxPython/wx/lib/buttons.py b/wxPython/wx/lib/buttons.py
index acc7ee46a475ea16d263a11241cbc0765f5e9fef..adeb59e1333a1076aaf9ad00b7128fa21549546a 100644 (file)
--- a/wxPython/wx/lib/buttons.py
+++ b/wxPython/wx/lib/buttons.py
@@ -18,18 +18,9 @@
 
 """
 This module implements various forms of generic buttons, meaning that
 
 """
 This module implements various forms of generic buttons, meaning that

-they are not built on native controls but are self-drawn.
-
-The GenButton is the base.  It acts like a normal button but you
-are able to better control how it looks, bevel width, colours, etc.
-
-GenBitmapButton is a button with one or more bitmaps that show
-the various states the button can be in.
-
-GenToggleButton stays depressed when clicked, until clicked again.
-
-GenBitmapToggleButton the same but with bitmaps.
-
+they are not built on native controls but are self-drawn.  They act
+like normal buttons but you are able to better control how they look,
+bevel width, colours, etc.

 """
 
 import wx
 """
 
 import wx


@@ -39,6 +30,7 @@ import imageutils
 #----------------------------------------------------------------------
 
 class GenButtonEvent(wx.PyCommandEvent):
 #----------------------------------------------------------------------
 
 class GenButtonEvent(wx.PyCommandEvent):

+    """Event sent from the generic buttons when the button is activated. """

     def __init__(self, eventType, ID):
         wx.PyCommandEvent.__init__(self, eventType, ID)
         self.isDown = False
     def __init__(self, eventType, ID):
         wx.PyCommandEvent.__init__(self, eventType, ID)
         self.isDown = False


@@ -60,6 +52,8 @@ class GenButtonEvent(wx.PyCommandEvent):
 #----------------------------------------------------------------------
 
 class GenButton(wx.PyControl):
 #----------------------------------------------------------------------
 
 class GenButton(wx.PyControl):

+    """A generic button, and base class for the other generic buttons."""
+

     labelDelta = 1
 
     def __init__(self, parent, ID, label,
     labelDelta = 1
 
     def __init__(self, parent, ID, label,


@@ -202,7 +196,9 @@ class GenButton(wx.PyControl):
         wx.PyControl.SetForegroundColour(self, colour)
         self.InitColours()
 
         wx.PyControl.SetForegroundColour(self, colour)
         self.InitColours()
 

-
+    def SetDefault(self):
+        self.GetParent().SetDefaultItem(self)
+        

     def _GetLabelSize(self):
         """ used internally """
         w, h = self.GetTextExtent(self.GetLabel())
     def _GetLabelSize(self):
         """ used internally """
         w, h = self.GetTextExtent(self.GetLabel())


@@ -354,6 +350,8 @@ class GenButton(wx.PyControl):
 #----------------------------------------------------------------------
 
 class GenBitmapButton(GenButton):
 #----------------------------------------------------------------------
 
 class GenBitmapButton(GenButton):

+    """A generic bitmap button."""
+

     def __init__(self, parent, ID, bitmap,
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
     def __init__(self, parent, ID, bitmap,
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,


@@ -427,7 +425,8 @@ class GenBitmapButton(GenButton):
 #----------------------------------------------------------------------
 
 
 #----------------------------------------------------------------------
 
 

-class GenBitmapTextButton(GenBitmapButton):     # generic bitmapped button with Text Label
+class GenBitmapTextButton(GenBitmapButton):
+    """A generic bitmapped button with text label"""

     def __init__(self, parent, ID, bitmap, label,
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
     def __init__(self, parent, ID, bitmap, label,
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,


@@ -548,12 +547,15 @@ class __ToggleMixin:
 
 
 class GenToggleButton(__ToggleMixin, GenButton):
 
 
 class GenToggleButton(__ToggleMixin, GenButton):

+    """A generic toggle button"""

     pass
 
 class GenBitmapToggleButton(__ToggleMixin, GenBitmapButton):
     pass
 
 class GenBitmapToggleButton(__ToggleMixin, GenBitmapButton):

+    """A generic toggle bitmap button"""

     pass
 
 class GenBitmapTextToggleButton(__ToggleMixin, GenBitmapTextButton):
     pass
 
 class GenBitmapTextToggleButton(__ToggleMixin, GenBitmapTextButton):

+    """A generic toggle bitmap button with text label"""

     pass
 
 #----------------------------------------------------------------------
     pass
 
 #----------------------------------------------------------------------