libs/gtkmm2ext/persistent_tooltip.cc

   1 /*
   2     Copyright (C) 2012 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <gtkmm/window.h>
  21 #include <gtkmm/label.h>
  22 #include "gtkmm2ext/persistent_tooltip.h"
  23
  24 #include "i18n.h"
  25
  26 using namespace std;
  27 using namespace Gtk;
  28 using namespace Gtkmm2ext;
  29
  30 /** @param target The widget to provide the tooltip for */
  31 PersistentTooltip::PersistentTooltip (Gtk::Widget* target)
  32         : _target (target)
  33         , _window (0)
  34         , _label (0)
  35         , _maybe_dragging (false)
  36 {
  37         target->signal_enter_notify_event().connect (sigc::mem_fun (*this, &PersistentTooltip::enter), false);
  38         target->signal_leave_notify_event().connect (sigc::mem_fun (*this, &PersistentTooltip::leave), false);
  39         target->signal_button_press_event().connect (sigc::mem_fun (*this, &PersistentTooltip::press), false);
  40         target->signal_button_release_event().connect (sigc::mem_fun (*this, &PersistentTooltip::release), false);
  41 }
  42
  43 PersistentTooltip::~PersistentTooltip ()
  44 {
  45         delete _window;
  46 }
  47
  48 bool
  49 PersistentTooltip::enter (GdkEventCrossing *)
  50 {
  51         if (_timeout.connected()) {
  52                 leave(NULL);
  53         }
  54         _timeout = Glib::signal_timeout().connect (sigc::mem_fun (*this, &PersistentTooltip::timeout), 500);
  55         return false;
  56 }
  57
  58 bool
  59 PersistentTooltip::timeout ()
  60 {
  61         show ();
  62         return false;
  63 }
  64
  65 bool
  66 PersistentTooltip::leave (GdkEventCrossing *)
  67 {
  68         _timeout.disconnect ();
  69         if (!dragging ()) {
  70                 hide ();
  71         }
  72
  73         return false;
  74 }
  75
  76 bool
  77 PersistentTooltip::press (GdkEventButton* ev)
  78 {
  79         if (ev->type == GDK_BUTTON_PRESS && ev->button == 1) {
  80                 _maybe_dragging = true;
  81         }
  82
  83         return false;
  84 }
  85
  86 bool
  87 PersistentTooltip::release (GdkEventButton* ev)
  88 {
  89         if (ev->type == GDK_BUTTON_RELEASE && ev->button == 1) {
  90                 _maybe_dragging = false;
  91         }
  92
  93         return false;
  94 }
  95
  96 bool
  97 PersistentTooltip::dragging () const
  98 {
  99         return _maybe_dragging;
 100 }
 101
 102 void
 103 PersistentTooltip::hide ()
 104 {
 105         if (_window) {
 106                 _window->hide ();
 107         }
 108 }
 109
 110 void
 111 PersistentTooltip::show ()
 112 {
 113         if (!_window) {
 114                 _window = new Window (WINDOW_POPUP);
 115                 _window->set_name (X_("ContrastingPopup"));
 116                 _window->set_position (WIN_POS_MOUSE);
 117                 _window->set_decorated (false);
 118
 119                 _label = manage (new Label);
 120                 _label->set_use_markup (true);
 121
 122                 _window->set_border_width (6);
 123                 _window->add (*_label);
 124                 _label->show ();
 125
 126                 Gtk::Window* tlw = dynamic_cast<Gtk::Window*> (_target->get_toplevel ());
 127                 if (tlw) {
 128                         _window->set_transient_for (*tlw);
 129                 }
 130         }
 131
 132         set_tip (_tip);
 133
 134         if (!_window->is_visible ()) {
 135                 int rx, ry, sw;
 136                 sw= gdk_screen_width();
 137                 _target->get_window()->get_origin (rx, ry);
 138                 _window->move (rx, ry + _target->get_height());
 139                 _window->present ();
 140
 141                 /* the window needs to be realized first
 142                  * for _window->get_width() to be correct.
 143                  */
 144                 if (sw < rx + _window->get_width()) {
 145                         rx = sw - _window->get_width();
 146                         _window->move (rx, ry + _target->get_height());
 147                 }
 148         }
 149 }
 150
 151 void
 152 PersistentTooltip::set_tip (string t)
 153 {
 154         _tip = t;
 155
 156         if (_label) {
 157                 _label->set_markup (t);
 158         }
 159 }