add hovering/show click functionality to ArdourButton
[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                 ShowHover = 0x2,
54                 NoModel = 0x4,
55         };
56
57         Tweaks tweaks() const { return _tweaks; }
58         void set_tweaks (Tweaks);
59
60         void set_active_state (Gtkmm2ext::ActiveState);
61         void set_visual_state (Gtkmm2ext::VisualState);
62
63         void set_elements (Element);
64         Element elements() const { return _elements; }
65
66         void set_corner_radius (float);
67         void set_diameter (float);
68
69         void set_text (const std::string&);
70         void set_markup (const std::string&);
71
72         void set_led_left (bool yn);
73         void set_distinct_led_click (bool yn);
74
75         sigc::signal<void> signal_led_clicked;
76
77         boost::shared_ptr<PBD::Controllable> get_controllable() { return binding_proxy.get_controllable(); }
78         void set_controllable (boost::shared_ptr<PBD::Controllable> c);
79         void watch ();
80
81         void set_related_action (Glib::RefPtr<Gtk::Action>);
82
83         bool on_button_press_event (GdkEventButton*);
84         bool on_button_release_event (GdkEventButton*);
85
86         void set_image (const Glib::RefPtr<Gdk::Pixbuf>&);
87
88   protected:
89         void render (cairo_t *);
90         void on_size_request (Gtk::Requisition* req);
91         void on_size_allocate (Gtk::Allocation&);
92         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
93         bool on_enter_notify_event (GdkEventCrossing*);
94         bool on_leave_notify_event (GdkEventCrossing*);
95
96         void controllable_changed ();
97         PBD::ScopedConnection watch_connection;
98
99   private:
100         Glib::RefPtr<Pango::Layout> _layout;
101         Glib::RefPtr<Gdk::Pixbuf>   _pixbuf;
102         std::string                 _text;
103         Element                     _elements;
104         Tweaks                      _tweaks;
105         BindingProxy binding_proxy;
106         bool    _act_on_release;
107
108         int   _text_width;
109         int   _text_height;
110         float _diameter;
111         float _corner_radius;
112
113         cairo_pattern_t* edge_pattern;
114         cairo_pattern_t* fill_pattern;
115         cairo_pattern_t* led_inset_pattern;
116         cairo_pattern_t* reflection_pattern;
117
118         double text_r;
119         double text_g;
120         double text_b;
121         double text_a;
122
123         double led_r;
124         double led_g;
125         double led_b;
126         double led_a;
127
128         bool _led_left;
129         bool _fixed_diameter;
130         bool _distinct_led_click;
131         cairo_rectangle_t* _led_rect;
132         bool _hovering;
133
134         void setup_led_rect ();
135         void set_colors ();
136         void color_handler ();
137
138         Glib::RefPtr<Gtk::Action> _action;
139         void action_activated ();
140         void action_toggled ();
141 };
142
143 #endif /* __gtk2_ardour_ardour_button_h__ */