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(wxPyControl):
  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         wxPyControl.__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         if wxPlatform == '__WXMSW__':
  83             EVT_LEFT_DCLICK(self,  self.OnLeftDown)
  84         EVT_MOTION(self,           self.OnMotion)
  85         EVT_SET_FOCUS(self,        self.OnGainFocus)
  86         EVT_KILL_FOCUS(self,       self.OnLoseFocus)
  87         EVT_KEY_DOWN(self,         self.OnKeyDown)
  88         EVT_KEY_UP(self,           self.OnKeyUp)
  89         EVT_ERASE_BACKGROUND(self, self.OnEraseBackground)
  90         EVT_PAINT(self,            self.OnPaint)
  91
  92
  93     def SetBestSize(self, size=None):
  94         """
  95         Given the current font and bezel width settings, calculate
  96         and set a good size.
  97         """
  98         if size is None:
  99             size = wxSize(-1,-1)
 100         if type(size) == type(()):
 101             size = wxSize(size[0], size[1])
 102         size = wxSize(size.width, size.height)  # make a copy
 103
 104         best = self.GetBestSize()
 105         if size.width == -1:
 106             size.width = best.width
 107         if size.height == -1:
 108             size.height = best.height
 109
 110         self.SetSize(size)
 111
 112
 113     def DoGetBestSize(self):
 114         """Overridden base class virtual.  Determines the best size of the
 115         button based on the label and bezel size."""
 116         w, h, useMin = self._GetLabelSize()
 117         defSize = wxButton_GetDefaultSize()
 118         width = 12 + w
 119         if useMin and width < defSize.width:
 120            width = defSize.width
 121         height = 11 + h
 122         if useMin and height < defSize.height:
 123             height = defSize.height
 124         width = width + self.bezelWidth - 1
 125         height = height + self.bezelWidth - 1
 126         return (width, height)
 127
 128
 129     def AcceptsFocus(self):
 130         """Overridden base class virtual."""
 131         return self.IsShown() and self.IsEnabled()
 132
 133
 134     def SetBezelWidth(self, width):
 135         """Set the width of the 3D effect"""
 136         self.bezelWidth = width
 137
 138     def GetBezelWidth(self):
 139         """Return the width of the 3D effect"""
 140         return self.bezelWidth
 141
 142     def SetUseFocusIndicator(self, flag):
 143         """Specifiy if a focus indicator (dotted line) should be used"""
 144         self.useFocusInd = flag
 145
 146     def GetUseFocusIndicator(self):
 147         """Return focus indicator flag"""
 148         return self.useFocusInd
 149
 150
 151     def InitColours(self):
 152         faceClr      = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNFACE)
 153         textClr      = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNTEXT)
 154         self.faceDnClr = faceClr
 155         self.SetBackgroundColour(faceClr)
 156         self.SetForegroundColour(textClr)
 157
 158         shadowClr    = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNSHADOW)
 159         highlightClr = wxSystemSettings_GetSystemColour(wxSYS_COLOUR_BTNHIGHLIGHT)
 160         self.shadowPen    = wxPen(shadowClr, 1, wxSOLID)
 161         self.highlightPen = wxPen(highlightClr, 1, wxSOLID)
 162         ##self.focusIndPen  = wxPen(textClr, 1, wxUSER_DASH)
 163         self.focusIndPen = wxPen(textClr, 1, wxDOT)
 164
 165
 166     def SetBackgroundColour(self, colour):
 167         wxPyControl.SetBackgroundColour(self, colour)
 168         colour = self.GetBackgroundColour()
 169
 170         # Calculate a new set of highlight and shadow colours based on
 171         # the new background colour.  Works okay if the colour is dark...
 172         r, g, b = colour.Get()
 173         fr, fg, fb = min(255,r+32), min(255,g+32), min(255,b+32)
 174         self.faceDnClr = wxColour(fr, fg, fb)
 175         sr, sg, sb = max(0,r-32), max(0,g-32), max(0,b-32)
 176         self.shadowPen = wxPen(wxColour(sr,sg,sb), 1, wxSOLID)
 177         hr, hg, hb = min(255,r+64), min(255,g+64), min(255,b+64)
 178         self.highlightPen = wxPen(wxColour(hr,hg,hb), 1, wxSOLID)
 179
 180
 181     def _GetLabelSize(self):
 182         """ used internally """
 183         w, h = self.GetTextExtent(self.GetLabel())
 184         return w, h, true
 185
 186
 187     def Notify(self):
 188         evt = wxGenButtonEvent(wxEVT_COMMAND_BUTTON_CLICKED, self.GetId())
 189         evt.SetIsDown(not self.up)
 190         evt.SetButtonObj(self)
 191         evt.SetEventObject(self)
 192         self.GetEventHandler().ProcessEvent(evt)
 193
 194
 195     def DrawBezel(self, dc, x1, y1, x2, y2):
 196         # draw the upper left sides
 197         if self.up:
 198             dc.SetPen(self.highlightPen)
 199         else:
 200             dc.SetPen(self.shadowPen)
 201         for i in range(self.bezelWidth):
 202             dc.DrawLine(x1+i, y1, x1+i, y2-i)
 203             dc.DrawLine(x1, y1+i, x2-i, y1+i)
 204
 205         # draw the lower right sides
 206         if self.up:
 207             dc.SetPen(self.shadowPen)
 208         else:
 209             dc.SetPen(self.highlightPen)
 210         for i in range(self.bezelWidth):
 211             dc.DrawLine(x1+i, y2-i, x2+1, y2-i)
 212             dc.DrawLine(x2-i, y1+i, x2-i, y2)
 213
 214
 215     def DrawLabel(self, dc, width, height, dw=0, dy=0):
 216         dc.SetFont(self.GetFont())
 217         if self.IsEnabled():
 218             dc.SetTextForeground(self.GetForegroundColour())
 219         else:
 220             dc.SetTextForeground(wxSystemSettings_GetSystemColour(wxSYS_COLOUR_GRAYTEXT))
 221         label = self.GetLabel()
 222         tw, th = dc.GetTextExtent(label)
 223         if not self.up:
 224             dw = dy = self.labelDelta
 225         dc.DrawText(label, (width-tw)/2+dw, (height-th)/2+dy)
 226
 227
 228     def DrawFocusIndicator(self, dc, w, h):
 229         bw = self.bezelWidth
 230         if self.hasFocus:
 231             self.focusIndPen.SetColour(self.GetForegroundColour())
 232         else:
 233             self.focusIndPen.SetColour(self.GetBackgroundColour())
 234         ##self.focusIndPen.SetDashes([1,2,1,2])  # This isn't quite working the way I expected...
 235         dc.SetPen(self.focusIndPen)
 236         dc.SetBrush(wxTRANSPARENT_BRUSH)
 237         dc.DrawRectangle(bw+2,bw+2, w-bw*2-4, h-bw*2-4)
 238
 239
 240     def OnPaint(self, event):
 241         (width, height) = self.GetClientSizeTuple()
 242         x1 = y1 = 0
 243         x2 = width-1
 244         y2 = height-1
 245         dc = wxBufferedPaintDC(self)
 246         if self.up:
 247             dc.SetBackground(wxBrush(self.GetBackgroundColour(), wxSOLID))
 248         else:
 249             dc.SetBackground(wxBrush(self.faceDnClr, wxSOLID))
 250         dc.Clear()
 251         self.DrawBezel(dc, x1, y1, x2, y2)
 252         self.DrawLabel(dc, width, height)
 253         if self.hasFocus and self.useFocusInd:
 254             self.DrawFocusIndicator(dc, width, height)
 255
 256
 257     def OnEraseBackground(self, event):
 258         pass
 259
 260
 261     def OnLeftDown(self, event):
 262         if not self.IsEnabled():
 263             return
 264         self.up = false
 265         self.CaptureMouse()
 266         self.SetFocus()
 267         self.Refresh()
 268         event.Skip()
 269
 270
 271     def OnLeftUp(self, event):
 272         if not self.IsEnabled():
 273             return
 274         self.ReleaseMouse()
 275         if not self.up:    # if the button was down when the mouse was released...
 276             self.Notify()
 277         self.up = true
 278         self.Refresh()
 279         event.Skip()
 280
 281
 282     def OnMotion(self, event):
 283         if not self.IsEnabled():
 284             return
 285         if event.LeftIsDown():
 286             x,y = event.GetPositionTuple()
 287             w,h = self.GetClientSizeTuple()
 288             if self.up and x<w and x>=0 and y<h and y>=0:
 289                 self.up = false
 290                 self.Refresh()
 291                 return
 292             if not self.up and (x<0 or y<0 or x>=w or y>=h):
 293                 self.up = true
 294                 self.Refresh()
 295                 return
 296         event.Skip()
 297
 298
 299     def OnGainFocus(self, event):
 300         self.hasFocus = true
 301         dc = wxClientDC(self)
 302         w, h = self.GetClientSizeTuple()
 303         if self.useFocusInd:
 304             self.DrawFocusIndicator(dc, w, h)
 305
 306
 307     def OnLoseFocus(self, event):
 308         self.hasFocus = false
 309         dc = wxClientDC(self)
 310         w, h = self.GetClientSizeTuple()
 311         if self.useFocusInd:
 312             self.DrawFocusIndicator(dc, w, h)
 313
 314
 315     def OnKeyDown(self, event):
 316         if self.hasFocus and event.KeyCode() == ord(" "):
 317             self.up = false
 318             self.Refresh()
 319         event.Skip()
 320
 321
 322     def OnKeyUp(self, event):
 323         if self.hasFocus and event.KeyCode() == ord(" "):
 324             self.up = true
 325             self.Notify()
 326             self.Refresh()
 327         event.Skip()
 328
 329
 330 #----------------------------------------------------------------------
 331
 332 class wxGenBitmapButton(wxGenButton):
 333     def __init__(self, parent, ID, bitmap,
 334                  pos = wxDefaultPosition, size = wxDefaultSize,
 335                  style = 0, validator = wxDefaultValidator,
 336                  name = "genbutton"):
 337         self.bmpLabel = bitmap
 338         self.bmpDisabled = None
 339         self.bmpFocus = None
 340         self.bmpSelected = None
 341         wxGenButton.__init__(self, parent, ID, "", pos, size, style, validator, name)
 342
 343
 344     def GetBitmapLabel(self):
 345         return self.bmpLabel
 346     def GetBitmapDisabled(self):
 347         return self.bmpDisabled
 348     def GetBitmapFocus(self):
 349         return self.bmpFocus
 350     def GetBitmapSelected(self):
 351         return self.bmpSelected
 352
 353
 354     def SetBitmapDisabled(self, bitmap):
 355         """Set bitmap to display when the button is disabled"""
 356         self.bmpDisabled = bitmap
 357
 358     def SetBitmapFocus(self, bitmap):
 359         """Set bitmap to display when the button has the focus"""
 360         self.bmpFocus = bitmap
 361         self.SetUseFocusIndicator(false)
 362
 363     def SetBitmapSelected(self, bitmap):
 364         """Set bitmap to display when the button is selected (pressed down)"""
 365         self.bmpSelected = bitmap
 366
 367     def SetBitmapLabel(self, bitmap):
 368         """Set the bitmap to display normally.  This is the only one that is required."""
 369         self.bmpLabel = bitmap
 370
 371
 372     def _GetLabelSize(self):
 373         """ used internally """
 374         if not self.bmpLabel:
 375             return -1, -1, false
 376         return self.bmpLabel.GetWidth()+2, self.bmpLabel.GetHeight()+2, false
 377
 378     def DrawLabel(self, dc, width, height, dw=0, dy=0):
 379         bmp = self.bmpLabel
 380         if self.bmpDisabled and not self.IsEnabled():
 381             bmp = self.bmpDisabled
 382         if self.bmpFocus and self.hasFocus:
 383             bmp = self.bmpFocus
 384         if self.bmpSelected and not self.up:
 385             bmp = self.bmpSelected
 386         bw,bh = bmp.GetWidth(), bmp.GetHeight()
 387         if not self.up:
 388             dw = dy = self.labelDelta
 389         hasMask = bmp.GetMask() != None
 390         dc.DrawBitmap(bmp, (width-bw)/2+dw, (height-bh)/2+dy, hasMask)
 391
 392
 393 #----------------------------------------------------------------------
 394
 395
 396 class wxGenBitmapTextButton(wxGenBitmapButton):     # generic bitmapped button with Text Label
 397     def __init__(self, parent, ID, bitmap, label,
 398                  pos = wxDefaultPosition, size = wxDefaultSize,
 399                  style = 0, validator = wxDefaultValidator,
 400                  name = "genbutton"):
 401         wxGenBitmapButton.__init__(self, parent, ID, bitmap, pos, size, style, validator, name)
 402         self.SetLabel(label)
 403
 404
 405     def _GetLabelSize(self):
 406         """ used internally """
 407         w, h = self.GetTextExtent(self.GetLabel())
 408         if not self.bmpLabel:
 409             return w, h, true       # if there isn't a bitmap use the size of the text
 410
 411         w_bmp = self.bmpLabel.GetWidth()+2
 412         h_bmp = self.bmpLabel.GetHeight()+2
 413         width = w + w_bmp
 414         if h_bmp > h:
 415             height = h_bmp
 416         else:
 417             height = h
 418         return width, height, true
 419
 420
 421     def DrawLabel(self, dc, width, height, dw=0, dy=0):
 422         bmp = self.bmpLabel
 423         if bmp != None:     # if the bitmap is used
 424             if self.bmpDisabled and not self.IsEnabled():
 425                 bmp = self.bmpDisabled
 426             if self.bmpFocus and self.hasFocus:
 427                 bmp = self.bmpFocus
 428             if self.bmpSelected and not self.up:
 429                 bmp = self.bmpSelected
 430             bw,bh = bmp.GetWidth(), bmp.GetHeight()
 431             if not self.up:
 432                 dw = dy = self.labelDelta
 433             hasMask = bmp.GetMask() != None
 434         else:
 435             bw = bh = 0     # no bitmap -> size is zero
 436
 437         dc.SetFont(self.GetFont())
 438         if self.IsEnabled():
 439             dc.SetTextForeground(self.GetForegroundColour())
 440         else:
 441             dc.SetTextForeground(wxSystemSettings_GetSystemColour(wxSYS_COLOUR_GRAYTEXT))
 442
 443         label = self.GetLabel()
 444         tw, th = dc.GetTextExtent(label)        # size of text
 445         if not self.up:
 446             dw = dy = self.labelDelta
 447
 448         pos_x = (width-bw-tw)/2+dw      # adjust for bitmap and text to centre
 449         if bmp !=None:
 450             dc.DrawBitmap(bmp, pos_x, (height-bh)/2+dy, hasMask)        # draw bitmap if available
 451             pos_x = pos_x + 2   # extra spacing from bitmap
 452
 453         dc.DrawText(label, pos_x + dw+bw, (height-th)/2+dy)             # draw the text
 454
 455
 456 #----------------------------------------------------------------------
 457
 458
 459 class __ToggleMixin:
 460     def SetToggle(self, flag):
 461         self.up = not flag
 462
 463     def GetToggle(self):
 464         return not self.up
 465
 466     def OnLeftDown(self, event):
 467         if not self.IsEnabled():
 468             return
 469         self.saveUp = self.up
 470         self.up = not self.up
 471         self.CaptureMouse()
 472         self.SetFocus()
 473         self.Refresh()
 474
 475     def OnLeftUp(self, event):
 476         if not self.IsEnabled():
 477             return
 478         if self.up != self.saveUp:
 479             self.Notify()
 480         self.ReleaseMouse()
 481         self.Refresh()
 482
 483     def OnKeyDown(self, event):
 484         event.Skip()
 485
 486     def OnKeyUp(self, event):
 487         if self.hasFocus and event.KeyCode() == ord(" "):
 488             self.up = not self.up
 489             self.Notify()
 490             self.Refresh()
 491         event.Skip()
 492
 493
 494
 495
 496 class wxGenToggleButton(__ToggleMixin, wxGenButton):
 497     pass
 498
 499 class wxGenBitmapToggleButton(__ToggleMixin, wxGenBitmapButton):
 500     pass
 501
 502 class wxGenBitmapTextToggleButton(__ToggleMixin, wxGenBitmapTextButton):
 503     pass
 504
 505 #----------------------------------------------------------------------
 506
 507