TipWindow

Shows simple text in a popup tip window on creation.

This is used by 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.

Inheritance Diagram

Inheritance diagram for class TipWindow

Methods Summary

__init__	Constructor.
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 TipWindow(Window)

Shows simple text in a popup tip window on creation.

Possible constructors:

TipWindow(parent, text, maxLength=100)

Methods

---

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

Constructor.

The tip is shown immediately after the window is constructed.

Parameters:

• parent (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

Simply passed to SetTipWindowPtr below, please see its documentation for the description of this parameter

If not None, passed to SetBoundingRect below, please see its documentation for the description of this parameter

---

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 (Rect) – The bounding rectangle for the mouse in the screen coordinates