remove all trace of SAE from source code.
[ardour.git] / gtk2_ardour / keyeditor.cc
index 07aad652afef65209ae104e64c9240154ddaecbc..d8d1f2d59263d75f2b01bbfea492da5d55b1a701 100644 (file)
@@ -1,11 +1,41 @@
+/*
+    Copyright (C) 2002 Paul Davis
+
+    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., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+#ifdef WAF_BUILD
+#include "gtk2ardour-config.h"
+#endif
+
 #include <map>
 
 #include <gtkmm/stock.h>
+#include <gtkmm/label.h>
 #include <gtkmm/accelkey.h>
 #include <gtkmm/accelmap.h>
 #include <gtkmm/uimanager.h>
 
-#include <pbd/strsplit.h>
+#include "gtkmm2ext/bindings.h"
+#include "gtkmm2ext/utils.h"
+
+#include "pbd/strsplit.h"
+
+#include "ardour/filesystem_paths.h"
+#include "ardour/profile.h"
 
 #include "actions.h"
 #include "keyboard.h"
 using namespace std;
 using namespace Gtk;
 using namespace Gdk;
+using namespace PBD;
+
+using Gtkmm2ext::Keyboard;
+using Gtkmm2ext::Bindings;
 
 KeyEditor::KeyEditor ()
-       : ArdourDialog (_("Keybinding Editor"), false)
+       : ArdourWindow (_("Key Bindings"))
+       , unbind_button (_("Remove shortcut"))
+       , unbind_box (BUTTONBOX_END)
+
+{
+       last_keyval = 0;
+
+       notebook.signal_switch_page ().connect (sigc::mem_fun (*this, &KeyEditor::page_change));
+
+       vpacker.pack_start (notebook, true, true);
+
+       Label* hint = manage (new Label (_("Select an action, then press the key(s) to (re)set its shortcut")));
+       hint->show ();
+       unbind_box.set_spacing (6);
+       unbind_box.pack_start (*hint, false, true);
+       unbind_box.pack_start (unbind_button, false, false);
+       unbind_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::unbind));
+
+       vpacker.pack_start (unbind_box, false, false);
+       unbind_box.show ();
+       unbind_button.show ();
+
+       reset_button.add (reset_label);
+       reset_label.set_markup (string_compose ("<span size=\"large\" weight=\"bold\">%1</span>", _("Reset Bindings to Defaults")));
+
+       reset_box.pack_start (reset_button, true, false);
+       reset_box.show ();
+       reset_button.show ();
+       reset_label.show ();
+       reset_button.signal_clicked().connect (sigc::mem_fun (*this, &KeyEditor::reset));
+       vpacker.pack_start (reset_box, false, false);
+
+       add (vpacker);
+
+       unbind_button.set_sensitive (false);
+}
+
+void
+KeyEditor::add_tab (string const & name, Bindings& bindings)
+{
+       Tab* t = new Tab (*this, name, &bindings);
+       t->populate ();
+       t->show_all ();
+       notebook.append_page (*t, name);
+}
+
+void
+KeyEditor::unbind ()
+{
+       current_tab()->unbind ();
+}
+
+void
+KeyEditor::page_change (GtkNotebookPage*, guint)
+{
+       current_tab()->view.get_selection()->unselect_all ();
+       unbind_button.set_sensitive (false);
+}
+
+bool
+KeyEditor::on_key_press_event (GdkEventKey* ev)
+{
+       if (!ev->is_modifier) {
+               last_keyval = ev->keyval;
+       }
+
+       /* Don't let anything else handle the key press, because navigation
+        * keys will be used by GTK to change the selection/treeview cursor
+        * position
+        */
+
+       return true;
+}
+
+bool
+KeyEditor::on_key_release_event (GdkEventKey* ev)
+{
+       if (last_keyval == 0) {
+               return false;
+       }
+
+       current_tab()->bind (ev, last_keyval);
+
+       last_keyval = 0;
+       return true;
+}
+
+KeyEditor::Tab::Tab (KeyEditor& ke, string const & str, Bindings* b)
+       : owner (ke)
+       , name (str)
+       , bindings (b)
 {
        model = TreeStore::create(columns);
 
        view.set_model (model);
-       view.append_column (_("Action"), columns.action);
-       view.append_column (_("Binding"), columns.binding);
+       view.append_column (_("Action"), columns.name);
+       view.append_column (_("Shortcut"), columns.binding);
        view.set_headers_visible (true);
        view.get_selection()->set_mode (SELECTION_SINGLE);
        view.set_reorderable (false);
-       view.set_size_request (300,200);
+       view.set_size_request (500,300);
        view.set_enable_search (false);
        view.set_rules_hint (true);
        view.set_name (X_("KeyEditorTree"));
 
-       view.get_selection()->signal_changed().connect (mem_fun (*this, &KeyEditor::action_selected));
-       
+       view.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &Tab::action_selected));
+
        scroller.add (view);
        scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
