2 Copyright (C) 2012 Paul Davis
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.
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.
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.
20 #include <gtkmm/window.h>
21 #include <gtkmm/label.h>
22 #include <gtkmm/settings.h>
23 #include "gtkmm2ext/persistent_tooltip.h"
25 #include "pbd/stacktrace.h"
31 using namespace Gtkmm2ext;
33 bool PersistentTooltip::_tooltips_enabled = true;
34 unsigned int PersistentTooltip::_tooltip_timeout = 500;
36 /** @param target The widget to provide the tooltip for */
37 PersistentTooltip::PersistentTooltip (Gtk::Widget* target, bool draggable, int margin_y)
41 , _draggable (draggable)
42 , _maybe_dragging (false)
43 , _align_to_center (true)
44 , _margin_y (margin_y)
46 target->signal_enter_notify_event().connect (sigc::mem_fun (*this, &PersistentTooltip::enter), false);
47 target->signal_leave_notify_event().connect (sigc::mem_fun (*this, &PersistentTooltip::leave), false);
48 target->signal_button_press_event().connect (sigc::mem_fun (*this, &PersistentTooltip::press), false);
49 target->signal_button_release_event().connect (sigc::mem_fun (*this, &PersistentTooltip::release), false);
50 _tooltip_timeout = Gtk::Settings::get_default()->property_gtk_tooltip_timeout ();
53 PersistentTooltip::~PersistentTooltip ()
59 PersistentTooltip::enter (GdkEventCrossing *)
61 if (_timeout.connected()) {
64 _timeout = Glib::signal_timeout().connect (sigc::mem_fun (*this, &PersistentTooltip::timeout), _tooltip_timeout);
69 PersistentTooltip::timeout ()
76 PersistentTooltip::leave (GdkEventCrossing *)
78 _timeout.disconnect ();
87 PersistentTooltip::press (GdkEventButton* ev)
89 if (ev->type == GDK_BUTTON_PRESS && ev->button == 1) {
90 _maybe_dragging = true;
97 PersistentTooltip::release (GdkEventButton* ev)
99 if (ev->type == GDK_BUTTON_RELEASE && ev->button == 1) {
100 _maybe_dragging = false;
107 PersistentTooltip::dragging () const
109 return _maybe_dragging && _draggable;
113 PersistentTooltip::hide ()
121 PersistentTooltip::show ()
123 if (_tip.empty() || !_tooltips_enabled) {
128 _window = new Window (WINDOW_POPUP);
129 _window->set_name (X_("ContrastingPopup"));
130 _window->set_position (WIN_POS_MOUSE);
131 _window->set_decorated (false);
133 _label = manage (new Label);
134 _label->modify_font (_font);
135 _label->set_use_markup (true);
137 _window->set_border_width (6);
138 _window->add (*_label);
141 Gtk::Window* tlw = dynamic_cast<Gtk::Window*> (_target->get_toplevel ());
143 _window->set_transient_for (*tlw);
149 if (!_window->is_visible ()) {
151 int sw = gdk_screen_width ();
153 _target->get_window()->get_origin (rx, ry);
155 /* the window needs to be realized first
156 * for _window->get_width() to be correct.
160 if (sw < rx + _window->get_width()) {
161 /* right edge of window would be off the right edge of
162 the screen, so don't show it in the usual place.
164 rx = sw - _window->get_width();
165 _window->move (rx, ry + _target->get_height() + _margin_y);
167 if (_align_to_center) {
168 _window->move (rx + (_target->get_width () - _window->get_width ()) / 2, ry + _target->get_height());
170 _window->move (rx, ry + _target->get_height());
180 PersistentTooltip::set_tip (string t)
185 _label->set_markup (t);
190 PersistentTooltip::set_font (Pango::FontDescription font)
195 _label->modify_font (_font);
200 PersistentTooltip::set_center_alignment (bool align_to_center)
202 _align_to_center = align_to_center;