gtk2_ardour/ardour_knob.h

   1 /*
   2     Copyright (C) 2014 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_knob_h__
  20 #define __gtk2_ardour_ardour_knob_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 #include "gtkmm2ext/persistent_tooltip.h"
  32
  33 class KnobPersistentTooltip : public Gtkmm2ext::PersistentTooltip
  34 {
  35 public:
  36         KnobPersistentTooltip (Gtk::Widget* w);
  37
  38         void start_drag ();
  39         void stop_drag ();
  40         bool dragging () const;
  41
  42 private:
  43         bool _dragging;
  44 };
  45
  46
  47 class ArdourKnob : public CairoWidget , public Gtkmm2ext::Activatable
  48 {
  49 public:
  50
  51         enum Element {
  52                 Arc = 0x1,
  53                 Bevel = 0x2,
  54                 unused2 = 0x4,
  55                 unused3 = 0x8,
  56                 unused4 = 0x10,
  57                 unused5 = 0x20,
  58         };
  59
  60         enum Flags {
  61                 NoFlags = 0,
  62                 Detent = 0x1,
  63                 ArcToZero = 0x2,
  64         };
  65
  66         ArdourKnob (Element e = default_elements, Flags flags = NoFlags);
  67         virtual ~ArdourKnob ();
  68
  69         void set_active_state (Gtkmm2ext::ActiveState);
  70         void set_visual_state (Gtkmm2ext::VisualState);
  71
  72         Element elements() const { return _elements; }
  73         void set_elements (Element);
  74         void add_elements (Element);
  75         static Element default_elements;
  76
  77         void set_tooltip_prefix (std::string pfx) { _tooltip_prefix = pfx; }
  78
  79         boost::shared_ptr<PBD::Controllable> get_controllable() { return binding_proxy.get_controllable(); }
  80         void set_controllable (boost::shared_ptr<PBD::Controllable> c);
  81
  82         bool on_button_press_event (GdkEventButton*);
  83         bool on_button_release_event (GdkEventButton*);
  84         bool on_scroll_event (GdkEventScroll* ev);
  85         bool on_motion_notify_event (GdkEventMotion *ev) ;
  86
  87         void color_handler ();
  88
  89   protected:
  90         void render (cairo_t *, cairo_rectangle_t *);
  91         void on_size_request (Gtk::Requisition* req);
  92         void on_size_allocate (Gtk::Allocation&);
  93         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
  94         void on_name_changed ();
  95         bool on_enter_notify_event (GdkEventCrossing*);
  96         bool on_leave_notify_event (GdkEventCrossing*);
  97         bool on_focus_in_event (GdkEventFocus*);
  98         bool on_focus_out_event (GdkEventFocus*);
  99
 100         void controllable_changed ();
 101         PBD::ScopedConnection watch_connection;
 102
 103
 104   private:
 105         Element                     _elements;
 106
 107         BindingProxy                binding_proxy;
 108
 109         bool _hovering;
 110         float _grabbed_x;
 111         float _grabbed_y;
 112
 113         float _val; // current value [0..1]
 114         float _normal; // default value, arc
 115         float _dead_zone_delta;
 116
 117         Flags _flags;
 118
 119         void action_sensitivity_changed ();
 120         void action_visibility_changed ();
 121         void action_tooltip_changed ();
 122
 123         std::string _tooltip_prefix;
 124         KnobPersistentTooltip _tooltip;
 125 };
 126
 127 #endif /* __gtk2_ardour_ardour_knob_h__ */