From 64915b09f75771b0b189c2aac20e5bef13ca20a0 Mon Sep 17 00:00:00 2001 From: "Peter F. Patel-Schneider" Date: Fri, 16 Apr 2021 10:08:27 -0400 Subject: [PATCH] docs: update description of mouse gestures setting --- docs/capabilities.md | 16 ++++++++++------ docs/rules.md | 1 + 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/capabilities.md b/docs/capabilities.md index 872bb2d9..03a39231 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -147,13 +147,17 @@ the DPI Switch button is diverted. ### Mouse Gestures -Some mice (such as the MX Master 3) have a button that can be used to -create up/down/left/right gestures, which then are seen by the Solaar rules as -MOUSE_GESTURE notifications. -This processing is only set up in Solaar when the Mouse Gestures setting is on and -the App Switch Gesture button or MultiPlatform Gesture Button is diverted. +Some mice (such as the MX Master 3) have a button that is supposed to be used to +create up/down/left/right mouse gestures. Other mice (such as the MX Master 3) don't +have a button specific for this but have buttons that can be used for it. -Mouse gestures is an experimental feature. Significant changes might be made in response to problems. +The Mouse Gestures setting assigns a button for this purpose. +Pressing the button, if the button is diverted, causes the mouse pointer to stop moving. +When the button is released a MOUSE_GESTURE notification with the total mouse movement +while the button was pressed is sent to the Solaar rule system. + +Mouse gestures is an experimental feature. +Significant changes might be made to it in the future. ## System Tray diff --git a/docs/rules.md b/docs/rules.md index e77e82e0..64d54a52 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -91,6 +91,7 @@ A `thumb_wheel_down` test is the rotation amount of a `THUMB WHEEL` downward rot same but for `LOWRES WHEEL` and `HIRES WHEEL`. A 'mouse-down' test is true for a mouse gesture mostly in the downward direction. `mouse-up', 'mouse-left', and 'mouse-right' are the same but for gestures in the other directions. +A 'mouse-noop' test is true for a mouse gesture where the mouse doesn't move much. `True` and `False` tests return True and False, respectively. A `KeyPress` action takes a sequence of X11 key symbols and simulates a chorded keypress on the keyboard.