gtk2_ardour/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
  26 #include "pbd/compose.h"
  27 #include "pbd/error.h"
  28 #include "pbd/stacktrace.h"
  29
  30 #include "gtkmm2ext/utils.h"
  31 #include "gtkmm2ext/rgb_macros.h"
  32 #include "gtkmm2ext/gui_thread.h"
  33
  34 #include "ardour/rc_configuration.h" // for widget prelight preference
  35
  36 #include "canvas/utils.h"
  37
  38 #include "ardour_button.h"
  39 #include "ardour_ui.h"
  40 #include "global_signals.h"
  41
  42 #include "i18n.h"
  43
  44 #define REFLECTION_HEIGHT 2
  45
  46 using namespace Gdk;
  47 using namespace Gtk;
  48 using namespace Glib;
  49 using namespace PBD;
  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         : _elements (e)
  60         , _tweaks (Tweaks (0))
  61         , _char_pixel_width (0)
  62         , _char_pixel_height (0)
  63         , _text_width (0)
  64         , _text_height (0)
  65         , _diameter (11.0)
  66         , _corner_radius (2.5)
  67         , _corner_mask (0xf)
  68         , _angle(0)
  69         , _xalign(.5)
  70         , _yalign(.5)
  71         , fill_inactive_color (0)
  72         , fill_active_color (0)
  73         , text_active_color(0)
  74         , text_inactive_color(0)
  75         , led_active_color(0)
  76         , led_inactive_color(0)
  77         , convex_pattern (0)
  78         , concave_pattern (0)
  79         , led_inset_pattern (0)
  80         , _led_rect (0)
  81         , _act_on_release (true)
  82         , _led_left (false)
  83         , _fixed_diameter (true)
  84         , _distinct_led_click (false)
  85         , _hovering (false)
  86         , _focused (false)
  87         , _fixed_colors_set (false)
  88         , _fallthrough_to_parent (false)
  89 {
  90         ARDOUR_UI_UTILS::ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
  91 }
  92
  93 ArdourButton::ArdourButton (const std::string& str, Element e)
  94         : _elements (e)
  95         , _tweaks (Tweaks (0))
  96         , _text_width (0)
  97         , _text_height (0)
  98         , _diameter (11.0)
  99         , _corner_radius (4.0)
 100         , _corner_mask (0xf)
 101         , _angle(0)
 102         , _xalign(.5)
 103         , _yalign(.5)
 104         , fill_inactive_color (0)
 105         , fill_active_color (0)
 106         , text_active_color(0)
 107         , text_inactive_color(0)
 108         , led_active_color(0)
 109         , led_inactive_color(0)
 110         , convex_pattern (0)
 111         , concave_pattern (0)
 112         , led_inset_pattern (0)
 113         , _led_rect (0)
 114         , _act_on_release (true)
 115         , _led_left (false)
 116         , _fixed_diameter (true)
 117         , _distinct_led_click (false)
 118         , _hovering (false)
 119         , _focused (false)
 120         , _fixed_colors_set (false)
 121 {
 122         set_text (str);
 123 }
 124
 125 ArdourButton::~ArdourButton()
 126 {
 127         delete _led_rect;
 128
 129         if (convex_pattern) {
 130                 cairo_pattern_destroy (convex_pattern);
 131         }
 132
 133         if (concave_pattern) {
 134                 cairo_pattern_destroy (concave_pattern);
 135         }
 136
 137         if (led_inset_pattern) {
 138                 cairo_pattern_destroy (led_inset_pattern);
 139         }
 140
 141 }
 142
 143 void
 144 ArdourButton::set_text (const std::string& str)
 145 {
 146         _text = str;
 147
 148         if (!_layout && !_text.empty()) {
 149                 _layout = Pango::Layout::create (get_pango_context());
 150         }
 151
 152         if (_layout) {
 153                 _layout->set_text (str);
 154         }
 155
 156         queue_resize ();
 157 }
 158
 159 void
 160 ArdourButton::set_markup (const std::string& str)
 161 {
 162         _text = str;
 163
 164         if (!_layout) {
 165                 _layout = Pango::Layout::create (get_pango_context());
 166         }
 167
 168         _layout->set_markup (str);
 169         queue_resize ();
 170 }
 171
 172 void
 173 ArdourButton::set_angle (const double angle)
 174 {
 175         _angle = angle;
 176 }
 177
 178 void
 179 ArdourButton::set_alignment (const float xa, const float ya)
 180 {
 181         _xalign = xa;
 182         _yalign = ya;
 183 }
 184
 185 void
 186 ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 187 {
 188         uint32_t text_color;
 189         uint32_t led_color;
 190         if ( active_state() == Gtkmm2ext::ExplicitActive ) {
 191                 text_color = text_active_color;
 192                 led_color = led_active_color;
 193         } else {
 194                 text_color = text_inactive_color;
 195                 led_color = led_inactive_color;
 196         }
 197
 198         void (*rounded_function)(cairo_t*, double, double, double, double, double);
 199
 200         switch (_corner_mask) {
 201         case 0x1: /* upper left only */
 202                 rounded_function = Gtkmm2ext::rounded_top_left_rectangle;
 203                 break;
 204         case 0x2: /* upper right only */
 205                 rounded_function = Gtkmm2ext::rounded_top_right_rectangle;
 206                 break;
 207         case 0x3: /* upper only */
 208                 rounded_function = Gtkmm2ext::rounded_top_rectangle;
 209                 break;
 210                 /* should really have functions for lower right, lower left,
 211                    lower only, but for now, we don't
 212                 */
 213         default:
 214                 rounded_function = Gtkmm2ext::rounded_rectangle;
 215         }
 216
 217         if (!_fixed_diameter) {
 218                 _diameter = std::min (get_width(), get_height());
 219         }
 220
 221         // draw edge (filling a rect underneath, rather than stroking a border on top, allows the corners to be lighter-weight.
 222         if ((_elements & (Body|Edge)) == (Body|Edge)) {
 223                 rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
 224                 cairo_set_source_rgba (cr, 0, 0, 0, 1);
 225                 cairo_fill(cr);
 226         }
 227
 228         // background fill
 229         if ((_elements & Body)==Body) {
 230                 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
 231                 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
 232                         ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
 233                         cairo_fill (cr);
 234                 } else if ( (active_state() == Gtkmm2ext::ExplicitActive) && !((_elements & Indicator)==Indicator) ) {
 235                         //background color
 236                         ArdourCanvas::set_source_rgba (cr, fill_active_color);
 237                         cairo_fill (cr);
 238                 } else {  //inactive, or it has an indicator
 239                         //background color
 240                         ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
 241                 }
 242                 cairo_fill (cr);
 243         }
 244
 245         // IMPLICIT ACTIVE: draw a border of the active color
 246         if ((_elements & Body)==Body) {
 247                 if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
 248                         cairo_set_line_width (cr, 2.0);
 249                         rounded_function (cr, 2, 2, get_width() - 4, get_height() - 4, _corner_radius);
 250                         ArdourCanvas::set_source_rgba (cr, fill_active_color);
 251                         cairo_stroke (cr);
 252                 }
 253         }
 254
 255         //show the "convex" or "concave" gradient
 256         if (!_flat_buttons) {
 257                 if ( active_state() == Gtkmm2ext::ExplicitActive && !((_elements & Indicator)==Indicator) ) {
 258                         //concave
 259                         cairo_set_source (cr, concave_pattern);
 260                         Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
 261                         cairo_fill (cr);
 262                 } else {
 263                         cairo_set_source (cr, convex_pattern);
 264                         Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
 265                         cairo_fill (cr);
 266                 }
 267         }
 268
 269         //Pixbuf, if any
 270         if (_pixbuf) {
 271
 272                 double x,y;
 273                 x = (get_width() - _pixbuf->get_width())/2.0;
 274                 y = (get_height() - _pixbuf->get_height())/2.0;
 275
 276                 //if this is a DropDown with an icon, then we need to
 277                   //move the icon left slightly to accomomodate the arrow
 278                 if (((_elements & Menu)==Menu)) {
 279                         cairo_save (cr);
 280                         cairo_translate (cr, -8,0 );
 281                 }
 282
 283                 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
 284                 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
 285                 cairo_fill (cr);
 286
 287                 //..and then return to our previous drawing position
 288                 if (((_elements & Menu)==Menu)) {
 289                         cairo_restore (cr);
 290                 }
 291         }
 292         else // rec-en is exclusive to pixbuf (tape machine mode, rec-en)
 293         if ((_elements & (RecButton|RecTapeMode)) == (RecButton|RecTapeMode)) {
 294                 const double h = get_height();
 295                 const double x = get_width() * .5;
 296                 const double y = get_height() * .5;
 297                 const double slit = .11 * M_PI;
 298                 cairo_save(cr);
 299                 cairo_translate(cr, x, y);
 300
 301                 cairo_arc (cr, 0, 0, y *.6, 0, 2 * M_PI);
 302                 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
 303                 cairo_fill_preserve(cr);
 304                 cairo_set_source_rgba (cr, .0, .0, .0, .5);
 305                 cairo_set_line_width(cr, 1);
 306                 cairo_stroke(cr);
 307
 308                 cairo_save(cr);
 309                 cairo_set_source_rgba (cr, .15, .07, .07, 1.0);
 310
 311                 cairo_rotate (cr, -.5 * M_PI);
 312                 cairo_move_to(cr, 0, 0);
 313                 cairo_arc (cr, 0, 0, h *.25, -slit, slit);
 314                 cairo_line_to(cr, 0, 0);
 315                 cairo_close_path(cr);
 316
 317                 cairo_fill(cr);
 318                 cairo_rotate (cr, 2. * M_PI / 3.);
 319
 320                 cairo_move_to(cr, 0, 0);
 321                 cairo_arc (cr, 0, 0, h *.25, -slit, slit);
 322                 cairo_line_to(cr, 0, 0);
 323                 cairo_close_path(cr);
 324                 cairo_fill(cr);
 325
 326                 cairo_rotate (cr, 2. * M_PI / 3.);
 327                 cairo_move_to(cr, 0, 0);
 328                 cairo_arc (cr, 0, 0, h *.25, -slit, slit);
 329                 cairo_line_to(cr, 0, 0);
 330                 cairo_close_path(cr);
 331                 cairo_fill(cr);
 332
 333                 cairo_restore(cr);
 334
 335                 cairo_arc (cr, 0, 0, h * .09, 0, 2 * M_PI);
 336                 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
 337                 cairo_fill(cr);
 338                 cairo_set_source_rgba (cr, .0, .0, .0, 1.0);
 339                 cairo_arc (cr, 0, 0, h *.05, 0, 2 * M_PI); // hole in the middle
 340                 cairo_fill(cr);
 341
 342                 cairo_restore(cr);
 343         }
 344         else if (_elements & RecButton) {
 345                 const double x = get_width() * .5;
 346                 const double y = get_height() * .5;
 347                 cairo_arc (cr, x, y, y *.55, 0, 2 * M_PI);
 348                 cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
 349                 cairo_fill_preserve(cr);
 350                 cairo_set_source_rgba (cr, .0, .0, .0, .5);
 351                 cairo_set_line_width(cr, 1);
 352                 cairo_stroke(cr);
 353         }
 354
 355         int text_margin;
 356         if (get_width() < 75 || (_elements & Menu) ) {
 357                 text_margin = 5;
 358         } else {
 359                 text_margin = 10;
 360         }
 361
 362         // Text, if any
 363         if ( !_pixbuf && ((_elements & Text)==Text) && !_text.empty()) {
 364
 365                 cairo_save (cr);
 366                 cairo_rectangle (cr, 2, 1, get_width()-4, get_height()-2);
 367                 cairo_clip(cr);
 368
 369                 cairo_new_path (cr);
 370                 ArdourCanvas::set_source_rgba (cr, text_color);
 371
 372                 if ( (_elements & Menu) == Menu) {
 373                         cairo_move_to (cr, rint(text_margin), rint((get_height() - _text_height)/2.0));
 374                         pango_cairo_show_layout (cr, _layout->gobj());
 375                 } else if ( (_elements & Indicator)  == Indicator) {
 376                         if (_led_left) {
 377                                 cairo_move_to (cr, rint(text_margin + _diameter + 4), rint((get_height() - _text_height)/2.0));
 378                         } else {
 379                                 cairo_move_to (cr, rint(text_margin), rint((get_height() - _text_height)/2.0));
 380                         }
 381                         pango_cairo_show_layout (cr, _layout->gobj());
 382                 } else {
 383                         /* align text */
 384
 385                         double ww, wh;
 386                         double xa, ya;
 387                         ww = get_width();
 388                         wh = get_height();
 389                         cairo_save (cr); // TODO retain rotataion.. adj. LED,...
 390                         cairo_rotate(cr, _angle * M_PI / 180.0);
 391                         cairo_device_to_user(cr, &ww, &wh);
 392                         xa = (ww - _text_width) * _xalign;
 393                         ya = (wh - _text_height) * _yalign;
 394
 395                         /* quick hack for left/bottom alignment at -90deg
 396                          * TODO this should be generalized incl rotation.
 397                          * currently only 'user' of this API is meter_strip.cc
 398                          */
 399                         if (_xalign < 0) xa = (ww * fabs(_xalign) + text_margin);
 400
 401                         // TODO honor left/right text_margin with min/max()
 402
 403                         cairo_move_to (cr, rint(.5 + xa), rint(ya));
 404                         pango_cairo_update_layout(cr, _layout->gobj());
 405                         pango_cairo_show_layout (cr, _layout->gobj());
 406                         cairo_restore (cr);
 407                 }
 408                 cairo_restore (cr);
 409         }
 410
 411         //Menu "triangle"
 412         if (((_elements & Menu)==Menu)) {
 413                 const float trih = ceil(_diameter/2.0);
 414                 const float triw2 = ceil(.577 * _diameter/2.0); // 1/sqrt(3) Equilateral triangle
 415                 //menu arrow
 416                 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
 417                 cairo_move_to(cr, get_width() - triw2 - 3. , rint((get_height() + trih) / 2.0));
 418                 cairo_rel_line_to(cr, -triw2, -trih);
 419                 cairo_rel_line_to(cr, 2. * triw2, 0);
 420                 cairo_close_path(cr);
 421
 422                 cairo_set_source_rgba (cr, 1, 1, 1, 0.4);
 423                 cairo_fill(cr);
 424
 425                 cairo_move_to(cr, get_width() - triw2 - 3 , rint((get_height() + trih) / 2.0));
 426                 cairo_rel_line_to(cr, .5 - triw2, .5 - trih);
 427                 cairo_rel_line_to(cr, 2. * triw2 - 1, 0);
 428                 cairo_close_path(cr);
 429                 cairo_set_source_rgba (cr, 0, 0, 0, 0.8);
 430                 cairo_set_line_width(cr, 1);
 431                 cairo_stroke(cr);
 432         }
 433
 434         //Indicator LED
 435         if (((_elements & Indicator)==Indicator)) {
 436
 437                 /* move to the center of the indicator/led */
 438
 439                 cairo_save (cr);
 440
 441                 if (_elements & Text) {
 442                         if (_led_left) {
 443                                 cairo_translate (cr, text_margin + (_diameter/2.0), get_height()/2.0);
 444                         } else {
 445                                 cairo_translate (cr, get_width() - ((_diameter/2.0) + 4.0), get_height()/2.0);
 446                         }
 447                 } else {
 448                         cairo_translate (cr, get_width()/2.0, get_height()/2.0);
 449                 }
 450
 451                 //inset
 452                 if (!_flat_buttons) {
 453                         cairo_arc (cr, 0, 0, _diameter/2, 0, 2 * M_PI);
 454                         cairo_set_source (cr, led_inset_pattern);
 455                         cairo_fill (cr);
 456                 }
 457
 458                 //black ring
 459                 cairo_set_source_rgb (cr, 0, 0, 0);
 460                 cairo_arc (cr, 0, 0, _diameter/2-1, 0, 2 * M_PI);
 461                 cairo_fill(cr);
 462
 463                 //led color
 464                 ArdourCanvas::set_source_rgba (cr, led_color);
 465                 cairo_arc (cr, 0, 0, _diameter/2-3, 0, 2 * M_PI);
 466                 cairo_fill(cr);
 467
 468                 cairo_restore (cr);
 469         }
 470
 471
 472         // a transparent gray layer to indicate insensitivity
 473         if ((visual_state() & Gtkmm2ext::Insensitive)) {
 474                 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
 475                 cairo_set_source_rgba (cr, 0.505, 0.517, 0.525, 0.6);
 476                 cairo_fill (cr);
 477         }
 478
 479         // if requested, show hovering
 480         if (ARDOUR::Config->get_widget_prelight()
 481                         && !((visual_state() & Gtkmm2ext::Insensitive))) {
 482                 if (_hovering) {
 483                         rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
 484                         cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
 485                         cairo_fill (cr);
 486                 }
 487         }
 488
 489         //user is currently pressing the button.  black outline helps to indicate this
 490         if ( _grabbed && !(_elements & (Inactive|Menu))) {
 491                 rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
 492                 cairo_set_line_width(cr, 2);
 493                 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5); // XXX no longer 'black'
 494                 cairo_stroke (cr);
 495         }
 496
 497         //some buttons (like processor boxes) can be selected  (so they can be deleted).  Draw a selection indicator
 498         if (visual_state() & Gtkmm2ext::Selected) {
 499 #if 0 // outline, edge + 1px outside
 500                 cairo_set_line_width(cr, 2);
 501                 cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
 502 #else // replace edge (if any)
 503                 cairo_set_line_width(cr, 1);
 504                 cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
 505 #endif
 506                 rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, _corner_radius);
 507                 cairo_stroke (cr);
 508         }
 509
 510         //I guess this means we have keyboard focus.  I don't think this works currently
 511         //
 512         //A: yes, it's keyboard focus and it does work when there's no editor window
 513         //   (the editor is always the first receiver for KeyDown).
 514         //   It's needed for eg. the engine-dialog at startup or after closing a sesion.
 515         if (_focused) {
 516                 rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, _corner_radius);
 517                 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.8);
 518                 double dashes = 1;
 519                 cairo_set_dash (cr, &dashes, 1, 0);
 520                 cairo_set_line_cap (cr, CAIRO_LINE_CAP_BUTT);
 521                 cairo_set_line_width (cr, 1.0);
 522                 cairo_stroke (cr);
 523                 cairo_set_dash (cr, 0, 0, 0);
 524         }
 525 }
 526
 527 void
 528 ArdourButton::set_diameter (float d)
 529 {
 530         _diameter = (d*2) + 5.0;
 531
 532         if (_diameter != 0.0) {
 533                 _fixed_diameter = true;
 534         }
 535
 536         build_patterns ();
 537         queue_resize ();
 538 }
 539
 540 void
 541 ArdourButton::set_corner_radius (float r)
 542 {
 543         _corner_radius = r;
 544         set_dirty ();
 545 }
 546
 547 void
 548 ArdourButton::on_size_request (Gtk::Requisition* req)
 549 {
 550         int xpad = 0;
 551         int ypad = 6;
 552
 553         CairoWidget::on_size_request (req);
 554
 555         if ((_elements & Text) && !_text.empty()) {
 556
 557                 //calc our real width for our string (but ignore the height, because that results in inconsistent button heights)
 558                 int ignored;
 559                 _layout->get_pixel_size (_text_width, ignored);
 560                 _text_height = char_pixel_height ();
 561
 562                 if (_text_width + _diameter < 75) {
 563                         xpad = 7;
 564                 } else {
 565                         xpad = 12;
 566                 }
 567         } else {
 568                 _text_width = 0;
 569                 _text_height = 0;
 570         }
 571
 572         if (_pixbuf) {
 573                 xpad = 6;
 574         }
 575
 576         if ((_elements & Indicator) && _fixed_diameter) {
 577                 if (_pixbuf) {
 578                         req->width = _pixbuf->get_width() + lrint (_diameter) + xpad;
 579                         req->height = max (_pixbuf->get_height(), (int) lrint (_diameter)) + ypad;
 580                 } else {
 581                         req->width = _text_width + lrint (_diameter) + xpad * 2; // margin left+right * 2
 582                         req->height = max (_text_height, (int) lrint (_diameter)) + ypad;
 583                 }
 584         } else {
 585                 if (_pixbuf) {
 586                         req->width = _pixbuf->get_width() + xpad;
 587                         req->height = _pixbuf->get_height() + ypad;
 588                 }  else {
 589                         req->width = _text_width + xpad;
 590                         req->height = _text_height + ypad;
 591                 }
 592         }
 593
 594         if ((_elements & Menu)) {
 595                 req->width += _diameter + 4;
 596         }
 597
 598         if ((_elements & RecButton) && !_pixbuf) {
 599                 assert(!(_elements & Text));
 600                 req->width += char_pixel_height();
 601                 req->height += char_pixel_height();
 602         }
 603
 604         req->width += _corner_radius;
 605 }
 606
 607 /**
 608  * This sets the colors used for rendering based on the name of the button, and
 609  * thus uses information from the GUI config data.
 610  */
 611 void
 612 ArdourButton::set_colors ()
 613 {
 614         if (_fixed_colors_set) {
 615                 return;
 616         }
 617         std::string name = get_name();
 618
 619         fill_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill active", name));
 620         fill_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill", name));
 621
 622         text_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text active", name));
 623         text_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text", name));
 624
 625         led_active_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led active", name));
 626         led_inactive_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led", name));
 627 }
 628 /**
 629  * This sets the colors used for rendering based on two fixed values, rather
 630  * than basing them on the button name, and thus information in the GUI config
 631  * data.
 632  */
 633 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
 634 {
 635         _fixed_colors_set = true;
 636
 637         fill_active_color = color_active;
 638         fill_inactive_color = color_inactive;
 639
 640         unsigned char r, g, b, a;
 641         UINT_TO_RGBA(color_active, &r, &g, &b, &a);
 642
 643         double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
 644                 (max (double(g), 255.) - min (double(g), 255.)) +
 645                 (max (double(b), 255.) - min (double(b), 255.));
 646
 647         double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
 648                 (max (double(g), 0.) - min (double(g), 0.)) +
 649                 (max (double(b), 0.) - min (double(b), 0.));
 650
 651         text_active_color = (white_contrast > black_contrast) ?
 652                 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
 653                 RGBA_TO_UINT(  0,   0,   0,   255);  /* use black */
 654
 655
 656         UINT_TO_RGBA(color_inactive, &r, &g, &b, &a);
 657
 658         white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
 659                 (max (double(g), 255.) - min (double(g), 255.)) +
 660                 (max (double(b), 255.) - min (double(b), 255.));
 661
 662         black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
 663                 (max (double(g), 0.) - min (double(g), 0.)) +
 664                 (max (double(b), 0.) - min (double(b), 0.));
 665
 666         text_inactive_color = (white_contrast > black_contrast) ?
 667                 RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
 668                 RGBA_TO_UINT(  0,   0,   0,   255);  /* use black */
 669
 670         /* XXX what about led colors ? */
 671
 672         build_patterns ();
 673         set_name (""); /* this will trigger a "style-changed" message and then set_colors() */
 674 }
 675
 676 void
 677 ArdourButton::build_patterns ()
 678 {
 679         if (convex_pattern) {
 680                 cairo_pattern_destroy (convex_pattern);
 681                 convex_pattern = 0;
 682         }
 683
 684         if (concave_pattern) {
 685                 cairo_pattern_destroy (concave_pattern);
 686                 concave_pattern = 0;
 687         }
 688
 689         if (led_inset_pattern) {
 690                 cairo_pattern_destroy (led_inset_pattern);
 691         }
 692
 693         //convex gradient
 694         convex_pattern = cairo_pattern_create_linear (0.0, 0, 0.0,  get_height());
 695         cairo_pattern_add_color_stop_rgba (convex_pattern, 0.0, 0,0,0, 0.0);
 696         cairo_pattern_add_color_stop_rgba (convex_pattern, 1.0, 0,0,0, 0.35);
 697
 698         //concave gradient
 699         concave_pattern = cairo_pattern_create_linear (0.0, 0, 0.0,  get_height());
 700         cairo_pattern_add_color_stop_rgba (concave_pattern, 0.0, 0,0,0, 0.5);
 701         cairo_pattern_add_color_stop_rgba (concave_pattern, 0.7, 0,0,0, 0.0);
 702
 703         if (_elements & Indicator) {
 704                 led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
 705                 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
 706                 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
 707         }
 708
 709         set_dirty ();
 710 }
 711
 712 void
 713 ArdourButton::set_led_left (bool yn)
 714 {
 715         _led_left = yn;
 716 }
 717
 718 bool
 719 ArdourButton::on_button_press_event (GdkEventButton *ev)
 720 {
 721         if ((_elements & Indicator) && _led_rect && _distinct_led_click) {
 722                 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
 723                     ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
 724                         return true;
 725                 }
 726         }
 727
 728         if (binding_proxy.button_press_handler (ev)) {
 729                 return true;
 730         }
 731
 732         _grabbed = true;
 733         queue_draw ();
 734
 735         if (!_act_on_release) {
 736                 if (_action) {
 737                         _action->activate ();
 738                         return true;
 739                 }
 740         }
 741
 742         if (_fallthrough_to_parent)
 743                 return false;
 744
 745         return true;
 746 }
 747
 748 bool
 749 ArdourButton::on_button_release_event (GdkEventButton *ev)
 750 {
 751         if (_hovering && (_elements & Indicator) && _led_rect && _distinct_led_click) {
 752                 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width &&
 753                     ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
 754                         signal_led_clicked(); /* EMIT SIGNAL */
 755                         return true;
 756                 }
 757         }
 758
 759         _grabbed = false;
 760         queue_draw ();
 761
 762         if (_hovering) {
 763                 signal_clicked ();
 764                 if (_act_on_release) {
 765                         if (_action) {
 766                                 _action->activate ();
 767                                 return true;
 768                         }
 769                 }
 770         }
 771
 772         if (_fallthrough_to_parent)
 773                 return false;
 774
 775         return true;
 776 }
 777
 778 void
 779 ArdourButton::set_distinct_led_click (bool yn)
 780 {
 781         _distinct_led_click = yn;
 782         setup_led_rect ();
 783 }
 784
 785 void
 786 ArdourButton::color_handler ()
 787 {
 788         set_colors ();
 789         build_patterns ();
 790         set_dirty ();
 791 }
 792
 793 void
 794 ArdourButton::on_size_allocate (Allocation& alloc)
 795 {
 796         CairoWidget::on_size_allocate (alloc);
 797         setup_led_rect ();
 798         build_patterns ();
 799 }
 800
 801 void
 802 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
 803 {
 804         watch_connection.disconnect ();
 805         binding_proxy.set_controllable (c);
 806 }
 807
 808 void
 809 ArdourButton::watch ()
 810 {
 811         boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
 812
 813         if (!c) {
 814                 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
 815                 return;
 816         }
 817
 818         c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
 819 }
 820
 821 void
 822 ArdourButton::controllable_changed ()
 823 {
 824         float val = binding_proxy.get_controllable()->get_value();
 825
 826         if (fabs (val) >= 0.5f) {
 827                 set_active_state (Gtkmm2ext::ExplicitActive);
 828         } else {
 829                 unset_active_state ();
 830         }
 831 }
 832
 833 void
 834 ArdourButton::set_related_action (RefPtr<Action> act)
 835 {
 836         Gtkmm2ext::Activatable::set_related_action (act);
 837
 838         if (_action) {
 839
 840                 action_tooltip_changed ();
 841
 842                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
 843                 if (tact) {
 844                         action_toggled ();
 845                         tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
 846                 }
 847
 848                 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
 849                 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
 850                 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
 851         }
 852 }
 853
 854 void
 855 ArdourButton::action_toggled ()
 856 {
 857         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
 858
 859         if (tact) {
 860                 if (tact->get_active()) {
 861                         set_active_state (Gtkmm2ext::ExplicitActive);
 862                 } else {
 863                         unset_active_state ();
 864                 }
 865         }
 866 }
 867
 868 void
 869 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
 870 {
 871         on_name_changed();
 872 }
 873
 874 void
 875 ArdourButton::on_name_changed ()
 876 {
 877         _char_pixel_width = 0;
 878         _char_pixel_height = 0;
 879         set_colors ();
 880         build_patterns ();
 881 }
 882
 883 void
 884 ArdourButton::setup_led_rect ()
 885 {
 886         int text_margin;
 887
 888         if (get_width() < 75) {
 889                 text_margin = 3;
 890         } else {
 891                 text_margin = 10;
 892         }
 893
 894         if (_elements & Indicator) {
 895                 _led_rect = new cairo_rectangle_t;
 896
 897                 if (_elements & Text) {
 898                         if (_led_left) {
 899                                 _led_rect->x = text_margin;
 900                         } else {
 901                                 _led_rect->x = get_width() - text_margin - _diameter/2.0;
 902                         }
 903                 } else {
 904                         /* centered */
 905                         _led_rect->x = get_width()/2.0 - _diameter/2.0;
 906                 }
 907
 908                 _led_rect->y = get_height()/2.0 - _diameter/2.0;
 909                 _led_rect->width = _diameter;
 910                 _led_rect->height = _diameter;
 911
 912         } else {
 913                 delete _led_rect;
 914                 _led_rect = 0;
 915         }
 916 }
 917
 918 void
 919 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
 920 {
 921         _pixbuf = img;
 922         queue_draw ();
 923 }
 924
 925 void
 926 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
 927 {
 928         bool changed = (_active_state != s);
 929         CairoWidget::set_active_state (s);
 930         if (changed) {
 931                 set_colors ();
 932                 build_patterns ();
 933         }
 934 }
 935
 936 void
 937 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
 938 {
 939         bool changed = (_visual_state != s);
 940         CairoWidget::set_visual_state (s);
 941         if (changed) {
 942                 set_colors ();
 943                 build_patterns ();
 944         }
 945 }
 946
 947
 948 bool
 949 ArdourButton::on_focus_in_event (GdkEventFocus* ev)
 950 {
 951         _focused = true;
 952         queue_draw ();
 953         return CairoWidget::on_focus_in_event (ev);
 954 }
 955
 956 bool
 957 ArdourButton::on_focus_out_event (GdkEventFocus* ev)
 958 {
 959         _focused = false;
 960         queue_draw ();
 961         return CairoWidget::on_focus_out_event (ev);
 962 }
 963
 964 bool
 965 ArdourButton::on_key_release_event (GdkEventKey *ev) {
 966         if (_focused &&
 967                         (ev->keyval == GDK_KEY_space || ev->keyval == GDK_Return))
 968         {
 969                 signal_clicked();
 970                 if (_action) {
 971                         _action->activate ();
 972                 }
 973                 return true;
 974         }
 975         return CairoWidget::on_key_release_event (ev);
 976 }
 977
 978 bool
 979 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
 980 {
 981         _hovering = (_elements & Inactive) ? false : true;
 982
 983         if (ARDOUR::Config->get_widget_prelight()) {
 984                 queue_draw ();
 985         }
 986
 987         return CairoWidget::on_enter_notify_event (ev);
 988 }
 989
 990 bool
 991 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
 992 {
 993         _hovering = false;
 994
 995         if (ARDOUR::Config->get_widget_prelight()) {
 996                 queue_draw ();
 997         }
 998
 999         return CairoWidget::on_leave_notify_event (ev);
1000 }
1001
1002 void
1003 ArdourButton::set_tweaks (Tweaks t)
1004 {
1005         if (_tweaks != t) {
1006                 _tweaks = t;
1007                 queue_draw ();
1008         }
1009 }
1010
1011 void
1012 ArdourButton::action_sensitivity_changed ()
1013 {
1014         if (_action->property_sensitive ()) {
1015                 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
1016         } else {
1017                 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
1018         }
1019
1020 }
1021
1022 void
1023 ArdourButton::recalc_char_pixel_geometry ()
1024 {
1025         if (_char_pixel_height > 0 && _char_pixel_width > 0) {
1026                 return;
1027         }
1028         if (!_layout) {
1029                 _layout = Pango::Layout::create (get_pango_context());
1030         }
1031         // NB. this is not static, since the geometry is different
1032         // depending on the font used.
1033         int w, h;
1034         std::string t = _layout->get_text();
1035         std::string x = _("ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
1036         _layout->set_text (x);
1037         _layout->get_pixel_size (w, h);
1038         _layout->set_text (t);
1039         _char_pixel_height = std::max(4, h);
1040         // number of actual chars in the string (not bytes)
1041         // Glib to the rescue.
1042         Glib::ustring gx(x);
1043         _char_pixel_width = std::max(4, w / (int)gx.size());
1044 }
1045
1046 void
1047 ArdourButton::action_visibility_changed ()
1048 {
1049         if (_action->property_visible ()) {
1050                 show ();
1051         } else {
1052                 hide ();
1053         }
1054 }
1055
1056 void
1057 ArdourButton::action_tooltip_changed ()
1058 {
1059         string str = _action->property_tooltip().get_value();
1060         ARDOUR_UI::instance()->set_tip (*this, str);
1061 }
1062
1063 void
1064 ArdourButton::set_elements (Element e)
1065 {
1066         _elements = e;
1067 }
1068
1069 void
1070 ArdourButton::add_elements (Element e)
1071 {
1072         _elements = (ArdourButton::Element) (_elements | e);
1073 }