merged with 1697 revision of trunk (which is post-rc1 but pre-rc2
[ardour.git] / 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 */
19
20 #ifndef __ardour_keyboard_h__
21 #define __ardour_keyboard_h__
22
23 #include <vector>
24 #include <string>
25
26 #include <sigc++/signal.h>
27 #include <gtk/gtk.h>
28
29 #include <ardour/types.h>
30 #include <pbd/stateful.h>
31
32 #include "selection.h"
33
34 using std::vector;
35 using std::string;
36
37 class Keyboard : public sigc::trackable, Stateful
38 {
39   public:
40         Keyboard ();
41         ~Keyboard ();
42
43         XMLNode& get_state (void);
44         int set_state (const XMLNode&);
45
46         typedef vector<uint32_t> State;
47         typedef uint32_t ModifierMask;
48
49         static uint32_t Control;
50         static uint32_t Shift;
51         static uint32_t Alt;
52         static uint32_t Meta;
53
54         bool key_is_down (uint32_t keyval);
55
56         static GdkModifierType RelevantModifierKeyMask;
57
58         static bool no_modifier_keys_pressed(GdkEventButton* ev) {
59                 return (ev->state & RelevantModifierKeyMask) == 0;
60         }
61
62         bool leave_window (GdkEventCrossing *ev, Gtk::Window*);
63         bool enter_window (GdkEventCrossing *ev, Gtk::Window*);
64
65         static bool modifier_state_contains (guint state, ModifierMask);
66         static bool modifier_state_equals   (guint state, ModifierMask);
67
68         static Selection::Operation selection_type (guint state);
69
70         static bool no_modifiers_active (guint state);
71
72         static void set_meta_modifier (guint);
73
74         static void set_snap_modifier (guint);
75         static ModifierMask snap_modifier () { return ModifierMask (snap_mod); }
76
77         static guint edit_button() { return edit_but; }
78         static void set_edit_button (guint);
79         static guint edit_modifier() { return edit_mod; }
80         static void set_edit_modifier(guint);
81
82         static guint delete_button() { return delete_but; }
83         static void set_delete_button(guint);
84         static guint delete_modifier() { return delete_mod; }
85         static void set_delete_modifier(guint);
86
87         static bool is_edit_event (GdkEventButton*);
88         static bool is_delete_event (GdkEventButton*);
89         static bool is_context_menu_event (GdkEventButton*);
90
91         static Keyboard& the_keyboard() { return *_the_keyboard; }
92
93   private:
94         static Keyboard* _the_keyboard;
95
96         guint           snooper_id;
97         State           state;
98
99         static guint     edit_but;
100         static guint     edit_mod;
101         static guint     delete_but;
102         static guint     delete_mod;
103         static guint     snap_mod;
104
105         static gint _snooper (GtkWidget*, GdkEventKey*, gpointer);
106         gint snooper (GtkWidget*, GdkEventKey*);
107 };
108
109 #endif /* __ardour_keyboard_h__ */