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