Document snap_delta modifier mask.

This commit is contained in:
nick_m 2015-05-23 23:41:26 +10:00
parent 39d4bbf5e1
commit 119c644dc0

View file

@ -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); }