Tooltip Class Reference

Inherits MenuWindow.

List of all members.

Public Types
typedef const char *(*	Generator )(Widget *, void *)
Public Member Functions
void	draw ()
void	layout ()
Static Public Member Functions
float	delay ()
void	delay (float f)
bool	enabled ()
void	enable (bool b=true)
void	disable ()
void	enter (Widget *, const Rectangle &, Generator, void *=0)
void	enter (Widget *, const Rectangle &, const char *text)
void	enter (Widget *)
void	current (Widget *)
void	exit ()
Widget *	current_widget ()
const Rectangle &	current_rectangle ()
Generator	current_generator ()
void *	current_data ()
Tooltip *	instance ()
Static Public Attributes
NamedStyle *	default_style

---

Detailed Description

This is the class of window that pops up to display a tooltip (with the yellow color and 1-pixel border).

In addition Toolip provides number of static functions for managing a single private instance, and making this pop up when the mouse is pointing at various rectangles in the GUI. FLTK calls these as the mouse moves between widgets, and a widget's handle() method can call these to present tooltips for various parts of itself.

You can change the appearance of the tooltips by modifying the contents of Tooltip::default_style.

---

Member Function Documentation

void Tooltip::current (  Widget *  w  )  [static]

Acts as though enter(widget) was done but does not pop up a tooltip. However, this makes it ignore a subsequent call to enter() for this same widget. This is useful to prevent a tooltip from reappearing when a modal overlapping window is deleted. FLTK does this automatically when a popup window disappears.

void * Tooltip::current_data (   )  [inline, static]

Last data for the generator function passed to enter().

Tooltip::Generator Tooltip::current_generator (   )  [inline, static]

Last generator function passed to enter();

const Rectangle & Tooltip::current_rectangle (   )  [inline, static]

Last rectangle passed to enter()

Widget * Tooltip::current_widget (   )  [inline, static]

Last widget passed to enter(), or NULL if exit() was called.

void Tooltip::delay (  float  f  )  [inline, static]

Set the time (in seconds) before tooltips pop up after enter() is called. Any time less than .1 causes the tooltip to pop up instantly.

void Tooltip::disable (   )  [inline, static]

Same as enable(false);

void Tooltip::enable (  bool  b = true  )  [inline, static]

If set to false tooltips never appear. Setting delay() really large will do the same thing, but this function is provided as most people find it more clear.

void Tooltip::enter (  Widget *  w  )  [static]

Locates either widget or the closest parent with an non-null Widget::tooltip() value and then does an enter() using this widget's area and that widget's tooltip(). If widget is NULL or there is no tooltip found then exit() is done instead. This is automatically called by FLTK when Widget::below_mouse() is changed.

void Tooltip::enter (  Widget *  widget, const Rectangle &  rectangle, const char *  text )  [static]

Same as the previous enter() except the tooltip is defined by the string constant passed as text. The text must be in a static location that will still exist when the tooltip pops up! If widget or text is NULL then exit() is done instead and no tooltip appears.

void Tooltip::enter (  Widget *  widget, const Rectangle &  rectangle, Tooltip::Generator  generator, void *  data = 0 )  [static]

Get ready to display a tooltip. The widget and the rectangle inside it define an area the tooltip is for. The mouse is assummed to currently be inside this rectangle. After a timeout period a tooltip is created and it will appear at the edge of the rectangle. If enter() with a different widget, generator, or data is called, or exit() is called, the tooltip will not appear. The generator callback is for deferring the calculation of the text until it is actually needed. Just before popping up the tooltip generator is called with the widget and data as arguments, and it should return a pointer to a static buffer containing the tooltip text. You can use '@' commands to insert arbitrary Symbol graphics into it. If generator returns NULL no tooltip will be popped up.

void Tooltip::exit (   )  [static]

Indicate that the mouse is no longer pointing at a tooltip area. Makes any visible tooltip disappear and cancel any pending one. No tooltip will appear until after enter() is called again.

Tooltip * Tooltip::instance (   )  [inline, static]

The Tooltip window that is used to display tooltips in response to enter(). This is NULL before the first tooltip is shown to the user.

void Tooltip::layout (   )  [virtual]

Measures the label() and resizes itself to fit, and positions itself to line up with the rectangle passed to the last enter(). Reimplemented from Window.

---

Member Data Documentation

NamedStyle * Tooltip::default_style [static]

The Tooltip::default_style controls how the automatic tooltip appears. It defaults to the yellow color() and a box() of BORDER_BOX. You may also want to set the textfont(), textsize(), textcolor(). Reimplemented from MenuWindow.

---

The documentation for this class was generated from the following files:

• fltk/Tooltip.h
• src/Tooltip.cxx

---