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 if (_update_colors) {
205 if (get_height() != _pattern_height) {
209 if ( active_state() == Gtkmm2ext::ExplicitActive ) {
210 text_color = text_active_color;
211 led_color = led_active_color;
213 text_color = text_inactive_color;
214 led_color = led_inactive_color;
217 if (use_custom_led_color) {
218 led_color = led_custom_color;
221 void (*rounded_function)(cairo_t*, double, double, double, double, double);
223 switch (_corner_mask) {
224 case 0x1: /* upper left only */
225 rounded_function = Gtkmm2ext::rounded_top_left_rectangle;
227 case 0x2: /* upper right only */
228 rounded_function = Gtkmm2ext::rounded_top_right_rectangle;
230 case 0x3: /* upper only */
231 rounded_function = Gtkmm2ext::rounded_top_rectangle;
233 /* should really have functions for lower right, lower left,
234 lower only, but for now, we don't
237 rounded_function = Gtkmm2ext::rounded_rectangle;
240 // draw edge (filling a rect underneath, rather than stroking a border on top, allows the corners to be lighter-weight.
241 if ((_elements & (Body|Edge)) == (Body|Edge)) {
242 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius + 1.5);
243 cairo_set_source_rgba (cr, 0, 0, 0, 1);
248 if ((_elements & Body)==Body) {
249 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
250 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
251 ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
253 } else if ( (active_state() == Gtkmm2ext::ExplicitActive) && !((_elements & Indicator)==Indicator) ) {
255 ArdourCanvas::set_source_rgba (cr, fill_active_color);
257 } else { //inactive, or it has an indicator
259 ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
264 // IMPLICIT ACTIVE: draw a border of the active color
265 if ((_elements & Body)==Body) {
266 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
267 cairo_set_line_width (cr, 2.0);
268 rounded_function (cr, 2, 2, get_width() - 4, get_height() - 4, _corner_radius-0.5);
269 ArdourCanvas::set_source_rgba (cr, fill_active_color);
274 //show the "convex" or "concave" gradient
275 if (!_flat_buttons) {
276 if ( active_state() == Gtkmm2ext::ExplicitActive && ( !((_elements & Indicator)==Indicator) || use_custom_led_color) ) {
278 cairo_set_source (cr, concave_pattern);
279 Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
282 cairo_set_source (cr, convex_pattern);
283 Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
288 #define VECTORICONSTROKEFILL \
289 cairo_set_line_width(cr, 1.5); \
290 cairo_set_source_rgba (cr, 0, 0, 0, 1.0); \
291 cairo_stroke_preserve(cr); \
292 cairo_set_source_rgba (cr, 1, 1, 1, 1.0); \
297 double x = rint((get_width() - _pixbuf->get_width()) * .5);
298 const double y = rint((get_height() - _pixbuf->get_height()) * .5);
299 #if 0 // DEBUG style (print on hover)
300 if (_hovering || (_elements & Inactive)) {
301 printf("%s: p:%dx%d (%dx%d)\n",
303 _pixbuf->get_width(), _pixbuf->get_height(),
304 get_width(), get_height());
307 if (_elements & Menu) {
308 //if this is a DropDown with an icon, then we need to
309 //move the icon left slightly to accomomodate the arrow
312 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
313 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
316 else /* VectorIcons are exclusive to Pixbuf Icons */
317 /* TODO separate these into dedicated class
318 * it may also be efficient to render them only once for every size (image-surface) */
319 if ((_elements & VectorIcon) && _icon == RecTapeMode) {
320 const double x = get_width() * .5;
321 const double y = get_height() * .5;
322 const double r = std::min(10., std::min(x, y) * .6); // TODO we need a better way to limit max. radius.
323 const double slit = .11 * M_PI;
325 cairo_translate(cr, x, y);
327 cairo_arc (cr, 0, 0, r, 0, 2 * M_PI);
328 if (active_state() == Gtkmm2ext::ExplicitActive) {
329 cairo_set_source_rgba (cr, .95, .1, .1, 1.);
331 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
333 cairo_fill_preserve(cr);
334 cairo_set_source_rgba (cr, .0, .0, .0, .5);
335 cairo_set_line_width(cr, 1);
339 cairo_set_source_rgba (cr, .15, .07, .07, 1.0);
341 cairo_rotate (cr, -.5 * M_PI);
342 cairo_move_to(cr, 0, 0);
343 cairo_arc (cr, 0, 0, r *.85, -slit, slit);
344 cairo_line_to(cr, 0, 0);
345 cairo_close_path(cr);
348 cairo_rotate (cr, 2. * M_PI / 3.);
350 cairo_move_to(cr, 0, 0);
351 cairo_arc (cr, 0, 0, r *.85, -slit, slit);
352 cairo_line_to(cr, 0, 0);
353 cairo_close_path(cr);
356 cairo_rotate (cr, 2. * M_PI / 3.);
357 cairo_move_to(cr, 0, 0);
358 cairo_arc (cr, 0, 0, r *.85, -slit, slit);
359 cairo_line_to(cr, 0, 0);
360 cairo_close_path(cr);
365 cairo_arc (cr, 0, 0, r * .3, 0, 2 * M_PI);
366 if (active_state() == Gtkmm2ext::ExplicitActive)
367 cairo_set_source_rgba (cr, .95, .1, .1, 1.);
369 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
371 cairo_set_source_rgba (cr, .0, .0, .0, 1.0);
372 cairo_arc (cr, 0, 0, r *.15, 0, 2 * M_PI); // hole in the middle
377 else if ((_elements & VectorIcon) && _icon == RecButton) {
378 const double x = get_width() * .5;
379 const double y = get_height() * .5;
380 const double r = std::min(10., std::min(x, y) * .55); // TODO we need a better way to limit max. radius.
381 cairo_arc (cr, x, y, r, 0, 2 * M_PI);
382 if (active_state() == Gtkmm2ext::ExplicitActive)
383 cairo_set_source_rgba (cr, .95, .1, .1, 1.);
385 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
386 cairo_fill_preserve(cr);
387 cairo_set_source_rgba (cr, .0, .0, .0, .8);
388 cairo_set_line_width(cr, 1);
391 else if ((_elements & VectorIcon) && _icon == CloseCross) {
392 const double x = get_width() * .5;
393 const double y = get_height() * .5;
394 const double o = .5 + std::min(x, y) * .4;
395 ArdourCanvas::set_source_rgba (cr, text_color);
396 cairo_set_line_width(cr, 1);
397 cairo_move_to(cr, x-o, y-o);
398 cairo_line_to(cr, x+o, y+o);
399 cairo_move_to(cr, x+o, y-o);
400 cairo_line_to(cr, x-o, y+o);
403 else if ((_elements & VectorIcon) && _icon == StripWidth) {
404 const double x0 = get_width() * .2;
405 const double x1 = get_width() * .8;
407 const double y0 = get_height() * .25;
408 const double y1= get_height() * .75;
410 const double ym= get_height() * .5;
413 const double xa0= get_height() * .39;
414 const double xa1= get_height() * .61;
415 const double ya0= get_height() * .35;
416 const double ya1= get_height() * .65;
418 ArdourCanvas::set_source_rgba (cr, text_color);
419 cairo_set_line_width(cr, 1);
422 cairo_move_to(cr, x0, y0);
423 cairo_line_to(cr, x0, y1);
424 cairo_move_to(cr, x1, y0);
425 cairo_line_to(cr, x1, y1);
428 cairo_move_to(cr, x0, ym);
429 cairo_line_to(cr, x1, ym);
432 cairo_move_to(cr, x0, ym);
433 cairo_line_to(cr, xa0, ya0);
434 cairo_move_to(cr, x0, ym);
435 cairo_line_to(cr, xa0, ya1);
438 cairo_move_to(cr, x1, ym);
439 cairo_line_to(cr, xa1, ya0);
440 cairo_move_to(cr, x1, ym);
441 cairo_line_to(cr, xa1, ya1);
444 else if ((_elements & VectorIcon) && _icon == DinMidi) {
445 const double x = get_width() * .5;
446 const double y = get_height() * .5;
447 const double r = std::min(x, y) * .75;
448 ArdourCanvas::set_source_rgba (cr, text_color);
449 cairo_set_line_width(cr, 1);
450 cairo_arc (cr, x, y, r, 0, 2 * M_PI);
453 // pins equally spaced 45deg
454 cairo_arc (cr, x, y * 0.5, r * .15, 0, 2 * M_PI);
456 cairo_arc (cr, x * 0.5, y, r * .15, 0, 2 * M_PI);
458 cairo_arc (cr, x * 1.5, y, r * .15, 0, 2 * M_PI);
460 // .5 + .5 * .5 * sin(45deg), 1.5 - .5 * .5 * cos(45deg)
461 cairo_arc (cr, x * 0.677, y * .677, r * .15, 0, 2 * M_PI);
463 cairo_arc (cr, x * 1.323, y * .677, r * .15, 0, 2 * M_PI);
467 cairo_arc (cr, x, y+r, r * .28, 1.05 * M_PI, 1.95 * M_PI);
470 else if ((_elements & VectorIcon) && _icon == TransportStop) {
471 const int wh = std::min (get_width(), get_height());
473 (get_width() - wh) * .5 + wh * .25,
474 (get_height() - wh) * .5 + wh * .25,
477 VECTORICONSTROKEFILL;
479 else if ((_elements & VectorIcon) && _icon == TransportPlay) {
480 const int wh = std::min (get_width(), get_height()) * .5;
481 const double y = get_height() * .5;
482 const double x = get_width() - wh;
484 const float tri = ceil(.577 * wh); // 1/sqrt(3)
486 cairo_move_to (cr, x + wh * .5, y);
487 cairo_line_to (cr, x - wh * .5, y - tri);
488 cairo_line_to (cr, x - wh * .5, y + tri);
489 cairo_close_path (cr);
491 VECTORICONSTROKEFILL;
493 else if ((_elements & VectorIcon) && _icon == TransportPanic) {
494 const int wh = std::min (get_width(), get_height()) * .1;
495 const double xc = get_width() * .5;
496 const double yh = get_height();
500 VECTORICONSTROKEFILL;
502 cairo_arc (cr, xc, yh *.75, wh, 0, 2 * M_PI);
503 VECTORICONSTROKEFILL;
505 else if ((_elements & VectorIcon) && (_icon == TransportStart || _icon == TransportEnd || _icon == TransportRange)) {
506 // small play triangle
507 int wh = std::min (get_width(), get_height());
508 const double y = get_height() * .5;
509 const double x = get_width() - wh * .5;
511 const float tri = ceil(.577 * wh * 2); // 1/sqrt(3)
513 const float ln = std::min (get_width(), get_height()) * .07;
515 if (_icon == TransportStart || _icon == TransportRange) {
517 x - wh - ln, y - tri * 1.7,
520 VECTORICONSTROKEFILL;
523 if (_icon == TransportEnd || _icon == TransportRange) {
525 x + wh - ln, y - tri * 1.7,
528 VECTORICONSTROKEFILL;
531 if (_icon == TransportStart) {
532 cairo_move_to (cr, x - wh, y);
533 cairo_line_to (cr, x + wh, y - tri);
534 cairo_line_to (cr, x + wh, y + tri);
536 cairo_move_to (cr, x + wh, y);
537 cairo_line_to (cr, x - wh, y - tri);
538 cairo_line_to (cr, x - wh, y + tri);
541 cairo_close_path (cr);
542 VECTORICONSTROKEFILL;
544 else if ((_elements & VectorIcon) && _icon == TransportLoop) {
545 const double x = get_width() * .5;
546 const double y = get_height() * .5;
547 const double r = std::min(x, y);
549 cairo_arc (cr, x, y, r * .6, 0, 2 * M_PI);
550 cairo_arc_negative (cr, x, y, r * .3, 2 * M_PI, 0);
552 VECTORICONSTROKEFILL;
553 #define ARCARROW(rad, ang) \
554 x + (rad) * sin((ang) * 2.0 * M_PI), y + (rad) * cos((ang) * 2.0 * M_PI)
556 cairo_move_to (cr, ARCARROW(r * .30, .72));
557 cairo_line_to (cr, ARCARROW(r * .08, .72));
558 cairo_line_to (cr, ARCARROW(r * .50, .60));
559 cairo_line_to (cr, ARCARROW(r * .73, .72));
560 cairo_line_to (cr, ARCARROW(r * .60, .72));
562 cairo_set_source_rgba (cr, 0, 0, 0, 1.0);
563 cairo_stroke_preserve(cr);
564 cairo_close_path (cr);
565 cairo_set_source_rgba (cr, 1, 1, 1, 1.0);
569 else if ((_elements & VectorIcon) && _icon == TransportMetronom) {
570 const double x = get_width() * .5;
571 const double y = get_height() * .5;
572 const double wh = std::min(x, y);
573 const double h = wh * .8;
574 const double w = wh * .5;
575 const double lw = w * .25;
578 x - w * .7, y + h * .25,
581 VECTORICONSTROKEFILL;
583 cairo_move_to (cr, x - w, y + h);
584 cairo_line_to (cr, x + w, y + h);
585 cairo_line_to (cr, x + w * .35, y - h);
586 cairo_line_to (cr, x - w * .35, y - h);
587 cairo_line_to (cr, x - w, y + h);
589 cairo_move_to (cr, x - w + lw, y + h -lw);
590 cairo_line_to (cr, x - w * .35 + lw, y - h + lw);
591 cairo_line_to (cr, x + w * .35 - lw, y - h + lw);
592 cairo_line_to (cr, x + w - lw, y + h -lw);
593 cairo_line_to (cr, x - w + lw, y + h -lw);
595 VECTORICONSTROKEFILL;
597 // ddx = .70 w = .75 * .5 wh = .375 wh
598 // ddy = .75 h - lw = .75 * .8 wh - wh .5 * .2 = .5 wh
600 // -> angle = atan (ang) = atan (375 / .5) ~= 36deg
601 const double dx = lw * .2; // 1 - cos(tan^-1(ang))
602 const double dy = lw * .4; // 1 - sin(tan^-1(ang))
603 cairo_move_to (cr, x - w * .3 , y + h * .25 + lw * .5);
604 cairo_line_to (cr, x - w + dx , y - h + lw + dy);
605 cairo_line_to (cr, x - w + lw , y - h + lw);
606 cairo_line_to (cr, x - w * .3 + lw, y + h * .25 + lw * .5);
607 cairo_close_path (cr);
609 VECTORICONSTROKEFILL;
612 x - w * .7, y + h * .25,
616 else if (_elements & VectorIcon) {
620 #undef VECTORICONSTROKEFILL
622 const int text_margin = char_pixel_width();
624 if (!_pixbuf && ((_elements & Text)==Text) && !_text.empty()) {
626 #if 0 // DEBUG style (print on hover)
627 if (_hovering || (_elements & Inactive)) {
628 bool layout_font = true;
629 Pango::FontDescription fd = _layout->get_font_description();
630 if (fd.gobj() == NULL) {
632 fd = get_pango_context()->get_font_description();
634 printf("%s: f:%dx%d aw:%.3f bh:%.0f t:%dx%d (%dx%d) %s\"%s\"\n",
636 char_pixel_width(), char_pixel_height(), char_avg_pixel_width(),
637 ceil(char_pixel_height() * BASELINESTRETCH),
638 _text_width, _text_height,
639 get_width(), get_height(),
640 layout_font ? "L:" : "W:",
641 fd.to_string().c_str());
646 cairo_rectangle (cr, 2, 1, get_width() - 4, get_height() - 2);
650 ArdourCanvas::set_source_rgba (cr, text_color);
651 const double text_ypos = (get_height() - _text_height) * .5;
653 if (_elements & Menu) {
654 // always left align (dropdown)
655 cairo_move_to (cr, text_margin, text_ypos);
656 pango_cairo_show_layout (cr, _layout->gobj());
657 } else if ( (_elements & Indicator) == Indicator) {
658 // left/right align depending on LED position
660 cairo_move_to (cr, text_margin + _diameter + .5 * char_pixel_width(), text_ypos);
662 cairo_move_to (cr, text_margin, text_ypos);
664 pango_cairo_show_layout (cr, _layout->gobj());
666 /* centered text otherwise */
673 cairo_rotate(cr, _angle * M_PI / 180.0);
674 cairo_device_to_user(cr, &ww, &wh);
675 xa = (ww - _text_width) * _xalign;
676 ya = (wh - _text_height) * _yalign;
678 /* quick hack for left/bottom alignment at -90deg
679 * TODO this should be generalized incl rotation.
680 * currently only 'user' of this API is meter_strip.cc
682 if (_xalign < 0) xa = ceil(.5 + (ww * fabs(_xalign) + text_margin));
684 cairo_move_to (cr, xa, ya);
685 pango_cairo_update_layout(cr, _layout->gobj());
686 pango_cairo_show_layout (cr, _layout->gobj());
693 if (_elements & Menu) {
694 const float trih = ceil(_diameter * .5);
695 const float triw2 = ceil(.577 * _diameter * .5); // 1/sqrt(3) Equilateral triangle
697 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
698 cairo_move_to(cr, get_width() - triw2 - 3. , rint((get_height() + trih) * .5));
699 cairo_rel_line_to(cr, -triw2, -trih);
700 cairo_rel_line_to(cr, 2. * triw2, 0);
701 cairo_close_path(cr);
703 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
706 cairo_move_to(cr, get_width() - triw2 - 3 , rint((get_height() + trih) * .5));
707 cairo_rel_line_to(cr, .5 - triw2, .5 - trih);
708 cairo_rel_line_to(cr, 2. * triw2 - 1, 0);
709 cairo_close_path(cr);
710 cairo_set_source_rgba (cr, 0, 0, 0, 0.8);
711 cairo_set_line_width(cr, 1);
716 if (_elements & Indicator) {
719 /* move to the center of the indicator/led */
720 if (_elements & Text) {
721 int led_xoff = ceil(char_pixel_width() + _diameter * .5);
723 cairo_translate (cr, led_xoff, get_height() * .5);
725 cairo_translate (cr, get_width() - led_xoff, get_height() * .5);
728 cairo_translate (cr, get_width() * .5, get_height() * .5);
732 if (!_flat_buttons) {
733 cairo_arc (cr, 0, 0, _diameter * .5, 0, 2 * M_PI);
734 cairo_set_source (cr, led_inset_pattern);
739 cairo_set_source_rgb (cr, 0, 0, 0);
740 cairo_arc (cr, 0, 0, _diameter * .5 - 1, 0, 2 * M_PI);
744 ArdourCanvas::set_source_rgba (cr, led_color);
745 cairo_arc (cr, 0, 0, _diameter * .5 - 3, 0, 2 * M_PI);
751 // a transparent overlay to indicate insensitivity
752 if ((visual_state() & Gtkmm2ext::Insensitive)) {
753 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
754 uint32_t ins_color = ARDOUR_UI::config()->color ("gtk_background");
755 ArdourCanvas::set_source_rgb_a (cr, ins_color, 0.6);
759 // if requested, show hovering
760 if (ARDOUR_UI::config()->get_widget_prelight()
761 && !((visual_state() & Gtkmm2ext::Insensitive))) {
763 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
764 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
769 //user is currently pressing the button. dark outline helps to indicate this
770 if (_grabbed && !(_elements & (Inactive|Menu))) {
771 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
772 cairo_set_line_width(cr, 2);
773 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5);
777 //some buttons (like processor boxes) can be selected (so they can be deleted). Draw a selection indicator
778 if (visual_state() & Gtkmm2ext::Selected) {
779 cairo_set_line_width(cr, 1);
780 cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
781 rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, _corner_radius);
785 //I guess this means we have keyboard focus. I don't think this works currently
787 //A: yes, it's keyboard focus and it does work when there's no editor window
788 // (the editor is always the first receiver for KeyDown).
789 // It's needed for eg. the engine-dialog at startup or after closing a sesion.
791 rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, _corner_radius);
792 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.8);
794 cairo_set_dash (cr, &dashes, 1, 0);
795 cairo_set_line_cap (cr, CAIRO_LINE_CAP_BUTT);
796 cairo_set_line_width (cr, 1.0);
798 cairo_set_dash (cr, 0, 0, 0);
803 ArdourButton::set_corner_radius (float r)
806 CairoWidget::set_dirty ();
810 ArdourButton::on_realize()
812 CairoWidget::on_realize ();
814 if (_layout && _layout->get_text() != _text) {
815 _layout->set_text (_text);
821 ArdourButton::on_size_request (Gtk::Requisition* req)
823 req->width = req->height = 0;
824 CairoWidget::on_size_request (req);
826 if (_diameter == 0) {
827 const float newdia = rint (ARDOUR_UI::config()->get_font_scale () / 9600.0); // 11px with 100% font-scaling
828 if (_diameter != newdia) {
834 if ((_elements & Text) && !_text.empty()) {
835 // if _layout does not exist, char_pixel_height() creates it,
836 req->height = std::max(req->height, (int) ceil(char_pixel_height() * BASELINESTRETCH + 1.0));
837 _layout->get_pixel_size (_text_width, _text_height);
838 req->width += rint(1.75 * char_pixel_width()); // padding
839 req->width += _text_width;
846 req->width += _pixbuf->get_width() + char_pixel_width();
847 req->height = std::max(req->height, _pixbuf->get_height() + 4);
850 if (_elements & Indicator) {
851 req->width += lrint (_diameter) + char_pixel_width();
852 req->height = std::max (req->height, (int) lrint (_diameter) + 4);
855 if ((_elements & Menu)) {
856 req->width += _diameter + 4;
859 if (_elements & VectorIcon) {
860 assert(!(_elements & Text));
861 const int wh = std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.));
863 req->height = std::max(req->height, wh);
866 /* Tweaks to mess the nice stuff above up again. */
867 if (_tweaks & TrackHeader) {
868 // forget everything above and just use a fixed square [em] size
869 // "TrackHeader Buttons" are single letter (usually uppercase)
870 // a SizeGroup is much less efficient (lots of gtk work under the hood for each track)
871 const int wh = std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.));
875 else if (_tweaks & Square) {
876 // currerntly unused (again)
877 if (req->width < req->height)
878 req->width = req->height;
879 if (req->height < req->width)
880 req->height = req->width;
881 } else if (_text_width > 0 && !(_elements & (Menu | Indicator))) {
882 // properly centered text for those elements that are centered
883 // (no sub-pixel offset)
884 if ((req->width - _text_width) & 1) { ++req->width; }
885 if ((req->height - _text_height) & 1) { ++req->height; }
888 printf("REQ: %s: %dx%d\n", get_name().c_str(), req->width, req->height);
893 * This sets the colors used for rendering based on the name of the button, and
894 * thus uses information from the GUI config data.
897 ArdourButton::set_colors ()
899 _update_colors = false;
900 if (_fixed_colors_set) {
903 std::string name = get_name();
906 fill_active_color = ARDOUR_UI::config()->color (string_compose ("%1: fill active", name), &failed);
908 fill_active_color = ARDOUR_UI::config()->color ("generic button: fill active");
910 fill_inactive_color = ARDOUR_UI::config()->color (string_compose ("%1: fill", name), &failed);
912 fill_inactive_color = ARDOUR_UI::config()->color ("generic button: fill");
915 text_active_color = ArdourCanvas::contrasting_text_color (fill_active_color);
916 text_inactive_color = ArdourCanvas::contrasting_text_color (fill_inactive_color);
918 led_active_color = ARDOUR_UI::config()->color (string_compose ("%1: led active", name), &failed);
920 led_active_color = ARDOUR_UI::config()->color ("generic button: led active");
923 /* The inactive color for the LED is just a fairly dark version of the
927 ArdourCanvas::HSV inactive (led_active_color);
930 led_inactive_color = inactive.color ();
934 * This sets the colors used for rendering based on two fixed values, rather
935 * than basing them on the button name, and thus information in the GUI config
938 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
940 _fixed_colors_set = true;
942 fill_active_color = color_active;
943 fill_inactive_color = color_inactive;
945 unsigned char r, g, b, a;
946 UINT_TO_RGBA(color_active, &r, &g, &b, &a);
948 double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
949 (max (double(g), 255.) - min (double(g), 255.)) +
950 (max (double(b), 255.) - min (double(b), 255.));
952 double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
953 (max (double(g), 0.) - min (double(g), 0.)) +
954 (max (double(b), 0.) - min (double(b), 0.));
956 text_active_color = (white_contrast > black_contrast) ?
957 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
958 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
961 UINT_TO_RGBA(color_inactive, &r, &g, &b, &a);
963 white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
964 (max (double(g), 255.) - min (double(g), 255.)) +
965 (max (double(b), 255.) - min (double(b), 255.));
967 black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
968 (max (double(g), 0.) - min (double(g), 0.)) +
969 (max (double(b), 0.) - min (double(b), 0.));
971 text_inactive_color = (white_contrast > black_contrast) ?
972 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
973 RGBA_TO_UINT( 0, 0, 0, 255); /* use black */
975 /* XXX what about led colors ? */
976 CairoWidget::set_dirty ();
980 ArdourButton::build_patterns ()
982 if (convex_pattern) {
983 cairo_pattern_destroy (convex_pattern);
987 if (concave_pattern) {
988 cairo_pattern_destroy (concave_pattern);
992 if (led_inset_pattern) {
993 cairo_pattern_destroy (led_inset_pattern);
994 led_inset_pattern = 0;
998 convex_pattern = cairo_pattern_create_linear (0.0, 0, 0.0, get_height());
999 cairo_pattern_add_color_stop_rgba (convex_pattern, 0.0, 0,0,0, 0.0);
1000 cairo_pattern_add_color_stop_rgba (convex_pattern, 1.0, 0,0,0, 0.35);
1003 concave_pattern = cairo_pattern_create_linear (0.0, 0, 0.0, get_height());
1004 cairo_pattern_add_color_stop_rgba (concave_pattern, 0.0, 0,0,0, 0.5);
1005 cairo_pattern_add_color_stop_rgba (concave_pattern, 0.7, 0,0,0, 0.0);
1007 led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
1008 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
1009 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
1011 _pattern_height = get_height() ;
1015 ArdourButton::set_led_left (bool yn)
1021 ArdourButton::on_button_press_event (GdkEventButton *ev)
1025 if (ev->button == 1 && (_elements & Indicator) && _led_rect && _distinct_led_click) {
1026 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
1027 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
1032 if (binding_proxy.button_press_handler (ev)) {
1037 CairoWidget::set_dirty ();
1039 if (ev->button == 1 && !_act_on_release) {
1041 _action->activate ();
1046 if (_fallthrough_to_parent)
1053 ArdourButton::on_button_release_event (GdkEventButton *ev)
1055 if (ev->button == 1 && _hovering && (_elements & Indicator) && _led_rect && _distinct_led_click) {
1056 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
1057 ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
1058 signal_led_clicked(); /* EMIT SIGNAL */
1064 CairoWidget::set_dirty ();
1066 if (ev->button == 1 && _hovering) {
1068 if (_act_on_release) {
1070 _action->activate ();
1076 if (_fallthrough_to_parent)
1083 ArdourButton::set_distinct_led_click (bool yn)
1085 _distinct_led_click = yn;
1090 ArdourButton::color_handler ()
1092 _update_colors = true;
1093 CairoWidget::set_dirty ();
1097 ArdourButton::on_size_allocate (Allocation& alloc)
1099 CairoWidget::on_size_allocate (alloc);
1104 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
1106 watch_connection.disconnect ();
1107 binding_proxy.set_controllable (c);
1111 ArdourButton::watch ()
1113 boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
1116 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
1119 c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
1123 ArdourButton::controllable_changed ()
1125 float val = binding_proxy.get_controllable()->get_value();
1127 if (fabs (val) >= 0.5f) {
1128 set_active_state (Gtkmm2ext::ExplicitActive);
1130 unset_active_state ();
1132 CairoWidget::set_dirty ();
1136 ArdourButton::set_related_action (RefPtr<Action> act)
1138 Gtkmm2ext::Activatable::set_related_action (act);
1142 action_tooltip_changed ();
1144 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
1147 tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
1150 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
1151 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
1152 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
1157 ArdourButton::action_toggled ()
1159 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
1162 if (tact->get_active()) {
1163 set_active_state (Gtkmm2ext::ExplicitActive);
1165 unset_active_state ();
1171 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
1173 _update_colors = true;
1174 CairoWidget::set_dirty ();
1178 ArdourButton::on_name_changed ()
1180 _char_pixel_width = 0;
1181 _char_pixel_height = 0;
1183 _update_colors = true;
1184 if (is_realized()) {
1190 ArdourButton::setup_led_rect ()
1192 if (!(_elements & Indicator)) {
1199 _led_rect = new cairo_rectangle_t;
1202 if (_elements & Text) {
1204 _led_rect->x = char_pixel_width();
1206 _led_rect->x = get_width() - char_pixel_width() + _diameter;
1210 _led_rect->x = .5 * get_width() - _diameter;
1213 _led_rect->y = .5 * (get_height() - _diameter);
1214 _led_rect->width = _diameter;
1215 _led_rect->height = _diameter;
1219 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
1222 if (is_realized()) {
1228 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
1230 bool changed = (_active_state != s);
1231 CairoWidget::set_active_state (s);
1233 _update_colors = true;
1234 CairoWidget::set_dirty ();
1239 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
1241 bool changed = (_visual_state != s);
1242 CairoWidget::set_visual_state (s);
1244 _update_colors = true;
1245 CairoWidget::set_dirty ();
1250 ArdourButton::on_focus_in_event (GdkEventFocus* ev)
1253 CairoWidget::set_dirty ();
1254 return CairoWidget::on_focus_in_event (ev);
1258 ArdourButton::on_focus_out_event (GdkEventFocus* ev)
1261 CairoWidget::set_dirty ();
1262 return CairoWidget::on_focus_out_event (ev);
1266 ArdourButton::on_key_release_event (GdkEventKey *ev) {
1268 (ev->keyval == GDK_space || ev->keyval == GDK_Return))
1272 _action->activate ();
1276 return CairoWidget::on_key_release_event (ev);
1280 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
1282 _hovering = (_elements & Inactive) ? false : true;
1284 if (ARDOUR_UI::config()->get_widget_prelight()) {
1285 CairoWidget::set_dirty ();
1288 return CairoWidget::on_enter_notify_event (ev);
1292 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
1296 if (ARDOUR_UI::config()->get_widget_prelight()) {
1297 CairoWidget::set_dirty ();
1300 return CairoWidget::on_leave_notify_event (ev);
1304 ArdourButton::set_tweaks (Tweaks t)
1308 if (is_realized()) {
1315 ArdourButton::action_sensitivity_changed ()
1317 if (_action->property_sensitive ()) {
1318 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
1320 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
1325 ArdourButton::set_layout_ellipsize_width (int w)
1327 if (_layout_ellipsize_width == w) {
1330 _layout_ellipsize_width = w;
1334 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1335 _layout->set_width (_layout_ellipsize_width - 3 * PANGO_SCALE);
1337 if (is_realized ()) {
1343 ArdourButton::set_text_ellipsize (Pango::EllipsizeMode e)
1345 if (_ellipsis == e) {
1352 _layout->set_ellipsize(_ellipsis);
1353 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1354 _layout->set_width (_layout_ellipsize_width - 3 * PANGO_SCALE);
1356 if (is_realized ()) {
1362 ArdourButton::ensure_layout ()
1366 _layout = Pango::Layout::create (get_pango_context());
1367 _layout->set_ellipsize(_ellipsis);
1368 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1369 _layout->set_width (_layout_ellipsize_width - 3* PANGO_SCALE);
1375 ArdourButton::recalc_char_pixel_geometry ()
1377 if (_char_pixel_height > 0 && _char_pixel_width > 0) {
1381 // NB. this is not static, since the geometry is different
1382 // depending on the font used.
1384 std::string x = _("ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
1385 _layout->set_text (x);
1386 _layout->get_pixel_size (w, h);
1387 _char_pixel_height = std::max(4, h);
1388 // number of actual chars in the string (not bytes)
1389 // Glib to the rescue.
1390 Glib::ustring gx(x);
1391 _char_avg_pixel_width = w / (float)gx.size();
1392 _char_pixel_width = std::max(4, (int) ceil (_char_avg_pixel_width));
1393 _layout->set_text (_text);
1397 ArdourButton::action_visibility_changed ()
1399 if (_action->property_visible ()) {
1407 ArdourButton::action_tooltip_changed ()
1409 string str = _action->property_tooltip().get_value();
1410 ARDOUR_UI::instance()->set_tip (*this, str);
1414 ArdourButton::set_elements (Element e)
1417 CairoWidget::set_dirty ();
1421 ArdourButton::add_elements (Element e)
1423 _elements = (ArdourButton::Element) (_elements | e);
1424 CairoWidget::set_dirty ();
1428 ArdourButton::set_icon (Icon i)
1431 CairoWidget::set_dirty ();
1435 ArdourButton::set_custom_led_color (uint32_t c, bool useit)
1437 if (led_custom_color == c && use_custom_led_color == useit) {
1441 led_custom_color = c;
1442 use_custom_led_color = useit;
1443 CairoWidget::set_dirty ();