ArdourButton: Pick up initial action sensitivity
[ardour.git] / gtk2_ardour / ardour_button.cc
index 305956ff5905ecdeb412054b3aa1d481ba16ceab..9aaf31ba766c80c0670eb08bf72074e33beda62f 100644 (file)
 #include "tooltips.h"
 #include "ui_config.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #define BASELINESTRETCH (1.25)
 #define TRACKHEADERBTNW (3.10)
 
-using namespace Gdk;
 using namespace Gtk;
 using namespace Glib;
 using namespace PBD;
@@ -58,8 +57,12 @@ ArdourButton::Element ArdourButton::led_default_elements = ArdourButton::Element
 ArdourButton::Element ArdourButton::just_led_default_elements = ArdourButton::Element (ArdourButton::Edge|ArdourButton::Body|ArdourButton::Indicator);
 
 ArdourButton::ArdourButton (Element e)
-       : _elements (e)
+       : _sizing_text("")
+       , _markup (false)
+       , _elements (e)
        , _icon (Gtkmm2ext::ArdourIcon::NoIcon)
+       , _icon_render_cb (0)
+       , _icon_render_cb_data (0)
        , _tweaks (Tweaks (0))
        , _char_pixel_width (0)
        , _char_pixel_height (0)
@@ -67,7 +70,7 @@ ArdourButton::ArdourButton (Element e)
        , _text_width (0)
        , _text_height (0)
        , _diameter (0)
-       , _corner_radius (2.5)
+       , _corner_radius (3.5)
        , _corner_mask (0xf)
        , _angle(0)
        , _xalign(.5)
@@ -97,10 +100,15 @@ ArdourButton::ArdourButton (Element e)
        , _pattern_height (0)
 {
        UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
+       /* This is not provided by gtkmm */
+       signal_grab_broken_event().connect (sigc::mem_fun (*this, &ArdourButton::on_grab_broken_event));
 }
 
 ArdourButton::ArdourButton (const std::string& str, Element e)
-       : _elements (e)
+       : _sizing_text("")
+       , _markup (false)
+       , _elements (e)
+       , _icon (Gtkmm2ext::ArdourIcon::NoIcon)
        , _tweaks (Tweaks (0))
        , _char_pixel_width (0)
        , _char_pixel_height (0)
@@ -108,7 +116,7 @@ ArdourButton::ArdourButton (const std::string& str, Element e)
        , _text_width (0)
        , _text_height (0)
        , _diameter (0)
-       , _corner_radius (2.5)
+       , _corner_radius (3.5)
        , _corner_mask (0xf)
        , _angle(0)
        , _xalign(.5)
@@ -140,6 +148,8 @@ ArdourButton::ArdourButton (const std::string& str, Element e)
        set_text (str);
        UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ArdourButton::color_handler));
        UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &ArdourButton::on_name_changed));
+       /* This is not provided by gtkmm */
+       signal_grab_broken_event().connect (sigc::mem_fun (*this, &ArdourButton::on_grab_broken_event));
 }
 
 ArdourButton::~ArdourButton()
@@ -166,22 +176,57 @@ ArdourButton::set_layout_font (const Pango::FontDescription& fd)
        if (_layout) {
                _layout->set_font_description (fd);
                queue_resize ();
+               _char_pixel_width = 0;
+               _char_pixel_height = 0;
+       }
+}
+
+void
+ArdourButton::set_text_internal () {
+       assert (_layout);
+       if (_markup) {
+               _layout->set_markup (_text);
+       } else {
+               _layout->set_text (_text);
        }
 }
 
 void
