]> git.mdlowis.com Git - proto/labwc.git/commitdiff
docs: add mouse emulation section
authorJens Peters <jp7677@gmail.com>
Wed, 24 Apr 2024 18:36:51 +0000 (20:36 +0200)
committerConsolatis <35009135+Consolatis@users.noreply.github.com>
Mon, 27 May 2024 20:40:50 +0000 (22:40 +0200)
Also clarify tablet button mapping restrictions.

docs/labwc-config.5.scd
docs/rc.xml.all

index ded6f390d2a70f5429426c45dcbd51272ae964ac..26cefdb2c4f3d5c78851e5951439f46366dd6ef9 100644 (file)
@@ -617,7 +617,7 @@ extending outward from the snapped edge.
 ## TABLET
 
 ```
-<tablet mapToOutput="" rotate="0">
+<tablet mapToOutput="" rotate="0" mouseEmulation="no">
   <area top="0.0" left="0.0" width="0.0" height="0.0" />
   <map button="Tip" to="Left" />
   <map button="Stylus" to="Right" />
@@ -657,21 +657,35 @@ extending outward from the snapped edge.
        additionally setting top to "12.5", the active area is centered
        vertically on the tablet surface.
 
+*<tablet mouseEmulation="" />* [yes|no]
+       The tablet can be forced to always use mouse emulation. This prevents
+       tablet specific restrictions, e.g. no support for drag-and-drop, but
+       also omits tablet specific features like reporting pen pressure.
+
 *<tablet><map button="" to="" />*
-       Tablet buttons emulate regular mouse buttons. If not specified
-       otherwise, the tip (Tip) is mapped to left mouse click, the first pen
-       button (Stylus) is mapped to right mouse button click and the second pen
-       button (Stylus2) emulates a middle mouse button click.
+       Pen buttons emulate regular mouse buttons. If not specified
+       otherwise, the first pen button (Stylus) is mapped to right mouse
+       button click and the second pen button (Stylus2) emulates a middle
+       mouse button click. For mouse emulation, the tip (Tip) is mapped to
+       left mouse click.
 
        Supported map *buttons* are:
-       - Tip
+       - Tip (mouse emulation only)
        - Stylus
        - Stylus2
        - Stylus3
        - Pad
        - Pad2..Pad9
 
-       See mouse section above for all supported *to* mouse buttons.
+       The stylus buttons (Stylus, Stylus2 and Stylus3) can be mapped *to*:
+       - Right
+       - Middle
+       - Side
+
+       The tablet pad buttons can be mapped to all available mouse buttons.
+       When using mouse emulation only, the tip and stylus buttons can also be
+       mapped to all available mouse buttons.
+       See mouse section above for all supported mouse buttons.
 
 ## LIBINPUT
 
index 2cccecd60f054434521c60a6c59a5dd3d0fea90c..a8f9f3a019ad8ff28e4ff4be0bf917fb57fbc560 100644 (file)
     height are omitted or default (0.0), width/height will be set to
     the remaining width/height seen from top/left.
 
-    Tablet buttons emulate regular mouse buttons. The tablet *button* can
-    be set to any of [Tip|Stylus|Stylus2|Stylus3|Pad|Pad2|Pad3|..|Pad9].
-    Valid *to* mouse buttons are [Left|Right|Middle].
+    The tablet can be forced to always use mouse emulation. This prevents
+    tablet specific restrictions, e.g. no support for drag&drop, but also
+    omits tablet specific features like reporting pen pressure.
+
+    Pen buttons emulate regular mouse buttons. The pen *button* can be any
+    of [Stylus|Stylus2|Stylus3] and can be mapped to mouse buttons
+    [Right|Middle|Side]. Tablet pad buttons [Pad|Pad2|Pad3|..|Pad9] also
+    emulate regular mouse buttons and can be mapped to any mouse button.
+    When using mouse emulation, the pen tip [tip] and the stylus buttons
+    can be set to any available mouse button [Left|Right|Middle|..|Task].
   -->
-  <tablet mapToOutput="" rotate="0">
+  <tablet mapToOutput="" rotate="0" mouseEmulation="no">
     <!-- Active area dimensions are in mm -->
     <area top="0.0" left="0.0" width="0.0" height="0.0" />
     <map button="Tip" to="Left" />