4 * Copyright 2002 the LyX Team
5 * Read the file COPYING
7 * \author Angus Leeming, a.leeming@ic.ac.uk
10 /* Tooltips for xforms. xforms 0.89 supports them directly, but 0.88 needs
11 * a bit of jiggery pokery. This class wraps it all up in a neat interface.
12 * Based on code originally in Toolbar_pimpl.C that appears to have been
13 * written by Matthias Ettrich and Jean-Marc Lasgouttes.
21 #include <boost/utility.hpp>
22 #include <boost/signals/signal0.hpp>
23 #include <boost/signals/trackable.hpp>
25 #include FORMS_H_LOCATION // Can't forward-declare FL_OBJECT
34 class Tooltips : boost::noncopyable, public boost::signals::trackable {
38 /// Initialise a tooltip for this ob.
39 void init(FL_OBJECT * ob, string const & tip);
41 /// Are the tooltips on or off?
42 static bool enabled() { return enabled_; }
44 /// This method is connected to the tooltipsToggled signal.
47 #if FL_VERSION < 1 && FL_REVISION < 89
49 /** Return the tooltip associated with this object.
50 * Required by an xforms callback routine.
52 string const get(FL_OBJECT *) const;
58 /// Are the tooltips on or off?
61 /** This method is connected to Dialogs::toggleTooltips and toggles
62 * the state of enabled_.
64 static void toggleEnabled();
66 /** Once enabled_ is changed, then this signal is emitted to update
69 static boost::signal0<void> toggled;
71 /// The tooltips are stored so that they can be turned on and off.
72 typedef std::map<FL_OBJECT *, string> TooltipsMap;
74 TooltipsMap tooltipsMap;
76 #if FL_VERSION < 1 && FL_REVISION < 89
78 /** A timer is started once the mouse enters an object, so that the
79 * tip appears a short delay afterwards.
81 FL_OBJECT * tooltip_timer_;