src/frontends/xforms/Tooltips.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Tooltips.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 /* Tooltips for xforms. xforms 0.89 supports them directly, but 0.88 needs
  13  * a bit of jiggery pokery. This class wraps it all up in a neat interface.
  14  * Based on code originally in Toolbar_pimpl.C that appears to have been
  15  * written by Matthias Ettrich and Jean-Marc Lasgouttes.
  16  */
  17
  18 #ifndef TOOLTIPS_H
  19 #define TOOLTIPS_H
  20
  21
  22 #include "LString.h"
  23
  24 #include <boost/utility.hpp>
  25 #include <boost/signals/signal0.hpp>
  26 #include <boost/signals/trackable.hpp>
  27
  28 #include "forms_fwd.h" // Can't forward-declare FL_OBJECT
  29
  30 #include <map>
  31
  32 class Tooltips : boost::noncopyable, public boost::signals::trackable {
  33 public:
  34         ///
  35         Tooltips();
  36
  37         /// Initialise a tooltip for this ob.
  38         void init(FL_OBJECT * ob, string const & tip);
  39
  40         /// Are the tooltips on or off?
  41         static bool enabled() { return enabled_; }
  42
  43         /** This method is connected to Dialogs::toggleTooltips and toggles
  44          *  the state of enabled_.
  45          */
  46         static void toggleEnabled();
  47
  48 private:
  49
  50         /// This method is connected to the Tooltips::toggled signal.
  51         void set();
  52
  53         /// Are the tooltips on or off?
  54         static bool enabled_;
  55
  56         /** Once enabled_ is changed, then this signal is emitted to update
  57          *  all the tooltips.
  58          */
  59         static boost::signal0<void> toggled;
  60
  61         /// The tooltips are stored so that they can be turned on and off.
  62         typedef std::map<FL_OBJECT *, string> TooltipsMap;
  63
  64         TooltipsMap tooltipsMap;
  65 };
  66
  67 #endif // TOOLTIPS_H