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"
33 #include "gtkmm2ext/visibility.h"
41 class LIBGTKMM2EXT_API Keyboard : public sigc::trackable, PBD::Stateful
47 XMLNode& get_state (void);
48 int set_state (const XMLNode&, int version);
50 virtual void setup_keybindings () = 0;
52 typedef std::vector<uint32_t> State;
53 typedef uint32_t ModifierMask;
55 static uint32_t PrimaryModifier;
56 static uint32_t SecondaryModifier;
57 static uint32_t TertiaryModifier;
58 static uint32_t Level4Modifier;
59 static uint32_t CopyModifier;
60 static uint32_t RangeSelectModifier;
61 static uint32_t GainFineScaleModifier;
62 static uint32_t GainExtraFineScaleModifier;
64 // Modifiers for scroll wheel
65 static uint32_t ScrollZoomVerticalModifier;
66 static uint32_t ScrollZoomHorizontalModifier;
67 static uint32_t ScrollHorizontalModifier;
69 static const char* primary_modifier_name ();
70 static const char* secondary_modifier_name ();
71 static const char* tertiary_modifier_name ();
72 static const char* level4_modifier_name ();
73 static const char* copy_modifier_name ();
74 static const char* rangeselect_modifier_name ();
76 static void set_primary_modifier (uint32_t newval) {
77 set_modifier (newval, PrimaryModifier);
79 static void set_secondary_modifier (uint32_t newval) {
80 set_modifier (newval, SecondaryModifier);
82 static void set_tertiary_modifier (uint32_t newval) {
83 set_modifier (newval, TertiaryModifier);
85 static void set_level4_modifier (uint32_t newval) {
86 set_modifier (newval, Level4Modifier);
88 static void set_copy_modifier (uint32_t newval) {
89 set_modifier (newval, CopyModifier);
91 static void set_range_select_modifier (uint32_t newval) {
92 set_modifier (newval, RangeSelectModifier);
95 bool key_is_down (uint32_t keyval);
97 static GdkModifierType RelevantModifierKeyMask;
99 static bool no_modifier_keys_pressed(GdkEventButton* ev) {
100 return (ev->state & RelevantModifierKeyMask) == 0;
103 static bool no_modifier_keys_pressed(GdkEventKey* ev) {
104 return (ev->state & RelevantModifierKeyMask) == 0;
107 bool leave_window (GdkEventCrossing *ev, Gtk::Window*);
108 bool enter_window (GdkEventCrossing *ev, Gtk::Window*);
109 bool focus_in_window (GdkEventFocus *ev, Gtk::Window*);
110 bool focus_out_window (GdkEventFocus *ev, Gtk::Window*);
112 static bool modifier_state_contains (guint state, ModifierMask);
113 static bool modifier_state_equals (guint state, ModifierMask);
115 static bool no_modifiers_active (guint state);
117 static void set_snap_modifier (guint);
119 /** @return Modifier mask to temporarily toggle grid setting; with this modifier
120 * - magnetic or normal grid should become no grid and
121 * - no grid should become normal grid
123 static ModifierMask snap_modifier () { return ModifierMask (snap_mod); }
125 static void set_snap_delta_modifier (guint);
127 /** @return Modifier mask to temporarily toggle between relative and absolute grid setting;
129 static ModifierMask snap_delta_modifier () { return ModifierMask (snap_delta_mod); }
131 static guint edit_button() { return edit_but; }
132 static void set_edit_button (guint);
133 static guint edit_modifier() { return edit_mod; }
134 static void set_edit_modifier(guint);
136 static guint delete_button() { return delete_but; }
137 static void set_delete_button(guint);
138 static guint delete_modifier() { return delete_mod; }
139 static void set_delete_modifier(guint);
141 static guint insert_note_button() { return insert_note_but; }
142 static void set_insert_note_button (guint);
143 static guint insert_note_modifier() { return insert_note_mod; }
144 static void set_insert_note_modifier(guint);
146 static bool is_edit_event (GdkEventButton*);
147 static bool is_delete_event (GdkEventButton*);
148 static bool is_insert_note_event (GdkEventButton*);
149 static bool is_context_menu_event (GdkEventButton*);
150 static bool is_button2_event (GdkEventButton*);
152 static Keyboard& the_keyboard() { return *_the_keyboard; }
154 static bool some_magic_widget_has_focus ();
155 static void magic_widget_grab_focus ();
156 static void magic_widget_drop_focus ();
157 static Gtk::Window* get_current_window () { return current_window; };
159 static void close_current_dialog ();
161 static void keybindings_changed ();
162 static void save_keybindings ();
163 static bool load_keybindings (std::string path);
164 static void set_can_save_keybindings (bool yn);
165 static std::string current_binding_name () { return _current_binding_name; }
166 static std::map<std::string,std::string> binding_files;
168 int reset_bindings ();
170 struct AccelKeyLess {
171 bool operator() (const Gtk::AccelKey a, const Gtk::AccelKey b) const {
172 if (a.get_key() != b.get_key()) {
173 return a.get_key() < b.get_key();
175 return a.get_mod() < b.get_mod();
180 sigc::signal0<void> ZoomVerticalModifierReleased;
183 static Keyboard* _the_keyboard;
188 static guint edit_but;
189 static guint edit_mod;
190 static guint delete_but;
191 static guint delete_mod;
192 static guint insert_note_but;
193 static guint insert_note_mod;
194 static guint snap_mod;
195 static guint snap_delta_mod;
196 static guint button2_modifiers;
197 static Gtk::Window* current_window;
198 static std::string user_keybindings_path;
199 static bool can_save_keybindings;
200 static bool bindings_changed_after_save_became_legal;
201 static std::string _current_binding_name;
203 typedef std::pair<std::string,std::string> two_strings;
205 static std::map<Gtk::AccelKey,two_strings,AccelKeyLess> release_keys;
207 static gint _snooper (GtkWidget*, GdkEventKey*, gpointer);
208 gint snooper (GtkWidget*, GdkEventKey*);
210 static void set_modifier (uint32_t newval, uint32_t& variable);
212 static bool _some_magic_widget_has_focus;
217 #endif /* __libgtkmm2ext_keyboard_h__ */