-       get_vbox()->pack_start (scroller);
 
-       scroller.show ();
-       view.show ();
+       set_spacing (6);
+       set_border_width (12);
+       pack_start (scroller);
 }
 
 void
-KeyEditor::on_show ()
+KeyEditor::Tab::action_selected ()
 {
-       populate ();
-       view.get_selection()->unselect_all ();
-       ArdourDialog::on_show ();
-}
+       if (view.get_selection()->count_selected_rows() == 0) {
+               return;
+       }
 
-void
-KeyEditor::on_unmap ()
-{
-       ArdourDialog::on_unmap ();
+       TreeModel::iterator i = view.get_selection()->get_selected();
+
+       owner.unbind_button.set_sensitive (false);
+
+       if (i != model->children().end()) {
+
+               string path = (*i)[columns.path];
+
+               if (!(*i)[columns.bindable]) {
+                       return;
+               }
+
+               string binding = (*i)[columns.binding];
+
+               if (!binding.empty()) {
+                       owner.unbind_button.set_sensitive (true);
+               }
+       }
 }
 
 void
-KeyEditor::action_selected ()
+KeyEditor::Tab::unbind ()
 {
+       TreeModel::iterator i = view.get_selection()->get_selected();
+
+       owner.unbind_button.set_sensitive (false);
+
+       if (i != model->children().end()) {
+               Glib::RefPtr<Action> action = (*i)[columns.action];
+
+               if (!(*i)[columns.bindable]) {
+                       return;
+               }
+
+               bindings->remove (action, Gtkmm2ext::Bindings::Press, true);
+               (*i)[columns.binding] = string ();
+       }
 }
 
-bool
-KeyEditor::on_key_release_event (GdkEventKey* ev)
+void
+KeyEditor::Tab::bind (GdkEventKey* release_event, guint pressed_key)
 {
        TreeModel::iterator i = view.get_selection()->get_selected();
 
        if (i != model->children().end()) {
-               string path = (*i)[columns.path];
-               
-               bool result = AccelMap::change_entry (path,
-                                                     ev->keyval,
-                                                     (ModifierType) ev->state,
-                                                     true);
 
-               if (result) {
-                       bool known;
-                       AccelKey key;
-
-                       known = ActionManager::lookup_entry (path, key);
-                       
-                       if (known) {
-                               (*i)[columns.binding] = ActionManager::ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod()));
-                       } else {
-                               (*i)[columns.binding] = string();
-                       }
+               string action_name = (*i)[columns.path];
+
+               if (!(*i)[columns.bindable]) {
+                       return;
                }
 
-               
-       }
+               GdkModifierType mod = (GdkModifierType)(Keyboard::RelevantModifierKeyMask & release_event->state);
+               Gtkmm2ext::KeyboardKey new_binding (mod, pressed_key);
 
-       return true;
+               bool result = bindings->replace (new_binding, Gtkmm2ext::Bindings::Press, action_name);
+
+               if (result) {
+                       (*i)[columns.binding] = gtk_accelerator_get_label (new_binding.key(), (GdkModifierType) new_binding.state());
+                       owner.unbind_button.set_sensitive (true);
+               }
+       }
 }
 
 void
