extra track header buttons are now ArdourButtons
[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
20 #ifndef __gtk2_ardour_ardour_button_h__
21 #define __gtk2_ardour_ardour_button_h__
22
23 #include <list>
24 #include <stdint.h>
25
26 #include <gtkmm/action.h>
27
28 #include "pbd/signals.h"
29 #include "gtkmm2ext/binding_proxy.h"
30
31 #include "cairo_widget.h"
32
33 class ArdourButton : public CairoWidget
34 {
35   public:
36         enum Element {
37                 Edge = 0x1,
38                 Body = 0x2,
39                 Text = 0x4,
40                 Indicator = 0x8,
41         };
42
43         static Element default_elements;
44         static Element led_default_elements;
45         static Element just_led_default_elements;
46
47         ArdourButton (Element e = default_elements);
48         ArdourButton (const std::string&, Element e = default_elements);
49         virtual ~ArdourButton ();
50
51         enum Tweaks {
52                 ShowClick = 0x1,
53                 NoModel = 0x4,
54         };
55
56         Tweaks tweaks() const { return _tweaks; }
57         void set_tweaks (Tweaks);
58
59         void set_active_state (Gtkmm2ext::ActiveState);
60         void set_visual_state (Gtkmm2ext::VisualState);
61
62         /* this is an API simplification for buttons
63            that only use the Active and Normal active states.
64         */
65         void set_active (bool);
66         bool get_active () { return active_state() != Gtkmm2ext::ActiveState (0); }
67
68         void set_elements (Element);
69         Element elements() const { return _elements; }
70
71         void set_corner_radius (float);
72         void set_diameter (float);
73
74         void set_text (const std::string&);
75         void set_markup (const std::string&);
76
77         void set_led_left (bool yn);
78         void set_distinct_led_click (bool yn);
79
80         sigc::signal<void> signal_led_clicked;
81         sigc::signal<void> signal_clicked;
82
83         boost::shared_ptr<PBD::Controllable> get_controllable() { return binding_proxy.get_controllable(); }
84         void set_controllable (boost::shared_ptr<PBD::Controllable> c);
85         void watch ();
86
87         void set_related_action (Glib::RefPtr<Gtk::Action>);
88
89         bool on_button_press_event (GdkEventButton*);
90         bool on_button_release_event (GdkEventButton*);
91
92         void set_image (const Glib::RefPtr<Gdk::Pixbuf>&);
93
94   protected:
95         void render (cairo_t *);
96         void on_size_request (Gtk::Requisition* req);
97         void on_size_allocate (Gtk::Allocation&);
98         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
99         bool on_enter_notify_event (GdkEventCrossing*);
100         bool on_leave_notify_event (GdkEventCrossing*);
101
102         void controllable_changed ();
103         PBD::ScopedConnection watch_connection;
104
105   private:
106         Glib::RefPtr<Pango::Layout> _layout;
107         Glib::RefPtr<Gdk::Pixbuf>   _pixbuf;
108         std::string                 _text;
109         Element                     _elements;
110         Tweaks                      _tweaks;
111         BindingProxy binding_proxy;
112         bool    _act_on_release;
113
114         int   _text_width;
115         int   _text_height;
116         float _diameter;
117         float _corner_radius;
118
119         cairo_pattern_t* edge_pattern;
120         cairo_pattern_t* fill_pattern;
121         cairo_pattern_t* led_inset_pattern;
122         cairo_pattern_t* reflection_pattern;
123
124         double text_r;
125         double text_g;
126         double text_b;
127         double text_a;
128
129         double led_r;
130         double led_g;
131         double led_b;
132         double led_a;
133
134         bool _led_left;
135         bool _fixed_diameter;
136         bool _distinct_led_click;
137         cairo_rectangle_t* _led_rect;
138         bool _hovering;
139
140         void setup_led_rect ();
141         void set_colors ();
142         void color_handler ();
143
144         Glib::RefPtr<Gtk::Action> _action;
145         void action_activated ();
146         void action_toggled ();
147
148         void action_sensitivity_changed ();
149         void action_visibility_changed ();
150         void action_tooltip_changed ();
151 };
152
153 #endif /* __gtk2_ardour_ardour_button_h__ */