wx.lib.agw.supertooltip.ToolTipWindowBase

Base class for the different Windows and Mac implementation.

Class Hierarchy

Inheritance diagram for class ToolTipWindowBase:

Known Subclasses

wx.lib.agw.supertooltip.ToolTipWindow

Methods Summary

__init__	Default class constructor.
AlphaCycle	Handles the wx.EVT_TIMER event for SuperToolTip.
CalculateBestPosition
CalculateBestSize	Calculates the SuperToolTip window best size.
DropShadow	Adds a shadow under the window.
Invalidate	Invalidate SuperToolTip size and repaint it.
MakeWindowTransparent	Makes the SuperToolTip window transparent.
OnDestroy	Handles the wx.EVT_LEFT_DOWN, wx.EVT_LEFT_DCLICK and wx.EVT_KILL_FOCUS
OnEraseBackground	Handles the wx.EVT_ERASE_BACKGROUND event for SuperToolTip.
OnMouseMotion	Handles the wx.EVT_MOTION event for SuperToolTip.
OnPaint	Handles the wx.EVT_PAINT event for SuperToolTip.
OnSize	Handles the wx.EVT_SIZE event for SuperToolTip.
SetFont	Sets the SuperToolTip font globally.
StartAlpha	Start the timer which set the alpha channel for SuperToolTip.

Class API

---

class ToolTipWindowBase(object)

Base class for the different Windows and Mac implementation.

Methods

---

__init__(self, parent, classParent)

Default class constructor.

Parameters:

• parent – the SuperToolTip parent widget;
• classParent – the SuperToolTip class object.

---

AlphaCycle(self, event)

Handles the wx.EVT_TIMER event for SuperToolTip.

Parameters:event – a TimerEvent event to be processed.

---

CalculateBestPosition(self, widget)

---

CalculateBestSize(self)

Calculates the SuperToolTip window best size.

---

DropShadow(self, drop=True)

Adds a shadow under the window.

Parameters:drop – whether to drop a shadow or not.

Note

This method is available only on Windows and requires Mark Hammond’s pywin32 package.

---

Invalidate(self)

Invalidate SuperToolTip size and repaint it.

---

MakeWindowTransparent(self, amount)

Makes the SuperToolTip window transparent.

Parameters:amount – the alpha channel value.

Note

This method is available only on Windows and requires Mark Hammond’s pywin32 package.

---

OnDestroy(self, event)

Handles the wx.EVT_LEFT_DOWN, wx.EVT_LEFT_DCLICK and wx.EVT_KILL_FOCUS events for SuperToolTip. All these events destroy the SuperToolTip, unless the user clicked on one hyperlink.

Parameters:event – a MouseEvent or a FocusEvent event to be processed.

---

OnEraseBackground(self, event)

Handles the wx.EVT_ERASE_BACKGROUND event for SuperToolTip.

Parameters:event – a EraseEvent event to be processed.

Note

This method is intentionally empty to reduce flicker.

---

OnMouseMotion(self, event)

Handles the wx.EVT_MOTION event for SuperToolTip.

Parameters:event – a MouseEvent event to be processed.

---

OnPaint(self, event)

Handles the wx.EVT_PAINT event for SuperToolTip.

If the event parameter is None, calculates best size and returns it.

Parameters:event – a PaintEvent event to be processed or None.

---

OnSize(self, event)

Handles the wx.EVT_SIZE event for SuperToolTip.

Parameters:event – a wx.SizeEvent event to be processed.

---

SetFont(self, font)

Sets the SuperToolTip font globally.

Parameters:font – the font to set.

---

StartAlpha(self, isShow)

Start the timer which set the alpha channel for SuperToolTip.

Parameters:isShow – whether SuperToolTip is being shown or deleted.

Note

This method is available only on Windows and requires Mark Hammond’s pywin32 package.