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