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"
28 #include <boost/algorithm/string.hpp>
31 #include <glib/gstdio.h>
33 #include <gtkmm/stock.h>
34 #include <gtkmm/label.h>
35 #include <gtkmm/accelkey.h>
36 #include <gtkmm/accelmap.h>
37 #include <gtkmm/uimanager.h>
39 #include "gtkmm2ext/bindings.h"
40 #include "gtkmm2ext/utils.h"
42 #include "pbd/error.h"
43 #include "pbd/openuri.h"
44 #include "pbd/strsplit.h"
46 #include "ardour/filesystem_paths.h"
47 #include "ardour/profile.h"
51 #include "keyeditor.h"
60 using Gtkmm2ext::Keyboard;
61 using Gtkmm2ext::Bindings;
63 sigc::signal<void> KeyEditor::UpdateBindings;
65 static void bindings_collision_dialog (Gtk::Window& parent, const std::string& bound_name)
67 ArdourDialog dialog (parent, _("Colliding keybindings"), true);
68 Label label (string_compose(
69 _("The key sequence is already bound to '%1'. Please remove the other binding first."), bound_name));
71 dialog.get_vbox()->pack_start (label, true, true);
72 dialog.add_button (_("Ok"), Gtk::RESPONSE_ACCEPT);
77 KeyEditor::KeyEditor ()
78 : ArdourWindow (_("Keyboard Shortcuts"))
79 , unbind_button (_("Remove shortcut"))
80 , unbind_box (BUTTONBOX_END)
81 , filter_entry (_("Search..."), true)
84 , sort_type(Gtk::SORT_ASCENDING)
87 notebook.signal_switch_page ().connect (sigc::mem_fun (*this, &KeyEditor::page_change));
89 vpacker.pack_start (notebook, true, true);
91 Glib::RefPtr<Gdk::Pixbuf> icon = ARDOUR_UI_UTILS::get_icon ("search");
92 filter_entry.set_icon_from_pixbuf (icon);
93 filter_entry.set_icon_tooltip_text (_("Click to reset search string"));
94 filter_entry.signal_search_string_updated ().connect (sigc::mem_fun (*this, &KeyEditor::search_string_updated));
95 vpacker.pack_start (filter_entry, false, false);
97 Label* hint = manage (new Label (_("To remove a shortcut, select an action then press this: ")));
99 unbind_box.pack_start (*hint, false, true);
100 unbind_box.pack_start (unbind_button, false, false);
101 unbind_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::unbind));
103 vpacker.set_spacing (4);
104 vpacker.pack_start (unbind_box, false, false);
106 unbind_button.show ();
108 reset_button.add (reset_label);
109 reset_label.set_markup (string_compose (" <span size=\"large\" weight=\"bold\">%1</span> ", _("Reset Bindings to Defaults")));
111 print_button.add (print_label);
112 print_label.set_markup (string_compose (" <span size=\"large\" weight=\"bold\">%1</span> ", _("Print Bindings (to your web browser)")));
114 print_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::print));
116 reset_box.pack_start (reset_button, true, false);
117 reset_box.pack_start (print_button, true, false);
119 reset_button.show ();
121 print_button.show ();
122 reset_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::reset));
123 vpacker.pack_start (*(manage (new HSeparator())), false, false, 5);
124 vpacker.pack_start (reset_box, false, false);
128 unbind_button.set_sensitive (false);
129 _refresh_connection = UpdateBindings.connect (sigc::mem_fun (*this, &KeyEditor::refresh));
133 KeyEditor::add_tab (string const & name, Bindings& bindings)
135 Tab* t = new Tab (*this, name, &bindings);
137 if (t->populate () == 0) {
145 notebook.append_page (*t, name);
150 KeyEditor::remove_tab (string const &name)
152 guint npages = notebook.get_n_pages ();
154 for (guint n = 0; n < npages; ++n) {
155 Widget* w = notebook.get_nth_page (n);
156 Tab* tab = dynamic_cast<Tab*> (w);
158 if (tab->name == name) {
159 notebook.remove_page (*w);
164 cerr << "Removed " << name << endl;
170 current_tab()->unbind ();
174 KeyEditor::page_change (GtkNotebookPage*, guint)
176 current_tab()->view.get_selection()->unselect_all ();
177 unbind_button.set_sensitive (false);
181 KeyEditor::Tab::key_press_event (GdkEventKey* ev)
183 if (view.get_selection()->count_selected_rows() != 1) {
187 if (!ev->is_modifier) {
188 last_keyval = ev->keyval;
191 /* Don't let anything else handle the key press, because navigation
192 * keys will be used by GTK to change the selection/treeview cursor
200 KeyEditor::Tab::key_release_event (GdkEventKey* ev)
202 if (view.get_selection()->count_selected_rows() != 1) {
206 if (last_keyval == 0) {
210 owner.current_tab()->bind (ev, last_keyval);
216 KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
222 data_model = TreeStore::create(columns);
225 filter = TreeModelFilter::create(data_model);
226 filter->set_visible_func (sigc::mem_fun (*this, &Tab::visible_func));
228 sorted_filter = TreeModelSort::create(filter);
230 view.set_model (sorted_filter);
231 view.append_column (_("Action"), columns.name);
232 view.append_column (_("Shortcut"), columns.binding);
233 view.set_headers_visible (true);
234 view.set_headers_clickable (true);
235 view.get_selection()->set_mode (SELECTION_SINGLE);
236 view.set_reorderable (false);
237 view.set_size_request (500,300);
238 view.set_enable_search (false);
239 view.set_rules_hint (true);
240 view.set_name (X_("KeyEditorTree"));
242 view.signal_cursor_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
243 view.signal_key_press_event().connect (sigc::mem_fun (*this, &Tab::key_press_event), false);
244 view.signal_key_release_event().connect (sigc::mem_fun (*this, &Tab::key_release_event), false);
246 view.get_column(0)->set_sort_column (columns.name);
247 view.get_column(1)->set_sort_column (columns.binding);
248 data_model->set_sort_column (owner.sort_column, owner.sort_type);
249 data_model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &Tab::sort_column_changed));
251 signal_map().connect (sigc::mem_fun (*this, &Tab::tab_mapped));
254 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
257 set_border_width (12);
258 pack_start (scroller);
262 KeyEditor::Tab::action_selected ()
264 if (view.get_selection()->count_selected_rows() == 0) {
268 TreeModel::const_iterator it = view.get_selection()->get_selected();
274 if (!(*it)[columns.bindable]) {
275 owner.unbind_button.set_sensitive (false);
279 const string& binding = (*it)[columns.binding];
281 if (!binding.empty()) {
282 owner.unbind_button.set_sensitive (true);
287 KeyEditor::Tab::unbind ()
289 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
291 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
293 if (!it || !(*it)[columns.bindable]) {
297 bindings->remove (Gtkmm2ext::Bindings::Press, action_path , true);
298 (*it)[columns.binding] = string ();
300 owner.unbind_button.set_sensitive (false);
304 KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
306 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
307 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
309 /* pressed key could be upper case if Shift was used. We want all
310 single keys stored as their lower-case version, so ensure this
313 pressed_key = gdk_keyval_to_lower (pressed_key);
315 if (!it || !(*it)[columns.bindable]) {
319 GdkModifierType mod = (GdkModifierType)(Keyboard::RelevantModifierKeyMask & release_event->state);
320 Gtkmm2ext::KeyboardKey new_binding (mod, pressed_key);
322 if (bindings->is_bound (new_binding, Gtkmm2ext::Bindings::Press)) {
323 bindings_collision_dialog (owner, bindings->bound_name (new_binding, Gtkmm2ext::Bindings::Press));
327 bool result = bindings->replace (new_binding, Gtkmm2ext::Bindings::Press, action_path);
330 (*it)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
331 owner.unbind_button.set_sensitive (true);
336 KeyEditor::Tab::populate ()
338 vector<string> paths;
339 vector<string> labels;
340 vector<string> tooltips;
342 vector<Glib::RefPtr<Action> > actions;
343 typedef std::map<string,TreeIter> NodeMap;
347 bindings->get_all_actions (paths, labels, tooltips, keys, actions);
349 vector<string>::iterator k;
350 vector<string>::iterator p;
351 vector<string>::iterator t;
352 vector<string>::iterator l;
353 vector<Glib::RefPtr<Action> >::iterator a;
355 data_model->clear ();
357 for (a = actions.begin(), l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l, ++a) {
360 vector<string> parts;
362 split (*p, parts, '/');
364 string category = parts[1];
365 string action_name = parts[2];
367 if (action_name.empty()) {
371 //kinda kludgy way to avoid displaying menu items as mappable
372 if ((action_name.find ("Menu") == action_name.length() - 4) ||
373 (action_name.find ("menu") == action_name.length() - 4) ||
374 (action_name == _("RegionList"))) {
378 if ((r = nodes.find (category)) == nodes.end()) {
380 /* category/group is missing, so add it first */
383 TreeModel::Row parent;
384 rowp = data_model->append();
385 nodes[category] = rowp;
387 parent[columns.name] = category;
388 parent[columns.bindable] = false;
389 parent[columns.action] = *a;
391 /* now set up the child row that we're about to fill
392 * out with information
395 row = *(data_model->append (parent.children()));
399 /* category/group is present, so just add the child row */
401 row = *(data_model->append ((*r->second)->children()));
405 /* add this action */
407 /* use the "visible label" as the action name */
410 /* no label, try using the tooltip instead */
411 row[columns.name] = *t;
413 row[columns.name] = *l;
415 row[columns.path] = string_compose ("%1/%2", category, action_name);
416 row[columns.bindable] = true;
418 if (*k == ActionManager::unbound_string) {
419 row[columns.binding] = string();
421 row[columns.binding] = *k;
423 row[columns.action] = *a;
426 return data_model->children().size();
430 KeyEditor::Tab::sort_column_changed ()
434 if (data_model->get_sort_column_id (column, type)) {
435 owner.sort_column = column;
436 owner.sort_type = type;
441 KeyEditor::Tab::tab_mapped ()
443 data_model->set_sort_column (owner.sort_column, owner.sort_type);
448 KeyEditor::Tab::visible_func(const Gtk::TreeModel::const_iterator& iter) const
454 // never filter when search string is empty or item is a category
455 if (owner.filter_string.empty () || !(*iter)[columns.bindable]) {
460 std::string name = (*iter)[columns.name];
461 boost::to_lower (name);
462 if (name.find (owner.filter_string) != std::string::npos) {
467 std::string binding = (*iter)[columns.binding];
468 boost::to_lower (binding);
469 if (binding.find (owner.filter_string) != std::string::npos) {
477 KeyEditor::Tab::find_action_path (TreeModel::const_iterator begin, TreeModel::const_iterator end, const std::string& action_path) const
483 for (TreeModel::iterator it = begin; it != end; ++it) {
484 if (it->children()) {
485 TreeModel::iterator jt = find_action_path (it->children().begin(), it->children().end(), action_path);
486 if (jt != it->children().end()) {
490 const std::string& path = (*it)[columns.path];
491 if (action_path.compare(path) == 0) {
501 Keyboard::the_keyboard().reset_bindings ();
506 KeyEditor::refresh ()
508 for (Tabs::iterator t = tabs.begin(); t != tabs.end(); ++t) {
509 (*t)->view.get_selection()->unselect_all ();
515 KeyEditor::current_tab ()
517 return dynamic_cast<Tab*> (notebook.get_nth_page (notebook.get_current_page()));
521 KeyEditor::search_string_updated (const std::string& filter)
523 filter_string = boost::to_lower_copy(filter);
524 KeyEditor::Tab* tab = current_tab ();
526 tab->filter->refilter ();
531 KeyEditor::print () const
534 Bindings::save_all_bindings_as_html (sstr);
536 if (sstr.str().empty()) {
545 if ((fd = g_file_open_tmp ("akprintXXXXXX.html", &file_name, &err)) < 0) {
547 error << string_compose (_("Could not open temporary file to print bindings (%1)"), err->message) << endmsg;
553 #ifdef PLATFORM_WINDOWS
559 if (!g_file_set_contents (file_name, sstr.str().c_str(), sstr.str().size(), &err)) {
560 #ifndef PLATFORM_WINDOWS
563 g_unlink (file_name);
565 error << string_compose (_("Could not save bindings to file (%1)"), err->message) << endmsg;
571 #ifndef PLATFORM_WINDOWS
575 PBD::open_uri (string_compose ("file:///%1", file_name));