gtk2_ardour/ardour_button.h

   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 #ifndef __gtk2_ardour_ardour_button_h__
  20 #define __gtk2_ardour_ardour_button_h__
  21
  22 #include <list>
  23 #include <stdint.h>
  24
  25 #include <gtkmm/action.h>
  26
  27 #include "pbd/signals.h"
  28 #include "gtkmm2ext/ardour_icon.h"
  29 #include "gtkmm2ext/binding_proxy.h"
  30 #include "gtkmm2ext/activatable.h"
  31 #include "gtkmm2ext/cairo_widget.h"
  32
  33 class ArdourButton : public CairoWidget , public Gtkmm2ext::Activatable
  34 {
  35         public:
  36         enum Element {
  37                 Edge = 0x1,
  38                 Body = 0x2,
  39                 Text = 0x4,
  40                 Indicator = 0x8,
  41                 unused = 0x10,
  42                 Menu = 0x20,
  43                 Inactive = 0x40, // no _action is defined AND state is not used
  44                 VectorIcon = 0x80, // tentative, see commit message
  45         };
  46
  47         static Element default_elements;
  48         static Element led_default_elements;
  49         static Element just_led_default_elements;
  50
  51         ArdourButton (Element e = default_elements);
  52         ArdourButton (const std::string&, Element e = default_elements);
  53         virtual ~ArdourButton ();
  54
  55         enum Tweaks {
  56                 Square = 0x1,
  57                 TrackHeader = 0x2,
  58                 OccasionalText = 0x4,
  59                 unused4 = 0x8,
  60         };
  61
  62         Tweaks tweaks() const { return _tweaks; }
  63         void set_tweaks (Tweaks);
  64
  65         void set_active_state (Gtkmm2ext::ActiveState);
  66         void set_visual_state (Gtkmm2ext::VisualState);
  67
  68         void set_custom_led_color (const uint32_t c, const bool useit = true);
  69
  70         void set_act_on_release (bool onRelease) { _act_on_release = onRelease; }
  71
  72         Element elements() const { return _elements; }
  73         void set_elements (Element);
  74         void add_elements (Element);
  75
  76         Gtkmm2ext::ArdourIcon::Icon icon() const { return _icon; }
  77         void set_icon (Gtkmm2ext::ArdourIcon::Icon);
  78
  79         void set_corner_radius (float);
  80
  81         void set_text (const std::string&, bool markup = false);
  82         const std::string& get_text () { return _text; }
  83         bool get_markup () const { return _markup; }
  84         void set_angle (const double);
  85         void set_alignment (const float, const float);
  86         void get_alignment (float& xa, float& ya) {xa = _xalign; ya = _yalign;};
  87
  88         void set_led_left (bool yn);
  89         void set_distinct_led_click (bool yn);
  90
  91         void set_layout_ellipsize_width (int w);
  92         void set_layout_font (const Pango::FontDescription&);
  93         void set_text_ellipsize (Pango::EllipsizeMode);
  94
  95     /* Sets the text used for size request computation. Pass an
  96      * empty string to return to the default behavior which uses
  97      * the currently displayed text for measurement. */
  98         void set_sizing_text (const std::string&);
  99         const std::string& get_sizing_text () {return _sizing_text;}
 100
 101         sigc::signal<void, GdkEventButton*> signal_led_clicked;
 102         sigc::signal<void> signal_clicked;
 103
 104         boost::shared_ptr<PBD::Controllable> get_controllable() { return binding_proxy.get_controllable(); }
 105         void set_controllable (boost::shared_ptr<PBD::Controllable> c);
 106         void watch ();
 107
 108         void set_related_action (Glib::RefPtr<Gtk::Action>);
 109
 110         bool on_button_press_event (GdkEventButton*);
 111         bool on_button_release_event (GdkEventButton*);
 112
 113         void set_image (const Glib::RefPtr<Gdk::Pixbuf>&);
 114
 115         void set_fixed_colors   (const uint32_t active_color, const uint32_t inactive_color);
 116         void set_active_color   (const uint32_t active_color);
 117         void set_inactive_color (const uint32_t inactive_color);
 118
 119         void set_fallthrough_to_parent(bool fall) { _fallthrough_to_parent = fall; }
 120
 121         unsigned int char_pixel_width() { if (_char_pixel_width < 1) recalc_char_pixel_geometry() ; return _char_pixel_width; }
 122         unsigned int char_pixel_height() { if (_char_pixel_height < 1) recalc_char_pixel_geometry() ; return _char_pixel_height; }
 123         float char_avg_pixel_width() { if (_char_pixel_width < 1) recalc_char_pixel_geometry() ; return _char_avg_pixel_width; }
 124
 125         protected:
 126         void render (cairo_t *, cairo_rectangle_t *);
 127         void on_size_request (Gtk::Requisition* req);
 128         void on_size_allocate (Gtk::Allocation&);
 129         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
 130         void on_name_changed ();
 131         void on_realize ();
 132         bool on_enter_notify_event (GdkEventCrossing*);
 133         bool on_leave_notify_event (GdkEventCrossing*);
 134         bool on_grab_broken_event(GdkEventGrabBroken*);
 135         bool on_focus_in_event (GdkEventFocus*);
 136         bool on_focus_out_event (GdkEventFocus*);
 137         bool on_key_release_event (GdkEventKey *);
 138
 139         void controllable_changed ();
 140         PBD::ScopedConnection watch_connection;
 141
 142         protected:
 143         Glib::RefPtr<Pango::Layout> _layout;
 144         Glib::RefPtr<Gdk::Pixbuf>   _pixbuf;
 145         std::string                 _text;
 146         std::string                 _sizing_text;
 147         bool                        _markup;
 148         Element                     _elements;
 149         Gtkmm2ext::ArdourIcon::Icon _icon;
 150         Tweaks                      _tweaks;
 151         BindingProxy                binding_proxy;
 152
 153         void set_text_internal ();
 154         void recalc_char_pixel_geometry ();
 155         unsigned int _char_pixel_width;
 156         unsigned int _char_pixel_height;
 157         float _char_avg_pixel_width;
 158
 159         int   _text_width;
 160         int   _text_height;
 161         float _diameter;
 162         float _corner_radius;
 163         int   _corner_mask;
 164
 165         double _angle;
 166         float _xalign, _yalign;
 167
 168         uint32_t fill_inactive_color;
 169         uint32_t fill_active_color;
 170
 171         uint32_t text_active_color;
 172         uint32_t text_inactive_color;
 173
 174         uint32_t led_active_color;
 175         uint32_t led_inactive_color;
 176         uint32_t led_custom_color;
 177         bool     use_custom_led_color;
 178
 179         cairo_pattern_t* convex_pattern;
 180         cairo_pattern_t* concave_pattern;
 181         cairo_pattern_t* led_inset_pattern;
 182         cairo_rectangle_t* _led_rect;
 183
 184         bool _act_on_release;
 185         bool _led_left;
 186         bool _distinct_led_click;
 187         bool _hovering;
 188         bool _focused;
 189         int  _fixed_colors_set;
 190         bool _fallthrough_to_parent;
 191         int _layout_ellipsize_width;
 192         Pango::EllipsizeMode _ellipsis;
 193         bool _update_colors;
 194         int _pattern_height;
 195
 196         void setup_led_rect ();
 197         void set_colors ();
 198         void color_handler ();
 199         void build_patterns ();
 200         void ensure_layout ();
 201
 202         void action_toggled ();
 203         void action_sensitivity_changed ();
 204         void action_visibility_changed ();
 205         void action_tooltip_changed ();
 206 };
 207
 208 #endif /* __gtk2_ardour_ardour_button_h__ */