|
| 1 | +<?xml version="1.0" encoding="UTF-8"?> |
| 2 | +<protocol name="wlr_virtual_pointer_unstable_v1"> |
| 3 | + <copyright> |
| 4 | + Copyright © 2019 Josef Gajdusek |
| 5 | + |
| 6 | + Permission is hereby granted, free of charge, to any person obtaining a |
| 7 | + copy of this software and associated documentation files (the "Software"), |
| 8 | + to deal in the Software without restriction, including without limitation |
| 9 | + the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 10 | + and/or sell copies of the Software, and to permit persons to whom the |
| 11 | + Software is furnished to do so, subject to the following conditions: |
| 12 | + |
| 13 | + The above copyright notice and this permission notice (including the next |
| 14 | + paragraph) shall be included in all copies or substantial portions of the |
| 15 | + Software. |
| 16 | + |
| 17 | + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 18 | + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 19 | + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 20 | + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 21 | + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 22 | + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 23 | + DEALINGS IN THE SOFTWARE. |
| 24 | + </copyright> |
| 25 | + |
| 26 | + <interface name="zwlr_virtual_pointer_v1" version="2"> |
| 27 | + <description summary="virtual pointer"> |
| 28 | + This protocol allows clients to emulate a physical pointer device. The |
| 29 | + requests are mostly mirror opposites of those specified in wl_pointer. |
| 30 | + </description> |
| 31 | + |
| 32 | + <enum name="error"> |
| 33 | + <entry name="invalid_axis" value="0" |
| 34 | + summary="client sent invalid axis enumeration value" /> |
| 35 | + <entry name="invalid_axis_source" value="1" |
| 36 | + summary="client sent invalid axis source enumeration value" /> |
| 37 | + </enum> |
| 38 | + |
| 39 | + <request name="motion"> |
| 40 | + <description summary="pointer relative motion event"> |
| 41 | + The pointer has moved by a relative amount to the previous request. |
| 42 | + |
| 43 | + Values are in the global compositor space. |
| 44 | + </description> |
| 45 | + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> |
| 46 | + <arg name="dx" type="fixed" summary="displacement on the x-axis"/> |
| 47 | + <arg name="dy" type="fixed" summary="displacement on the y-axis"/> |
| 48 | + </request> |
| 49 | + |
| 50 | + <request name="motion_absolute"> |
| 51 | + <description summary="pointer absolute motion event"> |
| 52 | + The pointer has moved in an absolute coordinate frame. |
| 53 | + |
| 54 | + Value of x can range from 0 to x_extent, value of y can range from 0 |
| 55 | + to y_extent. |
| 56 | + </description> |
| 57 | + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> |
| 58 | + <arg name="x" type="uint" summary="position on the x-axis"/> |
| 59 | + <arg name="y" type="uint" summary="position on the y-axis"/> |
| 60 | + <arg name="x_extent" type="uint" summary="extent of the x-axis"/> |
| 61 | + <arg name="y_extent" type="uint" summary="extent of the y-axis"/> |
| 62 | + </request> |
| 63 | + |
| 64 | + <request name="button"> |
| 65 | + <description summary="button event"> |
| 66 | + A button was pressed or released. |
| 67 | + </description> |
| 68 | + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> |
| 69 | + <arg name="button" type="uint" summary="button that produced the event"/> |
| 70 | + <arg name="state" type="uint" enum="wl_pointer.button_state" summary="physical state of the button"/> |
| 71 | + </request> |
| 72 | + |
| 73 | + <request name="axis"> |
| 74 | + <description summary="axis event"> |
| 75 | + Scroll and other axis requests. |
| 76 | + </description> |
| 77 | + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> |
| 78 | + <arg name="axis" type="uint" enum="wl_pointer.axis" summary="axis type"/> |
| 79 | + <arg name="value" type="fixed" summary="length of vector in touchpad coordinates"/> |
| 80 | + </request> |
| 81 | + |
| 82 | + <request name="frame"> |
| 83 | + <description summary="end of a pointer event sequence"> |
| 84 | + Indicates the set of events that logically belong together. |
| 85 | + </description> |
| 86 | + </request> |
| 87 | + |
| 88 | + <request name="axis_source"> |
| 89 | + <description summary="axis source event"> |
| 90 | + Source information for scroll and other axis. |
| 91 | + </description> |
| 92 | + <arg name="axis_source" type="uint" enum="wl_pointer.axis_source" summary="source of the axis event"/> |
| 93 | + </request> |
| 94 | + |
| 95 | + <request name="axis_stop"> |
| 96 | + <description summary="axis stop event"> |
| 97 | + Stop notification for scroll and other axes. |
| 98 | + </description> |
| 99 | + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> |
| 100 | + <arg name="axis" type="uint" enum="wl_pointer.axis" summary="the axis stopped with this event"/> |
| 101 | + </request> |
| 102 | + |
| 103 | + <request name="axis_discrete"> |
| 104 | + <description summary="axis click event"> |
| 105 | + Discrete step information for scroll and other axes. |
| 106 | + |
| 107 | + This event allows the client to extend data normally sent using the axis |
| 108 | + event with discrete value. |
| 109 | + </description> |
| 110 | + <arg name="time" type="uint" summary="timestamp with millisecond granularity"/> |
| 111 | + <arg name="axis" type="uint" enum="wl_pointer.axis" summary="axis type"/> |
| 112 | + <arg name="value" type="fixed" summary="length of vector in touchpad coordinates"/> |
| 113 | + <arg name="discrete" type="int" summary="number of steps"/> |
| 114 | + </request> |
| 115 | + |
| 116 | + <request name="destroy" type="destructor" since="1"> |
| 117 | + <description summary="destroy the virtual pointer object"/> |
| 118 | + </request> |
| 119 | + </interface> |
| 120 | + |
| 121 | + <interface name="zwlr_virtual_pointer_manager_v1" version="2"> |
| 122 | + <description summary="virtual pointer manager"> |
| 123 | + This object allows clients to create individual virtual pointer objects. |
| 124 | + </description> |
| 125 | + |
| 126 | + <request name="create_virtual_pointer"> |
| 127 | + <description summary="Create a new virtual pointer"> |
| 128 | + Creates a new virtual pointer. The optional seat is a suggestion to the |
| 129 | + compositor. |
| 130 | + </description> |
| 131 | + <arg name="seat" type="object" interface="wl_seat" allow-null="true"/> |
| 132 | + <arg name="id" type="new_id" interface="zwlr_virtual_pointer_v1"/> |
| 133 | + </request> |
| 134 | + |
| 135 | + <request name="destroy" type="destructor" since="1"> |
| 136 | + <description summary="destroy the virtual pointer manager"/> |
| 137 | + </request> |
| 138 | + |
| 139 | + <!-- Version 2 additions --> |
| 140 | + <request name="create_virtual_pointer_with_output" since="2"> |
| 141 | + <description summary="Create a new virtual pointer"> |
| 142 | + Creates a new virtual pointer. The seat and the output arguments are |
| 143 | + optional. If the seat argument is set, the compositor should assign the |
| 144 | + input device to the requested seat. If the output argument is set, the |
| 145 | + compositor should map the input device to the requested output. |
| 146 | + </description> |
| 147 | + <arg name="seat" type="object" interface="wl_seat" allow-null="true"/> |
| 148 | + <arg name="output" type="object" interface="wl_output" allow-null="true"/> |
| 149 | + <arg name="id" type="new_id" interface="zwlr_virtual_pointer_v1"/> |
| 150 | + </request> |
| 151 | + </interface> |
| 152 | +</protocol> |
0 commit comments