src/frontends/xforms/Tooltips.C

   1 /**
   2  * \file Tooltips.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS
   9  */
  10
  11 /* Tooltips for xforms. xforms 0.89 supports them directly, but 0.88 needs
  12  * a bit of jiggery pokery. This class wraps it all up in a neat interface.
  13  * Based on code originally in Toolbar_pimpl.C that appears to have been
  14  * written by Matthias Ettrich and Jean-Marc Lasgouttes.
  15  */
  16
  17 #include <config.h>
  18
  19 #ifdef __GNUG__
  20 #pragma implementation
  21 #endif
  22
  23 #include "Tooltips.h"
  24 #include "xforms_helpers.h" // formatted
  25 #include "gettext.h"
  26 #include "support/lstrings.h"
  27 #include "support/LAssert.h"
  28 #include FORMS_H_LOCATION
  29
  30 #include <boost/bind.hpp>
  31
  32 bool Tooltips::enabled_ = true;
  33
  34 boost::signal0<void> Tooltips::toggled;
  35
  36
  37 #if FL_VERSION > 0 || FL_REVISION >= 89
  38
  39 Tooltips::Tooltips()
  40 {
  41         toggled.connect(boost::bind(&Tooltips::set, this));
  42 }
  43
  44
  45 void Tooltips::toggleEnabled()
  46 {
  47         enabled_ = !enabled_;
  48         toggled();
  49 }
  50
  51
  52 void Tooltips::set()
  53 {
  54         if (tooltipsMap.empty())
  55                 // There are no objects with tooltips in this dialog, so
  56                 // just go away. Don't change the cursor to a question mark.
  57                 return;
  58
  59         TooltipsMap::iterator it  = tooltipsMap.begin();
  60         TooltipsMap::iterator end = tooltipsMap.end();
  61         for (; it != end; ++it) {
  62                 FL_OBJECT * const ob = it->first;
  63                 char const * const c_str = enabled_ ? it->second.c_str() : 0;
  64                 fl_set_object_helper(ob, c_str);
  65         }
  66 }
  67
  68
  69 void Tooltips::init(FL_OBJECT * ob, string const & tip)
  70 {
  71         lyx::Assert(ob && ob->form);
  72
  73         // Paranoia check!
  74         TooltipsMap::const_iterator it = tooltipsMap.find(ob);
  75         if (it != tooltipsMap.end())
  76                 return;
  77
  78         string const str = trim(tip);
  79         if (str.empty())
  80                 return;
  81
  82         // Store the tooltip string
  83         tooltipsMap[ob] = formatted(str, 400);
  84
  85         // Set the tooltip
  86         char const * const c_str = enabled_ ? str.c_str() : 0;
  87         fl_set_object_helper(ob, c_str);
  88 }
  89
  90
  91 #else // if FL_REVISION < 89
  92
  93 namespace {
  94
  95 int TooltipHandler(FL_OBJECT *ob, int event);
  96
  97 void TooltipTimerCB(FL_OBJECT * timer, long data);
  98
  99 }
 100
 101 extern "C" {
 102
 103 static int C_TooltipHandler(FL_OBJECT * ob, int event,
 104                                     FL_Coord, FL_Coord, int, void *)
 105 {
 106         return TooltipHandler(ob, event);
 107 }
 108
 109
 110 static void C_TooltipTimerCB(FL_OBJECT * ob, long data)
 111 {
 112         TooltipTimerCB(ob, data);
 113 }
 114
 115 }
 116
 117
 118 Tooltips::Tooltips()
 119         : tooltip_timer_(0)
 120 {
 121         toggled.connect(boost::bind(&Tooltips::set, this));
 122 }
 123
 124
 125 void Tooltips::toggleEnabled()
 126 {
 127         enabled_ = !enabled_;
 128         toggled();
 129 }
 130
 131
 132 void Tooltips::set()
 133 {}
 134
 135
 136 void Tooltips::init(FL_OBJECT * ob, string const & tip)
 137 {
 138         lyx::Assert(ob && ob->form);
 139
 140         // Paranoia check!
 141         TooltipsMap::const_iterator it = tooltipsMap.find(ob);
 142         if (it != tooltipsMap.end())
 143                 return;
 144
 145         string const str = trim(tip);
 146         if (str.empty())
 147                 return;
 148
 149         // Store the tooltip string
 150         tooltipsMap[ob] = formatted(str, 400);
 151
 152         if (!tooltip_timer_) {
 153                 if (fl_current_form && ob->form != fl_current_form)
 154                         fl_end_form();
 155
 156                 bool const open_form = !fl_current_form;
 157                 if (open_form)
 158                         fl_addto_form(ob->form);
 159
 160                 tooltip_timer_ = fl_add_timer(FL_HIDDEN_TIMER, 0, 0, 0, 0, "");
 161
 162                 if (open_form)
 163                         fl_end_form();
 164         }
 165
 166         fl_set_object_posthandler(ob, C_TooltipHandler);
 167         ob->u_cdata = reinterpret_cast<char *>(tooltip_timer_);
 168         tooltip_timer_->u_vdata = this;
 169 }
 170
 171
 172 string const Tooltips::get(FL_OBJECT * ob) const
 173 {
 174         TooltipsMap::const_iterator it = tooltipsMap.find(ob);
 175         if (it == tooltipsMap.end())
 176                 return string();
 177         return it->second;
 178 }
 179
 180
 181 namespace {
 182
 183 void TooltipTimerCB(FL_OBJECT * timer, long data)
 184 {
 185         FL_OBJECT * ob = reinterpret_cast<FL_OBJECT*>(data);
 186         lyx::Assert(ob && ob->form && timer && timer->u_vdata);
 187         FL_FORM * form = ob->form;
 188         Tooltips * tooltip = static_cast<Tooltips *>(timer->u_vdata);
 189
 190         string const help = tooltip->get(ob);
 191         if (help.empty())
 192                 return;
 193
 194         fl_show_oneliner(help.c_str(),
 195                          form->x + ob->x, form->y + ob->y + ob->h);
 196 }
 197
 198
 199 // post_handler for tooltip help
 200 int TooltipHandler(FL_OBJECT * ob, int event)
 201 {
 202         if (!Tooltips::enabled())
 203                 return 0;
 204
 205         lyx::Assert(ob);
 206         FL_OBJECT * timer = reinterpret_cast<FL_OBJECT *>(ob->u_cdata);
 207         lyx::Assert(timer);
 208
 209         // We do not test for empty help here, since this can never happen
 210         if (event == FL_ENTER) {
 211                 fl_set_object_callback(timer,
 212                                        C_TooltipTimerCB,
 213                                        reinterpret_cast<long>(ob));
 214                 fl_set_timer(timer, 1);
 215         }
 216         else if (event != FL_MOTION) {
 217                 fl_set_timer(timer, 0);
 218                 fl_hide_oneliner();
 219         }
 220         return 0;
 221 }
 222
 223 } // namespace anon
 224
 225 #endif // FL_REVISION >= 89