-KeyEditor::populate ()
+KeyEditor::Tab::populate ()
 {
        vector<string> paths;
        vector<string> labels;
+       vector<string> tooltips;
        vector<string> keys;
-       vector<AccelKey> bindings;
+       vector<Glib::RefPtr<Action> > actions;
        typedef std::map<string,TreeIter> NodeMap;
        NodeMap nodes;
        NodeMap::iterator r;
-       
-       ActionManager::get_all_actions (labels, paths, keys, bindings);
-       
+
+       bindings->get_all_actions (paths, labels, tooltips, keys, actions);
+
        vector<string>::iterator k;
        vector<string>::iterator p;
+       vector<string>::iterator t;
        vector<string>::iterator l;
+       vector<Glib::RefPtr<Action> >::iterator a;
 
        model->clear ();
 
-       for (l = labels.begin(), k = keys.begin(), p = paths.begin(); l != labels.end(); ++k, ++p, ++l) {
-               
+       for (a = actions.begin(), l = labels.begin(), k = keys.begin(), p = paths.begin(), t = tooltips.begin(); l != labels.end(); ++k, ++p, ++t, ++l, ++a) {
+
                TreeModel::Row row;
                vector<string> parts;
-               
-               parts.clear ();
 
                split (*p, parts, '/');
-               
-               if (parts.empty()) {
+
+               string category = parts[1];
+               string action_name = parts[2];
+
+               if (action_name.empty()) {
+                       continue;
+               }
+
+               //kinda kludgy way to avoid displaying menu items as mappable
+               if ((action_name.find ("Menu") == action_name.length() - 4) ||
+                   (action_name.find ("menu") == action_name.length() - 4) ||
+                   (action_name == _("RegionList"))) {
                        continue;
                }
 
-               if ((r = nodes.find (parts[1])) == nodes.end()) {
+               if ((r = nodes.find (category)) == nodes.end()) {
 
-                       /* top level is missing */
+                       /* category/group is missing, so add it first */
 
                        TreeIter rowp;
                        TreeModel::Row parent;
                        rowp = model->append();
-                       nodes[parts[1]] = rowp;
+                       nodes[category] = rowp;
                        parent = *(rowp);
-                       parent[columns.action] = parts[1];
+                       parent[columns.name] = category;
+                       parent[columns.bindable] = false;
+                       parent[columns.action] = *a;
+
+                       /* now set up the child row that we're about to fill
+                        * out with information
+                        */
 
                        row = *(model->append (parent.children()));
 
                } else {
-                       
+
+                       /* category/group is present, so just add the child row */
+
                        row = *(model->append ((*r->second)->children()));
 
                }
-               
+
                /* add this action */
 
-               row[columns.action] = (*l);
-               row[columns.path] = (*p);
-               
+               /* use the "visible label" as the action name */
+
+               if (l->empty ()) {
+                       /* no label, try using the tooltip instead */
+                       row[columns.name] = *t;
+               } else {
+                       row[columns.name] = *l;
+               }
+               row[columns.path] = string_compose ("%1/%2", category, action_name);
+               row[columns.bindable] = true;
+
                if (*k == ActionManager::unbound_string) {
                        row[columns.binding] = string();
                } else {
-                       row[columns.binding] = (*k);
+                       row[columns.binding] = *k;
                }
+               row[columns.action] = *a;
+       }
+}
+
+void
+KeyEditor::reset ()
+{
+       Keyboard::the_keyboard().reset_bindings ();
+
+       for (Tabs::iterator t = tabs.begin(); t != tabs.end(); ++t) {
+               (*t)->view.get_selection()->unselect_all ();
+               (*t)->populate ();
        }
 }
+
+KeyEditor::Tab*
+KeyEditor::current_tab ()
+{
+       return dynamic_cast<Tab*> (notebook.get_nth_page (notebook.get_current_page()));
+}