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"
37 #include "canvas/colors.h"
39 #include "ardour_button.h"
40 #include "ardour_ui.h"
41 #include "global_signals.h"
45 #define BASELINESTRETCH (1.25)
46 #define TRACKHEADERBTNW (3.10)
56 ArdourButton::Element ArdourButton::default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text);
57 ArdourButton::Element ArdourButton::led_default_elements = ArdourButton::Element (ArdourButton::default_elements|ArdourButton::Indicator);
58 ArdourButton::Element ArdourButton::just_led_default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Indicator);
60 ArdourButton::ArdourButton (Element e)
62 , _icon (ArdourButton::NoIcon)
63 , _tweaks (Tweaks (0))
64 , _char_pixel_width (0)
65 , _char_pixel_height (0)
66 , _char_avg_pixel_width (0)
70 , _corner_radius (2.5)
75 , fill_inactive_color (0)
76 , fill_active_color (0)
77 , text_active_color(0)
78 , text_inactive_color(0)
80 , led_inactive_color(0)
81 , led_custom_color (0)
82 , use_custom_led_color (false)
85 , led_inset_pattern (0)
87 , _act_on_release (true)
89 , _distinct_led_click (false)
92 , _fixed_colors_set (false)
93 , _fallthrough_to_parent (false)
94 , _layout_ellipsize_width (-1)
95 , _ellipsis (Pango::ELLIPSIZE_NONE)
96 , _update_colors (true)
99 ARDOUR_UI_UTILS::ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
102 ArdourButton::ArdourButton (const std::string& str, Element e)
104 , _tweaks (Tweaks (0))
108 , _corner_radius (2.5)
113 , fill_inactive_color (0)
114 , fill_active_color (0)
115 , text_active_color(0)
116 , text_inactive_color(0)
117 , led_active_color(0)
118 , led_inactive_color(0)
119 , led_custom_color (0)
120 , use_custom_led_color (false)
122 , concave_pattern (0)
123 , led_inset_pattern (0)
125 , _act_on_release (true)
127 , _distinct_led_click (false)
130 , _fixed_colors_set (false)
131 , _fallthrough_to_parent (false)
132 , _layout_ellipsize_width (-1)
133 , _ellipsis (Pango::ELLIPSIZE_NONE)
134 , _update_colors (true)
135 , _pattern_height (0)
138 ARDOUR_UI_UTILS::ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
139 ARDOUR_UI_UTILS::DPIReset.connect (sigc::mem_fun (*this, &ArdourButton::on_name_changed));
142 ArdourButton::~ArdourButton()
146 if (convex_pattern) {
147 cairo_pattern_destroy (convex_pattern);
150 if (concave_pattern) {
151 cairo_pattern_destroy (concave_pattern);
154 if (led_inset_pattern) {
155 cairo_pattern_destroy (led_inset_pattern);
160 ArdourButton::set_layout_font (const Pango::FontDescription& fd)
164 _layout->set_font_description (fd);
170 ArdourButton::set_text (const std::string& str)
173 if (!is_realized()) {
177 if (_layout && _layout->get_text() != _text) {
178 _layout->set_text (_text);
184 ArdourButton::set_angle (const double angle)
190 ArdourButton::set_alignment (const float xa, const float ya)
197 ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
202 const float corner_radius = std::max(2.f, _corner_radius * ARDOUR_UI::ui_scale);
204 if (_update_colors) {
207 if (get_height() != _pattern_height) {
211 if ( active_state() == Gtkmm2ext::ExplicitActive ) {
212 text_color = text_active_color;
213 led_color = led_active_color;
215 text_color = text_inactive_color;
216 led_color = led_inactive_color;
219 if (use_custom_led_color) {
220 led_color = led_custom_color;
223 void (*rounded_function)(cairo_t*, double, double, double, double, double);
225 switch (_corner_mask) {
226 case 0x1: /* upper left only */
227 rounded_function = Gtkmm2ext::rounded_top_left_rectangle;
229 case 0x2: /* upper right only */
230 rounded_function = Gtkmm2ext::rounded_top_right_rectangle;
232 case 0x3: /* upper only */
233 rounded_function = Gtkmm2ext::rounded_top_rectangle;
235 /* should really have functions for lower right, lower left,
236 lower only, but for now, we don't
239 rounded_function = Gtkmm2ext::rounded_rectangle;
242 // draw edge (filling a rect underneath, rather than stroking a border on top, allows the corners to be lighter-weight.
243 if ((_elements & (Body|Edge)) == (Body|Edge)) {
244 rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius + 1.5);
245 cairo_set_source_rgba (cr, 0, 0, 0, 1);
250 if ((_elements & Body)==Body) {
251 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
252 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
253 ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
255 } else if ( (active_state() == Gtkmm2ext::ExplicitActive) && !((_elements & Indicator)==Indicator) ) {
257 ArdourCanvas::set_source_rgba (cr, fill_active_color);
259 } else { //inactive, or it has an indicator
261 ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
266 // IMPLICIT ACTIVE: draw a border of the active color
267 if ((_elements & Body)==Body) {
268 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
269 cairo_set_line_width (cr, 2.0);
270 rounded_function (cr, 2, 2, get_width() - 4, get_height() - 4, corner_radius-0.5);
271 ArdourCanvas::set_source_rgba (cr, fill_active_color);
276 //show the "convex" or "concave" gradient
277 if (!_flat_buttons) {
278 if ( active_state() == Gtkmm2ext::ExplicitActive && ( !((_elements & Indicator)==Indicator) || use_custom_led_color) ) {
280 cairo_set_source (cr, concave_pattern);
281 Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
284 cairo_set_source (cr, convex_pattern);
285 Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
290 #define VECTORICONSTROKEFILL(fillalpha) \
291 cairo_set_line_width(cr, 1.5); \
292 cairo_set_source_rgba (cr, 0, 0, 0, 1.0); \
293 cairo_stroke_preserve(cr); \
294 cairo_set_source_rgba (cr, 1, 1, 1, (fillalpha)); \
299 double x = rint((get_width() - _pixbuf->get_width()) * .5);
300 const double y = rint((get_height() - _pixbuf->get_height()) * .5);
301 #if 0 // DEBUG style (print on hover)
302 if (_hovering || (_elements & Inactive)) {
303 printf("%s: p:%dx%d (%dx%d)\n",
305 _pixbuf->get_width(), _pixbuf->get_height(),
306 get_width(), get_height());
309 if (_elements & Menu) {
310 //if this is a DropDown with an icon, then we need to
311 //move the icon left slightly to accomomodate the arrow
314 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
315 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
318 else /* VectorIcons are exclusive to Pixbuf Icons */
319 /* TODO separate these into dedicated class
320 * it may also be efficient to render them only once for every size (image-surface) */
321 if ((_elements & VectorIcon) && _icon == RecTapeMode) {
322 const double x = get_width() * .5;
323 const double y = get_height() * .5;
324 const double r = std::min(x, y) * .6;
325 const double slit = .11 * M_PI;
327 cairo_translate(cr, x, y);
329 cairo_arc (cr, 0, 0, r, 0, 2 * M_PI);
330 if (active_state() == Gtkmm2ext::ExplicitActive) {
331 cairo_set_source_rgba (cr, .95, .1, .1, 1.);
333 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
335 cairo_fill_preserve(cr);
336 cairo_set_source_rgba (cr, .0, .0, .0, .5);
337 cairo_set_line_width(cr, 1);
341 cairo_set_source_rgba (cr, .15, .07, .07, 1.0);
343 cairo_rotate (cr, -.5 * M_PI);
344 cairo_move_to(cr, 0, 0);
345 cairo_arc (cr, 0, 0, r *.85, -slit, slit);
346 cairo_line_to(cr, 0, 0);
347 cairo_close_path(cr);
350 cairo_rotate (cr, 2. * M_PI / 3.);
352 cairo_move_to(cr, 0, 0);
353 cairo_arc (cr, 0, 0, r *.85, -slit, slit);
354 cairo_line_to(cr, 0, 0);
355 cairo_close_path(cr);
358 cairo_rotate (cr, 2. * M_PI / 3.);
359 cairo_move_to(cr, 0, 0);
360 cairo_arc (cr, 0, 0, r *.85, -slit, slit);
361 cairo_line_to(cr, 0, 0);
362 cairo_close_path(cr);
367 cairo_arc (cr, 0, 0, r * .3, 0, 2 * M_PI);
368 if (active_state() == Gtkmm2ext::ExplicitActive)
369 cairo_set_source_rgba (cr, .95, .1, .1, 1.);
371 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
373 cairo_set_source_rgba (cr, .0, .0, .0, 1.0);
374 cairo_arc (cr, 0, 0, r *.15, 0, 2 * M_PI); // hole in the middle
379 else if ((_elements & VectorIcon) && _icon == RecButton) {
380 const double x = get_width() * .5;
381 const double y = get_height() * .5;
382 const double r = std::min(x, y) * .55;
383 cairo_arc (cr, x, y, r, 0, 2 * M_PI);
384 if (active_state() == Gtkmm2ext::ExplicitActive)
385 cairo_set_source_rgba (cr, .95, .1, .1, 1.);
387 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
388 cairo_fill_preserve(cr);
389 cairo_set_source_rgba (cr, .0, .0, .0, .8);
390 cairo_set_line_width(cr, 1);
393 else if ((_elements & VectorIcon) && _icon == CloseCross) {
394 const double x = get_width() * .5;
395 const double y = get_height() * .5;
396 const double o = .5 + std::min(x, y) * .4;
397 ArdourCanvas::set_source_rgba (cr, text_color);
398 cairo_set_line_width(cr, 1);
399 cairo_move_to(cr, x-o, y-o);
400 cairo_line_to(cr, x+o, y+o);
401 cairo_move_to(cr, x+o, y-o);
402 cairo_line_to(cr, x-o, y+o);
405 else if ((_elements & VectorIcon) && _icon == StripWidth) {
406 const double x0 = get_width() * .2;
407 const double x1 = get_width() * .8;
409 const double y0 = get_height() * .25;
410 const double y1= get_height() * .75;
412 const double ym= get_height() * .5;
415 const double xa0= get_height() * .39;
416 const double xa1= get_height() * .61;
417 const double ya0= get_height() * .35;
418 const double ya1= get_height() * .65;
420 ArdourCanvas::set_source_rgba (cr, text_color);
421 cairo_set_line_width(cr, 1);
424 cairo_move_to(cr, x0, y0);
425 cairo_line_to(cr, x0, y1);
426 cairo_move_to(cr, x1, y0);
427 cairo_line_to(cr, x1, y1);
430 cairo_move_to(cr, x0, ym);
431 cairo_line_to(cr, x1, ym);
434 cairo_move_to(cr, x0, ym);
435 cairo_line_to(cr, xa0, ya0);
436 cairo_move_to(cr, x0, ym);
437 cairo_line_to(cr, xa0, ya1);
440 cairo_move_to(cr, x1, ym);
441 cairo_line_to(cr, xa1, ya0);
442 cairo_move_to(cr, x1, ym);
443 cairo_line_to(cr, xa1, ya1);
446 else if ((_elements & VectorIcon) && _icon == DinMidi) {
447 const double x = get_width() * .5;
448 const double y = get_height() * .5;
449 const double r = std::min(x, y) * .75;
450 ArdourCanvas::set_source_rgba (cr, text_color);
451 cairo_set_line_width(cr, 1);
452 cairo_arc (cr, x, y, r, 0, 2 * M_PI);
455 // pins equally spaced 45deg
456 cairo_arc (cr, x, y * 0.5, r * .15, 0, 2 * M_PI);
458 cairo_arc (cr, x * 0.5, y, r * .15, 0, 2 * M_PI);
460 cairo_arc (cr, x * 1.5, y, r * .15, 0, 2 * M_PI);
462 // .5 + .5 * .5 * sin(45deg), 1.5 - .5 * .5 * cos(45deg)
463 cairo_arc (cr, x * 0.677, y * .677, r * .15, 0, 2 * M_PI);
465 cairo_arc (cr, x * 1.323, y * .677, r * .15, 0, 2 * M_PI);
469 cairo_arc (cr, x, y+r, r * .28, 1.05 * M_PI, 1.95 * M_PI);
472 else if ((_elements & VectorIcon) && _icon == TransportStop) {
473 const int wh = std::min (get_width(), get_height());
475 (get_width() - wh) * .5 + wh * .25,
476 (get_height() - wh) * .5 + wh * .25,
479 VECTORICONSTROKEFILL(0.8);
481 else if ((_elements & VectorIcon) && _icon == TransportPlay) {
482 const int wh = std::min (get_width(), get_height()) * .5;
483 const double y = get_height() * .5;
484 const double x = get_width() - wh;
486 const float tri = ceil(.577 * wh); // 1/sqrt(3)
488 cairo_move_to (cr, x + wh * .5, y);
489 cairo_line_to (cr, x - wh * .5, y - tri);
490 cairo_line_to (cr, x - wh * .5, y + tri);
491 cairo_close_path (cr);
493 VECTORICONSTROKEFILL(0.8);
495 else if ((_elements & VectorIcon) && _icon == TransportPanic) {
496 const int wh = std::min (get_width(), get_height()) * .1;
497 const double xc = get_width() * .5;
498 const double yh = get_height();
502 VECTORICONSTROKEFILL(0.8);
504 cairo_arc (cr, xc, yh *.75, wh, 0, 2 * M_PI);
505 VECTORICONSTROKEFILL(0.8);
507 else if ((_elements & VectorIcon) && (_icon == TransportStart || _icon == TransportEnd || _icon == TransportRange)) {
508 // small play triangle
509 int wh = std::min (get_width(), get_height());
510 const double y = get_height() * .5;
511 const double x = get_width() - wh * .5;
513 const float tri = ceil(.577 * wh * 2); // 1/sqrt(3)
515 const float ln = std::min (get_width(), get_height()) * .07;
517 if (_icon == TransportStart || _icon == TransportRange) {
519 x - wh - ln, y - tri * 1.7,
522 VECTORICONSTROKEFILL(1.0);
525 if (_icon == TransportEnd || _icon == TransportRange) {
527 x + wh - ln, y - tri * 1.7,
530 VECTORICONSTROKEFILL(1.0);
533 if (_icon == TransportStart) {
534 cairo_move_to (cr, x - wh, y);
535 cairo_line_to (cr, x + wh, y - tri);
536 cairo_line_to (cr, x + wh, y + tri);
538 cairo_move_to (cr, x + wh, y);
539 cairo_line_to (cr, x - wh, y - tri);
540 cairo_line_to (cr, x - wh, y + tri);
543 cairo_close_path (cr);
544 VECTORICONSTROKEFILL(1.0);
546 else if ((_elements & VectorIcon) && _icon == TransportLoop) {
547 const double x = get_width() * .5;
548 const double y = get_height() * .5;
549 const double r = std::min(x, y);
551 cairo_arc (cr, x, y, r * .6, 0, 2 * M_PI);
552 cairo_arc_negative (cr, x, y, r * .3, 2 * M_PI, 0);
554 VECTORICONSTROKEFILL(1.0);
555 #define ARCARROW(rad, ang) \
556 x + (rad) * sin((ang) * 2.0 * M_PI), y + (rad) * cos((ang) * 2.0 * M_PI)
558 cairo_move_to (cr, ARCARROW(r * .30, .72));
559 cairo_line_to (cr, ARCARROW(r * .08, .72));
560 cairo_line_to (cr, ARCARROW(r * .54, .60));
561 cairo_line_to (cr, ARCARROW(r * .73, .72));
562 cairo_line_to (cr, ARCARROW(r * .60, .72));
564 cairo_set_source_rgba (cr, 0, 0, 0, 1.0);
565 cairo_stroke_preserve(cr);
566 cairo_close_path (cr);
567 cairo_set_source_rgba (cr, 1, 1, 1, 1.0);
571 else if ((_elements & VectorIcon) && _icon == TransportMetronom) {
572 const double x = get_width() * .5;
573 const double y = get_height() * .5;
574 const double wh = std::min(x, y);
575 const double h = wh * .8;
576 const double w = wh * .5;
577 const double lw = w * .25;
580 x - w * .7, y + h * .25,
583 VECTORICONSTROKEFILL(1.0);
585 cairo_move_to (cr, x - w, y + h);
586 cairo_line_to (cr, x + w, y + h);
587 cairo_line_to (cr, x + w * .35, y - h);
588 cairo_line_to (cr, x - w * .35, y - h);
589 cairo_line_to (cr, x - w, y + h);
591 cairo_move_to (cr, x - w + lw, y + h -lw);
592 cairo_line_to (cr, x - w * .35 + lw, y - h + lw);
593 cairo_line_to (cr, x + w * .35 - lw, y - h + lw);
594 cairo_line_to (cr, x + w - lw, y + h -lw);
595 cairo_line_to (cr, x - w + lw, y + h -lw);
597 VECTORICONSTROKEFILL(1.0);
599 // ddx = .70 w = .75 * .5 wh = .375 wh
600 // ddy = .75 h - lw = .75 * .8 wh - wh .5 * .2 = .5 wh
602 // -> angle = atan (ang) = atan (375 / .5) ~= 36deg
603 const double dx = lw * .2; // 1 - cos(tan^-1(ang))
604 const double dy = lw * .4; // 1 - sin(tan^-1(ang))
605 cairo_move_to (cr, x - w * .3 , y + h * .25 + lw * .5);
606 cairo_line_to (cr, x - w + dx , y - h + lw + dy);
607 cairo_line_to (cr, x - w + lw , y - h + lw);
608 cairo_line_to (cr, x - w * .3 + lw, y + h * .25 + lw * .5);
609 cairo_close_path (cr);
611 VECTORICONSTROKEFILL(1.0);
614 x - w * .7, y + h * .25,
618 else if (_elements & VectorIcon) {
622 #undef VECTORICONSTROKEFILL
624 const int text_margin = char_pixel_width();
626 if (!_pixbuf && ((_elements & Text)==Text) && !_text.empty()) {
628 #if 0 // DEBUG style (print on hover)
629 if (_hovering || (_elements & Inactive)) {
630 bool layout_font = true;
631 Pango::FontDescription fd = _layout->get_font_description();
632 if (fd.gobj() == NULL) {
634 fd = get_pango_context()->get_font_description();
636 printf("%s: f:%dx%d aw:%.3f bh:%.0f t:%dx%d (%dx%d) %s\"%s\"\n",
638 char_pixel_width(), char_pixel_height(), char_avg_pixel_width(),
639 ceil(char_pixel_height() * BASELINESTRETCH),
640 _text_width, _text_height,
641 get_width(), get_height(),
642 layout_font ? "L:" : "W:",
643 fd.to_string().c_str());
648 cairo_rectangle (cr, 2, 1, get_width() - 4, get_height() - 2);
652 ArdourCanvas::set_source_rgba (cr, text_color);
653 const double text_ypos = (get_height() - _text_height) * .5;
655 if (_elements & Menu) {
656 // always left align (dropdown)
657 cairo_move_to (cr, text_margin, text_ypos);
658 pango_cairo_show_layout (cr, _layout->gobj());
659 } else if ( (_elements & Indicator) == Indicator) {
660 // left/right align depending on LED position
662 cairo_move_to (cr, text_margin + _diameter + .5 * char_pixel_width(), text_ypos);
664 cairo_move_to (cr, text_margin, text_ypos);
666 pango_cairo_show_layout (cr, _layout->gobj());
668 /* centered text otherwise */
675 cairo_rotate(cr, _angle * M_PI / 180.0);
676 cairo_device_to_user(cr, &ww, &wh);
677 xa = (ww - _text_width) * _xalign;
678 ya = (wh - _text_height) * _yalign;
680 /* quick hack for left/bottom alignment at -90deg
681 * TODO this should be generalized incl rotation.
682 * currently only 'user' of this API is meter_strip.cc
684 if (_xalign < 0) xa = ceil(.5 + (ww * fabs(_xalign) + text_margin));
686 cairo_move_to (cr, xa, ya);
687 pango_cairo_update_layout(cr, _layout->gobj());
688 pango_cairo_show_layout (cr, _layout->gobj());
695 if (_elements & Menu) {
696 const float trih = ceil(_diameter * .5);
697 const float triw2 = ceil(.577 * _diameter * .5); // 1/sqrt(3) Equilateral triangle
699 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
700 cairo_move_to(cr, get_width() - triw2 - 3. , rint((get_height() + trih) * .5));
701 cairo_rel_line_to(cr, -triw2, -trih);
702 cairo_rel_line_to(cr, 2. * triw2, 0);
703 cairo_close_path(cr);
705 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
708 cairo_move_to(cr, get_width() - triw2 - 3 , rint((get_height() + trih) * .5));
709 cairo_rel_line_to(cr, .5 - triw2, .5 - trih);
710 cairo_rel_line_to(cr, 2. * triw2 - 1, 0);
711 cairo_close_path(cr);
712 cairo_set_source_rgba (cr, 0, 0, 0, 0.8);
713 cairo_set_line_width(cr, 1);
718 if (_elements & Indicator) {
721 /* move to the center of the indicator/led */
722 if (_elements & Text) {
723 int led_xoff = ceil(char_pixel_width() + _diameter * .5);
725 cairo_translate (cr, led_xoff, get_height() * .5);
727 cairo_translate (cr, get_width() - led_xoff, get_height() * .5);
730 cairo_translate (cr, get_width() * .5, get_height() * .5);
734 if (!_flat_buttons) {
735 cairo_arc (cr, 0, 0, _diameter * .5, 0, 2 * M_PI);
736 cairo_set_source (cr, led_inset_pattern);
741 cairo_set_source_rgb (cr, 0, 0, 0);
742 cairo_arc (cr, 0, 0, _diameter * .5 - 1 * ARDOUR_UI::ui_scale, 0, 2 * M_PI);
746 ArdourCanvas::set_source_rgba (cr, led_color);
747 cairo_arc (cr, 0, 0, _diameter * .5 - 3 * ARDOUR_UI::ui_scale, 0, 2 * M_PI);
753 // a transparent overlay to indicate insensitivity
754 if ((visual_state() & Gtkmm2ext::Insensitive)) {
755 rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius);
756 uint32_t ins_color = ARDOUR_UI::config()->color ("gtk_background");
757 ArdourCanvas::set_source_rgb_a (cr, ins_color, 0.6);
761 // if requested, show hovering
762 if (ARDOUR_UI::config()->get_widget_prelight()
763 && !((visual_state() & Gtkmm2ext::Insensitive))) {
765 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
766 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
771 //user is currently pressing the button. dark outline helps to indicate this
772 if (_grabbed && !(_elements & (Inactive|Menu))) {
773 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
774 cairo_set_line_width(cr, 2);
775 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5);
779 //some buttons (like processor boxes) can be selected (so they can be deleted). Draw a selection indicator
780 if (visual_state() & Gtkmm2ext::Selected) {
781 cairo_set_line_width(cr, 1);
782 cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
783 rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, corner_radius);
787 //I guess this means we have keyboard focus. I don't think this works currently
789 //A: yes, it's keyboard focus and it does work when there's no editor window
790 // (the editor is always the first receiver for KeyDown).
791 // It's needed for eg. the engine-dialog at startup or after closing a sesion.
793 rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, corner_radius);
794 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.8);
796 cairo_set_dash (cr, &dashes, 1, 0);
797 cairo_set_line_cap (cr, CAIRO_LINE_CAP_BUTT);
798 cairo_set_line_width (cr, 1.0);
800 cairo_set_dash (cr, 0, 0, 0);
805 ArdourButton::set_corner_radius (float r)
808 CairoWidget::set_dirty ();
812 ArdourButton::on_realize()
814 CairoWidget::on_realize ();
816 if (_layout && _layout->get_text() != _text) {
817 _layout->set_text (_text);
823 ArdourButton::on_size_request (Gtk::Requisition* req)
825 req->width = req->height = 0;
826 CairoWidget::on_size_request (req);
828 if (_diameter == 0) {
829 const float newdia = rintf (11.f * ARDOUR_UI::ui_scale);
830 if (_diameter != newdia) {
836 if ((_elements & Text) && !_text.empty()) {
837 // if _layout does not exist, char_pixel_height() creates it,
838 req->height = std::max(req->height, (int) ceil(char_pixel_height() * BASELINESTRETCH + 1.0));
839 _layout->get_pixel_size (_text_width, _text_height);
840 req->width += rint(1.75 * char_pixel_width()); // padding
841 req->width += _text_width;
848 req->width += _pixbuf->get_width() + char_pixel_width();
849 req->height = std::max(req->height, _pixbuf->get_height() + 4);
852 if (_elements & Indicator) {
853 req->width += lrint (_diameter) + char_pixel_width();
854 req->height = std::max (req->height, (int) lrint (_diameter) + 4);
857 if ((_elements & Menu)) {
858 req->width += _diameter + 4;
861 if (_elements & VectorIcon) {
862 assert(!(_elements & Text));
863 const int wh = std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.));
865 req->height = std::max(req->height, wh);
868 /* Tweaks to mess the nice stuff above up again. */
869 if (_tweaks & TrackHeader) {
870 // forget everything above and just use a fixed square [em] size
871 // "TrackHeader Buttons" are single letter (usually uppercase)
872 // a SizeGroup is much less efficient (lots of gtk work under the hood for each track)
873 const int wh = std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.));
877 else if (_tweaks & Square) {
878 // currerntly unused (again)
879 if (req->width < req->height)
880 req->width = req->height;
881 if (req->height < req->width)
882 req->height = req->width;
883 } else if (_text_width > 0 && !(_elements & (Menu | Indicator))) {
884 // properly centered text for those elements that are centered
885 // (no sub-pixel offset)
886 if ((req->width - _text_width) & 1) { ++req->width; }
887 if ((req->height - _text_height) & 1) { ++req->height; }
890 printf("REQ: %s: %dx%d\n", get_name().c_str(), req->width, req->height);
895 * This sets the colors used for rendering based on the name of the button, and
896 * thus uses information from the GUI config data.
899 ArdourButton::set_colors ()
901 _update_colors = false;
902 if (_fixed_colors_set) {
905 std::string name = get_name();
908 fill_active_color = ARDOUR_UI::config()->color (string_compose ("%1: fill active", name), &failed);
910 fill_active_color = ARDOUR_UI::config()->color ("generic button: fill active");
912 fill_inactive_color = ARDOUR_UI::config()->color (string_compose ("%1: fill", name), &failed);
914 fill_inactive_color = ARDOUR_UI::config()->color ("generic button: fill");
917 text_active_color = ArdourCanvas::contrasting_text_color (fill_active_color);
918 text_inactive_color = ArdourCanvas::contrasting_text_color (fill_inactive_color);
920 led_active_color = ARDOUR_UI::config()->color (string_compose ("%1: led active", name), &failed);
922 led_active_color = ARDOUR_UI::config()->color ("generic button: led active");
925 /* The inactive color for the LED is just a fairly dark version of the
929 ArdourCanvas::HSV inactive (led_active_color);
932 led_inactive_color = inactive.color ();
936 * This sets the colors used for rendering based on two fixed values, rather
937 * than basing them on the button name, and thus information in the GUI config
940 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
942 _fixed_colors_set = true;
944 fill_active_color = color_active;
945 fill_inactive_color = color_inactive;
947 unsigned char r, g, b, a;
948 UINT_TO_RGBA(color_active, &r, &g, &b, &a);
950 double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
951 (max (double(g), 255.) - min (double(g), 255.)) +
952 (max (double(b), 255.) - min (double(b), 255.));
954 double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
955 (max (double(g), 0.) - min (double(g), 0.)) +
956 (max (double(b), 0.) - min (double(b), 0.));
958 text_active_color = (white_contrast > black_contrast) ?
959 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
960 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
963 UINT_TO_RGBA(color_inactive, &r, &g, &b, &a);
965 white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
966 (max (double(g), 255.) - min (double(g), 255.)) +
967 (max (double(b), 255.) - min (double(b), 255.));
969 black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
970 (max (double(g), 0.) - min (double(g), 0.)) +
971 (max (double(b), 0.) - min (double(b), 0.));
973 text_inactive_color = (white_contrast > black_contrast) ?
974 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
975 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
977 /* XXX what about led colors ? */
978 CairoWidget::set_dirty ();
982 ArdourButton::build_patterns ()
984 if (convex_pattern) {
985 cairo_pattern_destroy (convex_pattern);
989 if (concave_pattern) {
990 cairo_pattern_destroy (concave_pattern);
994 if (led_inset_pattern) {
995 cairo_pattern_destroy (led_inset_pattern);
996 led_inset_pattern = 0;
1000 convex_pattern = cairo_pattern_create_linear (0.0, 0, 0.0, get_height());
1001 cairo_pattern_add_color_stop_rgba (convex_pattern, 0.0, 0,0,0, 0.0);
1002 cairo_pattern_add_color_stop_rgba (convex_pattern, 1.0, 0,0,0, 0.35);
1005 concave_pattern = cairo_pattern_create_linear (0.0, 0, 0.0, get_height());
1006 cairo_pattern_add_color_stop_rgba (concave_pattern, 0.0, 0,0,0, 0.5);
1007 cairo_pattern_add_color_stop_rgba (concave_pattern, 0.7, 0,0,0, 0.0);
1009 led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
1010 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
1011 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
1013 _pattern_height = get_height() ;
1017 ArdourButton::set_led_left (bool yn)
1023 ArdourButton::on_button_press_event (GdkEventButton *ev)
1027 if (ev->button == 1 && (_elements & Indicator) && _led_rect && _distinct_led_click) {
1028 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
1029 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
1034 if (binding_proxy.button_press_handler (ev)) {
1039 CairoWidget::set_dirty ();
1041 if (ev->button == 1 && !_act_on_release) {
1043 _action->activate ();
1048 if (_fallthrough_to_parent)
1055 ArdourButton::on_button_release_event (GdkEventButton *ev)
1057 if (ev->button == 1 && _hovering && (_elements & Indicator) && _led_rect && _distinct_led_click) {
1058 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
1059 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
1060 signal_led_clicked(); /* EMIT SIGNAL */
1066 CairoWidget::set_dirty ();
1068 if (ev->button == 1 && _hovering) {
1070 if (_act_on_release) {
1072 _action->activate ();
1078 if (_fallthrough_to_parent)
1085 ArdourButton::set_distinct_led_click (bool yn)
1087 _distinct_led_click = yn;
1092 ArdourButton::color_handler ()
1094 _update_colors = true;
1095 CairoWidget::set_dirty ();
1099 ArdourButton::on_size_allocate (Allocation& alloc)
1101 CairoWidget::on_size_allocate (alloc);
1106 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
1108 watch_connection.disconnect ();
1109 binding_proxy.set_controllable (c);
1113 ArdourButton::watch ()
1115 boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
1118 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
1121 c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
1125 ArdourButton::controllable_changed ()
1127 float val = binding_proxy.get_controllable()->get_value();
1129 if (fabs (val) >= 0.5f) {
1130 set_active_state (Gtkmm2ext::ExplicitActive);
1132 unset_active_state ();
1134 CairoWidget::set_dirty ();
1138 ArdourButton::set_related_action (RefPtr<Action> act)
1140 Gtkmm2ext::Activatable::set_related_action (act);
1144 action_tooltip_changed ();
1146 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
1149 tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
1152 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
1153 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
1154 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
1159 ArdourButton::action_toggled ()
1161 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
1164 if (tact->get_active()) {
1165 set_active_state (Gtkmm2ext::ExplicitActive);
1167 unset_active_state ();
1173 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
1175 _update_colors = true;
1176 CairoWidget::set_dirty ();
1180 ArdourButton::on_name_changed ()
1182 _char_pixel_width = 0;
1183 _char_pixel_height = 0;
1185 _update_colors = true;
1186 if (is_realized()) {
1192 ArdourButton::setup_led_rect ()
1194 if (!(_elements & Indicator)) {
1201 _led_rect = new cairo_rectangle_t;
1204 if (_elements & Text) {
1206 _led_rect->x = char_pixel_width();
1208 _led_rect->x = get_width() - char_pixel_width() + _diameter;
1212 _led_rect->x = .5 * get_width() - _diameter;
1215 _led_rect->y = .5 * (get_height() - _diameter);
1216 _led_rect->width = _diameter;
1217 _led_rect->height = _diameter;
1221 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
1224 if (is_realized()) {
1230 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
1232 bool changed = (_active_state != s);
1233 CairoWidget::set_active_state (s);
1235 _update_colors = true;
1236 CairoWidget::set_dirty ();
1241 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
1243 bool changed = (_visual_state != s);
1244 CairoWidget::set_visual_state (s);
1246 _update_colors = true;
1247 CairoWidget::set_dirty ();
1252 ArdourButton::on_focus_in_event (GdkEventFocus* ev)
1255 CairoWidget::set_dirty ();
1256 return CairoWidget::on_focus_in_event (ev);
1260 ArdourButton::on_focus_out_event (GdkEventFocus* ev)
1263 CairoWidget::set_dirty ();
1264 return CairoWidget::on_focus_out_event (ev);
1268 ArdourButton::on_key_release_event (GdkEventKey *ev) {
1270 (ev->keyval == GDK_space || ev->keyval == GDK_Return))
1274 _action->activate ();
1278 return CairoWidget::on_key_release_event (ev);
1282 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
1284 _hovering = (_elements & Inactive) ? false : true;
1286 if (ARDOUR_UI::config()->get_widget_prelight()) {
1287 CairoWidget::set_dirty ();
1290 return CairoWidget::on_enter_notify_event (ev);
1294 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
1298 if (ARDOUR_UI::config()->get_widget_prelight()) {
1299 CairoWidget::set_dirty ();
1302 return CairoWidget::on_leave_notify_event (ev);
1306 ArdourButton::set_tweaks (Tweaks t)
1310 if (is_realized()) {
1317 ArdourButton::action_sensitivity_changed ()
1319 if (_action->property_sensitive ()) {
1320 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
1322 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
1327 ArdourButton::set_layout_ellipsize_width (int w)
1329 if (_layout_ellipsize_width == w) {
1332 _layout_ellipsize_width = w;
1336 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1337 _layout->set_width (_layout_ellipsize_width - 3 * PANGO_SCALE);
1339 if (is_realized ()) {
1345 ArdourButton::set_text_ellipsize (Pango::EllipsizeMode e)
1347 if (_ellipsis == e) {
1354 _layout->set_ellipsize(_ellipsis);
1355 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1356 _layout->set_width (_layout_ellipsize_width - 3 * PANGO_SCALE);
1358 if (is_realized ()) {
1364 ArdourButton::ensure_layout ()
1368 _layout = Pango::Layout::create (get_pango_context());
1369 _layout->set_ellipsize(_ellipsis);
1370 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1371 _layout->set_width (_layout_ellipsize_width - 3* PANGO_SCALE);
1377 ArdourButton::recalc_char_pixel_geometry ()
1379 if (_char_pixel_height > 0 && _char_pixel_width > 0) {
1383 // NB. this is not static, since the geometry is different
1384 // depending on the font used.
1386 std::string x = _("ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
1387 _layout->set_text (x);
1388 _layout->get_pixel_size (w, h);
1389 _char_pixel_height = std::max(4, h);
1390 // number of actual chars in the string (not bytes)
1391 // Glib to the rescue.
1392 Glib::ustring gx(x);
1393 _char_avg_pixel_width = w / (float)gx.size();
1394 _char_pixel_width = std::max(4, (int) ceil (_char_avg_pixel_width));
1395 _layout->set_text (_text);
1399 ArdourButton::action_visibility_changed ()
1401 if (_action->property_visible ()) {
1409 ArdourButton::action_tooltip_changed ()
1411 string str = _action->property_tooltip().get_value();
1412 ARDOUR_UI::instance()->set_tip (*this, str);
1416 ArdourButton::set_elements (Element e)
1419 CairoWidget::set_dirty ();
1423 ArdourButton::add_elements (Element e)
1425 _elements = (ArdourButton::Element) (_elements | e);
1426 CairoWidget::set_dirty ();
1430 ArdourButton::set_icon (Icon i)
1433 CairoWidget::set_dirty ();
1437 ArdourButton::set_custom_led_color (uint32_t c, bool useit)
1439 if (led_custom_color == c && use_custom_led_color == useit) {
1443 led_custom_color = c;
1444 use_custom_led_color = useit;
1445 CairoWidget::set_dirty ();