wx.ToolTip

This class holds information about a tooltip associated with a window (see wx.Window.SetToolTip ).

The four static methods, wx.ToolTip.Enable , wx.ToolTip.SetDelay wx.ToolTip.SetAutoPop and wx.ToolTip.SetReshow can be used to globally alter tooltips behaviour.

Class Hierarchy

Inheritance diagram for class ToolTip:

Methods Summary

__init__	Constructor.
Enable	Enable or disable tooltips globally.
GetTip	Get the tooltip text.
GetWindow	Get the associated window.
SetAutoPop	Set the delay after which the tooltip disappears or how long a tooltip remains visible.
SetDelay	Set the delay after which the tooltip appears.
SetMaxWidth	Set tooltip maximal width in pixels.
SetReshow	Set the delay between subsequent tooltips to appear.
SetTip	Set the tooltip text.

Properties Summary

Tip	See GetTip and SetTip
Window	See GetWindow

Class API

class wx.ToolTip(Object)

Possible constructors:

ToolTip(tip)

This class holds information about a tooltip associated with a window (see Window.SetToolTip()).

Methods

__init__(self, tip)

Constructor.

Parameters

tip (string) –

---

static Enable(flag)

Enable or disable tooltips globally.

Parameters

flag (bool) –

Note

May not be supported on all platforms (eg. Cocoa).

---

GetTip(self)

Get the tooltip text.

Return type

string

---

GetWindow(self)

Get the associated window.

Return type

wx.Window

---

static SetAutoPop(msecs)

Set the delay after which the tooltip disappears or how long a tooltip remains visible.

Parameters

msecs (long) –

Note

May not be supported on all platforms (eg. Cocoa, GTK).

---

static SetDelay(msecs)

Set the delay after which the tooltip appears.

Parameters

msecs (long) –

Note

May not be supported on all platforms.

---

static SetMaxWidth(width)

Set tooltip maximal width in pixels.

By default, tooltips are wrapped at a suitably chosen width. You can pass -1 as width to disable wrapping them completely, 0 to restore the default behaviour or an arbitrary positive value to wrap them at the given width.

Notice that this function does not change the width of the tooltips created before calling it.

Parameters

width (int) –

Note

Currently this function is MSW-only.

---

static SetReshow(msecs)

Set the delay between subsequent tooltips to appear.

Parameters

msecs (long) –

Note

May not be supported on all platforms (eg. Cocoa, GTK).

---

SetTip(self, tip)

Set the tooltip text.

Parameters

tip (string) –

Properties

Tip

See GetTip and SetTip

---

Window

See GetWindow