These buttons work like regular wx buttons and can be used the same way.
They are very dramatic and add a strong visual and artistic flair to your interface. Use when there is something really significant and a regular button just doesn't cut it.
The buttons are drawn with gradient shading (no bitmaps). They can be any size and support any font.
This source has a self-test. Just run "python roundbutton.py".
Python, 584 lines
Download
Copy to clipboard1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 | # --------------------------------------------------------------------------------- #
# ROUNDBUTTON wxPython IMPLEMENTATION
#
# Edward Sitarski, @ 27 November 2011
#
#
# TODO List
#
# 1) Anything to do?
#
#
# For all kind of problems, requests of enhancements and bug reports, please
# write to me at:
#
# edward.sitarski@gmail.com
#
# End Of Comments
# --------------------------------------------------------------------------------- #
"""
RoundButton is a custom-drawn button class which draws round buttons that look like they are made of glass.
Description
===========
RoundButton is a custom-drawn button class which draws round buttons that look like they are made of glass.
Gradient fills are used extensively, both linear and radially to create the 3d effect.
As no bitmaps are required, RoundButtons can be used to display any sized text.
Yes, they take up a lot of space, but RoundButtons create a dramatic sense of importance to what happens after they are pressed.
Use with care. Lives might be at stake.
Supported Platforms
===================
RoundButton has been tested on the following platforms:
* Windows (Windows XP).
* Linux (Ubuntu)
Window Styles
=============
`No particular window styles are available for this class.`
Events Processing
=================
This class processes the following events:
================= ==================================================
Event Name Description
================= ==================================================
``wx.EVT_BUTTON`` Process a `wx.wxEVT_COMMAND_BUTTON_CLICKED` event, when the button is clicked.
================= ==================================================
License And Version
===================
RoundButton is distributed under the wxPython license.
Latest Revision: Edward Sitarski @ 27 Nov 2011, 17.00 EST
Version 0.1
"""
import wx
import math
import wx.lib.agw.artmanager as AM
HOVER = 1
CLICK = 2
class RoundButtonEvent(wx.PyCommandEvent):
""" Event sent from L{RoundButton} when the button is activated. """
def __init__(self, eventType, eventId):
"""
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier.
"""
wx.PyCommandEvent.__init__(self, eventType, eventId)
self.isDown = False
self.theButton = None
def SetButtonObj(self, btn):
"""
Sets the event object for the event.
:param `btn`: the button object, an instance of L{RoundButton}.
"""
self.theButton = btn
def GetButtonObj(self):
""" Returns the object associated with this event. """
return self.theButton
class RoundButton(wx.PyControl):
""" This is the main class implementation of L{RoundButton}. """
def __init__(self, parent, id=wx.ID_ANY, label="", pos=wx.DefaultPosition,
size=wx.DefaultSize, style=wx.NO_BORDER, validator=wx.DefaultValidator,
name="roundbutton"):
"""
Default class constructor.
:param `parent`: the L{RoundButton} parent;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `label`: the button text label;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the button style (unused);
:param `validator`: the validator associated to the button;
:param `name`: the button name.
"""
wx.PyControl.__init__(self, parent, id, pos, size, style, validator, name)
self.Bind(wx.EVT_PAINT, self.OnPaint)
self.Bind(wx.EVT_ERASE_BACKGROUND, lambda event: None)
self.Bind(wx.EVT_SIZE, self.OnSize)
self.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDown)
self.Bind(wx.EVT_LEFT_UP, self.OnLeftUp)
self.Bind(wx.EVT_LEAVE_WINDOW, self.OnMouseLeave)
self.Bind(wx.EVT_ENTER_WINDOW, self.OnMouseEnter)
self.Bind(wx.EVT_SET_FOCUS, self.OnGainFocus)
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_LEFT_DCLICK, self.OnLeftDown)
self._mouseAction = None
self._hasFocus = False
self._buttonRadius = 0
self.SetLabel(label)
self.InheritAttributes()
self.SetInitialSize(size)
def OnSize(self, event):
"""
Handles the ``wx.EVT_SIZE`` event for L{RoundButton}.
:param `event`: a `wx.SizeEvent` event to be processed.
"""
event.Skip()
self.Refresh()
def _containsEvent( self, event ):
"""
Checks that the event occured in the L{RoundButton} circle.
:param `event`: a `wx.MouseEvent` event.
"""
x, y, width, height = self.GetClientRect()
x += width // 2
y += height // 2
px, py = event.GetPosition().Get()
dx = px - x
dy = py - y
return dx * dx + dy * dy < self._buttonRadius * self._buttonRadius
def OnLeftDown(self, event):
"""
Handles the ``wx.EVT_LEFT_DOWN`` event for L{RoundButton}.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
if not self.IsEnabled() or not self._containsEvent(event):
return
self._mouseAction = CLICK
self.CaptureMouse()
self.Refresh()
event.Skip()
def OnLeftUp(self, event):
"""
Handles the ``wx.EVT_LEFT_UP`` event for L{RoundButton}.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
if not self.IsEnabled() or not self.HasCapture():
return
if self.HasCapture():
self.ReleaseMouse()
if self._containsEvent(event):
self._mouseAction = HOVER
self.Notify()
else:
self._mouseAction = None
self.Refresh()
event.Skip()
def OnMouseEnter(self, event):
"""
Handles the ``wx.EVT_ENTER_WINDOW`` event for L{RoundButton}.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
if not self.IsEnabled():
return
self._mouseAction = HOVER
self.Refresh()
event.Skip()
def OnMouseLeave(self, event):
"""
Handles the ``wx.EVT_LEAVE_WINDOW`` event for L{RoundButton}.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
self._mouseAction = None
self.Refresh()
event.Skip()
def OnGainFocus(self, event):
"""
Handles the ``wx.EVT_SET_FOCUS`` event for L{RoundButton}.
:param `event`: a `wx.FocusEvent` event to be processed.
"""
self._hasFocus = True
self.Refresh()
self.Update()
def OnLoseFocus(self, event):
"""
Handles the ``wx.EVT_KILL_FOCUS`` event for L{RoundButton}.
:param `event`: a `wx.FocusEvent` event to be processed.
"""
self._hasFocus = False
self.Refresh()
self.Update()
def OnKeyDown(self, event):
"""
Handles the ``wx.EVT_KEY_DOWN`` event for L{RoundButton}.
:param `event`: a `wx.KeyEvent` event to be processed.
"""
if self._hasFocus and event.GetKeyCode() == ord(" "):
self._mouseAction = HOVER
self.Refresh()
event.Skip()
def OnKeyUp(self, event):
"""
Handles the ``wx.EVT_KEY_UP`` event for L{RoundButton}.
:param `event`: a `wx.KeyEvent` event to be processed.
"""
if self._hasFocus and event.GetKeyCode() == ord(" "):
self._mouseAction = HOVER
self.Notify()
self.Refresh()
event.Skip()
def SetInitialSize(self, size=None):
"""
Given the current font and bezel width settings, calculate
and set a good size.
:param `size`: an instance of `wx.Size`.
"""
if size is None:
size = wx.DefaultSize
wx.PyControl.SetInitialSize(self, size)
SetBestSize = SetInitialSize
def AcceptsFocus(self):
"""
Can this window be given focus by mouse click?
:note: Overridden from `wx.PyControl`.
"""
return self.IsShown() and self.IsEnabled()
def GetDefaultAttributes(self):
"""
Overridden base class virtual. By default we should use
the same font/colour attributes as the native `wx.Button`.
"""
return wx.Button.GetClassDefaultAttributes()
def ShouldInheritColours(self):
"""
Overridden base class virtual. Buttons usually don't inherit
the parent's colours.
:note: Overridden from `wx.PyControl`.
"""
return False
def Enable(self, enable=True):
"""
Enables/disables the button.
:param `enable`: ``True`` to enable the button, ``False`` to disable it.
:note: Overridden from `wx.PyControl`.
"""
wx.PyControl.Enable(self, enable)
self.Refresh()
def DoGetBestSize(self):
"""
Overridden base class virtual. Determines the best size of the
button based on the label and bezel size.
"""
label = self.GetLabel()
if not label:
return wx.Size(32, 32)
dc = wx.ClientDC(self)
dc.SetFont(self.GetFont())
retWidth, retHeight = dc.GetTextExtent(label)
width = int(max(retWidth, retHeight) * 1.5)
return wx.Size(width, width)
def SetDefault(self):
""" Sets the default button. """
tlw = wx.GetTopLevelParent(self)
if hasattr(tlw, 'SetDefaultItem'):
tlw.SetDefaultItem(self)
def Notify(self):
""" Actually sends a ``wx.EVT_BUTTON`` event to the listener (if any). """
evt = RoundButtonEvent(wx.wxEVT_COMMAND_BUTTON_CLICKED, self.GetId())
evt.SetButtonObj(self)
evt.SetEventObject(self)
self.GetEventHandler().ProcessEvent(evt)
def SetFontToFitLabel(self, font = None):
''' Sets the internal font size so that the label will fit on the button.'''
''' font parameter is used to get the font specificiation only - the size does not matter. '''
''' If no font parameter is given, the current font is used. '''
label = self.GetLabel().strip()
if not label:
return
if not font:
font = self.GetFont()
# Get a known font size based on the font specification.
fontPixels = 48
fontCur = wx.FontFromPixelSize((0,fontPixels), font.GetFamily(), font.GetStyle(), font.GetWeight(),
font.GetUnderlined(), font.GetFaceName(), font.GetEncoding() )
dc = wx.WindowDC( self )
dc.SetFont( fontCur )
lines = label.strip().split('\n')
tw, th = dc.GetTextExtent( lines[0] )
x, y, width, height = self.GetClientRect()
# Get the centre of the button and the drawable radius.
r = min(width, height) // 2
xCenter = x + width // 2
yCenter = y + height // 2
rDrawable = r * 0.80 * 0.93 * 0.95
# For all lines, check the top and bottom corners and get the maximum radius.
r2Max = 0
yCur = yCenter - th * len(lines) / 2.0
for line in lines:
twCur, thCur = dc.GetTextExtent( line )
tx, ty = xCenter - twCur / 2, yCur
dx, dy = tx - xCenter, ty - yCenter
r2Max = max( r2Max, dx*dx + dy*dy )
dy += th
r2Max = max( r2Max, dx*dx + dy*dy )
yCur += th
# Adjust the font size based on the ratio that we would have drawn outside the button circle.
fontPixels *= rDrawable / math.sqrt( r2Max )
fontCur = wx.FontFromPixelSize((0,fontPixels), font.GetFamily(), font.GetStyle(), font.GetWeight(),
font.GetUnderlined(), font.GetFaceName(), font.GetEncoding() )
self.SetFont( fontCur )
def OnPaint(self, event):
"""
Handles the ``wx.EVT_PAINT`` event for L{RoundButton}.
:param `event`: a `wx.PaintEvent` event to be processed.
"""
dc = wx.BufferedPaintDC(self)
am = AM.ArtManager()
gc = wx.GraphicsContext.Create(dc)
dc.SetBackground(wx.Brush(self.GetParent().GetBackgroundColour()))
dc.Clear()
clientRect = self.GetClientRect()
boundaryRect = clientRect
x, y, width, height = clientRect
colour = self.GetForegroundColour()
textColour = am.DarkColour(wx.WHITE, 3.0) if am.IsDark(colour) else am.LightColour(wx.BLACK, 3.0)
pressed = False
if wx.Window.GetCapture() != self:
if self._mouseAction == HOVER:
colour = am.LightColour(colour, 10.0)
else:
colour = am.DarkColour(colour, 10.0)
textColour = am.DarkColour(textColour, 10.0)
pressed = True
r = min(boundaryRect.GetWidth(), boundaryRect.GetHeight()) // 2
xCenter = x + width // 2
yCenter = y + height // 2
gc.SetPen( wx.TRANSPARENT_PEN )
def drawCircle( x, y, r ):
gc.DrawEllipse( x - r, y - r, r * 2, r * 2 )
# Draw the metal ring
gc.SetBrush( gc.CreateRadialGradientBrush(
xCenter, yCenter - r,
xCenter, yCenter - r,
r * 2,
wx.WHITE, wx.Colour(33,33,33) ) )
drawCircle( xCenter, yCenter, r )
rSmaller = r * 0.80
gc.SetBrush( gc.CreateRadialGradientBrush(
xCenter, yCenter + rSmaller,
xCenter, yCenter + rSmaller,
rSmaller * 2,
wx.WHITE, wx.Colour(33,33,33) ) )
drawCircle( xCenter, yCenter, rSmaller )
# Draw the body of the button.
rSmaller *= 0.93
if pressed:
shrink = 0.025
yCenter -= r * shrink / 2.0
dc.SetFont( self.GetFont() )
cRegular = colour
gc.SetBrush( gc.CreateRadialGradientBrush(
xCenter, yCenter + rSmaller * 0.9,
xCenter, yCenter + rSmaller,
rSmaller * 2,
am.LightColour(colour, 75.0), cRegular ) )
drawCircle( xCenter, yCenter, rSmaller )
self._buttonRadius = rSmaller
# Draw the flare at the top of the button (a shaded ellipse with a linear gradient).
gc.SetBrush( gc.CreateLinearGradientBrush(
xCenter - rSmaller, yCenter - rSmaller,
xCenter - rSmaller, yCenter,
am.LightColour(colour, 40.0), am.LightColour(colour, 30.0)) )
# Magic constants to get things to look right.
rWidth = rSmaller * (2.0 * 0.7 * 0.9)
rHeight = rSmaller * (0.8 * 0.9)
gc.DrawEllipse( xCenter - rWidth / 2, yCenter - rSmaller, rWidth, rHeight )
# Draw an outline around the button body.
# Also covers up the gap between the flare and the top edge of the button.
gc.SetPen( wx.Pen(wx.Colour(50,50,50), r * 0.025) )
gc.SetBrush( wx.TRANSPARENT_BRUSH )
gc.DrawEllipse( xCenter - rSmaller, yCenter - rSmaller, rSmaller * 2, rSmaller * 2 )
dc.SetTextForeground( textColour )
label = self.GetLabel().strip()
if not label:
return
lines = label.split('\n')
textWidth, textHeight = dc.GetTextExtent( label[0] )
yText = yCenter - textHeight * len(lines) / 2.0
for line in lines:
dc.DrawText( line, xCenter - dc.GetTextExtent(line)[0] // 2, yText )
yText += textHeight
if __name__ == '__main__':
# Self-test.
app = wx.PySimpleApp()
mainWin = wx.Frame(None,title="roundbutton", size=(1024,600))
mainWin.SetBackgroundColour( wx.WHITE )
vs = wx.BoxSizer( wx.VERTICAL )
hs = wx.BoxSizer( wx.HORIZONTAL )
vs.Add( hs )
# Pure colours seem to work best as they approximate the jewel tones of coloured glass.
btnDefs = [
# Label Colour Use bold Font?
['GO', wx.Colour(0,128,0), True ],
['STOP', wx.Colour(128,0,0), True ],
['SLOW', wx.Colour(100,100,0), True ],
['PANIC', wx.Colour(128,0,0), True ],
['ENGINE\nSTART', wx.Colour(0,128, 0), False ],
['Manual\nOverride', wx.Colour(0,0,128), False ],
['Reload', wx.Colour(0,128,128), False ],
['LAUNCH', wx.Colour(128,0,128), False ],
]
btnSize = 150
# The font size does not matter here - we just it for the properties.
boldFont = wx.FFontFromPixelSize((0,32), wx.DEFAULT, flags=wx.FONTFLAG_BOLD)
for i, (label, colour, boldFlag) in enumerate(btnDefs):
btn = RoundButton(mainWin, wx.ID_ANY, label, size=(btnSize, btnSize))
btn.SetBackgroundColour( wx.WHITE )
btn.SetForegroundColour( colour )
# Call SetFontToFitLabel after setting the size of the button.
if boldFlag:
btn.SetFontToFitLabel( boldFont )
else:
btn.SetFontToFitLabel() # Use the button's default font, but change the font size to fit the label.
if i and i % 4 == 0:
hs = wx.BoxSizer( wx.HORIZONTAL )
vs.Add( hs )
hs.Add( btn, flag=wx.ALL, border = 4 )
mainWin.SetSizer( vs )
mainWin.Show()
app.MainLoop()
|
When you need to the user know that they are about to perform something serious, use a roundbutton for dramatic effect. Add an artistic and dramatic look to your interface, however, they do take up a lot of space.
The code as a self-test so you can run "python roundbutton.py" to see what it does. Remember to set the size of the button before calling SetFontToFitLabel.
See the wxPython documentation about pushbuttons for implementation details.
