wxPython/wxPython/lib/buttons.py

   1 #----------------------------------------------------------------------
   2 # Name:        wxPython.lib.buttons
   3 # Purpose:     Various kinds of generic buttons, (not native controls but
   4 #              self-drawn.)
   5 #
   6 # Author:      Robin Dunn
   7 #
   8 # Created:     9-Dec-1999
   9 # RCS-ID:      $Id$
  10 # Copyright:   (c) 1999 by Total Control Software
  11 # Licence:     wxWindows license
  12 #----------------------------------------------------------------------
  13
  14 """
  15 This module implements various forms of generic buttons, meaning that
  16 they are not built on native controls but are self-drawn.
  17
  18 The wxGenButton is the base.  It acts like a normal button but you
  19 are able to better control how it looks, bevel width, colours, etc.
  20
  21 wxGenBitmapButton is a button with one or more bitmaps that show
  22 the various states the button can be in.
  23
  24 wxGenToggleButton stays depressed when clicked, until clicked again.
  25
  26 wxGenBitmapToggleButton the same but with bitmaps.
  27
  28 """
  29
  30 from wxPython.wx import *
  31
  32 #----------------------------------------------------------------------
  33
  34 class wxGenButtonEvent(wxPyCommandEvent):
  35     def __init__(self, eventType, ID):
  36         wxPyCommandEvent.__init__(self, eventType, ID)
  37         self.isDown = false
  38         self.theButton = None
  39
  40     def SetIsDown(self, isDown):
  41         self.isDown = isDown
  42
  43     def GetIsDown(self):
  44         return self.isDown
  45
  46     def SetButtonObj(self, btn):
  47         self.theButton = btn
  48
  49     def GetButtonObj(self):
  50         return self.theButton
  51
  52
  53 #----------------------------------------------------------------------
  54
  55 class wxGenButton(wxControl):
  56     labelDelta = 1
  57
  58     def __init__(self, parent, ID, label,
  59                  pos = wxDefaultPosition, size = wxDefaultSize,
  60                  style = 0, validator = wxDefaultValidator,
  61                  name = "genbutton"):
  62         if style == 0:
  63             style = wxNO_BORDER
  64         wxControl.__init__(self, parent, ID, pos, size, style, validator, name)
  65
  66         self.up = true
  67         self.bezelWidth = 2
  68         self.hasFocus = false
  69         self.useFocusInd = true
  70
  71         self.SetLabel(label)
  72         self.SetPosition(pos)
  73         font = parent.GetFont()
  74         if not font.Ok():
  75             font = wxSystemSettings_GetSystemFont(wxSYS_DEFAULT_GUI_FONT)
  76         self.SetFont(font)
  77         self.SetBestSize(size)
  78         self.InitColours()
  79
  80         EVT_LEFT_DOWN(self,        self.OnLeftDown)
  81         EVT_LEFT_UP(self,          self.OnLeftUp)
  82         EVT_MOTION(self,           self.OnMotion)
  83         EVT_SET_FOCUS(self,        self.OnGainFocus)
  84         EVT_KILL_FOCUS(self,       self.OnLoseFocus)
  85         EVT_KEY_DOWN(self,         self.OnKeyDown)
  86         EVT_KEY_UP(self,           self.OnKeyUp)
  87         EVT_ERASE_BACKGROUND(self, self.OnEraseBackground)
  88         EVT_PAINT(self,            self.OnPaint)
  89
  90
  91     def SetBestSize(self, size=None):
  92         """
  93         Given the current font and bezel width settings, calculate
  94         and set a good size.
  95         """
  96         if size is None:
  97             size = wxSize(-1,-1)
  98         if type(size) == type(()):
  99             size = wxSize(size[0], size[1])
 100
 101         # make a new size so we don't mess with the one passed in
 102         size = wxSize(size.width, size.height)
 103
 104         w, h, useMin = self._GetLabelSize()
 105         defSize = wxButton_GetDefaultSize()
 106         if size.width == -1:
 107             size.width = 12 + w
 108             if useMin and size.width < defSize.width:
 109                 size.width = defSize.width
 110         if size.height == -1:
 111             size.height = 11 + h
 112             if useMin and size.height < defSize.height:
 113                 size.height = defSize.height
 114
 115         size.width = size.width + self.bezelWidth - 1
 116         size.height = size.height + self.bezelWidth - 1
 117
 118         self.SetSize(size)
 119
 120
 121     def SetBezelWidth(self, width):
 122         """Set the width of the 3D effect"""
 123         self.bezelWidth = width
 124
 125     def GetBezelWidth(self):
 126         """Return the width of the 3D effect"""
 127         return self.bezelWidth
 128
 129     def SetUseFocusIndicator(self, flag):
 130         """Specifiy if a focus indicator (dotted line) should be used"""
 131         self.useFocusInd = flag
 132
 133     def GetUseFocusIndicator(self):
 134         """Return focus indicator flag"""
 135         return self.useFocusInd
 136
 137
 138     def InitColours(self):
 139         faceClr      = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNFACE)
 140         textClr      = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNTEXT)
 141         self.faceDnClr = faceClr
 142         self.SetBackgroundColour(faceClr)
 143         self.SetForegroundColour(textClr)
 144
 145         shadowClr    = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNSHADOW)
 146         highlightClr = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNHIGHLIGHT)
 147         self.shadowPen    = wxPen(shadowClr, 1, wxSOLID)
 148         self.highlightPen = wxPen(highlightClr, 1, wxSOLID)
 149         ##self.focusIndPen  = wxPen(textClr, 1, wxUSER_DASH)
 150         self.focusIndPen = wxPen(textClr, 1, wxDOT)
 151
 152
 153     def SetBackgroundColour(self, colour):
 154         wxWindow.SetBackgroundColour(self, colour)
 155
 156         # Calculate a new set of highlight and shadow colours based on
 157         # the new background colour.  Works okay if the colour is dark...
 158         r, g, b = colour.Get()
 159         fr, fg, fb = min(255,r+32), min(255,g+32), min(255,b+32)
 160         self.faceDnClr = wxColour(fr, fg, fb)
 161         sr, sg, sb = max(0,r-32), max(0,g-32), max(0,b-32)
 162         self.shadowPen = wxPen(wxColour(sr,sg,sb), 1, wxSOLID)
 163         hr, hg, hb = min(255,r+64), min(255,g+64), min(255,b+64)
 164         self.highlightPen = wxPen(wxColour(hr,hg,hb), 1, wxSOLID)
 165
 166
 167     def _GetLabelSize(self):
 168         """ used internally """
 169         w, h = self.GetTextExtent(self.GetLabel())
 170         return w, h, true
 171
 172
 173     def Notify(self):
 174         evt = wxGenButtonEvent(wxEVT_COMMAND_BUTTON_CLICKED, self.GetId())
 175         evt.SetIsDown(not self.up)
 176         evt.SetButtonObj(self)
 177         self.GetEventHandler().ProcessEvent(evt)
 178
 179
 180     def DrawBezel(self, dc, x1, y1, x2, y2):
 181         # draw the upper left sides
 182         if self.up:
 183             dc.SetPen(self.highlightPen)
 184         else:
 185             dc.SetPen(self.shadowPen)
 186         for i in range(self.bezelWidth):
 187             dc.DrawLine(x1+i, y1, x1+i, y2-i)
 188             dc.DrawLine(x1, y1+i, x2-i, y1+i)
 189
 190         # draw the lower right sides
 191         if self.up:
 192             dc.SetPen(self.shadowPen)
 193         else:
 194             dc.SetPen(self.highlightPen)
 195         for i in range(self.bezelWidth):
 196             dc.DrawLine(x1+i, y2-i, x2+1, y2-i)
 197             dc.DrawLine(x2-i, y1+i, x2-i, y2)
 198
 199
 200     def DrawLabel(self, dc, width, height, dw=0, dy=0):
 201         dc.SetFont(self.GetFont())
 202         if self.IsEnabled():
 203             dc.SetTextForeground(self.GetForegroundColour())
 204         else:
 205             dc.SetTextForeground(wxSystemSettings_GetSystemColour(wxSYS_COLOUR_GRAYTEXT))
 206         label = self.GetLabel()
 207         tw, th = dc.GetTextExtent(label)
 208         if not self.up:
 209             dw = dy = self.labelDelta
 210         dc.DrawText(label, (width-tw)/2+dw, (height-th)/2+dy)
 211
 212
 213     def DrawFocusIndicator(self, dc, w, h):
 214         bw = self.bezelWidth
 215         dc.SetLogicalFunction(wxINVERT)
 216         self.focusIndPen.SetColour(self.GetForegroundColour())
 217         ##self.focusIndPen.SetDashes([1,2,1,2])  # This isn't quite working the way I expected...
 218         dc.SetPen(self.focusIndPen)
 219         dc.SetBrush(wxTRANSPARENT_BRUSH)
 220         dc.DrawRectangle(bw+2,bw+2, w-bw*2-4, h-bw*2-4)
 221
 222
 223     def OnPaint(self, event):
 224         (width, height) = self.GetClientSizeTuple()
 225         x1 = y1 = 0
 226         x2 = width-1
 227         y2 = height-1
 228         dc = wxPaintDC(self)
 229         if self.up:
 230             dc.SetBackground(wxBrush(self.GetBackgroundColour(), wxSOLID))
 231         else:
 232             dc.SetBackground(wxBrush(self.faceDnClr, wxSOLID))
 233         dc.Clear()
 234         self.DrawBezel(dc, x1, y1, x2, y2)
 235         self.DrawLabel(dc, width, height)
 236         if self.hasFocus and self.useFocusInd:
 237             self.DrawFocusIndicator(dc, width, height)
 238
 239
 240     def OnEraseBackground(self, event):
 241         pass
 242
 243
 244     def OnLeftDown(self, event):
 245         if not self.IsEnabled():
 246             return
 247         self.up = false
 248         self.CaptureMouse()
 249         self.SetFocus()
 250         self.Refresh()
 251
 252
 253     def OnLeftUp(self, event):
 254         if not self.IsEnabled():
 255             return
 256         if not self.up:    # if the button was down when the mouse was released...
 257             self.Notify()
 258         self.up = true
 259         self.ReleaseMouse()
 260         self.Refresh()
 261
 262
 263     def OnMotion(self, event):
 264         if not self.IsEnabled():
 265             return
 266         if event.LeftIsDown():
 267             x,y = event.GetPositionTuple()
 268             w,h = self.GetClientSizeTuple()
 269             if self.up and x<w and x>=0 and y<h and y>=0:
 270                 self.up = false
 271                 self.Refresh()
 272                 return
 273             if not self.up and (x<0 or y<0 or x>=w or y>=h):
 274                 self.up = true
 275                 self.Refresh()
 276                 return
 277
 278
 279     def OnGainFocus(self, event):
 280         self.hasFocus = true
 281         dc = wxClientDC(self)
 282         w, h = self.GetClientSizeTuple()
 283         if self.useFocusInd:
 284             self.DrawFocusIndicator(dc, w, h)
 285
 286
 287     def OnLoseFocus(self, event):
 288         self.hasFocus = false
 289         dc = wxClientDC(self)
 290         w, h = self.GetClientSizeTuple()
 291         if self.useFocusInd:
 292             self.DrawFocusIndicator(dc, w, h)
 293
 294
 295     def OnKeyDown(self, event):
 296         if self.hasFocus and event.KeyCode() == ord(" "):
 297             self.up = false
 298             self.Refresh()
 299         event.Skip()
 300
 301
 302     def OnKeyUp(self, event):
 303         if self.hasFocus and event.KeyCode() == ord(" "):
 304             self.up = true
 305             self.Notify()
 306             self.Refresh()
 307         event.Skip()
 308
 309
 310 #----------------------------------------------------------------------
 311
 312 class wxGenBitmapButton(wxGenButton):
 313     def __init__(self, parent, ID, bitmap,
 314                  pos = wxDefaultPosition, size = wxDefaultSize,
 315                  style = 0, validator = wxDefaultValidator,
 316                  name = "genbutton"):
 317         self.bmpLabel = bitmap
 318         self.bmpDisabled = None
 319         self.bmpFocus = None
 320         self.bmpSelected = None
 321         wxGenButton.__init__(self, parent, ID, "", pos, size, style, validator, name)
 322
 323
 324     def GetBitmapLabel(self):
 325         return self.bmpLabel
 326     def GetBitmapDisabled(self):
 327         return self.bmpDisabled
 328     def GetBitmapFocus(self):
 329         return self.bmpFocus
 330     def GetBitmapSelected(self):
 331         return self.bmpSelected
 332
 333
 334     def SetBitmapDisabled(self, bitmap):
 335         """Set bitmap to display when the button is disabled"""
 336         self.bmpDisabled = bitmap
 337
 338     def SetBitmapFocus(self, bitmap):
 339         """Set bitmap to display when the button has the focus"""
 340         self.bmpFocus = bitmap
 341         self.SetUseFocusIndicator(false)
 342
 343     def SetBitmapSelected(self, bitmap):
 344         """Set bitmap to display when the button is selected (pressed down)"""
 345         self.bmpSelected = bitmap
 346
 347     def SetBitmapLabel(self, bitmap):
 348         """Set the bitmap to display normally.  This is the only one that is required."""
 349         self.bmpLabel = bitmap
 350
 351
 352     def _GetLabelSize(self):
 353         """ used internally """
 354         if not self.bmpLabel:
 355             return -1, -1, false
 356         return self.bmpLabel.GetWidth()+2, self.bmpLabel.GetHeight()+2, false
 357
 358
 359     def DrawLabel(self, dc, width, height, dw=0, dy=0):
 360         bmp = self.bmpLabel
 361         if self.bmpDisabled and not self.IsEnabled():
 362             bmp = self.bmpDisabled
 363         if self.bmpFocus and self.hasFocus:
 364             bmp = self.bmpFocus
 365         if self.bmpSelected and not self.up:
 366             bmp = self.bmpSelected
 367         bw,bh = bmp.GetWidth(), bmp.GetHeight()
 368         if not self.up:
 369             dw = dy = self.labelDelta
 370         hasMask = bmp.GetMask() != None
 371         dc.DrawBitmap(bmp, (width-bw)/2+dw, (height-bh)/2+dy, hasMask)
 372
 373
 374
 375 #----------------------------------------------------------------------
 376
 377
 378 class __ToggleMixin:
 379     def SetToggle(self, flag):
 380         self.up = not flag
 381
 382     def GetToggle(self):
 383         return not self.up
 384
 385     def OnLeftDown(self, event):
 386         if not self.IsEnabled():
 387             return
 388         self.saveUp = self.up
 389         self.up = not self.up
 390         self.CaptureMouse()
 391         self.SetFocus()
 392         self.Refresh()
 393
 394     def OnLeftUp(self, event):
 395         if not self.IsEnabled():
 396             return
 397         if self.up != self.saveUp:
 398             self.Notify()
 399         self.ReleaseMouse()
 400         self.Refresh()
 401
 402     def OnKeyDown(self, event):
 403         event.Skip()
 404
 405     def OnKeyUp(self, event):
 406         if self.hasFocus and event.KeyCode() == ord(" "):
 407             self.up = not self.up
 408             self.Notify()
 409             self.Refresh()
 410         event.Skip()
 411
 412
 413
 414
 415 class wxGenToggleButton(__ToggleMixin, wxGenButton):
 416     pass
 417
 418 class wxGenBitmapToggleButton(__ToggleMixin, wxGenBitmapButton):
 419     pass
 420
 421 #----------------------------------------------------------------------
 422
 423