Alter snap modifier so that it turns the grid on when it's off as well as vice-versa.

[ardour.git] / gtk2_ardour / keyboard.h

diff --git a/gtk2_ardour/keyboard.h b/gtk2_ardour/keyboard.h
index 29052993348cebf7f35e41765bf8d685943a5350..cff45b11f200ffbf1e47bbcb76209a2bb6e61bcf 100644 (file)
--- a/gtk2_ardour/keyboard.h
+++ b/gtk2_ardour/keyboard.h
@@ -90,6 +90,11 @@ class Keyboard : public sigc::trackable, PBD::Stateful
        static bool no_modifiers_active (guint state);
 
        static void set_snap_modifier (guint);
+
+       /** @return Modifier mask to temporarily toggle grid setting; with this modifier
+        *  - magnetic or normal grid should become no grid and
+        *  - no grid should become normal grid
+        */
        static ModifierMask snap_modifier () { return ModifierMask (snap_mod); }
 
        static guint edit_button() { return edit_but; }