gtk2_ardour/keyboard.h

   1 /*
   2     Copyright (C) 2001 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     $Id$
  19 */
  20
  21 #ifndef __ardour_keyboard_h__
  22 #define __ardour_keyboard_h__
  23
  24 #include <vector>
  25 #include <string>
  26
  27 #include <sigc++/signal.h>
  28 #include <gtk/gtk.h>
  29
  30 #include <ardour/types.h>
  31 #include <ardour/stateful.h>
  32
  33 using std::vector;
  34 using std::string;
  35
  36 class Keyboard : public sigc::trackable, Stateful
  37 {
  38   public:
  39         Keyboard ();
  40         ~Keyboard ();
  41
  42         XMLNode& get_state (void);
  43         int set_state (const XMLNode&);
  44
  45         typedef vector<uint32_t> State;
  46
  47         int  get_prefix(float&, bool& was_floating);
  48         void start_prefix ();
  49
  50         static State  translate_key_name (const string&);
  51         static string get_real_keyname (const string& name);
  52
  53         typedef uint32_t ModifierMask;
  54
  55         static uint32_t Control;
  56         static uint32_t Shift;
  57         static uint32_t Alt;
  58         static uint32_t Meta;
  59
  60         bool key_is_down (uint32_t keyval);
  61
  62         static GdkModifierType RelevantModifierKeyMask;
  63
  64         static bool no_modifier_keys_pressed(GdkEventButton* ev) {
  65                 return (ev->state & RelevantModifierKeyMask) == 0;
  66         }
  67
  68         bool leave_window (GdkEventCrossing *ev, Gtk::Window*);
  69         bool enter_window (GdkEventCrossing *ev, Gtk::Window*);
  70
  71         static bool modifier_state_contains (guint state, ModifierMask);
  72         static bool modifier_state_equals   (guint state, ModifierMask);
  73
  74         static bool no_modifiers_active (guint state);
  75
  76         static void set_meta_modifier (guint);
  77
  78         static void set_snap_modifier (guint);
  79         static ModifierMask snap_modifier () { return ModifierMask (snap_mod); }
  80
  81         static guint edit_button() { return edit_but; }
  82         static void set_edit_button (guint);
  83         static guint edit_modifier() { return edit_mod; }
  84         static void set_edit_modifier(guint);
  85
  86         static guint delete_button() { return delete_but; }
  87         static void set_delete_button(guint);
  88         static guint delete_modifier() { return delete_mod; }
  89         static void set_delete_modifier(guint);
  90
  91         static bool is_edit_event (GdkEventButton*);
  92         static bool is_delete_event (GdkEventButton*);
  93         static bool is_context_menu_event (GdkEventButton*);
  94
  95         static Keyboard& the_keyboard() { return *_the_keyboard; }
  96
  97   private:
  98         static Keyboard* _the_keyboard;
  99
 100         bool   _queue_events;
 101         bool   _flush_queue;
 102
 103         guint           snooper_id;
 104         State           state;
 105         bool            collecting_prefix;
 106         string          current_prefix;
 107         int*            modifier_masks;
 108         int             modifier_mask;
 109         int             min_keycode;
 110         int             max_keycode;
 111
 112         static guint     edit_but;
 113         static guint     edit_mod;
 114         static guint     delete_but;
 115         static guint     delete_mod;
 116         static guint     snap_mod;
 117
 118         static gint _snooper (GtkWidget*, GdkEventKey*, gpointer);
 119         gint snooper (GtkWidget*, GdkEventKey*);
 120
 121         void queue_event (GdkEventKey*);
 122         void get_modifier_masks ();
 123         void check_modifier_state ();
 124         void clear_modifier_state ();
 125
 126         void check_meta_numlock (char keycode, guint mod, string modname);
 127 };
 128
 129 #endif /* __ardour_keyboard_h__ */