AGW Logo

agw_title ToolTipWindowBase

Base class for the different Windows and Mac implementation.

hierarchy Inheritance Diagram

Inheritance diagram for: ToolTipWindowBase

Inheritance diagram of ToolTipWindowBase


subclasses Known Subclasses


method_summary Methods Summary

__init__Default class constructor.
AlphaCycleHandles the wx.EVT_TIMER event for SuperToolTip.
CalculateBestPosition
CalculateBestSizeCalculates the SuperToolTip window best size.
DropShadowAdds a shadow under the window.
InvalidateInvalidate SuperToolTip size and repaint it.
MakeWindowTransparentMakes the SuperToolTip window transparent.
OnDestroyHandles the wx.EVT_LEFT_DOWN, wx.EVT_LEFT_DCLICK and wx.EVT_KILL_FOCUS
OnEraseBackgroundHandles the wx.EVT_ERASE_BACKGROUND event for SuperToolTip.
OnMouseMotionHandles the wx.EVT_MOTION event for SuperToolTip.
OnPaintHandles the wx.EVT_PAINT event for SuperToolTip.
OnSizeHandles the wx.EVT_SIZE event for SuperToolTip.
SetFontSets the SuperToolTip font globally.
StartAlphaStart the timer which set the alpha channel for SuperToolTip.

API Class API

class ToolTipWindowBase(object)[source]

Base class for the different Windows and Mac implementation.



__init__(parent, classParent)[source]

Default class constructor.

Parameters:


AlphaCycle(event)[source]

Handles the wx.EVT_TIMER event for SuperToolTip.

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


CalculateBestPosition(widget)[source]


CalculateBestSize()[source]

Calculates the SuperToolTip window best size.



DropShadow(drop=True)[source]

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()[source]

Invalidate SuperToolTip size and repaint it.



MakeWindowTransparent(amount)[source]

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(event)[source]

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 wx.MouseEvent or a wx.FocusEvent event to be processed.


OnEraseBackground(event)[source]

Handles the wx.EVT_ERASE_BACKGROUND event for SuperToolTip.

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

Note

This method is intentionally empty to reduce flicker.



OnMouseMotion(event)[source]

Handles the wx.EVT_MOTION event for SuperToolTip.

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


OnPaint(event)[source]

Handles the wx.EVT_PAINT event for SuperToolTip.

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


OnSize(event)[source]

Handles the wx.EVT_SIZE event for SuperToolTip.

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


SetFont(font)[source]

Sets the SuperToolTip font globally.

Parameters:font – the font to set.


StartAlpha(isShow)[source]

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.

Tree

Table Of Contents

Previous topic

ToolTipWindow

Next topic

supertooltip functions