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/accelkey.h>
34 #include <gtkmm/accelmap.h>
35 #include <gtkmm/label.h>
36 #include <gtkmm/separator.h>
37 #include <gtkmm/stock.h>
38 #include <gtkmm/treemodelsort.h>
39 #include <gtkmm/uimanager.h>
41 #include "gtkmm2ext/bindings.h"
42 #include "gtkmm2ext/utils.h"
44 #include "pbd/error.h"
45 #include "pbd/openuri.h"
46 #include "pbd/strsplit.h"
48 #include "ardour/filesystem_paths.h"
49 #include "ardour/profile.h"
53 #include "keyeditor.h"
62 using Gtkmm2ext::Keyboard;
63 using Gtkmm2ext::Bindings;
65 sigc::signal<void> KeyEditor::UpdateBindings;
67 static void bindings_collision_dialog (Gtk::Window& parent, const std::string& bound_name)
69 ArdourDialog dialog (parent, _("Colliding keybindings"), true);
70 Label label (string_compose(
71 _("The key sequence is already bound to '%1'. Please remove the other binding first."), bound_name));
73 dialog.get_vbox()->pack_start (label, true, true);
74 dialog.add_button (_("Ok"), Gtk::RESPONSE_ACCEPT);
79 KeyEditor::KeyEditor ()
80 : ArdourWindow (_("Keyboard Shortcuts"))
81 , unbind_button (_("Remove shortcut"))
82 , unbind_box (BUTTONBOX_END)
83 , filter_entry (_("Search..."), true)
86 , sort_type(Gtk::SORT_ASCENDING)
89 notebook.signal_switch_page ().connect (sigc::mem_fun (*this, &KeyEditor::page_change));
91 vpacker.pack_start (notebook, true, true);
93 Glib::RefPtr<Gdk::Pixbuf> icon = ARDOUR_UI_UTILS::get_icon ("search");
94 filter_entry.set_icon_from_pixbuf (icon);
95 filter_entry.set_icon_tooltip_text (_("Click to reset search string"));
96 filter_entry.signal_search_string_updated ().connect (sigc::mem_fun (*this, &KeyEditor::search_string_updated));
97 vpacker.pack_start (filter_entry, false, false);
99 Label* hint = manage (new Label (_("To remove a shortcut, select an action then press this: ")));
101 unbind_box.pack_start (*hint, false, true);
102 unbind_box.pack_start (unbind_button, false, false);
103 unbind_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::unbind));
105 vpacker.set_spacing (4);
106 vpacker.pack_start (unbind_box, false, false);
108 unbind_button.show ();
110 reset_button.add (reset_label);
111 reset_label.set_markup (string_compose (" <span size=\"large\" weight=\"bold\">%1</span> ", _("Reset Bindings to Defaults")));
113 print_button.add (print_label);
114 print_label.set_markup (string_compose (" <span size=\"large\" weight=\"bold\">%1</span> ", _("Print Bindings (to your web browser)")));
116 print_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::print));
118 reset_box.pack_start (reset_button, true, false);
119 reset_box.pack_start (print_button, true, false);
121 reset_button.show ();
123 print_button.show ();
124 reset_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::reset));
125 vpacker.pack_start (*(manage (new HSeparator())), false, false, 5);
126 vpacker.pack_start (reset_box, false, false);
130 unbind_button.set_sensitive (false);
131 _refresh_connection = UpdateBindings.connect (sigc::mem_fun (*this, &KeyEditor::refresh));
135 KeyEditor::add_tab (string const & name, Bindings& bindings)
137 Tab* t = new Tab (*this, name, &bindings);
139 if (t->populate () == 0) {
147 notebook.append_page (*t, name);
152 KeyEditor::remove_tab (string const &name)
154 guint npages = notebook.get_n_pages ();
156 for (guint n = 0; n < npages; ++n) {
157 Widget* w = notebook.get_nth_page (n);
158 Tab* tab = dynamic_cast<Tab*> (w);
160 if (tab->name == name) {
161 notebook.remove_page (*w);
166 cerr << "Removed " << name << endl;
172 current_tab()->unbind ();
176 KeyEditor::page_change (GtkNotebookPage*, guint)
178 current_tab()->view.get_selection()->unselect_all ();
179 unbind_button.set_sensitive (false);
183 KeyEditor::Tab::key_press_event (GdkEventKey* ev)
185 if (view.get_selection()->count_selected_rows() != 1) {
189 if (!ev->is_modifier) {
190 last_keyval = ev->keyval;
193 /* Don't let anything else handle the key press, because navigation
194 * keys will be used by GTK to change the selection/treeview cursor
202 KeyEditor::Tab::key_release_event (GdkEventKey* ev)
204 if (view.get_selection()->count_selected_rows() != 1) {
208 if (last_keyval == 0) {
212 owner.current_tab()->bind (ev, last_keyval);
218 KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
224 data_model = TreeStore::create(columns);
227 filter = TreeModelFilter::create(data_model);
228 filter->set_visible_func (sigc::mem_fun (*this, &Tab::visible_func));
230 sorted_filter = TreeModelSort::create(filter);
232 view.set_model (sorted_filter);
233 view.append_column (_("Action"), columns.name);
234 view.append_column (_("Shortcut"), columns.binding);
235 view.set_headers_visible (true);
236 view.set_headers_clickable (true);
237 view.get_selection()->set_mode (SELECTION_SINGLE);
238 view.set_reorderable (false);
239 view.set_size_request (500,300);
240 view.set_enable_search (false);
241 view.set_rules_hint (true);
242 view.set_name (X_("KeyEditorTree"));
244 view.signal_cursor_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
245 view.signal_key_press_event().connect (sigc::mem_fun (*this, &Tab::key_press_event), false);
246 view.signal_key_release_event().connect (sigc::mem_fun (*this, &Tab::key_release_event), false);
248 view.get_column(0)->set_sort_column (columns.name);
249 view.get_column(1)->set_sort_column (columns.binding);
250 data_model->set_sort_column (owner.sort_column, owner.sort_type);
251 data_model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &Tab::sort_column_changed));
253 signal_map().connect (sigc::mem_fun (*this, &Tab::tab_mapped));
256 scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
259 set_border_width (12);
260 pack_start (scroller);
264 KeyEditor::Tab::action_selected ()
266 if (view.get_selection()->count_selected_rows() == 0) {
270 TreeModel::const_iterator it = view.get_selection()->get_selected();
276 if (!(*it)[columns.bindable]) {
277 owner.unbind_button.set_sensitive (false);
281 const string& binding = (*it)[columns.binding];
283 if (!binding.empty()) {
284 owner.unbind_button.set_sensitive (true);
289 KeyEditor::Tab::unbind ()
291 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
293 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
295 if (!it || !(*it)[columns.bindable]) {
299 bindings->remove (Gtkmm2ext::Bindings::Press, action_path , true);
300 (*it)[columns.binding] = string ();
302 owner.unbind_button.set_sensitive (false);
306 KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
308 const std::string& action_path = (*view.get_selection()->get_selected())[columns.path];
309 TreeModel::iterator it = find_action_path (data_model->children().begin(), data_model->children().end(), action_path);
311 /* pressed key could be upper case if Shift was used. We want all
312 single keys stored as their lower-case version, so ensure this
315 pressed_key = gdk_keyval_to_lower (pressed_key);
317 if (!it || !(*it)[columns.bindable]) {
321 GdkModifierType mod = (GdkModifierType)(Keyboard::RelevantModifierKeyMask & release_event->state);
322 Gtkmm2ext::KeyboardKey new_binding (mod, pressed_key);
324 if (bindings->is_bound (new_binding, Gtkmm2ext::Bindings::Press)) {
325 bindings_collision_dialog (owner, bindings->bound_name (new_binding, Gtkmm2ext::Bindings::Press));
329 bool result = bindings->replace (new_binding, Gtkmm2ext::Bindings::Press, action_path);
332 (*it)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
333 owner.unbind_button.set_sensitive (true);
338 KeyEditor::Tab::populate ()
340 vector<string> paths;
341 vector<string> labels;
342 vector<string> tooltips;
344 vector<Glib::RefPtr<Action> > actions;
345 typedef std::map<string,TreeIter> NodeMap;
349 bindings->get_all_actions (paths, labels, tooltips, keys, actions);
351 vector<string>::iterator k;
352 vector<string>::iterator p;
353 vector<string>::iterator t;
354 vector<string>::iterator l;
355 vector<Glib::RefPtr<Action> >::iterator a;
357 data_model->clear ();
359 for (a = actions.begin(), l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l, ++a) {
362 vector<string> parts;
364 split (*p, parts, '/');
366 string category = parts[1];
367 string action_name = parts[2];
369 if (action_name.empty()) {
373 //kinda kludgy way to avoid displaying menu items as mappable
374 if ((action_name.find ("Menu") == action_name.length() - 4) ||
375 (action_name.find ("menu") == action_name.length() - 4) ||
376 (action_name == _("RegionList"))) {
380 if ((r = nodes.find (category)) == nodes.end()) {
382 /* category/group is missing, so add it first */
385 TreeModel::Row parent;
386 rowp = data_model->append();
387 nodes[category] = rowp;
389 parent[columns.name] = category;
390 parent[columns.bindable] = false;
391 parent[columns.action] = *a;
393 /* now set up the child row that we're about to fill
394 * out with information
397 row = *(data_model->append (parent.children()));
401 /* category/group is present, so just add the child row */
403 row = *(data_model->append ((*r->second)->children()));
407 /* add this action */
409 /* use the "visible label" as the action name */
412 /* no label, try using the tooltip instead */
413 row[columns.name] = *t;
415 row[columns.name] = *l;
417 row[columns.path] = string_compose ("%1/%2", category, action_name);
418 row[columns.bindable] = true;
420 if (*k == ActionManager::unbound_string) {
421 row[columns.binding] = string();
423 row[columns.binding] = *k;
425 row[columns.action] = *a;
428 return data_model->children().size();
432 KeyEditor::Tab::sort_column_changed ()
436 if (data_model->get_sort_column_id (column, type)) {
437 owner.sort_column = column;
438 owner.sort_type = type;
443 KeyEditor::Tab::tab_mapped ()
445 data_model->set_sort_column (owner.sort_column, owner.sort_type);
450 KeyEditor::Tab::visible_func(const Gtk::TreeModel::const_iterator& iter) const
456 // never filter when search string is empty or item is a category
457 if (owner.filter_string.empty () || !(*iter)[columns.bindable]) {
462 std::string name = (*iter)[columns.name];
463 boost::to_lower (name);
464 if (name.find (owner.filter_string) != std::string::npos) {
469 std::string binding = (*iter)[columns.binding];
470 boost::to_lower (binding);
471 if (binding.find (owner.filter_string) != std::string::npos) {
479 KeyEditor::Tab::find_action_path (TreeModel::const_iterator begin, TreeModel::const_iterator end, const std::string& action_path) const
485 for (TreeModel::iterator it = begin; it != end; ++it) {
486 if (it->children()) {
487 TreeModel::iterator jt = find_action_path (it->children().begin(), it->children().end(), action_path);
488 if (jt != it->children().end()) {
492 const std::string& path = (*it)[columns.path];
493 if (action_path.compare(path) == 0) {
503 Keyboard::the_keyboard().reset_bindings ();
508 KeyEditor::refresh ()
510 for (Tabs::iterator t = tabs.begin(); t != tabs.end(); ++t) {
511 (*t)->view.get_selection()->unselect_all ();
517 KeyEditor::current_tab ()
519 return dynamic_cast<Tab*> (notebook.get_nth_page (notebook.get_current_page()));
523 KeyEditor::search_string_updated (const std::string& filter)
525 filter_string = boost::to_lower_copy(filter);
526 KeyEditor::Tab* tab = current_tab ();
528 tab->filter->refilter ();
533 KeyEditor::print () const
536 Bindings::save_all_bindings_as_html (sstr);
538 if (sstr.str().empty()) {
547 if ((fd = g_file_open_tmp ("akprintXXXXXX.html", &file_name, &err)) < 0) {
549 error << string_compose (_("Could not open temporary file to print bindings (%1)"), err->message) << endmsg;
555 #ifdef PLATFORM_WINDOWS
561 if (!g_file_set_contents (file_name, sstr.str().c_str(), sstr.str().size(), &err)) {
562 #ifndef PLATFORM_WINDOWS
565 g_unlink (file_name);
567 error << string_compose (_("Could not save bindings to file (%1)"), err->message) << endmsg;
573 #ifndef PLATFORM_WINDOWS
577 PBD::open_uri (string_compose ("file:///%1", file_name));