2 Copyright (C) 2010 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.
19 #ifndef __gtk2_ardour_ardour_button_h__
20 #define __gtk2_ardour_ardour_button_h__
25 #include <gtkmm/action.h>
27 #include "pbd/signals.h"
28 #include "gtkmm2ext/ardour_icon.h"
29 #include "gtkmm2ext/binding_proxy.h"
30 #include "gtkmm2ext/activatable.h"
31 #include "gtkmm2ext/cairo_widget.h"
33 class ArdourButton : public CairoWidget , public Gtkmm2ext::Activatable
43 Inactive = 0x40, // no _action is defined AND state is not used
45 IconRenderCallback = 0x100,
48 typedef void (* rendercallback_t) (cairo_t*, int, int, uint32_t, void*);
50 static Element default_elements;
51 static Element led_default_elements;
52 static Element just_led_default_elements;
54 ArdourButton (Element e = default_elements);
55 ArdourButton (const std::string&, Element e = default_elements);
56 virtual ~ArdourButton ();
65 Tweaks tweaks() const { return _tweaks; }
66 void set_tweaks (Tweaks);
68 void set_active_state (Gtkmm2ext::ActiveState);
69 void set_visual_state (Gtkmm2ext::VisualState);
71 void set_custom_led_color (const uint32_t c, const bool useit = true);
73 void set_act_on_release (bool onRelease) { _act_on_release = onRelease; }
75 Element elements() const { return _elements; }
76 void set_elements (Element);
77 void add_elements (Element);
79 Gtkmm2ext::ArdourIcon::Icon icon() const { return _icon; }
80 void set_icon (Gtkmm2ext::ArdourIcon::Icon);
81 void set_icon (rendercallback_t, void*);
83 void set_corner_radius (float);
85 void set_text (const std::string&, bool markup = false);
86 const std::string& get_text () { return _text; }
87 bool get_markup () const { return _markup; }
88 void set_angle (const double);
89 void set_alignment (const float, const float);
90 void get_alignment (float& xa, float& ya) {xa = _xalign; ya = _yalign;};
92 void set_led_left (bool yn);
93 void set_distinct_led_click (bool yn);
95 void set_layout_ellipsize_width (int w);
96 void set_layout_font (const Pango::FontDescription&);
97 void set_text_ellipsize (Pango::EllipsizeMode);
99 /* Sets the text used for size request computation. Pass an
100 * empty string to return to the default behavior which uses
101 * the currently displayed text for measurement. */
102 void set_sizing_text (const std::string&);
103 const std::string& get_sizing_text () {return _sizing_text;}
105 sigc::signal<void, GdkEventButton*> signal_led_clicked;
106 sigc::signal<void> signal_clicked;
108 boost::shared_ptr<PBD::Controllable> get_controllable() { return binding_proxy.get_controllable(); }
109 void set_controllable (boost::shared_ptr<PBD::Controllable> c);
112 void set_related_action (Glib::RefPtr<Gtk::Action>);
114 bool on_button_press_event (GdkEventButton*);
115 bool on_button_release_event (GdkEventButton*);
117 void set_image (const Glib::RefPtr<Gdk::Pixbuf>&);
119 void set_fixed_colors (const uint32_t active_color, const uint32_t inactive_color);
120 void set_active_color (const uint32_t active_color);
121 void set_inactive_color (const uint32_t inactive_color);
123 void set_fallthrough_to_parent(bool fall) { _fallthrough_to_parent = fall; }
125 unsigned int char_pixel_width() { if (_char_pixel_width < 1) recalc_char_pixel_geometry() ; return _char_pixel_width; }
126 unsigned int char_pixel_height() { if (_char_pixel_height < 1) recalc_char_pixel_geometry() ; return _char_pixel_height; }
127 float char_avg_pixel_width() { if (_char_pixel_width < 1) recalc_char_pixel_geometry() ; return _char_avg_pixel_width; }
130 void render (Cairo::RefPtr<Cairo::Context> const&, cairo_rectangle_t*);
131 void on_size_request (Gtk::Requisition* req);
132 void on_size_allocate (Gtk::Allocation&);
133 void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
134 void on_name_changed ();
136 bool on_enter_notify_event (GdkEventCrossing*);
137 bool on_leave_notify_event (GdkEventCrossing*);
138 bool on_grab_broken_event(GdkEventGrabBroken*);
139 bool on_focus_in_event (GdkEventFocus*);
140 bool on_focus_out_event (GdkEventFocus*);
141 bool on_key_release_event (GdkEventKey *);
142 bool on_key_press_event (GdkEventKey *);
144 void controllable_changed ();
145 PBD::ScopedConnection watch_connection;
148 Glib::RefPtr<Pango::Layout> _layout;
149 Glib::RefPtr<Gdk::Pixbuf> _pixbuf;
151 std::string _sizing_text;
154 Gtkmm2ext::ArdourIcon::Icon _icon;
155 rendercallback_t _icon_render_cb;
156 void* _icon_render_cb_data;
158 BindingProxy binding_proxy;
160 void set_text_internal ();
161 void recalc_char_pixel_geometry ();
162 unsigned int _char_pixel_width;
163 unsigned int _char_pixel_height;
164 float _char_avg_pixel_width;
169 float _corner_radius;
173 float _xalign, _yalign;
175 uint32_t fill_inactive_color;
176 uint32_t fill_active_color;
178 uint32_t text_active_color;
179 uint32_t text_inactive_color;
181 uint32_t led_active_color;
182 uint32_t led_inactive_color;
183 uint32_t led_custom_color;
184 bool use_custom_led_color;
186 cairo_pattern_t* convex_pattern;
187 cairo_pattern_t* concave_pattern;
188 cairo_pattern_t* led_inset_pattern;
189 cairo_rectangle_t* _led_rect;
191 bool _act_on_release;
193 bool _distinct_led_click;
196 int _fixed_colors_set;
197 bool _fallthrough_to_parent;
198 int _layout_ellipsize_width;
199 Pango::EllipsizeMode _ellipsis;
203 void setup_led_rect ();
205 void color_handler ();
206 void build_patterns ();
207 void ensure_layout ();
209 void action_toggled ();
210 void action_sensitivity_changed ();
211 void action_visibility_changed ();
212 void action_tooltip_changed ();
215 #endif /* __gtk2_ardour_ardour_button_h__ */