Rationalize ArdourButton and lots of associated theming issues.
[ardour.git] / gtk2_ardour / ardour_button.h
1 /*
2     Copyright (C) 2010 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 #ifndef __gtk2_ardour_ardour_button_h__
20 #define __gtk2_ardour_ardour_button_h__
21
22 #include <list>
23 #include <stdint.h>
24
25 #include <gtkmm/action.h>
26
27 #include "pbd/signals.h"
28 #include "gtkmm2ext/binding_proxy.h"
29 #include "gtkmm2ext/activatable.h"
30 #include "gtkmm2ext/cairo_widget.h"
31
32 class ArdourButton : public CairoWidget , public Gtkmm2ext::Activatable
33 {
34   public:
35         enum Element {
36                 Edge = 0x1,
37                 Body = 0x2,
38                 Text = 0x4,
39                 Indicator = 0x8,
40                 unused = 0x10,
41                 Menu = 0x20,
42         };
43
44         static Element default_elements;
45         static Element led_default_elements;
46         static Element just_led_default_elements;
47
48         static void set_flat_buttons (bool yn);
49         static bool flat_buttons() { return _flat_buttons; }
50
51         ArdourButton (Element e = default_elements);
52         ArdourButton (const std::string&, Element e = default_elements);
53         virtual ~ArdourButton ();
54
55         enum Tweaks {
56                 unused1 = 0x1,
57                 unused2 = 0x2,
58                 unused3 = 0x4,
59         };
60
61         Tweaks tweaks() const { return _tweaks; }
62         void set_tweaks (Tweaks);
63
64         void set_active_state (Gtkmm2ext::ActiveState);
65         void set_visual_state (Gtkmm2ext::VisualState);
66
67         void set_act_on_release (bool onRelease) { _act_on_release = onRelease; }
68
69         Element elements() const { return _elements; }
70         void set_elements (Element);
71         void add_elements (Element);
72         
73         void set_corner_radius (float);
74         void set_diameter (float);
75
76         void set_text (const std::string&);
77         const std::string& get_text () {return _text;}
78         void set_markup (const std::string&);
79         void set_angle (const double);
80         void set_alignment (const float, const float);
81         void get_alignment (float& xa, float& ya) {xa = _xalign; ya = _yalign;};
82
83         void set_led_left (bool yn);
84         void set_distinct_led_click (bool yn);
85
86         Glib::RefPtr<Pango::Layout> layout() const { return _layout; }
87
88         sigc::signal<void> signal_led_clicked;
89         sigc::signal<void> signal_clicked;
90
91         boost::shared_ptr<PBD::Controllable> get_controllable() { return binding_proxy.get_controllable(); }
92         void set_controllable (boost::shared_ptr<PBD::Controllable> c);
93         void watch ();
94
95         void set_related_action (Glib::RefPtr<Gtk::Action>);
96
97         bool on_button_press_event (GdkEventButton*);
98         bool on_button_release_event (GdkEventButton*);
99
100         void set_image (const Glib::RefPtr<Gdk::Pixbuf>&);
101
102         void set_fixed_colors (const uint32_t active_color, const uint32_t inactive_color);
103
104   protected:
105         void render (cairo_t *, cairo_rectangle_t *);
106         void on_size_request (Gtk::Requisition* req);
107         void on_size_allocate (Gtk::Allocation&);
108         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
109         void on_name_changed ();
110         bool on_enter_notify_event (GdkEventCrossing*);
111         bool on_leave_notify_event (GdkEventCrossing*);
112         bool on_focus_in_event (GdkEventFocus*);
113         bool on_focus_out_event (GdkEventFocus*);
114         bool on_key_release_event (GdkEventKey *);
115
116         void controllable_changed ();
117         PBD::ScopedConnection watch_connection;
118
119   protected:
120         Glib::RefPtr<Pango::Layout> _layout;
121         Glib::RefPtr<Gdk::Pixbuf>   _pixbuf;
122         std::string                 _text;
123         Element                     _elements;
124         Tweaks                      _tweaks;
125         BindingProxy                binding_proxy;
126
127         int   _text_width;
128         int   _text_height;
129         float _diameter;
130         float _corner_radius;
131         int   _corner_mask;
132
133         double _angle;
134         float _xalign, _yalign;
135
136         uint32_t fill_inactive_color;
137         uint32_t fill_active_color;
138
139         uint32_t text_active_color;
140         uint32_t text_inactive_color;
141
142         uint32_t led_active_color;
143         uint32_t led_inactive_color;
144     
145         cairo_pattern_t* convex_pattern;
146         cairo_pattern_t* concave_pattern;
147
148         cairo_pattern_t* led_inset_pattern;
149     
150         cairo_rectangle_t* _led_rect;
151
152         bool _act_on_release;
153         bool _led_left;
154         bool _fixed_diameter;
155         bool _distinct_led_click;
156         bool _hovering;
157         bool _focused;
158         bool _fixed_colors_set;
159     
160         static bool _flat_buttons;
161
162         void setup_led_rect ();
163         void set_colors ();
164         void color_handler ();
165         void build_patterns ();
166
167         void action_toggled ();
168
169         void action_sensitivity_changed ();
170         void action_visibility_changed ();
171         void action_tooltip_changed ();
172 };
173
174 #endif /* __gtk2_ardour_ardour_button_h__ */