Scroll to navigation

wxToolTip(3erl) Erlang Module Definition wxToolTip(3erl)

NAME

wxToolTip - Functions for wxToolTip class

DESCRIPTION

This class holds information about a tooltip associated with a window (see wxWindow:setToolTip/2).

The four static methods, enable/1, setDelay/1 wxToolTip::SetAutoPop() (not implemented in wx) and wxToolTip::SetReshow() (not implemented in wx) can be used to globally alter tooltips behaviour.

wxWidgets docs: wxToolTip

DATA TYPES

wxToolTip() = wx:wx_object()

EXPORTS


enable(Flag) -> ok


Types:

Flag = boolean()

Enable or disable tooltips globally.

Note: May not be supported on all platforms (eg. wxCocoa).


setDelay(Msecs) -> ok


Types:

Msecs = integer()

Set the delay after which the tooltip appears.

Note: May not be supported on all platforms.


new(Tip) -> wxToolTip()


Types:

Tip = unicode:chardata()

Constructor.


setTip(This, Tip) -> ok


Types:

This = wxToolTip()
Tip = unicode:chardata()

Set the tooltip text.


getTip(This) -> unicode:charlist()


Types:

This = wxToolTip()

Get the tooltip text.


getWindow(This) -> wxWindow:wxWindow()


Types:

This = wxToolTip()

Get the associated window.


destroy(This :: wxToolTip()) -> ok


Destroys the object.

wx 2.1 wxWidgets team.