libs/gtkmm2ext/gtkmm2ext/persistent_tooltip.h

   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 #ifndef gtkmm2ext_persistent_tooltip_h
  21 #define gtkmm2ext_persistent_tooltip_h
  22
  23 #include <sigc++/trackable.h>
  24
  25 namespace Gtkmm2ext {
  26
  27 /** A class which offers a tooltip-like window which can be made to
  28  *  stay open during a drag.
  29  */
  30 class PersistentTooltip : public sigc::trackable
  31 {
  32 public:
  33         PersistentTooltip (Gtk::Widget *);
  34         virtual ~PersistentTooltip ();
  35
  36         void set_tip (std::string);
  37
  38         virtual bool dragging () const;
  39
  40 private:
  41         bool timeout ();
  42         void show ();
  43         void hide ();
  44         bool enter (GdkEventCrossing *);
  45         bool leave (GdkEventCrossing *);
  46         bool press (GdkEventButton *);
  47         bool release (GdkEventButton *);
  48
  49         /** The widget that we are providing a tooltip for */
  50         Gtk::Widget* _target;
  51         /** Our window */
  52         Gtk::Window* _window;
  53         /** Our label */
  54         Gtk::Label* _label;
  55         /** true if we are `dragging', in the sense that button 1
  56             is being held over _target.
  57         */
  58         bool _maybe_dragging;
  59         /** Connection to a timeout used to open the tooltip */
  60         sigc::connection _timeout;
  61         /** The tip text */
  62         std::string _tip;
  63 };
  64
  65 }
  66
  67 #endif