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 #include "gtkmm2ext/visibility.h"
  26
  27 namespace Gtkmm2ext {
  28
  29 /** A class which offers a tooltip-like window which can be made to
  30  *  stay open during a drag.
  31  */
  32 class LIBGTKMM2EXT_API PersistentTooltip : public sigc::trackable
  33 {
  34   public:
  35         PersistentTooltip (Gtk::Widget *, bool draggable = false, int margin_y = 0);
  36         virtual ~PersistentTooltip ();
  37
  38         void set_tip (std::string);
  39         void set_font (Pango::FontDescription font);
  40         void set_center_alignment (bool align_to_center);
  41
  42         virtual bool dragging () const;
  43
  44   private:
  45         bool timeout ();
  46         void show ();
  47         void hide ();
  48         bool enter (GdkEventCrossing *);
  49         bool leave (GdkEventCrossing *);
  50         bool press (GdkEventButton *);
  51         bool release (GdkEventButton *);
  52
  53         /** The widget that we are providing a tooltip for */
  54         Gtk::Widget* _target;
  55         /** Our window */
  56         Gtk::Window* _window;
  57         /** Our label */
  58         Gtk::Label* _label;
  59
  60         /** allow to drag
  61          */
  62         bool _draggable;
  63         /** true if we are `dragging', in the sense that button 1
  64             is being held over _target.
  65         */
  66         bool _maybe_dragging;
  67         /** Connection to a timeout used to open the tooltip */
  68         sigc::connection _timeout;
  69         /** The tip text */
  70         std::string _tip;
  71         Pango::FontDescription _font;
  72         bool _align_to_center;
  73         int _margin_y;
  74 };
  75
  76 }
  77
  78 #endif