2 Copyright (C) 2002 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.
21 #include "gtk2ardour-config.h"
26 #include <boost/algorithm/string.hpp>
28 #include <gtkmm/stock.h>
29 #include <gtkmm/label.h>
30 #include <gtkmm/accelkey.h>
31 #include <gtkmm/accelmap.h>
32 #include <gtkmm/uimanager.h>
34 #include "gtkmm2ext/bindings.h"
35 #include "gtkmm2ext/utils.h"
37 #include "pbd/strsplit.h"
39 #include "ardour/filesystem_paths.h"
40 #include "ardour/profile.h"
44 #include "keyeditor.h"
53 using Gtkmm2ext::Keyboard;
54 using Gtkmm2ext::Bindings;
56 void bindings_collision_dialog (Gtk::Window& parent)
58 ArdourDialog dialog (parent, _("Colliding keybindings"), true);
59 Label label (_("The key sequence is already bound. Please remove the other binding first."));
61 dialog.get_vbox()->pack_start (label, true, true);
62 dialog.add_button (_("Ok"), Gtk::RESPONSE_ACCEPT);
67 KeyEditor::KeyEditor ()
68 : ArdourWindow (_("Key Bindings"))
69 , unbind_button (_("Remove shortcut"))
70 , unbind_box (BUTTONBOX_END)
71 , filter_entry (_("Search..."), true)
74 , sort_type(Gtk::SORT_ASCENDING)
77 notebook.signal_switch_page ().connect (sigc::mem_fun (*this, &KeyEditor::page_change));
79 vpacker.pack_start (notebook, true, true);
81 Glib::RefPtr<Gdk::Pixbuf> icon = ARDOUR_UI_UTILS::get_icon ("search");
82 filter_entry.set_icon_from_pixbuf (icon);
83 filter_entry.set_icon_tooltip_text (_("Click to reset search string"));
84 filter_entry.signal_search_string_updated ().connect (sigc::mem_fun (*this, &KeyEditor::search_string_updated));
85 vpacker.pack_start (filter_entry, false, false);
87 Label* hint = manage (new Label (_("Select an action, then press the key(s) to (re)set its shortcut")));
89 unbind_box.set_spacing (6);
90 unbind_box.pack_start (*hint, false, true);
91 unbind_box.pack_start (unbind_button, false, false);
92 unbind_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::unbind));
94 vpacker.pack_start (unbind_box, false, false);
96 unbind_button.show ();
98 reset_button.add (reset_label);
99 reset_label.set_markup (string_compose ("<span size=\"large\" weight=\"bold\">%1</span>", _("Reset Bindings to Defaults")));
101 reset_box.pack_start (reset_button, true, false);
103 reset_button.show ();
105 reset_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::reset));
106 vpacker.pack_start (reset_box, false, false);
110 unbind_button.set_sensitive (false);
114 KeyEditor::add_tab (string const & name, Bindings& bindings)
116 Tab* t = new Tab (*this, name, &bindings);
118 if (t->populate () == 0) {
125 notebook.append_page (*t, name);
130 KeyEditor::remove_tab (string const &name)
132 guint npages = notebook.get_n_pages ();
134 for (guint n = 0; n < npages; ++n) {
135 Widget* w = notebook.get_nth_page (n);
136 Tab* tab = dynamic_cast<Tab*> (w);
138 if (tab->name == name) {
139 notebook.remove_page (*w);
144 cerr << "Removed " << name << endl;
150 current_tab()->unbind ();
154 KeyEditor::page_change (GtkNotebookPage*, guint)
156 current_tab()->view.get_selection()->unselect_all ();
157 unbind_button.set_sensitive (false);
161 KeyEditor::Tab::key_press_event (GdkEventKey* ev)
163 if (view.get_selection()->count_selected_rows() != 1) {
167 if (!ev->is_modifier) {
168 last_keyval = ev->keyval;
171 /* Don't let anything else handle the key press, because navigation
172 * keys will be used by GTK to change the selection/treeview cursor
180 KeyEditor::Tab::key_release_event (GdkEventKey* ev)
182 if (view.get_selection()->count_selected_rows() != 1) {
186 if (last_keyval == 0) {
190 owner.current_tab()->bind (ev, last_keyval);
196 KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
202 data_model = TreeStore::create(columns);
205 filter = TreeModelFilter::create(data_model);
206 filter->set_visible_func (sigc::mem_fun (*this, &Tab::visible_func));
208 sorted_filter = TreeModelSort::create(filter);
210 view.set_model (sorted_filter);
211 view.append_column (_("Action"), columns.name);
212 view.append_column (_("Shortcut"), columns.binding);
213 view.set_headers_visible (true);
214 view.set_headers_clickable (true);
215 view.get_selection()->set_mode (SELECTION_SINGLE);
216 view.set_reorderable (false);
217 view.set_size_request (500,300);
218 view.set_enable_search (false);
219 view.set_rules_hint (true);
220 view.set_name (X_("KeyEditorTree"));
222 view.signal_cursor_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
223 view.signal_key_press_event().connect (sigc::mem_fun (*this, &Tab::key_press_event), false);
224 view.signal_key_release_event().connect (sigc::mem_fun (*this, &Tab::key_release_event), false);
226 view.get_column(0)->set_sort_column (columns.name);
227 view.get_column(1)->set_sort_column (columns.binding);
228 data_model->set_sort_column (owner.sort_column, owner.sort_type);
229 data_model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &Tab::sort_column_changed));
231 signal_map().connect (sigc::mem_fun (*this, &Tab::tab_mapped));
234 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
237 set_border_width (12);
238 pack_start (scroller);
242 KeyEditor::Tab::action_selected ()
244 if (view.get_selection()->count_selected_rows() == 0) {
248 TreeModel::const_iterator it = view.get_selection()->get_selected();
254 if (!(*it)[columns.bindable]) {
255 owner.unbind_button.set_sensitive (false);
259 const string& binding = (*it)[columns.binding];
261 if (!binding.empty()) {
262 owner.unbind_button.set_sensitive (true);
267 KeyEditor::Tab::unbind ()
269 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
271 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
273 if (!it || !(*it)[columns.bindable]) {
277 bindings->remove (Gtkmm2ext::Bindings::Press, action_path , true);
278 (*it)[columns.binding] = string ();
280 owner.unbind_button.set_sensitive (false);
284 KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
286 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
287 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
289 /* pressed key could be upper case if Shift was used. We want all
290 single keys stored as their lower-case version, so ensure this
293 pressed_key = gdk_keyval_to_lower (pressed_key);
295 if (!it || !(*it)[columns.bindable]) {
299 GdkModifierType mod = (GdkModifierType)(Keyboard::RelevantModifierKeyMask & release_event->state);
300 Gtkmm2ext::KeyboardKey new_binding (mod, pressed_key);
302 if (bindings->is_bound (new_binding, Gtkmm2ext::Bindings::Press)) {
303 bindings_collision_dialog (owner);
307 bool result = bindings->replace (new_binding, Gtkmm2ext::Bindings::Press, action_path);
310 (*it)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
311 owner.unbind_button.set_sensitive (true);
316 KeyEditor::Tab::populate ()
318 vector<string> paths;
319 vector<string> labels;
320 vector<string> tooltips;
322 vector<Glib::RefPtr<Action> > actions;
323 typedef std::map<string,TreeIter> NodeMap;
327 bindings->get_all_actions (paths, labels, tooltips, keys, actions);
329 vector<string>::iterator k;
330 vector<string>::iterator p;
331 vector<string>::iterator t;
332 vector<string>::iterator l;
333 vector<Glib::RefPtr<Action> >::iterator a;
335 data_model->clear ();
337 for (a = actions.begin(), l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l, ++a) {
340 vector<string> parts;
342 split (*p, parts, '/');
344 string category = parts[1];
345 string action_name = parts[2];
347 if (action_name.empty()) {
351 //kinda kludgy way to avoid displaying menu items as mappable
352 if ((action_name.find ("Menu") == action_name.length() - 4) ||
353 (action_name.find ("menu") == action_name.length() - 4) ||
354 (action_name == _("RegionList"))) {
358 if ((r = nodes.find (category)) == nodes.end()) {
360 /* category/group is missing, so add it first */
363 TreeModel::Row parent;
364 rowp = data_model->append();
365 nodes[category] = rowp;
367 parent[columns.name] = category;
368 parent[columns.bindable] = false;
369 parent[columns.action] = *a;
371 /* now set up the child row that we're about to fill
372 * out with information
375 row = *(data_model->append (parent.children()));
379 /* category/group is present, so just add the child row */
381 row = *(data_model->append ((*r->second)->children()));
385 /* add this action */
387 /* use the "visible label" as the action name */
390 /* no label, try using the tooltip instead */
391 row[columns.name] = *t;
393 row[columns.name] = *l;
395 row[columns.path] = string_compose ("%1/%2", category, action_name);
396 row[columns.bindable] = true;
398 if (*k == ActionManager::unbound_string) {
399 row[columns.binding] = string();
401 row[columns.binding] = *k;
403 row[columns.action] = *a;
406 return data_model->children().size();
410 KeyEditor::Tab::sort_column_changed ()
414 if (data_model->get_sort_column_id (column, type)) {
415 owner.sort_column = column;
416 owner.sort_type = type;
421 KeyEditor::Tab::tab_mapped ()
423 data_model->set_sort_column (owner.sort_column, owner.sort_type);
428 KeyEditor::Tab::visible_func(const Gtk::TreeModel::const_iterator& iter) const
434 // never filter when search string is empty or item is a category
435 if (owner.filter_string.empty () || !(*iter)[columns.bindable]) {
440 std::string name = (*iter)[columns.name];
441 boost::to_lower (name);
442 if (name.find (owner.filter_string) != std::string::npos) {
447 std::string binding = (*iter)[columns.binding];
448 boost::to_lower (binding);
449 if (binding.find (owner.filter_string) != std::string::npos) {
457 KeyEditor::Tab::find_action_path (TreeModel::const_iterator begin, TreeModel::const_iterator end, const std::string& action_path) const
463 for (TreeModel::iterator it = begin; it != end; ++it) {
464 if (it->children()) {
465 TreeModel::iterator jt = find_action_path (it->children().begin(), it->children().end(), action_path);
466 if (jt != it->children().end()) {
470 const std::string& path = (*it)[columns.path];
471 if (action_path.compare(path) == 0) {
481 Keyboard::the_keyboard().reset_bindings ();
483 for (Tabs::iterator t = tabs.begin(); t != tabs.end(); ++t) {
484 (*t)->view.get_selection()->unselect_all ();
490 KeyEditor::current_tab ()
492 return dynamic_cast<Tab*> (notebook.get_nth_page (notebook.get_current_page()));
496 KeyEditor::search_string_updated (const std::string& filter)
498 filter_string = boost::to_lower_copy(filter);
499 current_tab ()->filter->refilter ();