wx.TipWindow

Shows simple text in a popup tip window on creation.

This is used by wx.SimpleHelpProvider to show popup help. The window automatically destroys itself when the user clicks on it or it loses the focus.

You may also use this class to emulate the tooltips when you need finer control over them than what the standard tooltips provide.

See also

wx.ToolTip

Class Hierarchy

Inheritance diagram for class TipWindow:

Methods Summary

__init__	Constructor.
GetClassDefaultAttributes
SetBoundingRect	By default, the tip window disappears when the user clicks the mouse or presses a keyboard key or if it loses focus in any other way - for example because the user switched to another application window.

Class API

class wx.TipWindow(Window)

Possible constructors:

TipWindow(parent, text, maxLength=100)

Shows simple text in a popup tip window on creation.

Methods

__init__(self, parent, text, maxLength=100)

Constructor.

The tip is shown immediately after the window is constructed.

Parameters

• parent (wx.Window) – The parent window, must be not None

• text (string) – The text to show, may contain the new line characters

• maxLength (int) – The length of each line, in pixels. Set to a very large value to avoid wrapping lines

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters

variant (WindowVariant) –

Return type

wx.VisualAttributes

---

SetBoundingRect(self, rectBound)

By default, the tip window disappears when the user clicks the mouse or presses a keyboard key or if it loses focus in any other way - for example because the user switched to another application window.

Additionally, if a non-empty rectBound is provided, the tip window will also automatically close if the mouse leaves this area. This is useful to dismiss the tip mouse when the mouse leaves the object it is associated with.

Parameters

rectBound (wx.Rect) – The bounding rectangle for the mouse in the screen coordinates