1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*
* Copyright (C) 2001-2016 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2012 Carl Hetherington <carl@carlh.net>
* Copyright (C) 2013 Colin Fletcher <colin.m.fletcher@googlemail.com>
* Copyright (C) 2015-2016 Nick Mainsbridge <mainsbridge@gmail.com>
* Copyright (C) 2015 Robin Gareus <robin@gareus.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __libgtkmm2ext_keyboard_h__
#define __libgtkmm2ext_keyboard_h__
#include <map>
#include <vector>
#include <string>
#include <gtk/gtk.h>
#include <gtkmm/accelkey.h>
#include "pbd/stateful.h"
#include "pbd/signals.h"
#include "gtkmm2ext/visibility.h"
namespace Gtk {
class Window;
}
namespace Gtkmm2ext {
class Bindings;
class ActionMap;
class LIBGTKMM2EXT_API Keyboard : public sigc::trackable, PBD::Stateful
{
public:
Keyboard ();
~Keyboard ();
XMLNode& get_state (void);
int set_state (const XMLNode&, int version);
virtual void setup_keybindings () = 0;
static void reset_relevant_modifier_key_mask ();
typedef std::vector<uint32_t> State;
typedef uint32_t ModifierMask;
static uint32_t PrimaryModifier;
static uint32_t SecondaryModifier;
static uint32_t TertiaryModifier;
static uint32_t Level4Modifier;
static uint32_t CopyModifier;
static uint32_t RangeSelectModifier;
static uint32_t GainFineScaleModifier;
static uint32_t GainExtraFineScaleModifier;
// Modifiers for scroll wheel
static uint32_t ScrollZoomVerticalModifier;
static uint32_t ScrollZoomHorizontalModifier;
static uint32_t ScrollHorizontalModifier;
static const char* primary_modifier_name ();
static const char* secondary_modifier_name ();
static const char* tertiary_modifier_name ();
static const char* level4_modifier_name ();
static const char* primary_modifier_short_name ();
static const char* secondary_modifier_short_name ();
static const char* tertiary_modifier_short_name ();
static const char* level4_modifier_short_name ();
static void set_primary_modifier (uint32_t newval) {
set_modifier (newval, PrimaryModifier);
}
static void set_secondary_modifier (uint32_t newval) {
set_modifier (newval, SecondaryModifier);
}
static void set_tertiary_modifier (uint32_t newval) {
set_modifier (newval, TertiaryModifier);
}
static void set_level4_modifier (uint32_t newval) {
set_modifier (newval, Level4Modifier);
}
static void set_copy_modifier (uint32_t newval) {
set_modifier (newval, CopyModifier);
}
static void set_range_select_modifier (uint32_t newval) {
set_modifier (newval, RangeSelectModifier);
}
bool key_is_down (uint32_t keyval);
static GdkModifierType RelevantModifierKeyMask;
static bool no_modifier_keys_pressed(GdkEventButton* ev) {
return (ev->state & RelevantModifierKeyMask) == 0;
}
static bool no_modifier_keys_pressed(GdkEventKey* ev) {
return (ev->state & RelevantModifierKeyMask) == 0;
}
bool leave_window (GdkEventCrossing *ev, Gtk::Window*);
bool enter_window (GdkEventCrossing *ev, Gtk::Window*);
bool focus_in_window (GdkEventFocus *ev, Gtk::Window*);
bool focus_out_window (GdkEventFocus *ev, Gtk::Window*);
static bool modifier_state_contains (guint state, ModifierMask);
static bool modifier_state_equals (guint state, ModifierMask);
static bool no_modifiers_active (guint state);
static void set_snap_modifier (guint);
/** @return Modifier mask to temporarily toggle grid setting; with this modifier
* - magnetic or normal grid should become no grid and
* - no grid should become normal grid
*/
static ModifierMask snap_modifier () { return ModifierMask (snap_mod); }
static void set_snap_delta_modifier (guint);
/** @return Modifier mask to temporarily toggle between relative and absolute grid setting.
* Absolute grid is for aligning objects with the grid lines.
* Relative grid is for maintaining an initial position relative to the grid lines.
* With this modifier:
* - magnetic or normal grid should snap relative to an initial grid offset
* - no grid should snap relative to the grid.
*/
static ModifierMask snap_delta_modifier () { return ModifierMask (snap_delta_mod); }
static guint edit_button() { return edit_but; }
static void set_edit_button (guint);
static guint edit_modifier() { return edit_mod; }
static void set_edit_modifier(guint);
static guint delete_button() { return delete_but; }
static void set_delete_button(guint);
static guint delete_modifier() { return delete_mod; }
static void set_delete_modifier(guint);
static guint insert_note_button() { return insert_note_but; }
static void set_insert_note_button (guint);
static guint insert_note_modifier() { return insert_note_mod; }
static void set_insert_note_modifier(guint);
static bool is_edit_event (GdkEventButton*);
static bool is_delete_event (GdkEventButton*);
static bool is_insert_note_event (GdkEventButton*);
static bool is_context_menu_event (GdkEventButton*);
static bool is_button2_event (GdkEventButton*);
static Keyboard& the_keyboard() { return *_the_keyboard; }
static bool some_magic_widget_has_focus ();
static void magic_widget_grab_focus ();
static void magic_widget_drop_focus ();
static Gtk::Window* get_current_window () { return current_window; };
static void close_current_dialog ();
static void keybindings_changed ();
static void save_keybindings ();
static void set_can_save_keybindings (bool yn);
static std::string current_binding_name () { return _current_binding_name; }
static std::map<std::string,std::string> binding_files;
static bool catch_user_event_for_pre_dialog_focus (GdkEvent* ev, Gtk::Window* w);
static bool load_keybindings (std::string const& path);
static void save_keybindings (std::string const& path);
static std::string binding_filename_suffix;
int reset_bindings ();
sigc::signal0<void> ZoomVerticalModifierReleased;
static sigc::signal0<void> RelevantModifierKeysChanged;
protected:
static Keyboard* _the_keyboard;
guint snooper_id;
State state;
static guint edit_but;
static guint edit_mod;
static guint delete_but;
static guint delete_mod;
static guint insert_note_but;
static guint insert_note_mod;
static guint snap_mod;
static guint snap_delta_mod;
static guint button2_modifiers;
static Gtk::Window* current_window;
static std::string user_keybindings_path;
static bool can_save_keybindings;
static bool bindings_changed_after_save_became_legal;
static std::string _current_binding_name;
typedef std::pair<std::string,std::string> two_strings;
static gint _snooper (GtkWidget*, GdkEventKey*, gpointer);
gint snooper (GtkWidget*, GdkEventKey*);
static void set_modifier (uint32_t newval, uint32_t& variable);
static bool _some_magic_widget_has_focus;
static Gtk::Window* pre_dialog_active_window;
static int read_keybindings (std::string const& path);
static int store_keybindings (std::string const& path);
};
} /* namespace */
#endif /* __libgtkmm2ext_keyboard_h__ */
|
