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>
25 #include "gtkmm2ext/visibility.h"
26 #include "gtkmm2ext/widget_state.h"
28 /** A parent class for widgets that are rendered using Cairo.
31 class LIBGTKMM2EXT_API CairoWidget : public Gtk::EventBox
35 virtual ~CairoWidget ();
39 Gtkmm2ext::ActiveState active_state() const { return _active_state; }
40 Gtkmm2ext::VisualState visual_state() const { return _visual_state; }
42 /* derived widgets can override these two to catch
43 changes in active & visual state
46 virtual void set_active_state (Gtkmm2ext::ActiveState);
47 virtual void set_visual_state (Gtkmm2ext::VisualState);
49 void unset_active_state () { set_active_state (Gtkmm2ext::Off); }
50 void unset_visual_state () { set_visual_state (Gtkmm2ext::NoVisualState); }
52 /* this is an API simplification for widgets
53 that only use the Active and Normal active states.
55 void set_active (bool);
56 bool get_active () { return active_state() != Gtkmm2ext::Off; }
58 /* widgets can be told to only draw their "foreground, and thus leave
59 in place whatever background is drawn by their parent. the default
60 is that the widget will fill its event window with the background
61 color of the parent container.
64 void set_draw_background (bool yn);
66 sigc::signal<void> StateChanged;
68 static void provide_background_for_cairo_widget (Gtk::Widget& w, const Gdk::Color& bg);
70 virtual void render (cairo_t *, cairo_rectangle_t*) = 0;
72 static void set_flat_buttons (bool yn);
73 static bool flat_buttons() { return _flat_buttons; }
75 static void set_source_rgb_a( cairo_t* cr, Gdk::Color, float a=1.0 );
77 /* set_focus_handler() will cause all button-press events on any
78 CairoWidget to invoke this slot/functor/function/method/callback.
80 We do this because in general, CairoWidgets do not grab
81 keyboard focus, but a button press on them should
82 clear focus from any active text entry.
84 This is global to all CairoWidgets and derived types.
86 However, derived types can override the behaviour by defining their
87 own on_button_press_event() handler which returns true under all
88 conditions (which will block this handler from being called). If
89 they wish to invoke any existing focus handler from their own
90 button press handler, they can just use: focus_handler();
92 static void set_focus_handler (sigc::slot<void>);
95 /** Render the widget to the given Cairo context */
96 virtual bool on_expose_event (GdkEventExpose *);
97 void on_size_allocate (Gtk::Allocation &);
98 void on_state_changed (Gtk::StateType);
99 void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
100 bool on_button_press_event (GdkEventButton*);
101 Gdk::Color get_parent_bg ();
103 /* this is an additional virtual "on_..." method. Glibmm does not
104 provide a direct signal for name changes, so this acts as a proxy.
107 virtual void on_name_changed () {};
109 Gtkmm2ext::ActiveState _active_state;
110 Gtkmm2ext::VisualState _visual_state;
113 static bool _flat_buttons;
116 static sigc::slot<void> focus_handler;
119 Glib::SignalProxyProperty _name_proxy;
120 sigc::connection _parent_style_change;
121 Widget * _current_parent;