9687427608024c1da6181750a363b365688556c5
[ardour.git] / libs / widgets / ardour_button.cc
1 /*
2     Copyright (C) 2010 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #include <iostream>
21 #include <cmath>
22 #include <algorithm>
23
24 #include <pangomm/layout.h>
25 #include <gtkmm/toggleaction.h>
26
27 #include "pbd/compose.h"
28 #include "pbd/controllable.h"
29 #include "pbd/error.h"
30 #include "pbd/stacktrace.h"
31
32 #include "gtkmm2ext/colors.h"
33 #include "gtkmm2ext/gui_thread.h"
34 #include "gtkmm2ext/rgb_macros.h"
35 #include "gtkmm2ext/utils.h"
36
37 #include "widgets/ardour_button.h"
38 #include "widgets/tooltips.h"
39 #include "widgets/ui_config.h"
40
41 #include "pbd/i18n.h"
42
43 #define BASELINESTRETCH (1.25)
44 #define TRACKHEADERBTNW (3.10)
45
46 using namespace Gtk;
47 using namespace Glib;
48 using namespace PBD;
49 using namespace ArdourWidgets;
50 using std::max;
51 using std::min;
52 using namespace std;
53
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);
57
58 ArdourButton::ArdourButton (Element e)
59         : _sizing_text("")
60         , _markup (false)
61         , _elements (e)
62         , _icon (ArdourIcon::NoIcon)
63         , _icon_render_cb (0)
64         , _icon_render_cb_data (0)
65         , _tweaks (Tweaks (0))
66         , _char_pixel_width (0)
67         , _char_pixel_height (0)
68         , _char_avg_pixel_width (0)
69         , _text_width (0)
70         , _text_height (0)
71         , _diameter (0)
72         , _corner_radius (3.5)
73         , _corner_mask (0xf)
74         , _angle(0)
75         , _xalign(.5)
76         , _yalign(.5)
77         , fill_inactive_color (0)
78         , fill_active_color (0)
79         , text_active_color(0)
80         , text_inactive_color(0)
81         , led_active_color(0)
82         , led_inactive_color(0)
83         , led_custom_color (0)
84         , use_custom_led_color (false)
85         , convex_pattern (0)
86         , concave_pattern (0)
87         , led_inset_pattern (0)
88         , _led_rect (0)
89         , _act_on_release (true)
90         , _led_left (false)
91         , _distinct_led_click (false)
92         , _hovering (false)
93         , _focused (false)
94         , _fixed_colors_set (false)
95         , _fallthrough_to_parent (false)
96         , _layout_ellipsize_width (-1)
97         , _ellipsis (Pango::ELLIPSIZE_NONE)
98         , _update_colors (true)
99         , _pattern_height (0)
100 {
101         UIConfigurationBase::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
102         /* This is not provided by gtkmm */
103         signal_grab_broken_event().connect (sigc::mem_fun (*this, &ArdourButton::on_grab_broken_event));
104 }
105
106 ArdourButton::ArdourButton (const std::string& str, Element e)
107         : _sizing_text("")
108         , _markup (false)
109         , _elements (e)
110         , _icon (ArdourIcon::NoIcon)
111         , _tweaks (Tweaks (0))
112         , _char_pixel_width (0)
113         , _char_pixel_height (0)
114         , _char_avg_pixel_width (0)
115         , _text_width (0)
116         , _text_height (0)
117         , _diameter (0)
118         , _corner_radius (3.5)
119         , _corner_mask (0xf)
120         , _angle(0)
121         , _xalign(.5)
122         , _yalign(.5)
123         , fill_inactive_color (0)
124         , fill_active_color (0)
125         , text_active_color(0)
126         , text_inactive_color(0)
127         , led_active_color(0)
128         , led_inactive_color(0)
129         , led_custom_color (0)
130         , use_custom_led_color (false)
131         , convex_pattern (0)
132         , concave_pattern (0)
133         , led_inset_pattern (0)
134         , _led_rect (0)
135         , _act_on_release (true)
136         , _led_left (false)
137         , _distinct_led_click (false)
138         , _hovering (false)
139         , _focused (false)
140         , _fixed_colors_set (false)
141         , _fallthrough_to_parent (false)
142         , _layout_ellipsize_width (-1)
143         , _ellipsis (Pango::ELLIPSIZE_NONE)
144         , _update_colors (true)
145         , _pattern_height (0)
146 {
147         set_text (str);
148         UIConfigurationBase::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
149         UIConfigurationBase::instance().DPIReset.connect (sigc::mem_fun (*this, &ArdourButton::on_name_changed));
150         /* This is not provided by gtkmm */
151         signal_grab_broken_event().connect (sigc::mem_fun (*this, &ArdourButton::on_grab_broken_event));
152 }
153
154 ArdourButton::~ArdourButton()
155 {
156         delete _led_rect;
157
158         if (convex_pattern) {
159                 cairo_pattern_destroy (convex_pattern);
160         }
161
162         if (concave_pattern) {
163                 cairo_pattern_destroy (concave_pattern);
164         }
165
166         if (led_inset_pattern) {
167                 cairo_pattern_destroy (led_inset_pattern);
168         }
169 }
170
171 void
172 ArdourButton::set_layout_font (const Pango::FontDescription& fd)
173 {
174         ensure_layout ();
175         if (_layout) {
176                 _layout->set_font_description (fd);
177                 queue_resize ();
178                 _char_pixel_width = 0;
179                 _char_pixel_height = 0;
180         }
181 }
182
183 void
184 ArdourButton::set_text_internal () {
185         assert (_layout);
186         if (_markup) {
187                 _layout->set_markup (_text);
188         } else {
189                 _layout->set_text (_text);
190         }
191 }
192
193 void
194 ArdourButton::set_text (const std::string& str, bool markup)
195 {
196         if (!(_elements & Text)) {
197                 return;
198         }
199         if (_text == str && _markup == markup) {
200                 return;
201         }
202
203         _text = str;
204         _markup = markup;
205         if (!is_realized()) {
206                 return;
207         }
208         ensure_layout ();
209         if (_layout && _layout->get_text() != _text) {
210                 set_text_internal ();
211                 /* on_size_request() will fill in _text_width/height
212                  * so queue it even if _sizing_text != "" */
213                 queue_resize ();
214         }
215 }
216
217 void
218 ArdourButton::set_sizing_text (const std::string& str)
219 {
220         if (_sizing_text == str) {
221                 return;
222         }
223         _sizing_text = str;
224         if (!is_realized()) {
225                 return;
226         }
227         ensure_layout ();
228         if (_layout) {
229                 queue_resize ();
230         }
231 }
232
233 void
234 ArdourButton::set_angle (const double angle)
235 {
236         _angle = angle;
237 }
238
239 void
240 ArdourButton::set_alignment (const float xa, const float ya)
241 {
242         _xalign = xa;
243         _yalign = ya;
244 }
245
246
247 /* TODO make this a dedicated function elsewhere.
248  *
249  * Option 1:
250  * virtual ArdourButton::render_vector_icon()
251  * ArdourIconButton::render_vector_icon
252  *
253  * Option 2:
254  * ARDOUR_UI_UTILS::render_vector_icon()
255  */
256 void
257 ArdourButton::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
258 {
259         cairo_t* cr = ctx->cobj();
260
261         uint32_t text_color;
262         uint32_t led_color;
263
264         const float corner_radius = std::max(2.f, _corner_radius * UIConfigurationBase::instance().get_ui_scale());
265
266         if (_update_colors) {
267                 set_colors ();
268         }
269         if (get_height() != _pattern_height) {
270                 build_patterns ();
271         }
272
273         if ( active_state() == Gtkmm2ext::ExplicitActive ) {
274                 text_color = text_active_color;
275                 led_color = led_active_color;
276         } else {
277                 text_color = text_inactive_color;
278                 led_color = led_inactive_color;
279         }
280
281         if (use_custom_led_color) {
282                 led_color = led_custom_color;
283         }
284
285         void (*rounded_function)(cairo_t*, double, double, double, double, double);
286
287         switch (_corner_mask) {
288         case 0x1: /* upper left only */
289                 rounded_function = Gtkmm2ext::rounded_top_left_rectangle;
290                 break;
291         case 0x2: /* upper right only */
292                 rounded_function = Gtkmm2ext::rounded_top_right_rectangle;
293                 break;
294         case 0x3: /* upper only */
295                 rounded_function = Gtkmm2ext::rounded_top_rectangle;
296                 break;
297                 /* should really have functions for lower right, lower left,
298                    lower only, but for now, we don't
299                 */
300         default:
301                 rounded_function = Gtkmm2ext::rounded_rectangle;
302         }
303
304         // draw edge (filling a rect underneath, rather than stroking a border on top, allows the corners to be lighter-weight.
305         if ((_elements & (Body|Edge)) == (Body|Edge)) {
306                 rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius + 1.5);
307                 cairo_set_source_rgba (cr, 0, 0, 0, 1);
308                 cairo_fill(cr);
309         }
310
311         // background fill
312         if ((_elements & Body)==Body) {
313                 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
314                 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
315                         Gtkmm2ext::set_source_rgba (cr, fill_inactive_color);
316                         cairo_fill (cr);
317                 } else if ( (active_state() == Gtkmm2ext::ExplicitActive) && !((_elements & Indicator)==Indicator) ) {
318                         //background color
319                         Gtkmm2ext::set_source_rgba (cr, fill_active_color);
320                         cairo_fill (cr);
321                 } else {  //inactive, or it has an indicator
322                         //background color
323                         Gtkmm2ext::set_source_rgba (cr, fill_inactive_color);
324                 }
325                 cairo_fill (cr);
326         }
327
328         // IMPLICIT ACTIVE: draw a border of the active color
329         if ((_elements & Body)==Body) {
330                 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
331                         cairo_set_line_width (cr, 2.0);
332                         rounded_function (cr, 2, 2, get_width() - 4, get_height() - 4, corner_radius-0.5);
333                         Gtkmm2ext::set_source_rgba (cr, fill_active_color);
334                         cairo_stroke (cr);
335                 }
336         }
337
338         //show the "convex" or "concave" gradient
339         if (!_flat_buttons && (_elements & Body)==Body) {
340                 if ( active_state() == Gtkmm2ext::ExplicitActive && ( !((_elements & Indicator)==Indicator) || use_custom_led_color) ) {
341                         //concave
342                         cairo_set_source (cr, concave_pattern);
343                         Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
344                         cairo_fill (cr);
345                 } else {
346                         cairo_set_source (cr, convex_pattern);
347                         Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
348                         cairo_fill (cr);
349                 }
350         }
351
352         //Pixbuf, if any
353         if (_pixbuf) {
354                 double x = rint((get_width() - _pixbuf->get_width()) * .5);
355                 const double y = rint((get_height() - _pixbuf->get_height()) * .5);
356 #if 0 // DEBUG style (print on hover)
357                 if (_hovering || (_elements & Inactive)) {
358                         printf("%s: p:%dx%d (%dx%d)\n",
359                                         get_name().c_str(),
360                                         _pixbuf->get_width(), _pixbuf->get_height(),
361                                         get_width(), get_height());
362                 }
363 #endif
364                 if (_elements & Menu) {
365                         //if this is a DropDown with an icon, then we need to
366                         //move the icon left slightly to accomomodate the arrow
367                         x -= _diameter - 2;
368                 }
369                 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
370                 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
371                 cairo_fill (cr);
372         }
373         else /* VectorIcon, IconRenderCallback are exclusive to Pixbuf Icons */
374         if (_elements & (VectorIcon | IconRenderCallback)) {
375                 int vw = get_width();
376                 int vh = get_height();
377                 if (_elements & Menu) {
378                         vw -= _diameter + 4;
379                 }
380                 if (_elements & VectorIcon) {
381                         ArdourIcon::render (cr, _icon, vw, vh, active_state(), text_color);
382                 } else {
383                         cairo_save (cr);
384                         rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius + 1.5);
385                         cairo_clip (cr);
386                         _icon_render_cb (cr, vw, vh, text_color, _icon_render_cb_data);
387                         cairo_restore (cr);
388                 }
389         }
390
391         const int text_margin = char_pixel_width();
392         // Text, if any
393         if (!_pixbuf && ((_elements & Text)==Text) && !_text.empty()) {
394                 assert(_layout);
395 #if 0 // DEBUG style (print on hover)
396                 if (_hovering || (_elements & Inactive)) {
397                         bool layout_font = true;
398                         Pango::FontDescription fd = _layout->get_font_description();
399                         if (fd.gobj() == NULL) {
400                                 layout_font = false;
401                                 fd = get_pango_context()->get_font_description();
402                         }
403                         printf("%s: f:%dx%d aw:%.3f bh:%.0f t:%dx%d (%dx%d) %s\"%s\"\n",
404                                         get_name().c_str(),
405                                         char_pixel_width(), char_pixel_height(), char_avg_pixel_width(),
406                                         ceil(char_pixel_height() * BASELINESTRETCH),
407                                         _text_width, _text_height,
408                                         get_width(), get_height(),
409                                         layout_font ? "L:" : "W:",
410                                         fd.to_string().c_str());
411                 }
412 #endif
413
414                 cairo_save (cr);
415                 cairo_rectangle (cr, 2, 1, get_width() - 4, get_height() - 2);
416                 cairo_clip(cr);
417
418                 cairo_new_path (cr);
419                 Gtkmm2ext::set_source_rgba (cr, text_color);
420                 const double text_ypos = (get_height() - _text_height) * .5;
421
422                 if (_elements & Menu) {
423                         // always left align (dropdown)
424                         cairo_move_to (cr, text_margin, text_ypos);
425                         pango_cairo_show_layout (cr, _layout->gobj());
426                 } else if ( (_elements & Indicator)  == Indicator) {
427                         // left/right align depending on LED position
428                         if (_led_left) {
429                                 cairo_move_to (cr, text_margin + _diameter + .5 * char_pixel_width(), text_ypos);
430                         } else {
431                                 cairo_move_to (cr, text_margin, text_ypos);
432                         }
433                         pango_cairo_show_layout (cr, _layout->gobj());
434                 } else {
435                         /* centered text otherwise */
436                         double ww, wh;
437                         double xa, ya;
438                         ww = get_width();
439                         wh = get_height();
440
441                         cairo_matrix_t m1;
442                         cairo_get_matrix (cr, &m1);
443                         cairo_matrix_t m2 = m1;
444                         m2.x0 = 0;
445                         m2.y0 = 0;
446                         cairo_set_matrix (cr, &m2);
447
448                         if (_angle) {
449                                 cairo_rotate(cr, _angle * M_PI / 180.0);
450                         }
451
452                         cairo_device_to_user(cr, &ww, &wh);
453                         xa = text_margin + (ww - _text_width - 2 * text_margin) * _xalign;
454                         ya = (wh - _text_height) * _yalign;
455
456                         /* quick hack for left/bottom alignment at -90deg
457                          * TODO this should be generalized incl rotation.
458                          * currently only 'user' of this API is meter_strip.cc
459                          */
460                         if (_xalign < 0) xa = ceil(.5 + (ww * fabs(_xalign) + text_margin));
461
462                         cairo_move_to (cr, xa + m1.x0, ya + m1.y0);
463                         pango_cairo_update_layout(cr, _layout->gobj());
464                         pango_cairo_show_layout (cr, _layout->gobj());
465                 }
466                 cairo_restore (cr);
467         }
468
469         //Menu "triangle"
470         if (_elements & Menu) {
471                 const float trih = ceil(_diameter * .5);
472                 const float triw2 = ceil(.577 * _diameter * .5); // 1/sqrt(3) Equilateral triangle
473                 //menu arrow
474                 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
475                 cairo_move_to(cr, get_width() - triw2 - 3. , rint((get_height() + trih) * .5));
476                 cairo_rel_line_to(cr, -triw2, -trih);
477                 cairo_rel_line_to(cr, 2. * triw2, 0);
478                 cairo_close_path(cr);
479
480                 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
481                 cairo_fill(cr);
482
483                 cairo_move_to(cr, get_width() - triw2 - 3 , rint((get_height() + trih) * .5));
484                 cairo_rel_line_to(cr, .5 - triw2, .5 - trih);
485                 cairo_rel_line_to(cr, 2. * triw2 - 1, 0);
486                 cairo_close_path(cr);
487                 cairo_set_source_rgba (cr, 0, 0, 0, 0.8);
488                 cairo_set_line_width(cr, 1);
489                 cairo_stroke(cr);
490         }
491
492         //Indicator LED
493         if (_elements & Indicator) {
494                 cairo_save (cr);
495
496                 /* move to the center of the indicator/led */
497                 if (_elements & Text) {
498                         int led_xoff = ceil(char_pixel_width() + _diameter * .5);
499                         if (_led_left) {
500                                 cairo_translate (cr, led_xoff, get_height() * .5);
501                         } else {
502                                 cairo_translate (cr, get_width() - led_xoff, get_height() * .5);
503                         }
504                 } else {
505                         cairo_translate (cr, get_width() * .5, get_height() * .5);
506                 }
507
508                 //inset
509                 if (!_flat_buttons) {
510                         cairo_arc (cr, 0, 0, _diameter * .5, 0, 2 * M_PI);
511                         cairo_set_source (cr, led_inset_pattern);
512                         cairo_fill (cr);
513                 }
514
515                 //black ring
516                 cairo_set_source_rgb (cr, 0, 0, 0);
517                 cairo_arc (cr, 0, 0, _diameter * .5 - 1 * UIConfigurationBase::instance().get_ui_scale(), 0, 2 * M_PI);
518                 cairo_fill(cr);
519
520                 //led color
521                 Gtkmm2ext::set_source_rgba (cr, led_color);
522                 cairo_arc (cr, 0, 0, _diameter * .5 - 3 * UIConfigurationBase::instance().get_ui_scale(), 0, 2 * M_PI);
523                 cairo_fill(cr);
524
525                 cairo_restore (cr);
526         }
527
528         // a transparent overlay to indicate insensitivity
529         if ((visual_state() & Gtkmm2ext::Insensitive)) {
530                 rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius);
531                 uint32_t ins_color = UIConfigurationBase::instance().color ("gtk_background");
532                 Gtkmm2ext::set_source_rgb_a (cr, ins_color, 0.6);
533                 cairo_fill (cr);
534         }
535
536         // if requested, show hovering
537         if (UIConfigurationBase::instance().get_widget_prelight()
538                         && !((visual_state() & Gtkmm2ext::Insensitive))) {
539                 if (_hovering) {
540                         rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
541                         cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
542                         cairo_fill (cr);
543                 }
544         }
545
546         //user is currently pressing the button. dark outline helps to indicate this
547         if (_grabbed && !(_elements & (Inactive|Menu))) {
548                 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
549                 cairo_set_line_width(cr, 2);
550                 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5);
551                 cairo_stroke (cr);
552         }
553
554         //some buttons (like processor boxes) can be selected  (so they can be deleted).  Draw a selection indicator
555         if (visual_state() & Gtkmm2ext::Selected) {
556                 cairo_set_line_width(cr, 1);
557                 cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
558                 rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, corner_radius);
559                 cairo_stroke (cr);
560         }
561
562         //I guess this means we have keyboard focus.  I don't think this works currently
563         //
564         //A: yes, it's keyboard focus and it does work when there's no editor window
565         //   (the editor is always the first receiver for KeyDown).
566         //   It's needed for eg. the engine-dialog at startup or after closing a sesion.
567         if (_focused) {
568                 rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, corner_radius);
569                 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.8);
570                 double dashes = 1;
571                 cairo_set_dash (cr, &dashes, 1, 0);
572                 cairo_set_line_cap (cr, CAIRO_LINE_CAP_BUTT);
573                 cairo_set_line_width (cr, 1.0);
574                 cairo_stroke (cr);
575                 cairo_set_dash (cr, 0, 0, 0);
576         }
577 }
578
579 void
580 ArdourButton::set_corner_radius (float r)
581 {
582         _corner_radius = r;
583         CairoWidget::set_dirty ();
584 }
585
586 void
587 ArdourButton::on_realize()
588 {
589         CairoWidget::on_realize ();
590         ensure_layout ();
591         if (_layout) {
592                 if (_layout->get_text() != _text) {
593                         set_text_internal ();
594                         queue_resize ();
595                 }
596         }
597 }
598
599 void
600 ArdourButton::on_size_request (Gtk::Requisition* req)
601 {
602         req->width = req->height = 0;
603         CairoWidget::on_size_request (req);
604
605         if (_diameter == 0) {
606                 const float newdia = rintf (11.f * UIConfigurationBase::instance().get_ui_scale());
607                 if (_diameter != newdia) {
608                         _pattern_height = 0;
609                         _diameter = newdia;
610                 }
611         }
612
613         if (_elements & Text) {
614
615                 ensure_layout();
616                 set_text_internal ();
617
618                 /* render() needs the size of the displayed text */
619                 _layout->get_pixel_size (_text_width, _text_height);
620
621                 if (_tweaks & OccasionalText) {
622
623                         /* size should not change based on presence or absence
624                          * of text.
625                          */
626
627                 } else /*if (!_text.empty() || !_sizing_text.empty()) */ {
628
629                         req->height = std::max(req->height, (int) ceil(char_pixel_height() * BASELINESTRETCH + 1.0));
630                         req->width += rint(1.75 * char_pixel_width()); // padding
631
632                         if (!_sizing_text.empty()) {
633                                 _layout->set_text (_sizing_text); /* use sizing text */
634                         }
635
636                         int sizing_text_width = 0, sizing_text_height = 0;
637                         _layout->get_pixel_size (sizing_text_width, sizing_text_height);
638
639                         req->width += sizing_text_width;
640
641                         if (!_sizing_text.empty()) {
642                                 set_text_internal (); /* restore display text */
643                         }
644                 }
645
646                 /* XXX hack (surprise). Deal with two common rotation angles */
647
648                 if (_angle == 90 || _angle == 270) {
649                         /* do not swap text width or height because we rely on
650                            these being the un-rotated values in ::render()
651                         */
652                         swap (req->width, req->height);
653                 }
654
655         } else {
656                 _text_width = 0;
657                 _text_height = 0;
658         }
659
660         if (_pixbuf) {
661                 req->width += _pixbuf->get_width() + char_pixel_width();
662                 req->height = std::max(req->height, _pixbuf->get_height() + 4);
663         }
664
665         if (_elements & Indicator) {
666                 req->width += lrint (_diameter) + char_pixel_width();
667                 req->height = std::max (req->height, (int) lrint (_diameter) + 4);
668         }
669
670         if ((_elements & Menu)) {
671                 req->width += _diameter + 4;
672         }
673
674         if (_elements & (VectorIcon | IconRenderCallback)) {
675                 assert(!(_elements & Text));
676                 const int wh = std::max (6., std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.)));
677                 req->width += wh;
678                 req->height = std::max(req->height, wh);
679         }
680
681         /* Tweaks to mess the nice stuff above up again. */
682         if (_tweaks & TrackHeader) {
683                 // forget everything above and just use a fixed square [em] size
684                 // "TrackHeader Buttons" are single letter (usually uppercase)
685                 // a SizeGroup is much less efficient (lots of gtk work under the hood for each track)
686                 const int wh = std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.));
687                 req->width  = wh;
688                 req->height = wh;
689         }
690         else if (_tweaks & Square) {
691                 // currerntly unused (again)
692                 if (req->width < req->height)
693                         req->width = req->height;
694                 if (req->height < req->width)
695                         req->height = req->width;
696         } else if (_sizing_text.empty() && _text_width > 0 && !(_elements & Menu)) {
697                 // properly centered text for those elements that are centered
698                 // (no sub-pixel offset)
699                 if ((req->width - _text_width) & 1) { ++req->width; }
700                 if ((req->height - _text_height) & 1) { ++req->height; }
701         }
702 #if 0
703                 printf("REQ: %s: %dx%d\n", get_name().c_str(), req->width, req->height);
704 #endif
705 }
706
707 /**
708  * This sets the colors used for rendering based on the name of the button, and
709  * thus uses information from the GUI config data.
710  */
711 void
712 ArdourButton::set_colors ()
713 {
714         _update_colors = false;
715
716         if (_fixed_colors_set == 0x3) {
717                 return;
718         }
719
720         std::string name = get_name();
721         bool failed = false;
722
723         if (!(_fixed_colors_set & 0x1)) {
724                 fill_active_color = UIConfigurationBase::instance().color (string_compose ("%1: fill active", name), &failed);
725                 if (failed) {
726                         fill_active_color = UIConfigurationBase::instance().color ("generic button: fill active");
727                 }
728         }
729
730         if (!(_fixed_colors_set & 0x2)) {
731                 fill_inactive_color = UIConfigurationBase::instance().color (string_compose ("%1: fill", name), &failed);
732                 if (failed) {
733                         fill_inactive_color = UIConfigurationBase::instance().color ("generic button: fill");
734                 }
735         }
736
737         text_active_color = Gtkmm2ext::contrasting_text_color (fill_active_color);
738         text_inactive_color = Gtkmm2ext::contrasting_text_color (fill_inactive_color);
739
740         led_active_color = UIConfigurationBase::instance().color (string_compose ("%1: led active", name), &failed);
741         if (failed) {
742                 led_active_color = UIConfigurationBase::instance().color ("generic button: led active");
743         }
744
745         /* The inactive color for the LED is just a fairly dark version of the
746          * active color.
747          */
748
749         Gtkmm2ext::HSV inactive (led_active_color);
750         inactive.v = 0.35;
751
752         led_inactive_color = inactive.color ();
753 }
754
755 /**
756  * This sets the colors used for rendering based on two fixed values, rather
757  * than basing them on the button name, and thus information in the GUI config
758  * data.
759  */
760 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
761 {
762         set_active_color (color_active);
763         set_inactive_color (color_inactive);
764 }
765
766 void ArdourButton::set_active_color (const uint32_t color)
767 {
768         _fixed_colors_set |= 0x1;
769
770         fill_active_color = color;
771
772         unsigned char r, g, b, a;
773         UINT_TO_RGBA(color, &r, &g, &b, &a);
774
775         double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
776                 (max (double(g), 255.) - min (double(g), 255.)) +
777                 (max (double(b), 255.) - min (double(b), 255.));
778
779         double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
780                 (max (double(g), 0.) - min (double(g), 0.)) +
781                 (max (double(b), 0.) - min (double(b), 0.));
782
783         text_active_color = (white_contrast > black_contrast) ?
784                 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
785                 RGBA_TO_UINT(  0,   0,   0,   255);  /* use black */
786
787         /* XXX what about led colors ? */
788         CairoWidget::set_dirty ();
789 }
790
791 void ArdourButton::set_inactive_color (const uint32_t color)
792 {
793         _fixed_colors_set |= 0x2;
794
795         fill_inactive_color = color;
796
797         unsigned char r, g, b, a;
798         UINT_TO_RGBA(color, &r, &g, &b, &a);
799
800         double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
801                 (max (double(g), 255.) - min (double(g), 255.)) +
802                 (max (double(b), 255.) - min (double(b), 255.));
803
804         double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
805                 (max (double(g), 0.) - min (double(g), 0.)) +
806                 (max (double(b), 0.) - min (double(b), 0.));
807
808         text_inactive_color = (white_contrast > black_contrast) ?
809                 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
810                 RGBA_TO_UINT(  0,   0,   0,   255);  /* use black */
811
812         /* XXX what about led colors ? */
813         CairoWidget::set_dirty ();
814 }
815
816 void
817 ArdourButton::build_patterns ()
818 {
819         if (convex_pattern) {
820                 cairo_pattern_destroy (convex_pattern);
821                 convex_pattern = 0;
822         }
823
824         if (concave_pattern) {
825                 cairo_pattern_destroy (concave_pattern);
826                 concave_pattern = 0;
827         }
828
829         if (led_inset_pattern) {
830                 cairo_pattern_destroy (led_inset_pattern);
831                 led_inset_pattern = 0;
832         }
833
834         //convex gradient
835         convex_pattern = cairo_pattern_create_linear (0.0, 0, 0.0,  get_height());
836         cairo_pattern_add_color_stop_rgba (convex_pattern, 0.0, 0,0,0, 0.0);
837         cairo_pattern_add_color_stop_rgba (convex_pattern, 1.0, 0,0,0, 0.35);
838
839         //concave gradient
840         concave_pattern = cairo_pattern_create_linear (0.0, 0, 0.0,  get_height());
841         cairo_pattern_add_color_stop_rgba (concave_pattern, 0.0, 0,0,0, 0.5);
842         cairo_pattern_add_color_stop_rgba (concave_pattern, 0.7, 0,0,0, 0.0);
843
844         led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
845         cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
846         cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
847
848         _pattern_height = get_height() ;
849 }
850
851 void
852 ArdourButton::set_led_left (bool yn)
853 {
854         _led_left = yn;
855 }
856
857 bool
858 ArdourButton::on_button_press_event (GdkEventButton *ev)
859 {
860         focus_handler (this);
861
862         if (ev->button == 1 && (_elements & Indicator) && _led_rect && _distinct_led_click) {
863                 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
864                     ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
865                         return true;
866                 }
867         }
868
869         if (binding_proxy.button_press_handler (ev)) {
870                 return true;
871         }
872
873         _grabbed = true;
874         CairoWidget::set_dirty ();
875
876         if (ev->button == 1 && !_act_on_release) {
877                 if (_action) {
878                         _action->activate ();
879                         return true;
880                 }
881         }
882
883         if (_fallthrough_to_parent)
884                 return false;
885
886         return true;
887 }
888
889 bool
890 ArdourButton::on_button_release_event (GdkEventButton *ev)
891 {
892         if (ev->button == 1 && _hovering && (_elements & Indicator) && _led_rect && _distinct_led_click) {
893                 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
894                     ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
895                         signal_led_clicked(ev); /* EMIT SIGNAL */
896                         return true;
897                 }
898         }
899
900         _grabbed = false;
901         CairoWidget::set_dirty ();
902
903         if (ev->button == 1 && _hovering) {
904                 signal_clicked ();
905                 if (_act_on_release) {
906                         if (_action) {
907                                 _action->activate ();
908                                 return true;
909                         }
910                 }
911         }
912
913         if (_fallthrough_to_parent)
914                 return false;
915
916         return true;
917 }
918
919 void
920 ArdourButton::set_distinct_led_click (bool yn)
921 {
922         _distinct_led_click = yn;
923         setup_led_rect ();
924 }
925
926 void
927 ArdourButton::color_handler ()
928 {
929         _update_colors = true;
930         CairoWidget::set_dirty ();
931 }
932
933 void
934 ArdourButton::on_size_allocate (Allocation& alloc)
935 {
936         CairoWidget::on_size_allocate (alloc);
937         setup_led_rect ();
938 }
939
940 void
941 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
942 {
943         watch_connection.disconnect ();
944         binding_proxy.set_controllable (c);
945 }
946
947 void
948 ArdourButton::watch ()
949 {
950         boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
951
952         if (!c) {
953                 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
954                 return;
955         }
956         c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
957 }
958
959 void
960 ArdourButton::controllable_changed ()
961 {
962         float val = binding_proxy.get_controllable()->get_value();
963
964         if (fabs (val) >= 0.5f) {
965                 set_active_state (Gtkmm2ext::ExplicitActive);
966         } else {
967                 unset_active_state ();
968         }
969         CairoWidget::set_dirty ();
970 }
971
972 void
973 ArdourButton::set_related_action (RefPtr<Action> act)
974 {
975         Gtkmm2ext::Activatable::set_related_action (act);
976
977         if (_action) {
978
979                 action_tooltip_changed ();
980                 action_sensitivity_changed ();
981
982                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
983                 if (tact) {
984                         action_toggled ();
985                         tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
986                 }
987
988                 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
989                 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
990                 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
991         }
992 }
993
994 void
995 ArdourButton::action_toggled ()
996 {
997         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
998
999         if (tact) {
1000                 if (tact->get_active()) {
1001                         set_active_state (Gtkmm2ext::ExplicitActive);
1002                 } else {
1003                         unset_active_state ();
1004                 }
1005         }
1006 }
1007
1008 void
1009 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
1010 {
1011         _update_colors = true;
1012         CairoWidget::set_dirty ();
1013         _char_pixel_width = 0;
1014         _char_pixel_height = 0;
1015         if (is_realized()) {
1016                 queue_resize ();
1017         }
1018 }
1019
1020 void
1021 ArdourButton::on_name_changed ()
1022 {
1023         _char_pixel_width = 0;
1024         _char_pixel_height = 0;
1025         _diameter = 0;
1026         _update_colors = true;
1027         if (is_realized()) {
1028                 queue_resize ();
1029         }
1030 }
1031
1032 void
1033 ArdourButton::setup_led_rect ()
1034 {
1035         if (!(_elements & Indicator)) {
1036                 delete _led_rect;
1037                 _led_rect = 0;
1038                 return;
1039         }
1040
1041         if (!_led_rect) {
1042                 _led_rect = new cairo_rectangle_t;
1043         }
1044
1045         if (_elements & Text) {
1046                 if (_led_left) {
1047                         _led_rect->x = char_pixel_width();
1048                 } else {
1049                         _led_rect->x = get_width() - char_pixel_width() + _diameter;
1050                 }
1051         } else {
1052                 /* centered */
1053                 _led_rect->x = .5 * get_width() - _diameter;
1054         }
1055
1056         _led_rect->y = .5 * (get_height() - _diameter);
1057         _led_rect->width = _diameter;
1058         _led_rect->height = _diameter;
1059 }
1060
1061 void
1062 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
1063 {
1064          _elements = (ArdourButton::Element) (_elements & ~ArdourButton::Text);
1065         _pixbuf = img;
1066         if (is_realized()) {
1067                 queue_resize ();
1068         }
1069 }
1070
1071 void
1072 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
1073 {
1074         bool changed = (_active_state != s);
1075         CairoWidget::set_active_state (s);
1076         if (changed) {
1077                 _update_colors = true;
1078                 CairoWidget::set_dirty ();
1079         }
1080 }
1081
1082 void
1083 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
1084 {
1085         bool changed = (_visual_state != s);
1086         CairoWidget::set_visual_state (s);
1087         if (changed) {
1088                 _update_colors = true;
1089                 CairoWidget::set_dirty ();
1090         }
1091 }
1092
1093 bool
1094 ArdourButton::on_focus_in_event (GdkEventFocus* ev)
1095 {
1096         _focused = true;
1097         CairoWidget::set_dirty ();
1098         return CairoWidget::on_focus_in_event (ev);
1099 }
1100
1101 bool
1102 ArdourButton::on_focus_out_event (GdkEventFocus* ev)
1103 {
1104         _focused = false;
1105         CairoWidget::set_dirty ();
1106         return CairoWidget::on_focus_out_event (ev);
1107 }
1108
1109 bool
1110 ArdourButton::on_key_release_event (GdkEventKey *ev) {
1111         if (_act_on_release && _focused &&
1112                         (ev->keyval == GDK_space || ev->keyval == GDK_Return))
1113         {
1114                 signal_clicked();
1115                 if (_action) {
1116                         _action->activate ();
1117                 }
1118                 return true;
1119         }
1120         return CairoWidget::on_key_release_event (ev);
1121 }
1122
1123 bool
1124 ArdourButton::on_key_press_event (GdkEventKey *ev) {
1125         if (!_act_on_release && _focused &&
1126                         (ev->keyval == GDK_space || ev->keyval == GDK_Return))
1127         {
1128                 signal_clicked();
1129                 if (_action) {
1130                         _action->activate ();
1131                 }
1132                 return true;
1133         }
1134         return CairoWidget::on_key_release_event (ev);
1135 }
1136
1137 bool
1138 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
1139 {
1140         _hovering = (_elements & Inactive) ? false : true;
1141
1142         if (UIConfigurationBase::instance().get_widget_prelight()) {
1143                 CairoWidget::set_dirty ();
1144         }
1145
1146         boost::shared_ptr<PBD::Controllable> c (binding_proxy.get_controllable ());
1147         if (c) {
1148                 PBD::Controllable::GUIFocusChanged (boost::weak_ptr<PBD::Controllable> (c));
1149         }
1150
1151         return CairoWidget::on_enter_notify_event (ev);
1152 }
1153
1154 bool
1155 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
1156 {
1157         _hovering = false;
1158
1159         if (UIConfigurationBase::instance().get_widget_prelight()) {
1160                 CairoWidget::set_dirty ();
1161         }
1162
1163         if (binding_proxy.get_controllable()) {
1164                 PBD::Controllable::GUIFocusChanged (boost::weak_ptr<PBD::Controllable> ());
1165         }
1166
1167         return CairoWidget::on_leave_notify_event (ev);
1168 }
1169
1170 bool
1171 ArdourButton::on_grab_broken_event(GdkEventGrabBroken* grab_broken_event) {
1172         /* Our implicit grab due to a button_press was broken by another grab:
1173          * the button will not get any button_release event if the mouse leaves
1174          * while the grab is taken, so unpress ourselves */
1175         _grabbed = false;
1176         CairoWidget::set_dirty ();
1177         return true;
1178 }
1179
1180 void
1181 ArdourButton::set_tweaks (Tweaks t)
1182 {
1183         if (_tweaks != t) {
1184                 _tweaks = t;
1185                 if (is_realized()) {
1186                         queue_resize ();
1187                 }
1188         }
1189 }
1190
1191 void
1192 ArdourButton::action_sensitivity_changed ()
1193 {
1194         if (_action->property_sensitive ()) {
1195                 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
1196         } else {
1197                 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
1198         }
1199 }
1200
1201 void
1202 ArdourButton::set_layout_ellipsize_width (int w)
1203 {
1204         if (_layout_ellipsize_width == w) {
1205                 return;
1206         }
1207         _layout_ellipsize_width = w;
1208         if (!_layout) {
1209                 return;
1210         }
1211         if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1212                 _layout->set_width (_layout_ellipsize_width - 3 * PANGO_SCALE);
1213         }
1214         if (is_realized ()) {
1215                 queue_resize ();
1216         }
1217 }
1218
1219 void
1220 ArdourButton::set_text_ellipsize (Pango::EllipsizeMode e)
1221 {
1222         if (_ellipsis == e) {
1223                 return;
1224         }
1225         _ellipsis = e;
1226         if (!_layout) {
1227                 return;
1228         }
1229         _layout->set_ellipsize(_ellipsis);
1230         if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1231                 _layout->set_width (_layout_ellipsize_width - 3 * PANGO_SCALE);
1232         }
1233         if (is_realized ()) {
1234                 queue_resize ();
1235         }
1236 }
1237
1238 void
1239 ArdourButton::ensure_layout ()
1240 {
1241         if (!_layout) {
1242                 ensure_style ();
1243                 _layout = Pango::Layout::create (get_pango_context());
1244                 _layout->set_ellipsize(_ellipsis);
1245                 if (_layout_ellipsize_width > 3 * PANGO_SCALE) {
1246                         _layout->set_width (_layout_ellipsize_width - 3* PANGO_SCALE);
1247                 }
1248         }
1249 }
1250
1251 void
1252 ArdourButton::recalc_char_pixel_geometry ()
1253 {
1254         if (_char_pixel_height > 0 && _char_pixel_width > 0) {
1255                 return;
1256         }
1257         ensure_layout();
1258         // NB. this is not static, since the geometry is different
1259         // depending on the font used.
1260         int w, h;
1261         std::string x = _("@ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
1262         _layout->set_text (x);
1263         _layout->get_pixel_size (w, h);
1264         _char_pixel_height = std::max(4, h);
1265         // number of actual chars in the string (not bytes)
1266         // Glib to the rescue.
1267         Glib::ustring gx(x);
1268         _char_avg_pixel_width = w / (float)gx.size();
1269         _char_pixel_width = std::max(4, (int) ceil (_char_avg_pixel_width));
1270         set_text_internal (); /* restore display text */
1271 }
1272
1273 void
1274 ArdourButton::action_visibility_changed ()
1275 {
1276         if (_action->property_visible ()) {
1277                 show ();
1278         } else {
1279                 hide ();
1280         }
1281 }
1282
1283 void
1284 ArdourButton::action_tooltip_changed ()
1285 {
1286         string str = _action->property_tooltip().get_value();
1287         set_tooltip (*this, str);
1288 }
1289
1290 void
1291 ArdourButton::set_elements (Element e)
1292 {
1293         _elements = e;
1294         CairoWidget::set_dirty ();
1295 }
1296
1297 void
1298 ArdourButton::add_elements (Element e)
1299 {
1300         _elements = (ArdourButton::Element) (_elements | e);
1301         CairoWidget::set_dirty ();
1302 }
1303
1304 void
1305 ArdourButton::set_icon (ArdourIcon::Icon i)
1306 {
1307         _icon = i;
1308         _icon_render_cb = 0;
1309         _icon_render_cb_data = 0;
1310         _elements = (ArdourButton::Element) ((_elements | VectorIcon) & ~(ArdourButton::Text | IconRenderCallback));
1311         CairoWidget::set_dirty ();
1312 }
1313
1314 void
1315 ArdourButton::set_icon (rendercallback_t cb, void* d)
1316 {
1317         if (!cb) {
1318                 _elements = (ArdourButton::Element) ((_elements | ArdourButton::Text) & ~(IconRenderCallback | VectorIcon));
1319                 _icon_render_cb = 0;
1320                 _icon_render_cb_data = 0;
1321         } else {
1322                 _elements = (ArdourButton::Element) ((_elements | IconRenderCallback) & ~(ArdourButton::Text | VectorIcon));
1323                 _icon_render_cb = cb;
1324                 _icon_render_cb_data = d;
1325         }
1326         CairoWidget::set_dirty ();
1327 }
1328
1329 void
1330 ArdourButton::set_custom_led_color (uint32_t c, bool useit)
1331 {
1332         if (led_custom_color == c && use_custom_led_color == useit) {
1333                 return;
1334         }
1335
1336         led_custom_color = c;
1337         use_custom_led_color = useit;
1338         CairoWidget::set_dirty ();
1339 }