From 119c644dc08a4575c2770257efea451d3968e3cc Mon Sep 17 00:00:00 2001 From: nick_m Date: Sat, 23 May 2015 23:41:26 +1000 Subject: [PATCH] Document snap_delta modifier mask. --- libs/gtkmm2ext/gtkmm2ext/keyboard.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/libs/gtkmm2ext/gtkmm2ext/keyboard.h b/libs/gtkmm2ext/gtkmm2ext/keyboard.h index 25c5154024..3ffa09f036 100644 --- a/libs/gtkmm2ext/gtkmm2ext/keyboard.h +++ b/libs/gtkmm2ext/gtkmm2ext/keyboard.h @@ -122,7 +122,12 @@ class LIBGTKMM2EXT_API Keyboard : public sigc::trackable, PBD::Stateful static ModifierMask snap_modifier () { return ModifierMask (snap_mod); } static void set_snap_delta_modifier (guint); - /** @return Modifier mask to temporarily toggle between relative and absolute grid setting; + /** @return Modifier mask to temporarily toggle between relative and absolute grid setting. + * Absolute grid is for aligning objects with the grid lines. + * Relative grid is for maintaining an initial position relative to the grid lines. + * With this modifier: + * - magnetic or normal grid should snap absolutely to the grid lines + * - no grid should become absolute grid. */ static ModifierMask snap_delta_modifier () { return ModifierMask (snap_delta_mod); }