-ArdourButton::set_text (const std::string& str)
+ArdourButton::set_text (const std::string& str, bool markup)
 {
-       if (_text == str) {
+       if (!(_elements & Text)) {
                return;
        }
+       if (_text == str && _markup == markup) {
+               return;
+       }
+
        _text = str;
+       _markup = markup;
        if (!is_realized()) {
                return;
        }
        ensure_layout ();
        if (_layout && _layout->get_text() != _text) {
-               _layout->set_text (_text);
+               set_text_internal ();
+               /* on_size_request() will fill in _text_width/height
+                * so queue it even if _sizing_text != "" */
+               queue_resize ();
+       }
+}
+
+void
+ArdourButton::set_sizing_text (const std::string& str)
+{
+       if (_sizing_text == str) {
+               return;
+       }
+       _sizing_text = str;
+       if (!is_realized()) {
+               return;
+       }
+       ensure_layout ();
+       if (_layout) {
                queue_resize ();
        }
 }
@@ -210,8 +255,10 @@ ArdourButton::set_alignment (const float xa, const float ya)
  * ARDOUR_UI_UTILS::render_vector_icon()
  */
 void
-ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
+ArdourButton::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
 {
+       cairo_t* cr = ctx->cobj();
+
        uint32_t text_color;
        uint32_t led_color;
 
@@ -290,7 +337,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
        }
 
        //show the "convex" or "concave" gradient
-       if (!_flat_buttons) {
+       if (!_flat_buttons && (_elements & Body)==Body) {
                if ( active_state() == Gtkmm2ext::ExplicitActive && ( !((_elements & Indicator)==Indicator) || use_custom_led_color) ) {
                        //concave
                        cairo_set_source (cr, concave_pattern);
@@ -324,9 +371,22 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
                cairo_fill (cr);
        }
-       else /* VectorIcons are exclusive to Pixbuf Icons */
-       if (_elements & VectorIcon) {
-               Gtkmm2ext::ArdourIcon::render (cr, _icon, get_width(), get_height(), active_state(), text_color);
+       else /* VectorIcon, IconRenderCallback are exclusive to Pixbuf Icons */
+       if (_elements & (VectorIcon | IconRenderCallback)) {
+               int vw = get_width();
+               int vh = get_height();
+               if (_elements & Menu) {
+                       vw -= _diameter + 4;
+               }
+               if (_elements & VectorIcon) {
+                       Gtkmm2ext::ArdourIcon::render (cr, _icon, vw, vh, active_state(), text_color);
+               } else {
+                       cairo_save (cr);
+                       rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius + 1.5);
+                       cairo_clip (cr);
+                       _icon_render_cb (cr, vw, vh, text_color, _icon_render_cb_data);
+                       cairo_restore (cr);
+               }
        }
 
        const int text_margin = char_pixel_width();
@@ -379,10 +439,19 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                        ww = get_width();
                        wh = get_height();
 
-                       cairo_save (cr);
-                       cairo_rotate(cr, _angle * M_PI / 180.0);
+                       cairo_matrix_t m1;
+                       cairo_get_matrix (cr, &m1);
+                       cairo_matrix_t m2 = m1;
+                       m2.x0 = 0;
+                       m2.y0 = 0;
+                       cairo_set_matrix (cr, &m2);
+
+                       if (_angle) {
+                               cairo_rotate(cr, _angle * M_PI / 180.0);
+                       }
+
                        cairo_device_to_user(cr, &ww, &wh);
-                       xa = (ww - _text_width) * _xalign;
+                       xa = text_margin + (ww - _text_width - 2 * text_margin) * _xalign;
                        ya = (wh - _text_height) * _yalign;
 
                        /* quick hack for left/bottom alignment at -90deg
@@ -391,10 +460,9 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                         */
                        if (_xalign < 0) xa = ceil(.5 + (ww * fabs(_xalign) + text_margin));
 
-                       cairo_move_to (cr, xa, ya);
+                       cairo_move_to (cr, xa + m1.x0, ya + m1.y0);
                        pango_cairo_update_layout(cr, _layout->gobj());
                        pango_cairo_show_layout (cr, _layout->gobj());
-                       cairo_restore (cr);
                }
                cairo_restore (cr);
        }
@@ -521,9 +589,11 @@ ArdourButton::on_realize()
 {
        CairoWidget::on_realize ();
        ensure_layout ();
-       if (_layout && _layout->get_text() != _text) {
-               _layout->set_text (_text);
-               queue_resize ();
+       if (_layout) {
+               if (_layout->get_text() != _text) {
+                       set_text_internal ();
+                       queue_resize ();
+               }
        }
 }
 
@@ -541,14 +611,38 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
                }
        }
 
