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"
27 #include <boost/algorithm/string.hpp>
29 #include <gtkmm/stock.h>
30 #include <gtkmm/label.h>
31 #include <gtkmm/accelkey.h>
32 #include <gtkmm/accelmap.h>
33 #include <gtkmm/uimanager.h>
35 #include "gtkmm2ext/bindings.h"
36 #include "gtkmm2ext/utils.h"
38 #include "pbd/strsplit.h"
40 #include "ardour/filesystem_paths.h"
41 #include "ardour/profile.h"
45 #include "keyeditor.h"
54 using Gtkmm2ext::Keyboard;
55 using Gtkmm2ext::Bindings;
57 sigc::signal<void> KeyEditor::UpdateBindings;
59 void bindings_collision_dialog (Gtk::Window& parent)
61 ArdourDialog dialog (parent, _("Colliding keybindings"), true);
62 Label label (_("The key sequence is already bound. Please remove the other binding first."));
64 dialog.get_vbox()->pack_start (label, true, true);
65 dialog.add_button (_("Ok"), Gtk::RESPONSE_ACCEPT);
70 KeyEditor::KeyEditor ()
71 : ArdourWindow (_("Key Bindings"))
72 , unbind_button (_("Remove shortcut"))
73 , unbind_box (BUTTONBOX_END)
74 , filter_entry (_("Search..."), true)
76 , print_button (_("Print"))
78 , sort_type(Gtk::SORT_ASCENDING)
81 notebook.signal_switch_page ().connect (sigc::mem_fun (*this, &KeyEditor::page_change));
83 vpacker.pack_start (notebook, true, true);
85 Glib::RefPtr<Gdk::Pixbuf> icon = ARDOUR_UI_UTILS::get_icon ("search");
86 filter_entry.set_icon_from_pixbuf (icon);
87 filter_entry.set_icon_tooltip_text (_("Click to reset search string"));
88 filter_entry.signal_search_string_updated ().connect (sigc::mem_fun (*this, &KeyEditor::search_string_updated));
89 vpacker.pack_start (filter_entry, false, false);
91 Label* hint = manage (new Label (_("Select an action, then press the key(s) to (re)set its shortcut")));
93 unbind_box.set_spacing (6);
94 unbind_box.pack_start (*hint, false, true);
95 unbind_box.pack_start (unbind_button, false, false);
96 unbind_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::unbind));
98 vpacker.pack_start (unbind_box, false, false);
100 unbind_button.show ();
102 reset_button.add (reset_label);
103 reset_label.set_markup (string_compose ("<span size=\"large\" weight=\"bold\">%1</span>", _("Reset Bindings to Defaults")));
105 print_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::print));
107 reset_box.pack_start (reset_button, true, false);
108 reset_box.pack_start (print_button, true, false);
110 reset_button.show ();
112 print_button.show ();
113 reset_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::reset));
114 vpacker.pack_start (reset_box, false, false);
118 unbind_button.set_sensitive (false);
119 UpdateBindings.connect (sigc::mem_fun (*this, &KeyEditor::refresh));
123 KeyEditor::add_tab (string const & name, Bindings& bindings)
125 Tab* t = new Tab (*this, name, &bindings);
127 if (t->populate () == 0) {
135 notebook.append_page (*t, name);
140 KeyEditor::remove_tab (string const &name)
142 guint npages = notebook.get_n_pages ();
144 for (guint n = 0; n < npages; ++n) {
145 Widget* w = notebook.get_nth_page (n);
146 Tab* tab = dynamic_cast<Tab*> (w);
148 if (tab->name == name) {
149 notebook.remove_page (*w);
154 cerr << "Removed " << name << endl;
160 current_tab()->unbind ();
164 KeyEditor::page_change (GtkNotebookPage*, guint)
166 current_tab()->view.get_selection()->unselect_all ();
167 unbind_button.set_sensitive (false);
171 KeyEditor::Tab::key_press_event (GdkEventKey* ev)
173 if (view.get_selection()->count_selected_rows() != 1) {
177 if (!ev->is_modifier) {
178 last_keyval = ev->keyval;
181 /* Don't let anything else handle the key press, because navigation
182 * keys will be used by GTK to change the selection/treeview cursor
190 KeyEditor::Tab::key_release_event (GdkEventKey* ev)
192 if (view.get_selection()->count_selected_rows() != 1) {
196 if (last_keyval == 0) {
200 owner.current_tab()->bind (ev, last_keyval);
206 KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
212 data_model = TreeStore::create(columns);
215 filter = TreeModelFilter::create(data_model);
216 filter->set_visible_func (sigc::mem_fun (*this, &Tab::visible_func));
218 sorted_filter = TreeModelSort::create(filter);
220 view.set_model (sorted_filter);
221 view.append_column (_("Action"), columns.name);
222 view.append_column (_("Shortcut"), columns.binding);
223 view.set_headers_visible (true);
224 view.set_headers_clickable (true);
225 view.get_selection()->set_mode (SELECTION_SINGLE);
226 view.set_reorderable (false);
227 view.set_size_request (500,300);
228 view.set_enable_search (false);
229 view.set_rules_hint (true);
230 view.set_name (X_("KeyEditorTree"));
232 view.signal_cursor_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
233 view.signal_key_press_event().connect (sigc::mem_fun (*this, &Tab::key_press_event), false);
234 view.signal_key_release_event().connect (sigc::mem_fun (*this, &Tab::key_release_event), false);
236 view.get_column(0)->set_sort_column (columns.name);
237 view.get_column(1)->set_sort_column (columns.binding);
238 data_model->set_sort_column (owner.sort_column, owner.sort_type);
239 data_model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &Tab::sort_column_changed));
241 signal_map().connect (sigc::mem_fun (*this, &Tab::tab_mapped));
244 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
247 set_border_width (12);
248 pack_start (scroller);
252 KeyEditor::Tab::action_selected ()
254 if (view.get_selection()->count_selected_rows() == 0) {
258 TreeModel::const_iterator it = view.get_selection()->get_selected();
264 if (!(*it)[columns.bindable]) {
265 owner.unbind_button.set_sensitive (false);
269 const string& binding = (*it)[columns.binding];
271 if (!binding.empty()) {
272 owner.unbind_button.set_sensitive (true);
277 KeyEditor::Tab::unbind ()
279 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
281 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
283 if (!it || !(*it)[columns.bindable]) {
287 bindings->remove (Gtkmm2ext::Bindings::Press, action_path , true);
288 (*it)[columns.binding] = string ();
290 owner.unbind_button.set_sensitive (false);
294 KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
296 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
297 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
299 /* pressed key could be upper case if Shift was used. We want all
300 single keys stored as their lower-case version, so ensure this
303 pressed_key = gdk_keyval_to_lower (pressed_key);
305 if (!it || !(*it)[columns.bindable]) {
309 GdkModifierType mod = (GdkModifierType)(Keyboard::RelevantModifierKeyMask & release_event->state);
310 Gtkmm2ext::KeyboardKey new_binding (mod, pressed_key);
312 if (bindings->is_bound (new_binding, Gtkmm2ext::Bindings::Press)) {
313 bindings_collision_dialog (owner);
317 bool result = bindings->replace (new_binding, Gtkmm2ext::Bindings::Press, action_path);
320 (*it)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
321 owner.unbind_button.set_sensitive (true);
326 KeyEditor::Tab::populate ()
328 vector<string> paths;
329 vector<string> labels;
330 vector<string> tooltips;
332 vector<Glib::RefPtr<Action> > actions;
333 typedef std::map<string,TreeIter> NodeMap;
337 bindings->get_all_actions (paths, labels, tooltips, keys, actions);
339 vector<string>::iterator k;
340 vector<string>::iterator p;
341 vector<string>::iterator t;
342 vector<string>::iterator l;
343 vector<Glib::RefPtr<Action> >::iterator a;
345 data_model->clear ();
347 for (a = actions.begin(), l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l, ++a) {
350 vector<string> parts;
352 split (*p, parts, '/');
354 string category = parts[1];
355 string action_name = parts[2];
357 if (action_name.empty()) {
361 //kinda kludgy way to avoid displaying menu items as mappable
362 if ((action_name.find ("Menu") == action_name.length() - 4) ||
363 (action_name.find ("menu") == action_name.length() - 4) ||
364 (action_name == _("RegionList"))) {
368 if ((r = nodes.find (category)) == nodes.end()) {
370 /* category/group is missing, so add it first */
373 TreeModel::Row parent;
374 rowp = data_model->append();
375 nodes[category] = rowp;
377 parent[columns.name] = category;
378 parent[columns.bindable] = false;
379 parent[columns.action] = *a;
381 /* now set up the child row that we're about to fill
382 * out with information
385 row = *(data_model->append (parent.children()));
389 /* category/group is present, so just add the child row */
391 row = *(data_model->append ((*r->second)->children()));
395 /* add this action */
397 /* use the "visible label" as the action name */
400 /* no label, try using the tooltip instead */
401 row[columns.name] = *t;
403 row[columns.name] = *l;
405 row[columns.path] = string_compose ("%1/%2", category, action_name);
406 row[columns.bindable] = true;
408 if (*k == ActionManager::unbound_string) {
409 row[columns.binding] = string();
411 row[columns.binding] = *k;
413 row[columns.action] = *a;
416 return data_model->children().size();
420 KeyEditor::Tab::sort_column_changed ()
424 if (data_model->get_sort_column_id (column, type)) {
425 owner.sort_column = column;
426 owner.sort_type = type;
431 KeyEditor::Tab::tab_mapped ()
433 data_model->set_sort_column (owner.sort_column, owner.sort_type);
438 KeyEditor::Tab::visible_func(const Gtk::TreeModel::const_iterator& iter) const
444 // never filter when search string is empty or item is a category
445 if (owner.filter_string.empty () || !(*iter)[columns.bindable]) {
450 std::string name = (*iter)[columns.name];
451 boost::to_lower (name);
452 if (name.find (owner.filter_string) != std::string::npos) {
457 std::string binding = (*iter)[columns.binding];
458 boost::to_lower (binding);
459 if (binding.find (owner.filter_string) != std::string::npos) {
467 KeyEditor::Tab::find_action_path (TreeModel::const_iterator begin, TreeModel::const_iterator end, const std::string& action_path) const
473 for (TreeModel::iterator it = begin; it != end; ++it) {
474 if (it->children()) {
475 TreeModel::iterator jt = find_action_path (it->children().begin(), it->children().end(), action_path);
476 if (jt != it->children().end()) {
480 const std::string& path = (*it)[columns.path];
481 if (action_path.compare(path) == 0) {
491 Keyboard::the_keyboard().reset_bindings ();
496 KeyEditor::refresh ()
498 for (Tabs::iterator t = tabs.begin(); t != tabs.end(); ++t) {
499 (*t)->view.get_selection()->unselect_all ();
505 KeyEditor::current_tab ()
507 return dynamic_cast<Tab*> (notebook.get_nth_page (notebook.get_current_page()));
511 KeyEditor::search_string_updated (const std::string& filter)
513 filter_string = boost::to_lower_copy(filter);
514 KeyEditor::Tab* tab = current_tab ();
516 tab->filter->refilter ();
521 KeyEditor::print () const
525 snprintf (templ, sizeof (templ), "akprintXXXXXX");
527 int fd = mkstemp (templ);
531 Bindings::save_all_bindings_as_html (cerr);