2 Copyright (C) 2001 Paul Davis
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.
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.
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.
20 #ifndef __libgtkmm2ext_keyboard_h__
21 #define __libgtkmm2ext_keyboard_h__
27 #include <sigc++/signal.h>
29 #include <gtkmm/accelkey.h>
31 #include "pbd/stateful.h"
39 class Keyboard
: public sigc::trackable
, PBD::Stateful
45 XMLNode
& get_state (void);
46 int set_state (const XMLNode
&, int version
);
48 virtual void setup_keybindings () = 0;
50 typedef std::vector
<uint32_t> State
;
51 typedef uint32_t ModifierMask
;
53 static uint32_t PrimaryModifier
;
54 static uint32_t SecondaryModifier
;
55 static uint32_t TertiaryModifier
;
56 static uint32_t Level4Modifier
;
57 static uint32_t CopyModifier
;
58 static uint32_t RangeSelectModifier
;
60 static const char* primary_modifier_name ();
61 static const char* secondary_modifier_name ();
62 static const char* tertiary_modifier_name ();
63 static const char* level4_modifier_name ();
64 static const char* copy_modifier_name ();
65 static const char* rangeselect_modifier_name ();
67 static void set_primary_modifier (uint32_t newval
) {
68 set_modifier (newval
, PrimaryModifier
);
70 static void set_secondary_modifier (uint32_t newval
) {
71 set_modifier (newval
, SecondaryModifier
);
73 static void set_tertiary_modifier (uint32_t newval
) {
74 set_modifier (newval
, TertiaryModifier
);
76 static void set_level4_modifier (uint32_t newval
) {
77 set_modifier (newval
, Level4Modifier
);
79 static void set_copy_modifier (uint32_t newval
) {
80 set_modifier (newval
, CopyModifier
);
82 static void set_range_select_modifier (uint32_t newval
) {
83 set_modifier (newval
, RangeSelectModifier
);
86 bool key_is_down (uint32_t keyval
);
88 static GdkModifierType RelevantModifierKeyMask
;
90 static bool no_modifier_keys_pressed(GdkEventButton
* ev
) {
91 return (ev
->state
& RelevantModifierKeyMask
) == 0;
94 static bool no_modifier_keys_pressed(GdkEventKey
* ev
) {
95 return (ev
->state
& RelevantModifierKeyMask
) == 0;
98 bool leave_window (GdkEventCrossing
*ev
, Gtk::Window
*);
99 bool enter_window (GdkEventCrossing
*ev
, Gtk::Window
*);
101 static bool modifier_state_contains (guint state
, ModifierMask
);
102 static bool modifier_state_equals (guint state
, ModifierMask
);
104 static bool no_modifiers_active (guint state
);
106 static void set_snap_modifier (guint
);
108 /** @return Modifier mask to temporarily toggle grid setting; with this modifier
109 * - magnetic or normal grid should become no grid and
110 * - no grid should become normal grid
112 static ModifierMask
snap_modifier () { return ModifierMask (snap_mod
); }
114 static guint
edit_button() { return edit_but
; }
115 static void set_edit_button (guint
);
116 static guint
edit_modifier() { return edit_mod
; }
117 static void set_edit_modifier(guint
);
119 static guint
delete_button() { return delete_but
; }
120 static void set_delete_button(guint
);
121 static guint
delete_modifier() { return delete_mod
; }
122 static void set_delete_modifier(guint
);
124 static guint
insert_note_button() { return insert_note_but
; }
125 static void set_insert_note_button (guint
);
126 static guint
insert_note_modifier() { return insert_note_mod
; }
127 static void set_insert_note_modifier(guint
);
129 static bool is_edit_event (GdkEventButton
*);
130 static bool is_delete_event (GdkEventButton
*);
131 static bool is_insert_note_event (GdkEventButton
*);
132 static bool is_context_menu_event (GdkEventButton
*);
133 static bool is_button2_event (GdkEventButton
*);
135 static Keyboard
& the_keyboard() { return *_the_keyboard
; }
137 static bool some_magic_widget_has_focus ();
138 static void magic_widget_grab_focus ();
139 static void magic_widget_drop_focus ();
141 static void keybindings_changed ();
142 static void save_keybindings ();
143 static bool load_keybindings (std::string path
);
144 static void set_can_save_keybindings (bool yn
);
145 static std::string
current_binding_name () { return _current_binding_name
; }
146 static std::map
<std::string
,std::string
> binding_files
;
148 struct AccelKeyLess
{
149 bool operator() (const Gtk::AccelKey a
, const Gtk::AccelKey b
) const {
150 if (a
.get_key() != b
.get_key()) {
151 return a
.get_key() < b
.get_key();
153 return a
.get_mod() < b
.get_mod();
159 static Keyboard
* _the_keyboard
;
164 static guint edit_but
;
165 static guint edit_mod
;
166 static guint delete_but
;
167 static guint delete_mod
;
168 static guint insert_note_but
;
169 static guint insert_note_mod
;
170 static guint snap_mod
;
171 static guint button2_modifiers
;
172 static Gtk::Window
* current_window
;
173 static std::string user_keybindings_path
;
174 static bool can_save_keybindings
;
175 static bool bindings_changed_after_save_became_legal
;
176 static std::string _current_binding_name
;
178 typedef std::pair
<std::string
,std::string
> two_strings
;
180 static std::map
<Gtk::AccelKey
,two_strings
,AccelKeyLess
> release_keys
;
182 static gint
_snooper (GtkWidget
*, GdkEventKey
*, gpointer
);
183 gint
snooper (GtkWidget
*, GdkEventKey
*);
185 static void set_modifier (uint32_t newval
, uint32_t& variable
);
187 static bool _some_magic_widget_has_focus
;
192 #endif /* __libgtkmm2ext_keyboard_h__ */