# --------------------------------------------------------------------------------- #
# SUPERTOOLTIP wxPython IMPLEMENTATION
#
# Andrea Gavana, @ 07 October 2008
# Latest Revision: 14 Sep 2011, 21.00 GMT
#
#
# TODO List
#
# 1) Maybe add some more customization like multiline text
# in the header and footer;
# 2) Check whether it's possible to use rounded corners and
# shadows on the Mac
#
#
# For all kind of problems, requests of enhancements and bug reports, please
# write to me at:
#
# andrea.gavana@gmail.com
# andrea.gavana@maerskoil.com
#
# Or, obviously, to the wxPython mailing list!!!
#
#
# End Of Comments
# --------------------------------------------------------------------------------- #
"""
L{SuperToolTip} is a class that mimics the behaviour of `wx.TipWindow` and generic tooltip
windows, although it is a custom-drawn widget.
Description
===========
L{SuperToolTip} is a class that mimics the behaviour of `wx.TipWindow` and generic tooltip
windows, although it is a custom-drawn widget.
This class supports:
* Blended triple-gradient for the tooltip background;
* Header text and header image, with possibility to set the header font indipendently;
* Footer text and footer image, with possibility to set the footer font indipendently;
* Multiline text message in the tooltip body, plus an optional image as "body image";
* Bold lines and hyperlink lines in the tooltip body;
* A wide set of predefined drawing styles for the tooltip background;
* Drawing of separator lines after the header and/or before the footer;
* Rounded corners and shadows below the tooltip window (Windows XP only);
* Fade in/fade out effects (Windows XP only);
* User-settable delays for the delay after which the tooltip appears and the delay
after which the tooltip is destroyed.
And a lot more. Check the demo for an almost complete review of the functionalities.
Usage
=====
Usage example::
import wx
import wx.lib.agw.supertooltip as STT
class MyFrame(wx.Frame):
def __init__(self, parent):
wx.Frame.__init__(self, parent, -1, "SuperToolTip Demo")
panel = wx.Panel(self)
button = wx.Button(panel, -1, "I am the SuperToolTip target", pos=(100, 50))
tip = STT.SuperToolTip("A nice tooltip message")
tip.SetHeader("Hello World")
tip.SetTarget(button)
tip.SetDrawHeaderLine(True)
tip.ApplyStyle("Office 2007 Blue")
tip.SetDropShadow(True)
# our normal wxApp-derived class, as usual
app = wx.PySimpleApp()
frame = MyFrame(None)
app.SetTopWindow(frame)
frame.Show()
app.MainLoop()
Supported Platforms
===================
L{SuperToolTip} has been tested on the following platforms:
* Windows (Windows XP).
Window Styles
=============
`No particular window styles are available for this class.`
Events Processing
=================
`No custom events are available for this class.`
License And Version
===================
L{SuperToolTip} is distributed under the wxPython license.
Latest Revision: Andrea Gavana @ 14 Sep 2011, 21.00 GMT
Version 0.4
"""
import wx
import webbrowser
# Let's see if we can add few nice shadows to our tooltips (Windows only)
_libimported = None
if wx.Platform == "__WXMSW__":
osVersion = wx.GetOsVersion()
# Shadows behind menus are supported only in XP
if osVersion[1] == 5 and osVersion[2] == 1:
try:
# Try Mark Hammond's win32all extensions
import win32api
import win32con
import win32gui
import winxpgui
_libimported = "MH"
except ImportError:
_libimported = None
else:
_libimported = None
# Define a bunch of predefined colour schemes...
_colourSchemes = {"Beige": (wx.Colour(255,255,255), wx.Colour(242,242,223), wx.Colour(198,195,160), wx.Colour(0,0,0)),
"Blue": (wx.Colour(255,255,255), wx.Colour(202,220,246), wx.Colour(150,180,222), wx.Colour(0,0,0)),
"Blue 2": (wx.Colour(255,255,255), wx.Colour(228,236,248), wx.Colour(198,214,235), wx.Colour(0,0,0)),
"Blue 3": (wx.Colour(255,255,255), wx.Colour(213,233,243), wx.Colour(151,195,216), wx.Colour(0,0,0)),
"Blue 4": (wx.Colour(255,255,255), wx.Colour(227,235,255), wx.Colour(102,153,255), wx.Colour(0,0,0)),
"Blue Glass": (wx.Colour(182,226,253), wx.Colour(137,185,232), wx.Colour(188,244,253), wx.Colour(0,0,0)),
"Blue Glass 2": (wx.Colour(192,236,255), wx.Colour(147,195,242), wx.Colour(198,254,255), wx.Colour(0,0,0)),
"Blue Glass 3": (wx.Colour(212,255,255), wx.Colour(167,215,255), wx.Colour(218,255,255), wx.Colour(0,0,0)),
"Blue Inverted": (wx.Colour(117,160,222), wx.Colour(167,210,240), wx.Colour(233,243,255), wx.Colour(0,0,0)),
"Blue Shift": (wx.Colour(124,178,190), wx.Colour(13,122,153), wx.Colour(0,89,116), wx.Colour(255,255,255)),
"CodeProject": (wx.Colour(255,250,172), wx.Colour(255,207,157), wx.Colour(255,153,0), wx.Colour(0,0,0)),
"Dark Gray": (wx.Colour(195,195,195), wx.Colour(168,168,168), wx.Colour(134,134,134), wx.Colour(255,255,255)),
"Deep Purple": (wx.Colour(131,128,164), wx.Colour(112,110,143), wx.Colour(90,88,117), wx.Colour(255,255,255)),
"Electric Blue": (wx.Colour(224,233,255), wx.Colour(135,146,251), wx.Colour(99,109,233), wx.Colour(0,0,0)),
"Firefox": (wx.Colour(255,254,207), wx.Colour(254,248,125), wx.Colour(225,119,24), wx.Colour(0,0,0)),
"Gold": (wx.Colour(255,202,0), wx.Colour(255,202,0), wx.Colour(255,202,0), wx.Colour(0,0,0)),
"Gold Shift": (wx.Colour(178,170,107), wx.Colour(202,180,32), wx.Colour(162,139,1), wx.Colour(255,255,255)),
"Gray": (wx.Colour(255,255,255), wx.Colour(228,228,228), wx.Colour(194,194,194), wx.Colour(0,0,0)),
"Green": (wx.Colour(234,241,223), wx.Colour(211,224,180), wx.Colour(182,200,150), wx.Colour(0,0,0)),
"Green Shift": (wx.Colour(129,184,129), wx.Colour(13,185,15), wx.Colour(1,125,1), wx.Colour(255,255,255)),
"Light Green": (wx.Colour(174,251,171), wx.Colour(145,221,146), wx.Colour(90,176,89), wx.Colour(0,0,0)),
"NASA Blue": (wx.Colour(0,91,134), wx.Colour(0,100,150), wx.Colour(0,105,160), wx.Colour(255,255,255)),
"Office 2007 Blue": (wx.Colour(255,255,255), wx.Colour(242,246,251), wx.Colour(202,218,239), wx.Colour(76,76,76)),
"Orange Shift": (wx.Colour(179,120,80), wx.Colour(183,92,19), wx.Colour(157,73,1), wx.Colour(255,255,255)),
"Outlook Green": (wx.Colour(236,242,208), wx.Colour(219,230,187), wx.Colour(195,210,155), wx.Colour(0,0,0)),
"Pale Green": (wx.Colour(249,255,248), wx.Colour(206,246,209), wx.Colour(148,225,155), wx.Colour(0,0,0)),
"Pink Blush": (wx.Colour(255,254,255), wx.Colour(255,231,242), wx.Colour(255,213,233), wx.Colour(0,0,0)),
"Pink Shift": (wx.Colour(202,135,188), wx.Colour(186,8,158), wx.Colour(146,2,116), wx.Colour(255,255,255)),
"Pretty Pink": (wx.Colour(255,240,249), wx.Colour(253,205,217), wx.Colour(255,150,177), wx.Colour(0,0,0)),
"Red": (wx.Colour(255,183,176), wx.Colour(253,157,143), wx.Colour(206,88,78), wx.Colour(0,0,0)),
"Red Shift": (wx.Colour(186,102,102), wx.Colour(229,23,9), wx.Colour(182,11,1), wx.Colour(255,255,255)),
"Silver": (wx.Colour(255,255,255), wx.Colour(242,242,246), wx.Colour(212,212,224), wx.Colour(0,0,0)),
"Silver 2": (wx.Colour(255,255,255), wx.Colour(242,242,248), wx.Colour(222,222,228), wx.Colour(0,0,0)),
"Silver Glass": (wx.Colour(158,158,158), wx.Colour(255,255,255), wx.Colour(105,105,105), wx.Colour(0,0,0)),
"Silver Inverted": (wx.Colour(161,160,186), wx.Colour(199,201,213), wx.Colour(255,255,255), wx.Colour(0,0,0)),
"Silver Inverted 2": (wx.Colour(181,180,206), wx.Colour(219,221,233), wx.Colour(255,255,255), wx.Colour(0,0,0)),
"Soylent Green": (wx.Colour(134,211,131), wx.Colour(105,181,106), wx.Colour(50,136,49), wx.Colour(255,255,255)),
"Spring Green": (wx.Colour(154,231,151), wx.Colour(125,201,126), wx.Colour(70,156,69), wx.Colour(255,255,255)),
"Too Blue": (wx.Colour(255,255,255), wx.Colour(225,235,244), wx.Colour(188,209,226), wx.Colour(0,0,0)),
"Totally Green": (wx.Colour(190,230,160), wx.Colour(190,230,160), wx.Colour(190,230,160), wx.Colour(0,0,0)),
"XP Blue": (wx.Colour(119,185,236), wx.Colour(81,144,223), wx.Colour(36,76,171), wx.Colour(255,255,255)),
"Yellow": (wx.Colour(255,255,220), wx.Colour(255,231,161), wx.Colour(254,218,108), wx.Colour(0,0,0))}
[docs]def GetStyleKeys():
""" Returns the predefined styles keywords. """
schemes = _colourSchemes.keys()
schemes.sort()
return schemes
[docs]def MakeBold(font):
"""
Makes a font bold. Utility method.
:param `font`: the font to be made bold.
"""
newFont = wx.Font(font.GetPointSize(), font.GetFamily(), font.GetStyle(),
wx.BOLD, font.GetUnderlined(), font.GetFaceName())
return newFont
[docs]def ExtractLink(line):
"""
Extract the link from an hyperlink line.
:param `line`: the line of text to be processed.
"""
line = line[4:]
indxStart = line.find("{")
indxEnd = line.find("}")
hl = line[indxStart+1:indxEnd].strip()
line = line[0:indxStart].strip()
return line, hl
[docs]class ToolTipWindowBase(object):
""" Base class for the different Windows and Mac implementation. """
[docs] def __init__(self, parent, classParent):
"""
Default class constructor.
:param `parent`: the L{SuperToolTip} parent widget;
:param `classParent`: the L{SuperToolTip} class object.
"""
self._spacing = 6
self._wasOnLink = False
self._hyperlinkRect, self._hyperlinkWeb = [], []
self._classParent = classParent
self._alphaTimer = wx.Timer(self, wx.ID_ANY)
# Bind the events
self.Bind(wx.EVT_PAINT, self.OnPaint)
self.Bind(wx.EVT_SIZE, self.OnSize)
self.Bind(wx.EVT_ERASE_BACKGROUND, self.OnEraseBackground)
self.Bind(wx.EVT_MOTION, self.OnMouseMotion)
self.Bind(wx.EVT_TIMER, self.AlphaCycle)
self.Bind(wx.EVT_KILL_FOCUS, self.OnDestroy)
self.Bind(wx.EVT_LEFT_DOWN, self.OnDestroy)
self.Bind(wx.EVT_LEFT_DCLICK, self.OnDestroy)
[docs] def OnPaint(self, event):
"""
Handles the ``wx.EVT_PAINT`` event for L{SuperToolTip}.
:param `event`: a `wx.PaintEvent` event to be processed.
"""
# Go with double buffering...
dc = wx.BufferedPaintDC(self)
frameRect = self.GetClientRect()
x, y, width, height = frameRect
# Store the rects for the hyperlink lines
self._hyperlinkRect, self._hyperlinkWeb = [], []
classParent = self._classParent
# Retrieve the colours for the blended triple-gradient background
topColour, middleColour, bottomColour = classParent.GetTopGradientColour(), \
classParent.GetMiddleGradientColour(), \
classParent.GetBottomGradientColour()
# Get the user options for header, bitmaps etc...
drawHeader, drawFooter = classParent.GetDrawHeaderLine(), classParent.GetDrawFooterLine()
topRect = wx.Rect(frameRect.x, frameRect.y, frameRect.width, frameRect.height/2)
bottomRect = wx.Rect(frameRect.x, frameRect.y+frameRect.height/2, frameRect.width, frameRect.height/2+1)
# Fill the triple-gradient
dc.GradientFillLinear(topRect, topColour, middleColour, wx.SOUTH)
dc.GradientFillLinear(bottomRect, middleColour, bottomColour, wx.SOUTH)
header, headerBmp = classParent.GetHeader(), classParent.GetHeaderBitmap()
headerFont, messageFont, footerFont, hyperlinkFont = classParent.GetHeaderFont(), classParent.GetMessageFont(), \
classParent.GetFooterFont(), classParent.GetHyperlinkFont()
xPos, yPos = self._spacing, 0
bmpXPos = bmpYPos = 0
bmpHeight = textHeight = bmpWidth = 0
if headerBmp and headerBmp.IsOk():
# We got the header bitmap
bmpHeight, bmpWidth = headerBmp.GetHeight(), headerBmp.GetWidth()
bmpXPos = self._spacing
if header:
# We got the header text
dc.SetFont(headerFont)
textWidth, textHeight = dc.GetTextExtent(header)
# Calculate the header height
height = max(textHeight, bmpHeight)
if header:
dc.DrawText(header, bmpXPos+bmpWidth+self._spacing, (height-textHeight+self._spacing)/2)
if headerBmp and headerBmp.IsOk():
dc.DrawBitmap(headerBmp, bmpXPos, (height-bmpHeight+self._spacing)/2, True)
if header or (headerBmp and headerBmp.IsOk()):
yPos += height
if drawHeader:
# Draw the separator line after the header
dc.SetPen(wx.GREY_PEN)
dc.DrawLine(self._spacing, yPos+self._spacing, width-self._spacing, yPos+self._spacing)
# Get the big body image (if any)
embeddedImage = classParent.GetBodyImage()
bmpWidth = bmpHeight = -1
if embeddedImage and embeddedImage.IsOk():
bmpWidth, bmpHeight = embeddedImage.GetWidth(), embeddedImage.GetHeight()
# A bunch of calculations to draw the main body message
messageHeight = 0
textSpacing = (bmpWidth > 0 and [3*self._spacing] or [2*self._spacing])[0]
lines = classParent.GetMessage().split("\n")
yText = yPos
normalText = wx.SystemSettings_GetColour(wx.SYS_COLOUR_MENUTEXT)
hyperLinkText = wx.BLUE
for indx, line in enumerate(lines):
# Loop over all the lines in the message
isLink = False
dc.SetTextForeground(normalText)
if line.startswith("</b>"): # is a bold line
line = line[4:]
font = MakeBold(messageFont)
dc.SetFont(font)
elif line.startswith("</l>"): # is a link
dc.SetFont(hyperlinkFont)
isLink = True
line, hl = ExtractLink(line)
dc.SetTextForeground(hyperLinkText)
else:
# Is a normal line
dc.SetFont(messageFont)
textWidth, textHeight = dc.GetTextExtent(line)
if textHeight == 0:
textWidth, textHeight = dc.GetTextExtent("a")
messageHeight += textHeight
xText = (bmpWidth > 0 and [bmpWidth+2*self._spacing] or [self._spacing])[0]
yText += textHeight/2+self._spacing
dc.DrawText(line, xText, yText)
if isLink:
# Store the hyperlink rectangle and link
self._hyperlinkRect.append(wx.Rect(xText, yText, textWidth, textHeight))
self._hyperlinkWeb.append(hl)
if indx == 0:
messagePos = yText
toAdd = 0
if bmpHeight > textHeight:
yPos += 2*self._spacing + bmpHeight
toAdd = self._spacing
else:
yPos += messageHeight + 2*self._spacing
yText = max(messageHeight, bmpHeight+2*self._spacing)
if embeddedImage and embeddedImage.IsOk():
# Draw the main body image
dc.DrawBitmap(embeddedImage, self._spacing, messagePos, True)
footer, footerBmp = classParent.GetFooter(), classParent.GetFooterBitmap()
bmpHeight = bmpWidth = textHeight = textWidth = 0
bmpXPos = bmpYPos = 0
if footerBmp and footerBmp.IsOk():
# Got the footer bitmap
bmpHeight, bmpWidth = footerBmp.GetHeight(), footerBmp.GetWidth()
bmpXPos = self._spacing
if footer:
# Got the footer text
dc.SetFont(footerFont)
textWidth, textHeight = dc.GetTextExtent(footer)
if textHeight or bmpHeight:
if drawFooter:
# Draw the separator line before the footer
dc.SetPen(wx.GREY_PEN)
dc.DrawLine(self._spacing, yPos-self._spacing/2+toAdd, width-self._spacing, yPos-self._spacing/2+toAdd)
# Draw the footer and footer bitmap (if any)
dc.SetTextForeground(normalText)
height = max(textHeight, bmpHeight)
yPos += toAdd
if footer:
dc.DrawText(footer, bmpXPos+bmpWidth+self._spacing, yPos + (height-textHeight+self._spacing)/2)
if footerBmp and footerBmp.IsOk():
dc.DrawBitmap(footerBmp, bmpXPos, yPos + (height-bmpHeight+self._spacing)/2, True)
[docs] def OnEraseBackground(self, event):
"""
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for L{SuperToolTip}.
:param `event`: a `wx.EraseEvent` event to be processed.
:note: This method is intentionally empty to reduce flicker.
"""
# This is intentionally empty to reduce flicker
pass
[docs] def OnSize(self, event):
"""
Handles the ``wx.EVT_SIZE`` event for L{SuperToolTip}.
:param `event`: a `wx.SizeEvent` event to be processed.
"""
self.Refresh()
event.Skip()
[docs] def OnMouseMotion(self, event):
"""
Handles the ``wx.EVT_MOTION`` event for L{SuperToolTip}.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
x, y = event.GetPosition()
for rect in self._hyperlinkRect:
if rect.Contains((x, y)):
# We are over one hyperlink...
self.SetCursor(wx.StockCursor(wx.CURSOR_HAND))
self._wasOnLink = True
return
if self._wasOnLink:
# Restore the normal cursor
self._wasOnLink = False
self.SetCursor(wx.NullCursor)
[docs] def OnDestroy(self, event):
"""
Handles the ``wx.EVT_LEFT_DOWN``, ``wx.EVT_LEFT_DCLICK`` and ``wx.EVT_KILL_FOCUS``
events for L{SuperToolTip}. All these events destroy the L{SuperToolTip},
unless the user clicked on one hyperlink.
:param `event`: a `wx.MouseEvent` or a `wx.FocusEvent` event to be processed.
"""
if not isinstance(event, wx.MouseEvent):
# We haven't clicked a link
self.Destroy()
return
x, y = event.GetPosition()
for indx, rect in enumerate(self._hyperlinkRect):
if rect.Contains((x, y)):
# Run the webbrowser with the clicked link
webbrowser.open_new_tab(self._hyperlinkWeb[indx])
return
if self._classParent.GetUseFade():
# Fade out...
self.StartAlpha(False)
else:
self.Destroy()
[docs] def StartAlpha(self, isShow):
"""
Start the timer which set the alpha channel for L{SuperToolTip}.
:param `isShow`: whether L{SuperToolTip} is being shown or deleted.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
if self._alphaTimer.IsRunning():
return
# Calculate starting alpha value and its step
self.amount = (isShow and [0] or [255])[0]
self.delta = (isShow and [5] or [-5])[0]
# Start the timer
self._alphaTimer.Start(30)
[docs] def SetFont(self, font):
"""
Sets the L{SuperToolTip} font globally.
:param `font`: the font to set.
"""
wx.PopupWindow.SetFont(self, font)
self._classParent.InitFont()
self.Invalidate()
[docs] def Invalidate(self):
""" Invalidate L{SuperToolTip} size and repaint it. """
if not self._classParent.GetMessage():
# No message yet...
return
self.CalculateBestSize()
self.Refresh()
[docs] def DropShadow(self, drop=True):
"""
Adds a shadow under the window.
:param `drop`: whether to drop a shadow or not.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
if not _libimported:
# No Mark Hammond's win32all extension
return
if wx.Platform != "__WXMSW__":
# This works only on Windows XP
return
hwnd = self.GetHandle()
# Create a rounded rectangle region
size = self.GetSize()
if drop:
if hasattr(win32gui, "CreateRoundRectRgn"):
rgn = win32gui.CreateRoundRectRgn(0, 0, size.x, size.y, 9, 9)
win32gui.SetWindowRgn(hwnd, rgn, True)
CS_DROPSHADOW = 0x00020000
# Load the user32 library
if not hasattr(self, "_winlib"):
self._winlib = win32api.LoadLibrary("user32")
csstyle = win32api.GetWindowLong(hwnd, win32con.GCL_STYLE)
if drop:
if csstyle & CS_DROPSHADOW:
return
else:
csstyle |= CS_DROPSHADOW #Nothing to be done
else:
csstyle &= ~CS_DROPSHADOW
# Drop the shadow underneath the window
GCL_STYLE= -26
cstyle= win32gui.GetClassLong(hwnd, GCL_STYLE)
if drop:
if cstyle & CS_DROPSHADOW == 0:
win32api.SetClassLong(hwnd, GCL_STYLE, cstyle | CS_DROPSHADOW)
else:
win32api.SetClassLong(hwnd, GCL_STYLE, cstyle &~ CS_DROPSHADOW)
[docs] def AlphaCycle(self, event):
"""
Handles the ``wx.EVT_TIMER`` event for L{SuperToolTip}.
:param `event`: a `wx.TimerEvent` event to be processed.
"""
# Increase (or decrease) the alpha channel
self.amount += self.delta
if self.amount > 255 or self.amount < 0:
# We're done, stop the timer
self._alphaTimer.Stop()
if self.amount < 0:
# Destroy the SuperToolTip, we are fading out
self.Destroy()
return
# Make the SuperToolTip more or less transparent
self.MakeWindowTransparent(self.amount)
if not self.IsShown():
self.Show()
[docs] def MakeWindowTransparent(self, amount):
"""
Makes the L{SuperToolTip} window transparent.
:param `amount`: the alpha channel value.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
if not _libimported:
# No way, only Windows XP with Mark Hammond's win32all
return
# this API call is not in all SDKs, only the newer ones, so
# we will runtime bind this
if wx.Platform != "__WXMSW__":
return
hwnd = self.GetHandle()
if not hasattr(self, "_winlib"):
self._winlib = win32api.LoadLibrary("user32")
pSetLayeredWindowAttributes = win32api.GetProcAddress(self._winlib,
"SetLayeredWindowAttributes")
if pSetLayeredWindowAttributes == None:
return
exstyle = win32api.GetWindowLong(hwnd, win32con.GWL_EXSTYLE)
if 0 == (exstyle & 0x80000):
win32api.SetWindowLong(hwnd, win32con.GWL_EXSTYLE, exstyle | 0x80000)
winxpgui.SetLayeredWindowAttributes(hwnd, 0, amount, 2)
[docs] def CalculateBestSize(self):
""" Calculates the L{SuperToolTip} window best size. """
# See the OnPaint method for explanations...
maxWidth = maxHeight = 0
dc = wx.ClientDC(self)
classParent = self._classParent
header, headerBmp = classParent.GetHeader(), classParent.GetHeaderBitmap()
textHeight, bmpHeight = 0, 0
headerFont, messageFont, footerFont, hyperlinkFont = classParent.GetHeaderFont(), classParent.GetMessageFont(), \
classParent.GetFooterFont(), classParent.GetHyperlinkFont()
if header:
dc.SetFont(headerFont)
textWidth, textHeight = dc.GetTextExtent(header)
maxWidth = max(maxWidth, textWidth + 2*self._spacing)
maxHeight += self._spacing/2
if headerBmp and headerBmp.IsOk():
maxWidth += headerBmp.GetWidth() + 2*self._spacing
bmpHeight = headerBmp.GetHeight()
if not header:
maxHeight += self._spacing/2
maxHeight += max(textHeight, bmpHeight)
if textHeight or bmpHeight:
maxHeight += self._spacing/2
# See the OnPaint method for explanations...
bmpWidth = bmpHeight = -1
embeddedImage = classParent.GetBodyImage()
if embeddedImage and embeddedImage.IsOk():
bmpWidth, bmpHeight = embeddedImage.GetWidth(), embeddedImage.GetHeight()
messageHeight = 0
textSpacing = (bmpWidth and [3*self._spacing] or [2*self._spacing])[0]
lines = classParent.GetMessage().split("\n")
for line in lines:
if line.startswith("</b>"): # is a bold line
font = MakeBold(messageFont)
dc.SetFont(font)
line = line[4:]
elif line.startswith("</l>"): # is a link
dc.SetFont(hyperlinkFont)
line, hl = ExtractLink(line)
else:
dc.SetFont(messageFont)
textWidth, textHeight = dc.GetTextExtent(line)
if textHeight == 0:
textWidth, textHeight = dc.GetTextExtent("a")
maxWidth = max(maxWidth, textWidth + textSpacing + bmpWidth)
messageHeight += textHeight
# See the OnPaint method for explanations...
messageHeight = max(messageHeight, bmpHeight)
maxHeight += messageHeight
toAdd = 0
if bmpHeight > textHeight:
maxHeight += 2*self._spacing
toAdd = self._spacing
else:
maxHeight += 2*self._spacing
footer, footerBmp = classParent.GetFooter(), classParent.GetFooterBitmap()
textHeight, bmpHeight = 0, 0
# See the OnPaint method for explanations...
if footer:
dc.SetFont(footerFont)
textWidth, textHeight = dc.GetTextExtent(footer)
maxWidth = max(maxWidth, textWidth + 2*self._spacing)
maxHeight += self._spacing/2
if footerBmp and footerBmp.IsOk():
bmpWidth, bmpHeight = footerBmp.GetWidth(), footerBmp.GetHeight()
maxWidth = max(maxWidth, textWidth + 3*self._spacing + bmpWidth)
if not footer:
maxHeight += self._spacing/2
if textHeight or bmpHeight:
maxHeight += self._spacing/2 + max(textHeight, bmpHeight)
maxHeight += toAdd
self.SetSize((maxWidth, maxHeight))
[docs] def CalculateBestPosition(self,widget):
screen = wx.ClientDisplayRect()[2:]
left,top = widget.ClientToScreenXY(0,0)
right,bottom = widget.ClientToScreenXY(*widget.GetClientRect()[2:])
size = self.GetSize()
if right+size[0]>screen[0]:
xpos = left-size[0]
else:
xpos = right
if bottom+size[1]>screen[1]:
ypos = top-size[1]
else:
ypos = bottom
self.SetPosition((xpos,ypos))
# Handle Mac and Windows/GTK differences...
if wx.Platform == "__WXMAC__":
class ToolTipWindow(wx.Frame, ToolTipWindowBase):
""" Popup window that works on wxMac. """
def __init__(self, parent, classParent):
"""
Default class constructor.
:param `parent`: the L{SuperToolTip} parent widget;
:param `classParent`: the L{SuperToolTip} class object.
"""
wx.Frame.__init__(self, parent, style=wx.NO_BORDER|wx.FRAME_FLOAT_ON_PARENT|wx.FRAME_NO_TASKBAR|wx.POPUP_WINDOW)
# Call the base class
ToolTipWindowBase.__init__(self, parent, classParent)
else:
[docs] class ToolTipWindow(ToolTipWindowBase, wx.PopupWindow):
"""
A simple `wx.PopupWindow` that holds fancy tooltips.
Not available on Mac as `wx.PopupWindow` is not implemented there.
"""
[docs] def __init__(self, parent, classParent):
"""
Default class constructor.
:param `parent`: the L{SuperToolTip} parent widget;
:param `classParent`: the L{SuperToolTip} class object.
"""
wx.PopupWindow.__init__(self, parent)
# Call the base class
ToolTipWindowBase.__init__(self, parent, classParent)
[docs]class SuperToolTip(object):
"""
The main class for L{SuperToolTip}, which holds all the methods
and setters/getters available to the user.
"""
[docs] def __init__(self, message, bodyImage=wx.NullBitmap, header="", headerBmp=wx.NullBitmap,
footer="", footerBmp=wx.NullBitmap):
"""
Default class constructor.
:param `message`: the main message in L{SuperToolTip} body;
:param `bodyImage`: the image in the L{SuperToolTip} body;
:param `header`: the header text;
:param `headerBmp`: the header bitmap;
:param `footer`: the footer text;
:param `footerBmp`: the footer bitmap.
"""
self._superToolTip = None
# Set all the initial options
self.SetMessage(message)
self.SetBodyImage(bodyImage)
self.SetHeader(header)
self.SetHeaderBitmap(headerBmp)
self.SetFooter(footer)
self.SetFooterBitmap(footerBmp)
self._dropShadow = False
self._useFade = False
self._topLine = False
self._bottomLine = False
self.InitFont()
# Get the running applications
self._runningApp = wx.GetApp()
self._runningApp.__superToolTip = True
# Build a couple of timers...
self._startTimer = wx.PyTimer(self.OnStartTimer)
self._endTimer = wx.PyTimer(self.OnEndTimer)
self.SetStartDelay()
self.SetEndDelay()
self.ApplyStyle("XP Blue")
[docs] def SetTarget(self, widget):
"""
Sets the target window for L{SuperToolTip}.
:param `widget`: the widget to which L{SuperToolTip} is associated.
"""
self._widget = widget
self._widget.Bind(wx.EVT_ENTER_WINDOW, self.OnWidgetEnter)
self._widget.Bind(wx.EVT_LEAVE_WINDOW, self.OnWidgetLeave)
[docs] def GetTarget(self):
""" Returns the target window for L{SuperToolTip}. """
if not hasattr(self, "_widget"):
raise Exception("\nError: the widget target for L{SuperToolTip} has not been set.")
return self._widget
[docs] def SetStartDelay(self, delay=1):
"""
Sets the time delay (in seconds) after which the L{SuperToolTip} is created.
:param `delay`: the delay in seconds.
"""
self._startDelayTime = float(delay)
[docs] def GetStartDelay(self):
""" Returns the tim delay (in seconds) after which the L{SuperToolTip} is created."""
return self._startDelayTime
[docs] def SetEndDelay(self, delay=1e6):
"""
Sets the delay time (in seconds) after which the L{SuperToolTip} is destroyed.
:param `delay`: the delay in seconds.
"""
self._endDelayTime = float(delay)
[docs] def GetEndDelay(self):
""" Returns the delay time (in seconds) after which the L{SuperToolTip} is destroyed."""
return self._endDelayTime
[docs] def OnWidgetEnter(self, event):
"""
Starts the L{SuperToolTip} timer for creation, handles the ``wx.EVT_ENTER_WINDOW`` event.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
if self._superToolTip:
# Not yet created
return
if not self._runningApp.__superToolTip:
# The running app doesn't want tooltips...
return
if self._startTimer.IsRunning():
# We are already running
event.Skip()
return
self._startTimer.Start(self._startDelayTime*1000)
event.Skip()
[docs] def OnWidgetLeave(self, event):
"""
Handles the ``wx.EVT_LEAVE_WINDOW`` event for the target widgets.
:param `event`: a `wx.MouseEvent` event to be processed.
"""
pos = wx.GetMousePosition()
realPos = self._widget.ScreenToClient(pos)
rect = self._widget.GetClientRect()
if rect.Contains(realPos):
# We get fake leave events...
event.Skip()
return
if self._superToolTip:
if self.GetUseFade():
# Fade out...
self._superToolTip.StartAlpha(False)
else:
self._superToolTip.Destroy()
self._startTimer.Stop()
self._endTimer.Stop()
event.Skip()
[docs] def GetTipWindow(self):
""" Return the TipWindow, will return None if not yet created """
return self._superToolTip
[docs] def OnStartTimer(self):
""" The creation time has expired, create the L{SuperToolTip}. """
# target widget might already be destroyed
if not self._widget:
self._startTimer.Stop()
return
tip = ToolTipWindow(self._widget, self)
self._superToolTip = tip
self._superToolTip.CalculateBestSize()
self._superToolTip.CalculateBestPosition(self._widget)
self._superToolTip.DropShadow(self.GetDropShadow())
if self.GetUseFade():
self._superToolTip.StartAlpha(True)
else:
self._superToolTip.Show()
self._startTimer.Stop()
self._endTimer.Start(self._endDelayTime*1000)
[docs] def OnEndTimer(self):
""" The show time for L{SuperToolTip} has expired, destroy the L{SuperToolTip}. """
if self._superToolTip:
if self.GetUseFade():
self._superToolTip.StartAlpha(False)
else:
self._superToolTip.Destroy()
self._endTimer.Stop()
[docs] def DoShowNow(self):
""" Create the L{SuperToolTip} immediately. """
if self._superToolTip:
# need to destroy it if already exists,
# otherwise we might end up with many of them
self._superToolTip.Destroy()
tip = ToolTipWindow(self._widget, self)
self._superToolTip = tip
self._superToolTip.CalculateBestSize()
self._superToolTip.CalculateBestPosition(self._widget)
self._superToolTip.DropShadow(self.GetDropShadow())
# need to stop this, otherwise we get into trouble when leaving the window
self._startTimer.Stop()
if self.GetUseFade():
self._superToolTip.StartAlpha(True)
else:
self._superToolTip.Show()
self._endTimer.Start(self._endDelayTime*1000)
[docs] def OnDestroy(self, event):
""" Handles the L{SuperToolTip} target destruction. """
if self._superToolTip:
# Unbind the events!
self._widget.Unbind(wx.EVT_LEAVE_WINDOW)
self._widget.Unbind(wx.EVT_ENTER_WINDOW)
self._superToolTip.Destroy()
del self._superToolTip
self._superToolTip = None
[docs] def SetHeaderBitmap(self, bmp):
"""
Sets the header bitmap for L{SuperToolTip}.
:param `bmp`: the header bitmap, a valid `wx.Bitmap` object.
"""
self._headerBmp = bmp
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def SetHeader(self, header):
"""
Sets the header text.
:param `header`: the header text to display.
"""
self._header = header
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def SetDrawHeaderLine(self, draw):
"""
Sets whether to draw a separator line after the header or not.
:param `draw`: ``True`` to draw a separator line after the header, ``False``
otherwise.
"""
self._topLine = draw
if self._superToolTip:
self._superToolTip.Refresh()
[docs] def GetDrawHeaderLine(self):
""" Returns whether the separator line after the header is drawn or not. """
return self._topLine
[docs] def SetBodyImage(self, bmp):
"""
Sets the main body bitmap for L{SuperToolTip}.
:param `bmp`: the body bitmap, a valid `wx.Bitmap` object.
"""
self._embeddedImage = bmp
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def GetBodyImage(self):
""" Returns the main body bitmap used in L{SuperToolTip}. """
return self._embeddedImage
[docs] def SetMessage(self, message):
"""
Sets the main body message for L{SuperToolTip}.
:param `message`: the message to display in the body.
"""
self._message = message
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def GetMessage(self):
""" Returns the main body message in L{SuperToolTip}. """
return self._message
[docs] def SetTopGradientColour(self, colour):
"""
Sets the top gradient colour for L{SuperToolTip}.
:param `colour`: the colour to use as top colour, a valid `wx.Colour` object.
"""
self._topColour = colour
if self._superToolTip:
self._superToolTip.Refresh()
[docs] def SetMiddleGradientColour(self, colour):
"""
Sets the middle gradient colour for L{SuperToolTip}.
:param `colour`: the colour to use as middle colour, a valid `wx.Colour` object.
"""
self._middleColour = colour
if self._superToolTip:
self._superToolTip.Refresh()
[docs] def SetBottomGradientColour(self, colour):
"""
Sets the bottom gradient colour for L{SuperToolTip}.
:param `colour`: the colour to use as bottom colour, a valid `wx.Colour` object.
"""
self._bottomColour = colour
if self._superToolTip:
self._superToolTip.Refresh()
[docs] def SetTextColour(self, colour):
"""
Sets the text colour for L{SuperToolTip}.
:param `colour`: the colour to use as text colour, a valid `wx.Colour` object.
"""
self._textColour = colour
if self._superToolTip:
self._superToolTip.Refresh()
[docs] def GetTopGradientColour(self):
""" Returns the top gradient colour. """
return self._topColour
[docs] def GetMiddleGradientColour(self):
""" Returns the middle gradient colour. """
return self._middleColour
[docs] def GetBottomGradientColour(self):
""" Returns the bottom gradient colour. """
return self._bottomColour
SetTopGradientColor = SetTopGradientColour
SetMiddleGradientColor = SetMiddleGradientColour
SetBottomGradientColor = SetBottomGradientColour
GetTopGradientColor = GetTopGradientColour
GetMiddleGradientColor = GetMiddleGradientColour
GetBottomGradientColor = GetBottomGradientColour
SetTextColor = SetTextColour
GetTextColor = GetTextColour
[docs] def InitFont(self):
""" Initalizes the fonts for L{SuperToolTip}. """
self._messageFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
self._headerFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
self._headerFont.SetWeight(wx.BOLD)
self._footerFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
self._footerFont.SetWeight(wx.BOLD)
self._hyperlinkFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
self._hyperlinkFont.SetWeight(wx.BOLD)
self._hyperlinkFont.SetUnderlined(True)
[docs] def SetMessageFont(self, font):
"""
Sets the font for the main body message.
:param `font`: the font to use for the main body message, a valid `wx.Font`
object.
"""
self._messageFont = font
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def SetHeaderFont(self, font):
"""
Sets the font for the header text.
:param `font`: the font to use for the header text, a valid `wx.Font`
object.
"""
self._headerFont = font
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def SetHyperlinkFont(self, font):
"""
Sets the font for the hyperlink text.
:param `font`: the font to use for the hyperlink text, a valid `wx.Font`
object.
"""
self._hyperlinkFont = font
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def GetMessageFont(self):
""" Returns the font used in the main body message. """
return self._messageFont
[docs] def GetHeaderFont(self):
""" Returns the font used for the header text. """
return self._headerFont
[docs] def GetHyperlinkFont(self):
""" Returns the font used for the hyperlink text. """
return self._hyperlinkFont
[docs] def SetDropShadow(self, drop):
"""
Whether to draw a shadow below L{SuperToolTip} or not.
:param `drop`: ``True`` to drop a shadow below the control, ``False`` otherwise.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
self._dropShadow = drop
if self._superToolTip:
self._superToolTip.Invalidate()
[docs] def GetDropShadow(self):
"""
Returns whether a shadow below L{SuperToolTip} is drawn or not.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
return self._dropShadow
[docs] def SetUseFade(self, fade):
"""
Whether to use a fade in/fade out effect or not.
:param `fade`: ``True`` to use a fade in/fade out effect, ``False`` otherwise.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
self._useFade = fade
[docs] def GetUseFade(self):
"""
Returns whether a fade in/fade out effect is used or not.
:note: This method is available only on Windows and requires Mark Hammond's
pywin32 package.
"""
return self._useFade
[docs] def ApplyStyle(self, style):
"""
Applies none of the predefined styles.
:param `style`: one of the predefined styles available at the
beginning of the module.
"""
if style not in _colourSchemes:
raise Exception("Invalid style '%s' selected"%style)
top, middle, bottom, text = _colourSchemes[style]
self._topColour = top
self._middleColour = middle
self._bottomColour = bottom
self._textColour = text
if self._superToolTip:
self._superToolTip.Refresh()
[docs] def EnableTip(self, enable=True):
"""
Globally (application-wide) enables/disables L{SuperToolTip}.
:param `enable`: ``True`` to enable L{SuperToolTip} globally, ``False`` otherwise.
"""
wx.GetApp().__superToolTip = enable
if not enable and self._superToolTip:
self._superToolTip.Destroy()
self._superToolTip = None
del self._superToolTip
