gtk2_ardour/cairo_widget.h

   1 /*
   2     Copyright (C) 2009 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 __gtk2_ardour_cairo_widget_h__
  21 #define __gtk2_ardour_cairo_widget_h__
  22
  23 #include <gtkmm/eventbox.h>
  24
  25 /** A parent class for widgets that are made up of a pixmap rendered using Cairo.
  26  *  The pixmap is painted to screen on GTK expose events, but the rendering
  27  *  is only done after set_dirty() has been called.
  28  */
  29
  30 class CairoWidget : public Gtk::EventBox
  31 {
  32 public:
  33         CairoWidget ();
  34         virtual ~CairoWidget ();
  35
  36         void set_dirty ();
  37
  38         /* widget states: unlike GTK, visual states like "Selected" or "Prelight"
  39            are orthogonal to active states.
  40         */
  41
  42         enum ActiveState {
  43                 Active = 1,
  44                 Mid,
  45         };
  46
  47         enum VisualState {
  48                 /* these can be OR-ed together */
  49                 Selected = 0x1,
  50                 Prelight = 0x2,
  51                 Insensitive = 0x4,
  52         };
  53
  54         ActiveState active_state() const { return _active_state; }
  55         VisualState visual_state() const { return _visual_state; }
  56         virtual void set_active_state (ActiveState);
  57         virtual void set_visual_state (VisualState);
  58         virtual void unset_active_state () { set_active_state (ActiveState (0)); }
  59         virtual void unset_visual_state () { set_visual_state (VisualState (0)); }
  60
  61         sigc::signal<void> StateChanged;
  62
  63 protected:
  64         /** Render the widget to the given Cairo context */
  65         virtual void render (cairo_t *) = 0;
  66         virtual bool on_expose_event (GdkEventExpose *);
  67         void on_size_allocate (Gtk::Allocation &);
  68         Gdk::Color get_parent_bg ();
  69
  70         int _width; ///< pixmap width
  71         int _height; ///< pixmap height
  72         ActiveState _active_state;
  73         VisualState _visual_state;
  74
  75 private:
  76         GdkPixmap* _pixmap; ///< our pixmap
  77         bool _dirty; ///< true if the pixmap requires re-rendering
  78 };
  79
  80 #endif