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.
24 #include <pangomm/layout.h>
26 #include "pbd/compose.h"
27 #include "pbd/error.h"
28 #include "pbd/stacktrace.h"
30 #include "gtkmm2ext/utils.h"
31 #include "gtkmm2ext/rgb_macros.h"
32 #include "gtkmm2ext/gui_thread.h"
34 #include "ardour/rc_configuration.h" // for widget prelight preference
36 #include "canvas/utils.h"
38 #include "ardour_button.h"
39 #include "ardour_ui.h"
40 #include "global_signals.h"
44 #define REFLECTION_HEIGHT 2
54 ArdourButton::Element ArdourButton::default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text);
55 ArdourButton::Element ArdourButton::led_default_elements = ArdourButton::Element (ArdourButton::default_elements|ArdourButton::Indicator);
56 ArdourButton::Element ArdourButton::just_led_default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Indicator);
58 ArdourButton::ArdourButton (Element e)
60 , _tweaks (Tweaks (0))
64 , _corner_radius (4.0)
69 , fill_inactive_color (0)
70 , fill_active_color (0)
71 , text_active_color(0)
72 , text_inactive_color(0)
74 , led_inactive_color(0)
77 , led_inset_pattern (0)
79 , _act_on_release (true)
81 , _fixed_diameter (true)
82 , _distinct_led_click (false)
85 , _fixed_colors_set (false)
86 , _fallthrough_to_parent (false)
88 ARDOUR_UI_UTILS::ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
91 ArdourButton::ArdourButton (const std::string& str, Element e)
93 , _tweaks (Tweaks (0))
97 , _corner_radius (4.0)
102 , fill_inactive_color (0)
103 , fill_active_color (0)
104 , text_active_color(0)
105 , text_inactive_color(0)
106 , led_active_color(0)
107 , led_inactive_color(0)
109 , concave_pattern (0)
110 , led_inset_pattern (0)
112 , _act_on_release (true)
114 , _fixed_diameter (true)
115 , _distinct_led_click (false)
118 , _fixed_colors_set (false)
123 ArdourButton::~ArdourButton()
127 if (convex_pattern) {
128 cairo_pattern_destroy (convex_pattern);
131 if (concave_pattern) {
132 cairo_pattern_destroy (concave_pattern);
135 if (led_inset_pattern) {
136 cairo_pattern_destroy (led_inset_pattern);
142 ArdourButton::set_text (const std::string& str)
146 if (!_layout && !_text.empty()) {
147 _layout = Pango::Layout::create (get_pango_context());
151 _layout->set_text (str);
158 ArdourButton::set_markup (const std::string& str)
163 _layout = Pango::Layout::create (get_pango_context());
166 _layout->set_markup (str);
171 ArdourButton::set_angle (const double angle)
177 ArdourButton::set_alignment (const float xa, const float ya)
184 ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
188 if ( active_state() == Gtkmm2ext::ExplicitActive ) {
189 text_color = text_active_color;
190 led_color = led_active_color;
192 text_color = text_inactive_color;
193 led_color = led_inactive_color;
196 void (*rounded_function)(cairo_t*, double, double, double, double, double);
198 switch (_corner_mask) {
199 case 0x1: /* upper left only */
200 rounded_function = Gtkmm2ext::rounded_top_left_rectangle;
202 case 0x2: /* upper right only */
203 rounded_function = Gtkmm2ext::rounded_top_right_rectangle;
205 case 0x3: /* upper only */
206 rounded_function = Gtkmm2ext::rounded_top_rectangle;
208 /* should really have functions for lower right, lower left,
209 lower only, but for now, we don't
212 rounded_function = Gtkmm2ext::rounded_rectangle;
215 if (!_fixed_diameter) {
216 _diameter = std::min (get_width(), get_height());
219 //border and background fill
220 if ((_elements & Body)==Body) {
221 if (_elements & Edge) {
223 cairo_set_source_rgba (cr, 0, 0, 0, 1);
224 rounded_function(cr, 0, 0, get_width(), get_height(), _corner_radius);
227 rounded_function (cr, 1, 1, get_width()-2, get_height()-2, _corner_radius - 1.5);
229 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
232 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
234 ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
238 cairo_set_line_width (cr, 2.0);
239 rounded_function (cr, 2, 2, get_width()-4, get_height()-4, _corner_radius - 1.5);
240 ArdourCanvas::set_source_rgba (cr, fill_active_color);
243 } else if ( (active_state() == Gtkmm2ext::ExplicitActive) && !((_elements & Indicator)==Indicator) ) {
246 ArdourCanvas::set_source_rgba (cr, fill_active_color);
249 } else { //inactive, or it has an indicator
252 ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
258 //show the "convex" or "concave" gradient
259 if (!_flat_buttons) {
260 if ( active_state() == Gtkmm2ext::ExplicitActive && !((_elements & Indicator)==Indicator) ) {
262 float width = get_width(); float height = get_height();
263 cairo_set_source (cr, concave_pattern);
264 Gtkmm2ext::rounded_rectangle (cr, 1, 1, width-2, height-2, _corner_radius - 1.5);
267 float width = get_width(); float height = get_height();
268 cairo_set_source (cr, convex_pattern);
269 Gtkmm2ext::rounded_rectangle (cr, 1, 1, width-2, height-2, _corner_radius - 1.5);
278 x = (get_width() - _pixbuf->get_width())/2.0;
279 y = (get_height() - _pixbuf->get_height())/2.0;
281 //if this is a DropDown with an icon, then we need to
282 //move the icon left slightly to accomomodate the arrow
283 if (((_elements & Menu)==Menu)) {
285 cairo_translate (cr, -8,0 );
288 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
289 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
292 //..and then return to our previous drawing position
293 if (((_elements & Menu)==Menu)) {
299 if (get_width() < 75) {
306 if ( !_pixbuf && ((_elements & Text)==Text) && !_text.empty()) {
309 cairo_rectangle (cr, 2, 1, get_width()-4, get_height()-2);
313 ArdourCanvas::set_source_rgba (cr, text_color);
315 if ( (_elements & Menu) == Menu) {
316 cairo_move_to (cr, text_margin, get_height()/2.0 - _text_height/2.0);
317 pango_cairo_show_layout (cr, _layout->gobj());
318 } else if ( (_elements & Indicator) == Indicator) {
320 cairo_move_to (cr, text_margin + _diameter + 4, get_height()/2.0 - _text_height/2.0);
322 cairo_move_to (cr, text_margin, get_height()/2.0 - _text_height/2.0);
324 pango_cairo_show_layout (cr, _layout->gobj());
332 cairo_save (cr); // TODO retain rotataion.. adj. LED,...
333 cairo_rotate(cr, _angle * M_PI / 180.0);
334 cairo_device_to_user(cr, &ww, &wh);
335 xa = (ww - _text_width) * _xalign;
336 ya = (wh - _text_height) * _yalign;
338 /* quick hack for left/bottom alignment at -90deg
339 * TODO this should be generalized incl rotation.
340 * currently only 'user' of this API is meter_strip.cc
342 if (_xalign < 0) xa = (ww * fabs(_xalign) + text_margin);
344 // TODO honor left/right text_margin with min/max()
346 cairo_move_to (cr, xa, ya);
347 pango_cairo_update_layout(cr, _layout->gobj());
348 pango_cairo_show_layout (cr, _layout->gobj());
351 /* use old center'ed layout for follow up items - until rotation/aligment code is completed */
352 cairo_move_to (cr, (get_width() - _text_width)/2.0, get_height()/2.0 - _text_height/2.0);
358 if (((_elements & Menu)==Menu)) {
363 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
364 cairo_move_to(cr, get_width() - ((_diameter/2.0) + 6.0), get_height()/2.0 +_diameter/4);
365 cairo_rel_line_to(cr, -_diameter/2, -_diameter/2);
366 cairo_rel_line_to(cr, _diameter, 0);
367 cairo_close_path(cr);
368 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
369 cairo_fill_preserve(cr);
370 cairo_set_source_rgba (cr, 0, 0, 0, 0.8);
371 cairo_set_line_width(cr, 0.5);
378 if (((_elements & Indicator)==Indicator)) {
380 /* move to the center of the indicator/led */
384 if (_elements & Text) {
386 cairo_translate (cr, text_margin + (_diameter/2.0), get_height()/2.0);
388 cairo_translate (cr, get_width() - ((_diameter/2.0) + 4.0), get_height()/2.0);
391 cairo_translate (cr, get_width()/2.0, get_height()/2.0);
395 if (!_flat_buttons) {
396 cairo_arc (cr, 0, 0, _diameter/2, 0, 2 * M_PI);
397 cairo_set_source (cr, led_inset_pattern);
402 cairo_set_source_rgb (cr, 0, 0, 0);
403 cairo_arc (cr, 0, 0, _diameter/2-1, 0, 2 * M_PI);
407 ArdourCanvas::set_source_rgba (cr, led_color);
408 cairo_arc (cr, 0, 0, _diameter/2-3, 0, 2 * M_PI);
415 // a transparent gray layer to indicate insensitivity
416 if ((visual_state() & Gtkmm2ext::Insensitive)) {
417 rounded_function (cr, 1, 1, get_width()-2, get_height()-2, _corner_radius);
418 cairo_set_source_rgba (cr, 0.505, 0.517, 0.525, 0.6);
422 // if requested, show hovering
423 if (ARDOUR::Config->get_widget_prelight()
424 && !((visual_state() & Gtkmm2ext::Insensitive))) {
426 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
427 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
432 //user is currently pressing the button. black outline helps to indicate this
433 if ( _grabbed && !((_elements & Menu)==Menu) && _action) {
434 cairo_set_line_width(cr,1);
435 rounded_function (cr, 1, 1, get_width()-2, get_height()-2, _corner_radius - 1);
436 cairo_set_source_rgba (cr, 0, 0, 0, 1.0);
440 //some buttons (like processor boxes) can be selected (so they can be deleted). Draw a white box around them
441 if (visual_state() & Gtkmm2ext::Selected) {
442 cairo_set_line_width(cr,2);
443 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
444 cairo_set_source_rgba (cr, 1, 1, 1, 0.75);
448 //I guess this means we have keyboard focus. I don't think this works currently
450 //A: yes, it's keyboard focus and it does work when there's no editor window
451 // (the editor is always the first receiver for KeyDown).
452 // It's needed for eg. the engine-dialog at startup or after closing a sesion.
454 rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, _corner_radius);
455 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.8);
457 cairo_set_dash (cr, &dashes, 1, 0);
458 cairo_set_line_cap (cr, CAIRO_LINE_CAP_BUTT);
459 cairo_set_line_width (cr, 1.0);
461 cairo_set_dash (cr, 0, 0, 0);
466 ArdourButton::set_diameter (float d)
468 _diameter = (d*2) + 5.0;
470 if (_diameter != 0.0) {
471 _fixed_diameter = true;
479 ArdourButton::set_corner_radius (float r)
486 ArdourButton::on_size_request (Gtk::Requisition* req)
491 CairoWidget::on_size_request (req);
493 if ((_elements & Text) && !_text.empty()) {
495 //calc our real width for our string (but ignore the height, because that results in inconsistent button heights)
497 _layout->get_pixel_size (_text_width, ignored);
499 //calc the height using some text with both ascenders and descenders
500 std::string t = _layout->get_text();
501 _layout->set_text ("WjgO"); //what we put here probably doesn't matter, as long as its the same for everyone
502 _layout->get_pixel_size (ignored, _text_height);
503 _layout->set_text (t);
505 if (_text_width + _diameter < 75) {
519 if ((_elements & Indicator) && _fixed_diameter) {
521 req->width = _pixbuf->get_width() + lrint (_diameter) + xpad;
522 req->height = max (_pixbuf->get_height(), (int) lrint (_diameter)) + ypad;
524 req->width = _text_width + lrint (_diameter) + xpad * 2; // margin left+right * 2
525 req->height = max (_text_height, (int) lrint (_diameter)) + ypad;
529 req->width = _pixbuf->get_width() + xpad;
530 req->height = _pixbuf->get_height() + ypad;
532 req->width = _text_width + xpad;
533 req->height = _text_height + ypad;
536 req->width += _corner_radius;
540 * This sets the colors used for rendering based on the name of the button, and
541 * thus uses information from the GUI config data.
544 ArdourButton::set_colors ()
546 if (_fixed_colors_set) {
549 std::string name = get_name();
551 fill_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill active", name));
552 fill_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill", name));
554 text_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text active", name));
555 text_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text", name));
557 led_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led active", name));
558 led_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led", name));
561 * This sets the colors used for rendering based on two fixed values, rather
562 * than basing them on the button name, and thus information in the GUI config
565 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
567 _fixed_colors_set = true;
569 fill_active_color = color_active;
570 fill_inactive_color = color_inactive;
572 unsigned char r, g, b, a;
573 UINT_TO_RGBA(color_active, &r, &g, &b, &a);
575 double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
576 (max (double(g), 255.) - min (double(g), 255.)) +
577 (max (double(b), 255.) - min (double(b), 255.));
579 double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
580 (max (double(g), 0.) - min (double(g), 0.)) +
581 (max (double(b), 0.) - min (double(b), 0.));
583 text_active_color = (white_contrast > black_contrast) ?
584 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
585 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
588 UINT_TO_RGBA(color_inactive, &r, &g, &b, &a);
590 white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
591 (max (double(g), 255.) - min (double(g), 255.)) +
592 (max (double(b), 255.) - min (double(b), 255.));
594 black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
595 (max (double(g), 0.) - min (double(g), 0.)) +
596 (max (double(b), 0.) - min (double(b), 0.));
598 text_inactive_color = (white_contrast > black_contrast) ?
599 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
600 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
602 /* XXX what about led colors ? */
605 set_name (""); /* this will trigger a "style-changed" message and then set_colors() */
609 ArdourButton::build_patterns ()
611 if (convex_pattern) {
612 cairo_pattern_destroy (convex_pattern);
616 if (concave_pattern) {
617 cairo_pattern_destroy (concave_pattern);
621 if (led_inset_pattern) {
622 cairo_pattern_destroy (led_inset_pattern);
625 float width = get_width(); float height = get_height();
628 convex_pattern = cairo_pattern_create_linear (0.0, 0, 0.0, height);
629 cairo_pattern_add_color_stop_rgba (convex_pattern, 0.0, 0,0,0, 0.0);
630 cairo_pattern_add_color_stop_rgba (convex_pattern, 1.0, 0,0,0, 0.35);
633 concave_pattern = cairo_pattern_create_linear (0.0, 0, 0.0, height);
634 cairo_pattern_add_color_stop_rgba (concave_pattern, 0.0, 0,0,0, 0.5);
635 cairo_pattern_add_color_stop_rgba (concave_pattern, 0.7, 0,0,0, 0.0);
637 if (_elements & Indicator) {
638 led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
639 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
640 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
647 ArdourButton::set_led_left (bool yn)
653 ArdourButton::on_button_press_event (GdkEventButton *ev)
655 if ((_elements & Indicator) && _led_rect && _distinct_led_click) {
656 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
657 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
662 if (binding_proxy.button_press_handler (ev)) {
669 if (!_act_on_release) {
671 _action->activate ();
676 if (_fallthrough_to_parent)
683 ArdourButton::on_button_release_event (GdkEventButton *ev)
685 if (_hovering && (_elements & Indicator) && _led_rect && _distinct_led_click) {
686 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
687 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
688 signal_led_clicked(); /* EMIT SIGNAL */
698 if (_act_on_release) {
700 _action->activate ();
706 if (_fallthrough_to_parent)
713 ArdourButton::set_distinct_led_click (bool yn)
715 _distinct_led_click = yn;
720 ArdourButton::color_handler ()
728 ArdourButton::on_size_allocate (Allocation& alloc)
730 CairoWidget::on_size_allocate (alloc);
736 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
738 watch_connection.disconnect ();
739 binding_proxy.set_controllable (c);
743 ArdourButton::watch ()
745 boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
748 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
752 c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
756 ArdourButton::controllable_changed ()
758 float val = binding_proxy.get_controllable()->get_value();
760 if (fabs (val) >= 0.5f) {
761 set_active_state (Gtkmm2ext::ExplicitActive);
763 unset_active_state ();
768 ArdourButton::set_related_action (RefPtr<Action> act)
770 Gtkmm2ext::Activatable::set_related_action (act);
774 action_tooltip_changed ();
776 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
779 tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
782 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
783 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
784 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
789 ArdourButton::action_toggled ()
791 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
794 if (tact->get_active()) {
795 set_active_state (Gtkmm2ext::ExplicitActive);
797 unset_active_state ();
803 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
810 ArdourButton::on_name_changed ()
817 ArdourButton::setup_led_rect ()
821 if (get_width() < 75) {
827 if (_elements & Indicator) {
828 _led_rect = new cairo_rectangle_t;
830 if (_elements & Text) {
832 _led_rect->x = text_margin;
834 _led_rect->x = get_width() - text_margin - _diameter/2.0;
838 _led_rect->x = get_width()/2.0 - _diameter/2.0;
841 _led_rect->y = get_height()/2.0 - _diameter/2.0;
842 _led_rect->width = _diameter;
843 _led_rect->height = _diameter;
852 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
859 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
861 bool changed = (_active_state != s);
862 CairoWidget::set_active_state (s);
870 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
872 bool changed = (_visual_state != s);
873 CairoWidget::set_visual_state (s);
882 ArdourButton::on_focus_in_event (GdkEventFocus* ev)
886 return CairoWidget::on_focus_in_event (ev);
890 ArdourButton::on_focus_out_event (GdkEventFocus* ev)
894 return CairoWidget::on_focus_out_event (ev);
898 ArdourButton::on_key_release_event (GdkEventKey *ev) {
900 (ev->keyval == GDK_KEY_space || ev->keyval == GDK_Return))
904 _action->activate ();
908 return CairoWidget::on_key_release_event (ev);
912 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
916 if (ARDOUR::Config->get_widget_prelight()) {
920 return CairoWidget::on_enter_notify_event (ev);
924 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
928 if (ARDOUR::Config->get_widget_prelight()) {
932 return CairoWidget::on_leave_notify_event (ev);
936 ArdourButton::set_tweaks (Tweaks t)
945 ArdourButton::action_sensitivity_changed ()
947 if (_action->property_sensitive ()) {
948 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
950 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
957 ArdourButton::action_visibility_changed ()
959 if (_action->property_visible ()) {
967 ArdourButton::action_tooltip_changed ()
969 string str = _action->property_tooltip().get_value();
970 ARDOUR_UI::instance()->set_tip (*this, str);
974 ArdourButton::set_elements (Element e)
980 ArdourButton::add_elements (Element e)
982 _elements = (ArdourButton::Element) (_elements | e);