-       if ((_elements & Text) && !_text.empty()) {
-               // if _layout does not exist, char_pixel_height() creates it,
-               req->height = std::max(req->height, (int) ceil(char_pixel_height() * BASELINESTRETCH + 1.0));
-               assert (_layout);
+       if (_elements & Text) {
+
+               ensure_layout();
+               set_text_internal ();
+
+               /* render() needs the size of the displayed text */
                _layout->get_pixel_size (_text_width, _text_height);
 
-               req->width += rint(1.75 * char_pixel_width()); // padding
-               req->width += _text_width;
+               if (_tweaks & OccasionalText) {
+
+                       /* size should not change based on presence or absence
+                        * of text.
+                        */
+
+               } else /*if (!_text.empty() || !_sizing_text.empty()) */ {
+
+                       req->height = std::max(req->height, (int) ceil(char_pixel_height() * BASELINESTRETCH + 1.0));
+                       req->width += rint(1.75 * char_pixel_width()); // padding
+
+                       if (!_sizing_text.empty()) {
+                               _layout->set_text (_sizing_text); /* use sizing text */
+                       }
+
+                       int sizing_text_width = 0, sizing_text_height = 0;
+                       _layout->get_pixel_size (sizing_text_width, sizing_text_height);
+
+                       req->width += sizing_text_width;
+
+                       if (!_sizing_text.empty()) {
+                               set_text_internal (); /* restore display text */
+                       }
+               }
 
                /* XXX hack (surprise). Deal with two common rotation angles */
 
@@ -578,7 +672,7 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
                req->width += _diameter + 4;
        }
 
-       if (_elements & VectorIcon) {
+       if (_elements & (VectorIcon | IconRenderCallback)) {
                assert(!(_elements & Text));
                const int wh = std::max (6., std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.)));
                req->width += wh;
@@ -600,7 +694,7 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
                        req->width = req->height;
                if (req->height < req->width)
                        req->height = req->width;
-       } else if (_text_width > 0 && !(_elements & (Menu | Indicator))) {
+       } else if (_sizing_text.empty() && _text_width > 0 && !(_elements & Menu)) {
                // properly centered text for those elements that are centered
                // (no sub-pixel offset)
                if ((req->width - _text_width) & 1) { ++req->width; }
@@ -619,19 +713,26 @@ void
 ArdourButton::set_colors ()
 {
        _update_colors = false;
-       if (_fixed_colors_set) {
+
+       if (_fixed_colors_set == 0x3) {
                return;
        }
+
        std::string name = get_name();
        bool failed = false;
 
-       fill_active_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
-       if (failed) {
-               fill_active_color = UIConfiguration::instance().color ("generic button: fill active");
+       if (!(_fixed_colors_set & 0x1)) {
+               fill_active_color = UIConfiguration::instance().color (string_compose ("%1: fill active", name), &failed);
+               if (failed) {
+                       fill_active_color = UIConfiguration::instance().color ("generic button: fill active");
+               }
        }
-       fill_inactive_color = UIConfiguration::instance().color (string_compose ("%1: fill", name), &failed);
-       if (failed) {
-               fill_inactive_color = UIConfiguration::instance().color ("generic button: fill");
+
+       if (!(_fixed_colors_set & 0x2)) {
+               fill_inactive_color = UIConfiguration::instance().color (string_compose ("%1: fill", name), &failed);
+               if (failed) {
+                       fill_inactive_color = UIConfiguration::instance().color ("generic button: fill");
+               }
        }
 
        text_active_color = ArdourCanvas::contrasting_text_color (fill_active_color);
@@ -659,13 +760,18 @@ ArdourButton::set_colors ()
  */
 void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t color_inactive)
 {
-       _fixed_colors_set = true;
+       set_active_color (color_active);
+       set_inactive_color (color_inactive);
+}
+
+void ArdourButton::set_active_color (const uint32_t color)
+{
+       _fixed_colors_set |= 0x1;
 
-       fill_active_color = color_active;
-       fill_inactive_color = color_inactive;
+       fill_active_color = color;
 
        unsigned char r, g, b, a;
-       UINT_TO_RGBA(color_active, &r, &g, &b, &a);
+       UINT_TO_RGBA(color, &r, &g, &b, &a);
 
        double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
                (max (double(g), 255.) - min (double(g), 255.)) +
@@ -679,14 +785,24 @@ void ArdourButton::set_fixed_colors (const uint32_t color_active, const uint32_t
                RGBA_TO_UINT(255, 255, 255, 255) : /* use white */
                RGBA_TO_UINT(  0,   0,   0,   255);  /* use black */
 
+       /* XXX what about led colors ? */
+       CairoWidget::set_dirty ();
+}
 
-       UINT_TO_RGBA(color_inactive, &r, &g, &b, &a);
+void ArdourButton::set_inactive_color (const uint32_t color)
+{
+       _fixed_colors_set |= 0x2;
+
+       fill_inactive_color = color;
+
+       unsigned char r, g, b, a;
+       UINT_TO_RGBA(color, &r, &g, &b, &a);
 
-       white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
+       double white_contrast = (max (double(r), 255.) - min (double(r), 255.)) +
                (max (double(g), 255.) - min (double(g), 255.)) +
                (max (double(b), 255.) - min (double(b), 255.));
 
-       black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
+       double black_contrast = (max (double(r), 0.) - min (double(r), 0.)) +
                (max (double(g), 0.) - min (double(g), 0.)) +
                (max (double(b), 0.) - min (double(b), 0.));
 
@@ -862,6 +978,7 @@ ArdourButton::set_related_action (RefPtr<Action> act)
        if (_action) {
 
                action_tooltip_changed ();
+               action_sensitivity_changed ();
 
                Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
                if (tact) {
@@ -894,6 +1011,11 @@ ArdourButton::on_style_changed (const RefPtr<Gtk::Style>&)
 {
        _update_colors = true;
        CairoWidget::set_dirty ();
+       _char_pixel_width = 0;
+       _char_pixel_height = 0;
+       if (is_realized()) {
+               queue_resize ();
+       }
 }
 
 void
@@ -940,6 +1062,7 @@ ArdourButton::setup_led_rect ()
 void
 ArdourButton::set_image (const RefPtr<Gdk::Pixbuf>& img)
 {
+        _elements = (ArdourButton::Element) (_elements & ~ArdourButton::Text);
        _pixbuf = img;
        if (is_realized()) {
                queue_resize ();
@@ -986,7 +1109,21 @@ ArdourButton::on_focus_out_event (GdkEventFocus* ev)
 
 bool
 ArdourButton::on_key_release_event (GdkEventKey *ev) {
-       if (_focused &&
+       if (_act_on_release && _focused &&
+                       (ev->keyval == GDK_space || ev->keyval == GDK_Return))
+       {
+               signal_clicked();
+               if (_action) {
+                       _action->activate ();
+               }
+               return true;
+       }
+       return CairoWidget::on_key_release_event (ev);
+}
+
+bool
+ArdourButton::on_key_press_event (GdkEventKey *ev) {
+       if (!_act_on_release && _focused &&
                        (ev->keyval == GDK_space || ev->keyval == GDK_Return))
        {
                signal_clicked();
@@ -1022,6 +1159,16 @@ ArdourButton::on_leave_notify_event (GdkEventCrossing* ev)
        return CairoWidget::on_leave_notify_event (ev);
 }
 
+bool
+ArdourButton::on_grab_broken_event(GdkEventGrabBroken* grab_broken_event) {
+       /* Our implicit grab due to a button_press was broken by another grab:
+        * the button will not get any button_release event if the mouse leaves
+        * while the grab is taken, so unpress ourselves */
+       _grabbed = false;
+       CairoWidget::set_dirty ();
+       return true;
+}
+
 void
 ArdourButton::set_tweaks (Tweaks t)
 {
@@ -1103,7 +1250,7 @@ ArdourButton::recalc_char_pixel_geometry ()
        // NB. this is not static, since the geometry is different
        // depending on the font used.
        int w, h;
-       std::string x = _("ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
+       std::string x = _("@ABCDEFGHIJLKMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789");
        _layout->set_text (x);
        _layout->get_pixel_size (w, h);
        _char_pixel_height = std::max(4, h);
@@ -1112,7 +1259,7 @@ ArdourButton::recalc_char_pixel_geometry ()
        Glib::ustring gx(x);
        _char_avg_pixel_width = w / (float)gx.size();
        _char_pixel_width = std::max(4, (int) ceil (_char_avg_pixel_width));
-       _layout->set_text (_text);
+       set_text_internal (); /* restore display text */
 }
 
 void
@@ -1150,7 +1297,24 @@ void
 ArdourButton::set_icon (Gtkmm2ext::ArdourIcon::Icon i)
 {
        _icon = i;
-       _elements = (ArdourButton::Element) ((_elements | ArdourButton::VectorIcon) & ~ArdourButton::Text);
+       _icon_render_cb = 0;
+       _icon_render_cb_data = 0;
+       _elements = (ArdourButton::Element) ((_elements | VectorIcon) & ~(ArdourButton::Text | IconRenderCallback));
+       CairoWidget::set_dirty ();
+}
+
+void
+ArdourButton::set_icon (rendercallback_t cb, void* d)
+{
+       if (!cb) {
+               _elements = (ArdourButton::Element) ((_elements | ArdourButton::Text) & ~(IconRenderCallback | VectorIcon));
+               _icon_render_cb = 0;
+               _icon_render_cb_data = 0;
+       } else {
+               _elements = (ArdourButton::Element) ((_elements | IconRenderCallback) & ~(ArdourButton::Text | VectorIcon));
+               _icon_render_cb = cb;
+               _icon_render_cb_data = d;
+       }
        CairoWidget::set_dirty ();
 }