2 Copyright (C) 2009 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 #ifndef __gtk2_ardour_cairo_widget_h__
21 #define __gtk2_ardour_cairo_widget_h__
23 #include <gtkmm/eventbox.h>
24 #include "gtkmm2ext/widget_state.h"
26 /** A parent class for widgets that are rendered using Cairo.
29 class CairoWidget : public Gtk::EventBox
33 virtual ~CairoWidget ();
37 Gtkmm2ext::ActiveState active_state() const { return _active_state; }
38 Gtkmm2ext::VisualState visual_state() const { return _visual_state; }
40 /* derived widgets can override these two to catch
41 changes in active & visual state
44 virtual void set_active_state (Gtkmm2ext::ActiveState);
45 virtual void set_visual_state (Gtkmm2ext::VisualState);
47 void unset_active_state () { set_active_state (Gtkmm2ext::Off); }
48 void unset_visual_state () { set_visual_state (Gtkmm2ext::NoVisualState); }
50 /* this is an API simplification for widgets
51 that only use the Active and Normal active states.
53 void set_active (bool);
54 bool get_active () { return active_state() != Gtkmm2ext::Off; }
56 /* widgets can be told to only draw their "foreground, and thus leave
57 in place whatever background is drawn by their parent. the default
58 is that the widget will fill its event window with the background
59 color of the parent container.
62 void set_draw_background (bool yn);
64 sigc::signal<void> StateChanged;
66 static void provide_background_for_cairo_widget (Gtk::Widget& w, const Gdk::Color& bg);
69 /** Render the widget to the given Cairo context */
70 virtual void render (cairo_t *) = 0;
71 virtual bool on_expose_event (GdkEventExpose *);
72 void on_size_allocate (Gtk::Allocation &);
73 void on_state_changed (Gtk::StateType);
74 Gdk::Color get_parent_bg ();
76 Gtkmm2ext::ActiveState _active_state;
77 Gtkmm2ext::VisualState _visual_state;