fixed indentation error

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

diff --git a/wxPython/wx/lib/buttons.py b/wxPython/wx/lib/buttons.py
index 833f176a576bb7d2e0283f509aedae04cddd7663..f4b9d7b4fbf6db9a7a67f0188a2c8b05a6ad509c 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,8 +30,9 @@ import imageutils
 #----------------------------------------------------------------------
 
 class GenButtonEvent(wx.PyCommandEvent):
 #----------------------------------------------------------------------
 
 class GenButtonEvent(wx.PyCommandEvent):

-    def __init__(self, eventType, ID):
-        wx.PyCommandEvent.__init__(self, eventType, ID)
+    """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
         self.theButton = None
 
         self.isDown = False
         self.theButton = None
 


@@ -60,24 +52,32 @@ 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
 
     labelDelta = 1
 

-    def __init__(self, parent, ID, label,
+    def __init__(self, parent, id=-1, label='',

                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
                  name = "genbutton"):
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
                  name = "genbutton"):

-        if style == 0:
-            style = wx.NO_BORDER
-        wx.PyControl.__init__(self, parent, ID, pos, size, style, validator, name)
+        cstyle = style
+        if cstyle == 0:
+            cstyle = wx.BORDER_NONE
+        wx.PyControl.__init__(self, parent, id, pos, size, cstyle, validator, name)

 
         self.up = True
 
         self.up = True

-        self.bezelWidth = 2

         self.hasFocus = False
         self.hasFocus = False

-        self.useFocusInd = True
+        self.style = style
+        if style & wx.BORDER_NONE:
+            self.bezelWidth = 0
+            self.useFocusInd = False
+        else:
+            self.bezelWidth = 2
+            self.useFocusInd = True

 
         self.SetLabel(label)
         self.InheritAttributes()
 
         self.SetLabel(label)
         self.InheritAttributes()

-        self.SetBestFittingSize(size)
+        self.SetInitialSize(size)

         self.InitColours()
 
         self.Bind(wx.EVT_LEFT_DOWN,        self.OnLeftDown)
         self.InitColours()
 
         self.Bind(wx.EVT_LEFT_DOWN,        self.OnLeftDown)


@@ -89,19 +89,19 @@ class GenButton(wx.PyControl):
         self.Bind(wx.EVT_KILL_FOCUS,       self.OnLoseFocus)
         self.Bind(wx.EVT_KEY_DOWN,         self.OnKeyDown)
         self.Bind(wx.EVT_KEY_UP,           self.OnKeyUp)
         self.Bind(wx.EVT_KILL_FOCUS,       self.OnLoseFocus)
         self.Bind(wx.EVT_KEY_DOWN,         self.OnKeyDown)
         self.Bind(wx.EVT_KEY_UP,           self.OnKeyUp)

-        self.Bind(wx.EVT_ERASE_BACKGROUND, self.OnEraseBackground)

         self.Bind(wx.EVT_PAINT,            self.OnPaint)
 
 
         self.Bind(wx.EVT_PAINT,            self.OnPaint)
 
 

-    def SetBestSize(self, size=None):
+    def SetInitialSize(self, size=None):

         """
         Given the current font and bezel width settings, calculate
         and set a good size.
         """
         if size is None:
             size = wx.DefaultSize            
         """
         Given the current font and bezel width settings, calculate
         and set a good size.
         """
         if size is None:
             size = wx.DefaultSize            

-        wx.PyControl.SetBestFittingSize(self, size)
-
+        wx.PyControl.SetInitialSize(self, size)
+    SetBestSize = SetInitialSize
+    

 
     def DoGetBestSize(self):
         """
 
     def DoGetBestSize(self):
         """


@@ -197,7 +197,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())


@@ -254,26 +256,47 @@ class GenButton(wx.PyControl):
         dc.DrawRectangle(bw+2,bw+2,  w-bw*2-4, h-bw*2-4)
         dc.SetLogicalFunction(wx.COPY)
 
         dc.DrawRectangle(bw+2,bw+2,  w-bw*2-4, h-bw*2-4)
         dc.SetLogicalFunction(wx.COPY)
 

-

     def OnPaint(self, event):
         (width, height) = self.GetClientSizeTuple()
         x1 = y1 = 0
         x2 = width-1
         y2 = height-1
     def OnPaint(self, event):
         (width, height) = self.GetClientSizeTuple()
         x1 = y1 = 0
         x2 = width-1
         y2 = height-1

-        dc = wx.BufferedPaintDC(self)
-        if self.up:
-            dc.SetBackground(wx.Brush(self.GetBackgroundColour(), wx.SOLID))
-        else:
-            dc.SetBackground(wx.Brush(self.faceDnClr, wx.SOLID))
-        dc.Clear()
+
+        dc = wx.PaintDC(self)
+        brush = self.GetBackgroundBrush(dc)
+        if brush is not None:
+            dc.SetBackground(brush)
+            dc.Clear()
+

         self.DrawBezel(dc, x1, y1, x2, y2)
         self.DrawLabel(dc, width, height)
         if self.hasFocus and self.useFocusInd:
             self.DrawFocusIndicator(dc, width, height)
 
 
         self.DrawBezel(dc, x1, y1, x2, y2)
         self.DrawLabel(dc, width, height)
         if self.hasFocus and self.useFocusInd:
             self.DrawFocusIndicator(dc, width, height)
 
 

-    def OnEraseBackground(self, event):
-        pass
+    def GetBackgroundBrush(self, dc):
+        if self.up:
+            colBg = self.GetBackgroundColour()
+            brush = wx.Brush(colBg, wx.SOLID)
+            if self.style & wx.BORDER_NONE:
+                myAttr = self.GetDefaultAttributes()
+                parAttr = self.GetParent().GetDefaultAttributes()
+                myDef = colBg == myAttr.colBg
+                parDef = self.GetParent().GetBackgroundColour() == parAttr.colBg
+                if myDef and parDef:
+                    if wx.Platform == "__WXMAC__":
+                        brush.MacSetTheme(1) # 1 == kThemeBrushDialogBackgroundActive
+                    elif wx.Platform == "__WXMSW__":
+                        if self.DoEraseBackground(dc):
+                            brush = None
+                elif myDef and not parDef:
+                    colBg = self.GetParent().GetBackgroundColour()
+                    brush = wx.Brush(colBg, wx.SOLID)
+        else:
+            # this line assumes that a pressed button should be hilighted with
+            # a solid colour even if the background is supposed to be transparent
+            brush = wx.Brush(self.faceDnClr, wx.SOLID)
+        return brush

 
 
     def OnLeftDown(self, event):
 
 
     def OnLeftDown(self, event):


@@ -294,8 +317,9 @@ class GenButton(wx.PyControl):
             if not self.up:    # if the button was down when the mouse was released...
                 self.Notify()
             self.up = True
             if not self.up:    # if the button was down when the mouse was released...
                 self.Notify()
             self.up = True

-            self.Refresh()
-            event.Skip()
+            if self:           # in case the button was destroyed in the eventhandler
+                self.Refresh()
+                event.Skip()

 
 
     def OnMotion(self, event):
 
 
     def OnMotion(self, event):


@@ -317,29 +341,25 @@ class GenButton(wx.PyControl):
 
     def OnGainFocus(self, event):
         self.hasFocus = True
 
     def OnGainFocus(self, event):
         self.hasFocus = True

-        dc = wx.ClientDC(self)
-        w, h = self.GetClientSizeTuple()
-        if self.useFocusInd:
-            self.DrawFocusIndicator(dc, w, h)
+        self.Refresh()
+        self.Update()

 
 
     def OnLoseFocus(self, event):
         self.hasFocus = False
 
 
     def OnLoseFocus(self, event):
         self.hasFocus = False

-        dc = wx.ClientDC(self)
-        w, h = self.GetClientSizeTuple()
-        if self.useFocusInd:
-            self.DrawFocusIndicator(dc, w, h)
+        self.Refresh()
+        self.Update()

 
 
     def OnKeyDown(self, event):
 
 
     def OnKeyDown(self, event):

-        if self.hasFocus and event.KeyCode() == ord(" "):
+        if self.hasFocus and event.GetKeyCode() == ord(" "):

             self.up = False
             self.Refresh()
         event.Skip()
 
 
     def OnKeyUp(self, event):
             self.up = False
             self.Refresh()
         event.Skip()
 
 
     def OnKeyUp(self, event):

-        if self.hasFocus and event.KeyCode() == ord(" "):
+        if self.hasFocus and event.GetKeyCode() == ord(" "):

             self.up = True
             self.Notify()
             self.Refresh()
             self.up = True
             self.Notify()
             self.Refresh()


@@ -349,7 +369,9 @@ class GenButton(wx.PyControl):
 #----------------------------------------------------------------------
 
 class GenBitmapButton(GenButton):
 #----------------------------------------------------------------------
 
 class GenBitmapButton(GenButton):

-    def __init__(self, parent, ID, bitmap,
+    """A generic bitmap button."""
+
+    def __init__(self, parent, id=-1, bitmap=wx.NullBitmap,

                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
                  name = "genbutton"):
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
                  name = "genbutton"):


@@ -357,7 +379,7 @@ class GenBitmapButton(GenButton):
         self.bmpFocus = None
         self.bmpSelected = None
         self.SetBitmapLabel(bitmap)
         self.bmpFocus = None
         self.bmpSelected = None
         self.SetBitmapLabel(bitmap)

-        GenButton.__init__(self, parent, ID, "", pos, size, style, validator, name)
+        GenButton.__init__(self, parent, id, "", pos, size, style, validator, name)

 
 
     def GetBitmapLabel(self):
 
 
     def GetBitmapLabel(self):


@@ -422,12 +444,13 @@ class GenBitmapButton(GenButton):
 #----------------------------------------------------------------------
 
 
 #----------------------------------------------------------------------
 
 

-class GenBitmapTextButton(GenBitmapButton):     # generic bitmapped button with Text Label
-    def __init__(self, parent, ID, bitmap, label,
+class GenBitmapTextButton(GenBitmapButton):
+    """A generic bitmapped button with text label"""
+    def __init__(self, parent, id=-1, bitmap=wx.NullBitmap, label='',

                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
                  name = "genbutton"):
                  pos = wx.DefaultPosition, size = wx.DefaultSize,
                  style = 0, validator = wx.DefaultValidator,
                  name = "genbutton"):

-        GenBitmapButton.__init__(self, parent, ID, bitmap, pos, size, style, validator, name)
+        GenBitmapButton.__init__(self, parent, id, bitmap, pos, size, style, validator, name)

         self.SetLabel(label)
 
 
         self.SetLabel(label)
 
 


@@ -508,10 +531,10 @@ class __ToggleMixin:
         if not self.IsEnabled() or not self.HasCapture():
             return
         if self.HasCapture():
         if not self.IsEnabled() or not self.HasCapture():
             return
         if self.HasCapture():

-            if self.up != self.saveUp:
-                self.Notify()

             self.ReleaseMouse()
             self.Refresh()
             self.ReleaseMouse()
             self.Refresh()

+            if self.up != self.saveUp:
+                self.Notify()

 
     def OnKeyDown(self, event):
         event.Skip()
 
     def OnKeyDown(self, event):
         event.Skip()


@@ -533,7 +556,7 @@ class __ToggleMixin:
         event.Skip()
 
     def OnKeyUp(self, event):
         event.Skip()
 
     def OnKeyUp(self, event):

-        if self.hasFocus and event.KeyCode() == ord(" "):
+        if self.hasFocus and event.GetKeyCode() == ord(" "):

             self.up = not self.up
             self.Notify()
             self.Refresh()
             self.up = not self.up
             self.Notify()
             self.Refresh()


@@ -543,12 +566,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
 
 #----------------------------------------------------------------------