722f2f49adfb80719b4232847f64abc56c9726c6
[ardour.git] / 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
29 #include "gtkmm2ext/utils.h"
30 #include "gtkmm2ext/rgb_macros.h"
31 #include "gtkmm2ext/gui_thread.h"
32
33 #include "ardour/rc_configuration.h" // for widget prelight preference
34
35 #include "ardour_button.h"
36 #include "ardour_ui.h"
37 #include "global_signals.h"
38
39 #include "i18n.h"
40
41 using namespace Gdk;
42 using namespace Gtk;
43 using namespace Glib;
44 using namespace PBD;
45 using std::max;
46 using std::min;
47 using namespace std;
48
49 ArdourButton::Element ArdourButton::default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text);
50 ArdourButton::Element ArdourButton::led_default_elements = ArdourButton::Element (ArdourButton::default_elements|ArdourButton::Indicator);
51 ArdourButton::Element ArdourButton::just_led_default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Indicator);
52
53 ArdourButton::ArdourButton (Element e)
54         : _elements (e)
55         , _tweaks (Tweaks (0))
56         , _act_on_release (true)
57         , _text_width (0)
58         , _text_height (0)
59         , _diameter (11.0)
60         , _corner_radius (9.0)
61         , edge_pattern (0)
62         , fill_pattern (0)
63         , led_inset_pattern (0)
64         , reflection_pattern (0)
65         , _led_left (false)
66         , _fixed_diameter (true)
67         , _distinct_led_click (false)
68         , _led_rect (0)
69         , _hovering (false)
70 {
71         ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
72 }
73
74 ArdourButton::ArdourButton (const std::string& str, Element e)
75         : _elements (e)
76         , _act_on_release (true)
77         , _text_width (0)
78         , _text_height (0)
79         , _diameter (11.0)
80         , _corner_radius (9.0)
81         , edge_pattern (0)
82         , fill_pattern (0)
83         , led_inset_pattern (0)
84         , reflection_pattern (0)
85         , _led_left (false)
86         , _fixed_diameter (true)
87         , _distinct_led_click (false)
88         , _led_rect (0)
89         , _hovering (false)
90 {
91         set_text (str);
92 }
93
94 ArdourButton::~ArdourButton()
95 {
96         delete _led_rect;
97 }
98
99 void
100 ArdourButton::set_text (const std::string& str)
101 {
102         _text = str;
103
104         if (!_layout && !_text.empty()) {
105                 _layout = Pango::Layout::create (get_pango_context());
106         } 
107
108         if (_layout) {
109                 _layout->set_text (str);
110         }
111
112         queue_resize ();
113 }
114
115 void
116 ArdourButton::set_markup (const std::string& str)
117 {
118         _text = str;
119
120         if (!_layout) {
121                 _layout = Pango::Layout::create (get_pango_context());
122         } 
123
124         _layout->set_text (str);
125         queue_resize ();
126 }
127
128 void
129 ArdourButton::render (cairo_t* cr)
130 {
131         if (!_fixed_diameter) {
132                 _diameter = std::min (_width, _height);
133         }
134
135         /* background fill. use parent window style, so that we fit in nicely.
136          */
137         
138         Color c = get_parent_bg ();
139
140         cairo_rectangle (cr, 0, 0, _width, _height);
141         cairo_stroke_preserve (cr);
142         cairo_set_source_rgb (cr, c.get_red_p(), c.get_green_p(), c.get_blue_p());
143         cairo_fill (cr);
144
145         if (_elements & Edge) {
146                 Gtkmm2ext::rounded_rectangle (cr, 0, 0, _width, _height, _corner_radius);
147                 cairo_set_source (cr, edge_pattern);
148                 cairo_fill (cr);
149         }
150
151         if (_elements & Body) {
152                 if (_elements & Edge) {
153                         Gtkmm2ext::rounded_rectangle (cr, 1, 1, _width-2, _height-2, _corner_radius - 1.0);
154                 } else {
155                         Gtkmm2ext::rounded_rectangle (cr, 0, 0, _width, _height, _corner_radius - 1.0);
156                 }
157                 cairo_set_source (cr, fill_pattern);
158                 cairo_fill (cr);
159         }
160
161         if (_pixbuf) {
162
163                 double x,y;
164                 x = (_width - _pixbuf->get_width())/2.0;
165                 y = (_height - _pixbuf->get_height())/2.0;
166
167                 cairo_rectangle (cr, x, y, _pixbuf->get_width(), _pixbuf->get_height());
168                 gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
169                 cairo_fill (cr);
170         }
171
172         /* text, if any */
173
174         int text_margin;
175
176         if (_width < 75) {
177                 text_margin = 3;
178         } else {
179                 text_margin = 10;
180         }
181
182         if ((_elements & Text) && !_text.empty()) {
183
184                 cairo_set_source_rgba (cr, text_r, text_g, text_b, text_a);
185
186                 if (_elements & Indicator) {
187                         if (_led_left) {
188                                 cairo_move_to (cr, text_margin + _diameter + 4, _height/2.0 - _text_height/2.0);
189                         } else {
190                                 cairo_move_to (cr, text_margin, _height/2.0 - _text_height/2.0);
191                         }
192                 } else {
193                         /* center text */
194                         cairo_move_to (cr, (_width - _text_width)/2.0, _height/2.0 - _text_height/2.0);
195                 }
196
197                 pango_cairo_show_layout (cr, _layout->gobj());
198         } 
199
200         if (_elements & Indicator) {
201
202                 /* move to the center of the indicator/led */
203
204                 cairo_save (cr);
205
206                 if (_elements & Text) {
207                         if (_led_left) {
208                                 cairo_translate (cr, text_margin + (_diameter/2.0), _height/2.0);
209                         } else {
210                                 cairo_translate (cr, _width - ((_diameter/2.0) + 4.0), _height/2.0);
211                         }
212                 } else {
213                         cairo_translate (cr, _width/2.0, _height/2.0);
214                 }
215                 
216                 //inset
217                 cairo_arc (cr, 0, 0, _diameter/2, 0, 2 * M_PI);
218                 cairo_set_source (cr, led_inset_pattern);
219                 cairo_fill (cr);
220                 
221                 //black ring
222                 cairo_set_source_rgb (cr, 0, 0, 0);
223                 cairo_arc (cr, 0, 0, _diameter/2-2, 0, 2 * M_PI);
224                 cairo_fill(cr);
225                 
226                 //led color
227                 cairo_set_source_rgba (cr, led_r, led_g, led_b, led_a);
228                 cairo_arc (cr, 0, 0, _diameter/2-3, 0, 2 * M_PI);
229                 cairo_fill(cr);
230                 
231                 //reflection
232                 cairo_scale(cr, 0.7, 0.7);
233                 cairo_arc (cr, 0, 0, _diameter/2-3, 0, 2 * M_PI);
234                 cairo_set_source (cr, reflection_pattern);
235                 cairo_fill (cr);
236
237                 cairo_restore (cr);
238
239         }
240
241
242         /* a partially transparent gray layer to indicate insensitivity */
243
244         if ((visual_state() & Gtkmm2ext::Insensitive)) {
245                 Gtkmm2ext::rounded_rectangle (cr, 0, 0, _width, _height, _corner_radius);
246                 cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.5);
247                 cairo_fill (cr);
248         }
249
250         /* if requested, show hovering */
251         
252         if (ARDOUR::Config->get_widget_prelight()) {
253                 if (_hovering) {
254                         Gtkmm2ext::rounded_rectangle (cr, 0, 0, _width, _height, _corner_radius);
255                         cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
256                         cairo_fill (cr);
257                 }
258         }
259 }
260
261 void
262 ArdourButton::set_diameter (float d)
263 {
264         _diameter = (d*2) + 5.0;
265
266         if (_diameter != 0.0) {
267                 _fixed_diameter = true;
268         }
269
270         set_colors ();
271 }
272
273 void
274 ArdourButton::set_corner_radius (float r)
275 {
276         _corner_radius = r;
277         set_dirty ();
278 }
279
280 void
281 ArdourButton::on_size_request (Gtk::Requisition* req)
282 {
283         int xpad = 0;
284         int ypad = 6;
285
286         CairoWidget::on_size_request (req);
287
288         if ((_elements & Text) && !_text.empty()) {
289                 _layout->get_pixel_size (_text_width, _text_height);
290                 if (_text_width + _diameter < 75) {
291                         xpad = 7;
292                 } else {
293                         xpad = 20;
294                 }
295         } else {
296                 _text_width = 0;
297                 _text_height = 0;
298         }
299
300         if (_pixbuf) {
301                 xpad = 6;
302         }
303
304         if ((_elements & Indicator) && _fixed_diameter) {
305                 if (_pixbuf) {
306                         req->width = _pixbuf->get_width() + lrint (_diameter) + xpad;
307                         req->height = max (_pixbuf->get_height(), (int) lrint (_diameter)) + ypad;
308                 } else {
309                         req->width = _text_width + lrint (_diameter) + xpad;
310                         req->height = max (_text_height, (int) lrint (_diameter)) + ypad;
311                 }
312         } else {
313                 if (_pixbuf) {
314                         req->width = _pixbuf->get_width() + xpad;
315                         req->height = _pixbuf->get_height() + ypad;
316                 }  else {
317                         req->width = _text_width + xpad;
318                         req->height = _text_height + ypad;
319                 }
320         }
321 }
322
323 void
324 ArdourButton::set_colors ()
325 {
326         uint32_t start_color;
327         uint32_t end_color;
328         uint32_t r, g, b, a;
329         uint32_t text_color;
330         uint32_t led_color;
331
332         /* we use the edge of the button to show Selected state, so the
333          * color/pattern used there will vary depending on that
334          */
335         
336         if (edge_pattern) {
337                 cairo_pattern_destroy (edge_pattern);
338         }
339
340         if (_elements & Edge) {
341
342                 edge_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _height);
343                 if (visual_state() & Gtkmm2ext::Selected) {
344                         start_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: border start selected", get_name()));
345                         end_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: border end selected", get_name()));
346                 } else {
347                         start_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: border start", get_name()));
348                         end_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: border end", get_name()));
349                 }
350                 UINT_TO_RGBA (start_color, &r, &g, &b, &a);
351                 cairo_pattern_add_color_stop_rgba (edge_pattern, 0, r/255.0,g/255.0,b/255.0, 0.7);
352                 UINT_TO_RGBA (end_color, &r, &g, &b, &a);
353                 cairo_pattern_add_color_stop_rgba (edge_pattern, 1, r/255.0,g/255.0,b/255.0, 0.7);
354         }
355
356
357         /* the fill pattern is used to indicate Normal/Active/Mid state
358          */
359
360         if (fill_pattern) {
361                 cairo_pattern_destroy (fill_pattern);
362         }
363
364         if (_elements & Body) {
365                 fill_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _height);
366                 
367                 if (active_state() == Gtkmm2ext::Mid) {
368                         start_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill start mid", get_name()));
369                         end_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill end mid", get_name()));
370                 } else if (active_state() == Gtkmm2ext::Active) {
371                         start_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill start active", get_name()));
372                         end_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill end active", get_name()));
373                 } else {
374                         start_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill start", get_name()));
375                         end_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: fill end", get_name()));
376                 }
377                 UINT_TO_RGBA (start_color, &r, &g, &b, &a);
378                 cairo_pattern_add_color_stop_rgba (fill_pattern, 0, r/255.0,g/255.0,b/255.0, a/255.0);
379                 UINT_TO_RGBA (end_color, &r, &g, &b, &a);
380                 cairo_pattern_add_color_stop_rgba (fill_pattern, 1, r/255.0,g/255.0,b/255.0, a/255.0);
381
382                 cerr << "Button color for " << get_name() << ": " << hex << start_color << " .. " << end_color << dec << endl;
383
384         }
385
386         if (led_inset_pattern) {
387                 cairo_pattern_destroy (led_inset_pattern);
388         }
389         
390         if (reflection_pattern) {
391                 cairo_pattern_destroy (reflection_pattern);
392         }
393
394         if (_elements & Indicator) {
395                 led_inset_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter);
396                 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 0, 0,0,0, 0.4);
397                 cairo_pattern_add_color_stop_rgba (led_inset_pattern, 1, 1,1,1, 0.7);
398
399                 reflection_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, _diameter/2-3);
400                 cairo_pattern_add_color_stop_rgba (reflection_pattern, 0, 1,1,1, active_state() ? 0.4 : 0.2);
401                 cairo_pattern_add_color_stop_rgba (reflection_pattern, 1, 1,1,1, 0.0);
402         }
403         
404         /* text and LED colors depend on Active/Normal/Mid */
405
406         if (active_state() == Gtkmm2ext::Active) {
407                 text_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text active", get_name()));
408                 led_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led active", get_name()));
409         } else if (active_state() == Gtkmm2ext::Mid) {
410                 text_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text mid", get_name()));
411                 led_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led mid", get_name()));
412         } else {
413                 text_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text", get_name()));
414                 led_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: led", get_name()));
415         }
416
417         UINT_TO_RGBA (text_color, &r, &g, &b, &a);
418         text_r = r/255.0;
419         text_g = g/255.0;
420         text_b = b/255.0;
421         text_a = a/255.0;
422         UINT_TO_RGBA (led_color, &r, &g, &b, &a);
423         led_r = r/255.0;
424         led_g = g/255.0;
425         led_b = b/255.0;
426         led_a = a/255.0;
427
428         set_dirty ();
429 }
430
431 void
432 ArdourButton::set_led_left (bool yn)
433 {
434         _led_left = yn;
435 }
436
437 bool
438 ArdourButton::on_button_press_event (GdkEventButton *ev)
439 {
440         if ((_elements & Indicator) && _led_rect && _distinct_led_click) {
441                 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width && 
442                     ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
443                         return true;
444                 }
445         }
446
447         if (_tweaks & ShowClick) {
448                 set_active_state (Gtkmm2ext::Active);
449         }
450
451         if (binding_proxy.button_press_handler (ev)) {
452                 return true;
453         }
454
455         if (!_act_on_release) {
456                 if (_action) {
457                         _action->activate ();
458                         return true;
459                 }
460         }
461
462         return false;
463 }
464
465 bool
466 ArdourButton::on_button_release_event (GdkEventButton *ev)
467 {
468         if ((_elements & Indicator) && _led_rect && _distinct_led_click) {
469                 if (ev->x >= _led_rect->x && ev->x < _led_rect->x + _led_rect->width && 
470                     ev->y >= _led_rect->y && ev->y < _led_rect->y + _led_rect->height) {
471                         signal_led_clicked(); /* EMIT SIGNAL */
472                         return true;
473                 }
474         }
475
476         if (_tweaks & ShowClick) {
477                 unset_active_state ();
478         }
479
480         signal_clicked ();
481
482         if (_act_on_release) {
483                 if (_action) {
484                         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
485                         _action->activate ();
486                         return true;
487                 }
488         }
489
490
491         return false;
492 }
493
494 void
495 ArdourButton::set_distinct_led_click (bool yn)
496 {
497         _distinct_led_click = yn;
498         setup_led_rect ();
499 }
500
501 void
502 ArdourButton::color_handler ()
503 {
504         set_colors ();
505         set_dirty ();
506 }
507
508 void
509 ArdourButton::on_size_allocate (Allocation& alloc)
510 {
511         CairoWidget::on_size_allocate (alloc);
512         setup_led_rect ();
513         set_colors ();
514 }
515
516 void
517 ArdourButton::set_controllable (boost::shared_ptr<Controllable> c)
518 {
519         watch_connection.disconnect ();
520         binding_proxy.set_controllable (c);
521 }
522
523 void
524 ArdourButton::watch ()
525 {
526         boost::shared_ptr<Controllable> c (binding_proxy.get_controllable ());
527
528         if (!c) {
529                 warning << _("button cannot watch state of non-existing Controllable\n") << endmsg;
530                 return;
531         }
532
533         c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourButton::controllable_changed, this), gui_context());
534 }
535
536 void
537 ArdourButton::controllable_changed ()
538 {
539         float val = binding_proxy.get_controllable()->get_value();
540
541         if (fabs (val) >= 0.5f) {
542                 set_active_state (Gtkmm2ext::Active);
543         } else {
544                 unset_active_state ();
545         }
546 }
547
548 void
549 ArdourButton::set_related_action (RefPtr<Action> act)
550 {
551         _action = act;
552
553         if (_action) {
554
555                 string str = _action->property_tooltip().get_value();
556                 if (!str.empty()) {
557                         ARDOUR_UI::instance()->set_tip (*this, str);
558                 }
559
560                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
561                 if (tact) {
562                         tact->signal_toggled().connect (sigc::mem_fun (*this, &ArdourButton::action_toggled));
563                 } 
564
565                 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &ArdourButton::action_sensitivity_changed));
566                 _action->connect_property_changed ("visible", sigc::mem_fun (*this, &ArdourButton::action_visibility_changed));
567                 _action->connect_property_changed ("tooltip", sigc::mem_fun (*this, &ArdourButton::action_tooltip_changed));
568         }
569 }
570
571 void
572 ArdourButton::action_toggled ()
573 {
574         Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
575
576         if (tact) {
577                 if (tact->get_active()) {
578                         set_active_state (Gtkmm2ext::Active);
579                 } else {
580                         unset_active_state ();
581                 }
582         }
583 }       
584
585 void
586 ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
587 {
588         set_colors ();
589 }
590
591 void
592 ArdourButton::setup_led_rect ()
593 {
594         int text_margin;
595
596         if (_width < 75) {
597                 text_margin = 3;
598         } else {
599                 text_margin = 10;
600         }
601
602         if (_elements & Indicator) {
603                 _led_rect = new cairo_rectangle_t;
604                 
605                 if (_elements & Text) {
606                         if (_led_left) {
607                                 _led_rect->x = text_margin;
608                         } else {
609                                 _led_rect->x = _width - text_margin - _diameter/2.0;
610                         }
611                 } else {
612                         /* centered */
613                         _led_rect->x = _width/2.0 - _diameter/2.0;
614                 }
615
616                 _led_rect->y = _height/2.0 - _diameter/2.0;
617                 _led_rect->width = _diameter;
618                 _led_rect->height = _diameter;
619
620         } else {
621                 delete _led_rect;
622                 _led_rect = 0;
623         }
624 }
625
626 void
627 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
628 {
629         _pixbuf = img;
630         queue_draw ();
631 }
632
633 void
634 ArdourButton::set_active (bool yn)
635 {
636         /* this is an API simplification for buttons
637            that only use the Active and Normal states.
638         */
639
640         if (yn) {
641                 set_active_state (Gtkmm2ext::Active);
642         } else {
643                 unset_active_state ();
644         }
645 }
646
647 void
648 ArdourButton::set_active_state (Gtkmm2ext::ActiveState s)
649 {
650         bool changed = (_active_state != s);
651         CairoWidget::set_active_state (s);
652         if (changed) {
653                 set_colors ();
654         }
655 }
656         
657 void
658 ArdourButton::set_visual_state (Gtkmm2ext::VisualState s)
659 {
660         bool changed = (_visual_state != s);
661         CairoWidget::set_visual_state (s);
662         if (changed) {
663                 set_colors ();
664         }
665 }
666         
667 bool
668 ArdourButton::on_enter_notify_event (GdkEventCrossing* ev)
669 {
670         _hovering = true;
671
672         if (ARDOUR::Config->get_widget_prelight()) {
673                 queue_draw ();
674         }
675
676         return CairoWidget::on_enter_notify_event (ev);
677 }
678
679 bool
680 ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
681 {
682         _hovering = false;
683
684         if (ARDOUR::Config->get_widget_prelight()) {
685                 queue_draw ();
686         }
687
688         return CairoWidget::on_leave_notify_event (ev);
689 }
690
691 void
692 ArdourButton::set_tweaks (Tweaks t)
693 {
694         if (_tweaks != t) {
695                 _tweaks = t;
696                 queue_draw ();
697         }
698 }
699
700 void
701 ArdourButton::action_sensitivity_changed ()
702 {
703         if (_action->property_sensitive ()) {
704                 set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
705         } else {
706                 set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
707         }
708         
709 }
710
711
712 void
713 ArdourButton::action_visibility_changed ()
714 {
715         if (_action->property_visible ()) {
716                 show ();
717         } else {
718                 hide ();
719         }
720 }
721
722 void
723 ArdourButton::action_tooltip_changed ()
724 {
725         string str = _action->property_tooltip().get_value();
726         ARDOUR_UI::instance()->set_tip (*this, str);
727 }
728