diff options
| -rw-r--r-- | staging/ext-action-binder/ext-action-binder-v1.xml | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/staging/ext-action-binder/ext-action-binder-v1.xml b/staging/ext-action-binder/ext-action-binder-v1.xml index 7840ebc..ee4d1f9 100644 --- a/staging/ext-action-binder/ext-action-binder-v1.xml +++ b/staging/ext-action-binder/ext-action-binder-v1.xml @@ -84,11 +84,26 @@ <description summary="sets the machine-readable trigger of a binding"> The trigger is a suggestion to the compositor, and the action should not rely to being set to that specific trigger. + The client does not know which trigger was actually set, but when a binding is bound, it recieves from the compositor a human readable string describing the trigger, if any, so it could show it in a ui. + + The trigger format is split into two fields, what kind of device triggers it, and a + general trigger string. + + as of version 1 of this protocol, the following kinds are defined: + "sym": trigger is a combo of XKB key names + "mouse": trigger is button[1-9], mapped to their x11 values, (1=left, 2=middle, 3=right, + 4=scroll up, 5=scroll down, 6=scroll left, 7=scroll right, 8=back, 9=forward) + "switch": trigger on the format switch:state, where "lid" and "tablet" are valid switches + "gesture": trigger on the format gesture[:fingers][:direction] with the following gestures: + hold: 1-5 fingers, no direction + swipe: 3-5 fingers, up, down, left or right + pinch: 2-5 fingers, all above, inward, outward, clockwise, counterclockwise </description> - <arg name="preferred_trigger" type="string" summary="a trigger that the client would like to trigger the action" /> + <arg name="kind" type="string" summary="what category of trigger it fits in"/> + <arg name="trigger" type="string" summary="a trigger that the client would like to trigger the action"/> </request> <request name="bind"> |