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 "ardour_button.h"
37 #include "ardour_ui.h"
38 #include "global_signals.h"
42 #define REFLECTION_HEIGHT 2
52 ArdourButton::Element ArdourButton::default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text);
53 ArdourButton::Element ArdourButton::led_default_elements = ArdourButton::Element (ArdourButton::default_elements|ArdourButton::Indicator);
54 ArdourButton::Element ArdourButton::just_led_default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Indicator);
55 bool ArdourButton::_flat_buttons = false;
57 ArdourButton::ArdourButton (Element e)
59 , _tweaks (Tweaks (0))
63 , _corner_radius (4.0)
70 , fill_start_inactive_color (0)
71 , fill_end_inactive_color (0)
72 , fill_start_active_color (0)
73 , fill_end_active_color (0)
74 , text_active_color(0)
75 , text_inactive_color(0)
77 , led_inactive_color(0)
79 , fill_pattern_active (0)
81 , led_inset_pattern (0)
82 , reflection_pattern (0)
84 , _act_on_release (true)
86 , _fixed_diameter (true)
87 , _distinct_led_click (false)
90 ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
93 ArdourButton::ArdourButton (const std::string& str, Element e)
95 , _tweaks (Tweaks (0))
99 , _corner_radius (4.0)
106 , fill_start_inactive_color (0)
107 , fill_end_inactive_color (0)
108 , fill_start_active_color (0)
109 , fill_end_active_color (0)
110 , text_active_color(0)
111 , text_inactive_color(0)
112 , led_active_color(0)
113 , led_inactive_color(0)
115 , fill_pattern_active (0)
117 , led_inset_pattern (0)
118 , reflection_pattern (0)
120 , _act_on_release (true)
122 , _fixed_diameter (true)
123 , _distinct_led_click (false)
129 ArdourButton::~ArdourButton()
134 cairo_pattern_destroy (shine_pattern);
138 cairo_pattern_destroy (fill_pattern);
141 if (fill_pattern_active) {
142 cairo_pattern_destroy (fill_pattern_active);
145 if (led_inset_pattern) {
146 cairo_pattern_destroy (led_inset_pattern);
149 if (reflection_pattern) {
150 cairo_pattern_destroy (reflection_pattern);
156 ArdourButton::set_text (const std::string& str)
160 if (!_layout && !_text.empty()) {
161 _layout = Pango::Layout::create (get_pango_context());
165 _layout->set_text (str);
172 ArdourButton::set_markup (const std::string& str)
177 _layout = Pango::Layout::create (get_pango_context());
180 _layout->set_markup (str);
185 ArdourButton::set_angle (const double angle)
191 ArdourButton::set_alignment (const float xa, const float ya)
198 ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
200 void (*rounded_function)(cairo_t*, double, double, double, double, double);
202 switch (_corner_mask) {
203 case 0x1: /* upper left only */
204 rounded_function = Gtkmm2ext::rounded_top_left_rectangle;
206 case 0x2: /* upper right only */
207 rounded_function = Gtkmm2ext::rounded_top_right_rectangle;
209 case 0x3: /* upper only */
210 rounded_function = Gtkmm2ext::rounded_top_rectangle;
212 /* should really have functions for lower right, lower left,
213 lower only, but for now, we don't
216 rounded_function = Gtkmm2ext::rounded_rectangle;
219 if (!_fixed_diameter) {
220 _diameter = std::min (get_width(), get_height());
225 if ((_elements & Body)==Body) {
226 if (_elements & Edge) {
228 cairo_set_source_rgba (cr, 0, 0, 0, 1);
229 rounded_function(cr, 0, 0, get_width(), get_height(), _corner_radius);
232 rounded_function (cr, 1, 1, get_width()-2, get_height()-2, _corner_radius - 1.5);
234 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
237 if (active_state() == Gtkmm2ext::ImplicitActive) {
239 if (!(_tweaks & ImplicitUsesSolidColor)) {
240 cairo_set_source (cr, fill_pattern);
242 cairo_set_source (cr, fill_pattern_active);
246 if (!(_tweaks & ImplicitUsesSolidColor)) {
248 UINT_TO_RGBA (fill_end_active_color, &r, &g, &b, &a);
249 cairo_set_line_width (cr, 1.0);
250 rounded_function (cr, 2, 2, get_width()-4, get_height()-4, _corner_radius - 1.5);
251 cairo_set_source_rgba (cr, r/255.0, g/255.0, b/255.0, a/255.0);
255 } else if (active_state() == Gtkmm2ext::ExplicitActive || ((_elements & Indicator)==Indicator) ) {
258 cairo_set_source (cr, fill_pattern_active);
264 cairo_set_source (cr, fill_pattern);
270 if ( ((_elements & FlatFace)==FlatFace) && (active_state() != Gtkmm2ext::ExplicitActive) ) {
272 if ( !_flat_buttons ) {
273 float rheight = get_height()*0.5-REFLECTION_HEIGHT;
274 Gtkmm2ext::rounded_rectangle (cr, 2, 3, get_width()-4, rheight, _corner_radius-1);
275 cairo_set_source (cr, shine_pattern);
279 if (active_state() == Gtkmm2ext::ExplicitActive) {
281 UINT_TO_RGBA (fill_start_active_color, &r, &g, &b, &a);
282 cairo_set_line_width (cr, 2.0);
283 rounded_function (cr, 2, 2, get_width()-4, get_height()-4, _corner_radius - 2.0);
284 cairo_set_source_rgba (cr, r/255.0, g/255.0, b/255.0, a/255.0);
289 UINT_TO_RGBA (fill_start_inactive_color, &r, &g, &b, &a);
290 cairo_set_line_width (cr, 2.0);
291 rounded_function (cr, 2, 2, get_width()-4, get_height()-4, _corner_radius - 2.0);
292 cairo_set_source_rgba (cr, r/255.0, g/255.0, b/255.0, a/255.0);
301 x = (get_width() - _pixbuf->get_width())/2.0;
302 y = (get_height() - _pixbuf->get_height())/2.0;
304 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
305 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
313 if (get_width() < 75) {
319 if ( ((_elements & Text)==Text) && !_text.empty()) {
321 cairo_rectangle (cr, 2, 1, get_width()-4, get_height()-2);
325 cairo_set_source_rgba (cr, text_r, text_g, text_b, text_a);
327 if (_elements & Indicator) {
329 cairo_move_to (cr, text_margin + _diameter + 4, get_height()/2.0 - _text_height/2.0);
331 cairo_move_to (cr, text_margin, get_height()/2.0 - _text_height/2.0);
333 pango_cairo_show_layout (cr, _layout->gobj());
341 cairo_save (cr); // TODO retain rotataion.. adj. LED,...
342 cairo_rotate(cr, _angle * M_PI / 180.0);
343 cairo_device_to_user(cr, &ww, &wh);
344 xa = (ww - _text_width) * _xalign;
345 ya = (wh - _text_height) * _yalign;
347 /* quick hack for left/bottom alignment at -90deg
348 * TODO this should be generalized incl rotation.
349 * currently only 'user' of this API is meter_strip.cc
351 if (_xalign < 0) xa = (ww * fabs(_xalign) + text_margin);
353 // TODO honor left/right text_margin with min/max()
355 cairo_move_to (cr, xa, ya);
356 pango_cairo_update_layout(cr, _layout->gobj());
357 pango_cairo_show_layout (cr, _layout->gobj());
360 /* use old center'ed layout for follow up items - until rotation/aligment code is completed */
361 cairo_move_to (cr, (get_width() - _text_width)/2.0, get_height()/2.0 - _text_height/2.0);
366 if (((_elements & Indicator)==Indicator)) {
368 /* move to the center of the indicator/led */
372 if (_elements & Text) {
374 cairo_translate (cr, text_margin + (_diameter/2.0), get_height()/2.0);
376 cairo_translate (cr, get_width() - ((_diameter/2.0) + 4.0), get_height()/2.0);
379 cairo_translate (cr, get_width()/2.0, get_height()/2.0);
383 cairo_arc (cr, 0, 0, _diameter/2, 0, 2 * M_PI);
384 cairo_set_source (cr, led_inset_pattern);
388 cairo_set_source_rgb (cr, 0, 0, 0);
389 cairo_arc (cr, 0, 0, _diameter/2-2, 0, 2 * M_PI);
393 cairo_set_source_rgba (cr, led_r, led_g, led_b, led_a);
394 cairo_arc (cr, 0, 0, _diameter/2-3, 0, 2 * M_PI);
401 /* a partially transparent gray layer to indicate insensitivity */
403 if ((visual_state() & Gtkmm2ext::Insensitive)) {
404 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
405 cairo_set_source_rgba (cr, 0.505, 0.517, 0.525, 0.6);
410 bool show_reflection = (active_state() == Gtkmm2ext::ExplicitActive);
411 show_reflection &= !_flat_buttons;
412 show_reflection &= !((_elements & Indicator)==Indicator);
413 if ( show_reflection ) {
414 float rheight = get_height()*0.5-REFLECTION_HEIGHT;
415 Gtkmm2ext::rounded_rectangle (cr, 2, get_height()*0.5-1, get_width()-4, rheight, _corner_radius-1);
416 cairo_set_source (cr, shine_pattern);
420 /* if requested, show hovering */
422 if (ARDOUR::Config->get_widget_prelight()
423 && !((visual_state() & Gtkmm2ext::Insensitive))) {
425 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
426 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
433 ArdourButton::set_diameter (float d)
435 _diameter = (d*2) + 5.0;
437 if (_diameter != 0.0) {
438 _fixed_diameter = true;
446 ArdourButton::set_corner_radius (float r)
453 ArdourButton::on_size_request (Gtk::Requisition* req)
458 CairoWidget::on_size_request (req);
460 if ((_elements & Text) && !_text.empty()) {
461 _layout->get_pixel_size (_text_width, _text_height);
462 if (_text_width + _diameter < 75) {
476 if ((_elements & Indicator) && _fixed_diameter) {
478 req->width = _pixbuf->get_width() + lrint (_diameter) + xpad;
479 req->height = max (_pixbuf->get_height(), (int) lrint (_diameter)) + ypad;
481 req->width = _text_width + lrint (_diameter) + xpad * 2; // margin left+right * 2
482 req->height = max (_text_height, (int) lrint (_diameter)) + ypad;
486 req->width = _pixbuf->get_width() + xpad;
487 req->height = _pixbuf->get_height() + ypad;
489 req->width = _text_width + xpad;
490 req->height = _text_height + ypad;
493 req->width += _corner_radius;
497 * This sets the colors used for rendering based on the name of the button, and
498 * thus uses information from the GUI config data.
501 ArdourButton::set_colors ()
503 std::string name = get_name();
505 border_color = ARDOUR_UI::config()->color_by_name ("button border");
507 fill_start_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill start active", name));
508 fill_end_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill end active", name));
510 fill_start_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill start", name));
511 fill_end_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill end", name));
513 text_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text active", name));
514 text_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text", name));
516 led_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led active", name));
517 led_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led", name));
520 * This sets the colors used for rendering based on two fixed values, rather
521 * than basing them on the button name, and thus information in the GUI config
524 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
526 set_name (""); /* this will trigger a "style-changed" message and then
530 fill_start_active_color = fill_end_active_color = color_active;
532 unsigned char r, g, b, a;
533 UINT_TO_RGBA(color_active, &r, &g, &b, &a);
535 double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
536 (max (double(g), 255.) - min (double(g), 255.)) +
537 (max (double(b), 255.) - min (double(b), 255.));
539 double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
540 (max (double(g), 0.) - min (double(g), 0.)) +
541 (max (double(b), 0.) - min (double(b), 0.));
544 text_inactive_color = (white_contrast > black_contrast) ?
545 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
546 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
548 fill_start_inactive_color = fill_end_inactive_color = color_inactive;
550 /* XXX what about led colors ? */
556 ArdourButton::build_patterns ()
558 uint32_t start_color;
565 cairo_pattern_destroy (shine_pattern);
570 cairo_pattern_destroy (fill_pattern);
574 if (fill_pattern_active) {
575 cairo_pattern_destroy (fill_pattern_active);
576 fill_pattern_active = 0;
579 if (_elements & Body) {
582 end_color = start_color = fill_start_active_color;
584 start_color = fill_start_active_color;
585 end_color = fill_end_active_color;
587 UINT_TO_RGBA (start_color, &r, &g, &b, &a);
594 shine_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, get_height());
595 cairo_pattern_add_color_stop_rgba (shine_pattern, 0, 1,1,1,0.0);
596 cairo_pattern_add_color_stop_rgba (shine_pattern, 0.5, 1,1,1,0.1);
597 cairo_pattern_add_color_stop_rgba (shine_pattern, 0.7, 1,1,1,0.2);
598 cairo_pattern_add_color_stop_rgba (shine_pattern, 1, 1,1,1,0.1);
600 fill_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, get_height()-3);
602 end_color = start_color = fill_start_inactive_color;
604 start_color = fill_start_inactive_color;
605 end_color = fill_end_inactive_color;
607 UINT_TO_RGBA (start_color, &r, &g, &b, &a);
608 cairo_pattern_add_color_stop_rgba (fill_pattern, 0, r/255.0,g/255.0,b/255.0, a/255.0);
609 UINT_TO_RGBA (end_color, &r, &g, &b, &a);
610 cairo_pattern_add_color_stop_rgba (fill_pattern, 1, r/255.0,g/255.0,b/255.0, a/255.0);
612 fill_pattern_active = cairo_pattern_create_linear (0.0, 0.0, 0.0, get_height()-3);
614 if (active_state() == Gtkmm2ext::ImplicitActive && (_tweaks & ImplicitUsesSolidColor)) {
615 end_color = start_color = led_active_color;
617 end_color = start_color = fill_end_active_color;
620 if (active_state() == Gtkmm2ext::ImplicitActive && (_tweaks & ImplicitUsesSolidColor)) {
621 end_color = start_color = led_active_color;
623 start_color = fill_start_active_color;
624 end_color = fill_end_active_color;
627 UINT_TO_RGBA (start_color, &r, &g, &b, &a);
628 cairo_pattern_add_color_stop_rgba (fill_pattern_active, 0, r/255.0,g/255.0,b/255.0, a/255.0);
629 UINT_TO_RGBA (end_color, &r, &g, &b, &a);
630 cairo_pattern_add_color_stop_rgba (fill_pattern_active, 1, r/255.0,g/255.0,b/255.0, a/255.0);
633 if (led_inset_pattern) {
634 cairo_pattern_destroy (led_inset_pattern);
637 if (reflection_pattern) {
638 cairo_pattern_destroy (reflection_pattern);
641 if (_elements & Indicator) {
642 led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
643 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
644 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
646 reflection_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter/2-3);
647 cairo_pattern_add_color_stop_rgba (reflection_pattern, 0, 1,1,1, active_state() ? 0.4 : 0.2);
648 cairo_pattern_add_color_stop_rgba (reflection_pattern, 1, 1,1,1, 0.0);
651 if (active_state() == Gtkmm2ext::ExplicitActive || ((_tweaks & ImplicitUsesSolidColor) && active_state() == Gtkmm2ext::ImplicitActive)) {
652 text_color = text_active_color;
653 led_color = led_active_color;
655 text_color = text_inactive_color;
656 led_color = led_inactive_color;
659 UINT_TO_RGBA (text_color, &r, &g, &b, &a);
664 UINT_TO_RGBA (led_color, &r, &g, &b, &a);
674 ArdourButton::set_led_left (bool yn)
680 ArdourButton::on_button_press_event (GdkEventButton *ev)
682 if ((_elements & Indicator) && _led_rect && _distinct_led_click) {
683 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
684 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
689 if (_tweaks & ShowClick) {
690 set_active_state (Gtkmm2ext::ExplicitActive);
693 if (binding_proxy.button_press_handler (ev)) {
697 if (!_act_on_release) {
699 _action->activate ();
708 ArdourButton::on_button_release_event (GdkEventButton *ev)
710 if (_hovering && (_elements & Indicator) && _led_rect && _distinct_led_click) {
711 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
712 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
713 signal_led_clicked(); /* EMIT SIGNAL */
718 if (_tweaks & ShowClick) {
719 unset_active_state ();
725 if (_act_on_release) {
727 _action->activate ();
737 ArdourButton::set_distinct_led_click (bool yn)
739 _distinct_led_click = yn;
744 ArdourButton::color_handler ()
752 ArdourButton::on_size_allocate (Allocation& alloc)
754 CairoWidget::on_size_allocate (alloc);
760 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
762 watch_connection.disconnect ();
763 binding_proxy.set_controllable (c);
767 ArdourButton::watch ()
769 boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
772 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
776 c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
780 ArdourButton::controllable_changed ()
782 float val = binding_proxy.get_controllable()->get_value();
784 if (fabs (val) >= 0.5f) {
785 set_active_state (Gtkmm2ext::ExplicitActive);
787 unset_active_state ();
792 ArdourButton::set_related_action (RefPtr<Action> act)
794 Gtkmm2ext::Activatable::set_related_action (act);
798 action_tooltip_changed ();
800 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
803 tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
806 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
807 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
808 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
813 ArdourButton::action_toggled ()
815 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
818 if (tact->get_active()) {
819 set_active_state (Gtkmm2ext::ExplicitActive);
821 unset_active_state ();
827 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
834 ArdourButton::on_name_changed ()
841 ArdourButton::setup_led_rect ()
845 if (get_width() < 75) {
851 if (_elements & Indicator) {
852 _led_rect = new cairo_rectangle_t;
854 if (_elements & Text) {
856 _led_rect->x = text_margin;
858 _led_rect->x = get_width() - text_margin - _diameter/2.0;
862 _led_rect->x = get_width()/2.0 - _diameter/2.0;
865 _led_rect->y = get_height()/2.0 - _diameter/2.0;
866 _led_rect->width = _diameter;
867 _led_rect->height = _diameter;
876 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
883 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
885 bool changed = (_active_state != s);
886 CairoWidget::set_active_state (s);
894 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
896 bool changed = (_visual_state != s);
897 CairoWidget::set_visual_state (s);
905 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
909 if (ARDOUR::Config->get_widget_prelight()) {
913 return CairoWidget::on_enter_notify_event (ev);
917 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
921 if (ARDOUR::Config->get_widget_prelight()) {
925 return CairoWidget::on_leave_notify_event (ev);
929 ArdourButton::set_tweaks (Tweaks t)
938 ArdourButton::action_sensitivity_changed ()
940 if (_action->property_sensitive ()) {
941 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
943 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
950 ArdourButton::action_visibility_changed ()
952 if (_action->property_visible ()) {
960 ArdourButton::action_tooltip_changed ()
962 string str = _action->property_tooltip().get_value();
963 ARDOUR_UI::instance()->set_tip (*this, str);
967 ArdourButton::set_rounded_corner_mask (int mask)
974 ArdourButton::set_elements (Element e)
980 ArdourButton::add_elements (Element e)
982 _elements = (ArdourButton::Element) (_elements | e);
986 ArdourButton::set_flat_buttons (bool yn)