diff options
Diffstat (limited to 'contrib/SDL-3.2.8/wayland-protocols/cursor-shape-v1.xml')
| -rw-r--r-- | contrib/SDL-3.2.8/wayland-protocols/cursor-shape-v1.xml | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/contrib/SDL-3.2.8/wayland-protocols/cursor-shape-v1.xml b/contrib/SDL-3.2.8/wayland-protocols/cursor-shape-v1.xml new file mode 100644 index 0000000..56f6a1a --- /dev/null +++ b/contrib/SDL-3.2.8/wayland-protocols/cursor-shape-v1.xml | |||
| @@ -0,0 +1,147 @@ | |||
| 1 | <?xml version="1.0" encoding="UTF-8"?> | ||
| 2 | <protocol name="cursor_shape_v1"> | ||
| 3 | <copyright> | ||
| 4 | Copyright 2018 The Chromium Authors | ||
| 5 | Copyright 2023 Simon Ser | ||
| 6 | |||
| 7 | Permission is hereby granted, free of charge, to any person obtaining a | ||
| 8 | copy of this software and associated documentation files (the "Software"), | ||
| 9 | to deal in the Software without restriction, including without limitation | ||
| 10 | the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
| 11 | and/or sell copies of the Software, and to permit persons to whom the | ||
| 12 | Software is furnished to do so, subject to the following conditions: | ||
| 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 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| 17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| 18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | ||
| 19 | THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| 20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| 21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| 22 | DEALINGS IN THE SOFTWARE. | ||
| 23 | </copyright> | ||
| 24 | |||
| 25 | <interface name="wp_cursor_shape_manager_v1" version="1"> | ||
| 26 | <description summary="cursor shape manager"> | ||
| 27 | This global offers an alternative, optional way to set cursor images. This | ||
| 28 | new way uses enumerated cursors instead of a wl_surface like | ||
| 29 | wl_pointer.set_cursor does. | ||
| 30 | |||
| 31 | Warning! The protocol described in this file is currently in the testing | ||
| 32 | phase. Backward compatible changes may be added together with the | ||
| 33 | corresponding interface version bump. Backward incompatible changes can | ||
| 34 | only be done by creating a new major version of the extension. | ||
| 35 | </description> | ||
| 36 | |||
| 37 | <request name="destroy" type="destructor"> | ||
| 38 | <description summary="destroy the manager"> | ||
| 39 | Destroy the cursor shape manager. | ||
| 40 | </description> | ||
| 41 | </request> | ||
| 42 | |||
| 43 | <request name="get_pointer"> | ||
| 44 | <description summary="manage the cursor shape of a pointer device"> | ||
| 45 | Obtain a wp_cursor_shape_device_v1 for a wl_pointer object. | ||
| 46 | </description> | ||
| 47 | <arg name="cursor_shape_device" type="new_id" interface="wp_cursor_shape_device_v1"/> | ||
| 48 | <arg name="pointer" type="object" interface="wl_pointer"/> | ||
| 49 | </request> | ||
| 50 | |||
| 51 | <request name="get_tablet_tool_v2"> | ||
| 52 | <description summary="manage the cursor shape of a tablet tool device"> | ||
| 53 | Obtain a wp_cursor_shape_device_v1 for a zwp_tablet_tool_v2 object. | ||
| 54 | </description> | ||
| 55 | <arg name="cursor_shape_device" type="new_id" interface="wp_cursor_shape_device_v1"/> | ||
| 56 | <arg name="tablet_tool" type="object" interface="zwp_tablet_tool_v2"/> | ||
| 57 | </request> | ||
| 58 | </interface> | ||
| 59 | |||
| 60 | <interface name="wp_cursor_shape_device_v1" version="1"> | ||
| 61 | <description summary="cursor shape for a device"> | ||
| 62 | This interface advertises the list of supported cursor shapes for a | ||
| 63 | device, and allows clients to set the cursor shape. | ||
| 64 | </description> | ||
| 65 | |||
| 66 | <enum name="shape"> | ||
| 67 | <description summary="cursor shapes"> | ||
| 68 | This enum describes cursor shapes. | ||
| 69 | |||
| 70 | The names are taken from the CSS W3C specification: | ||
| 71 | https://w3c.github.io/csswg-drafts/css-ui/#cursor | ||
| 72 | </description> | ||
| 73 | <entry name="default" value="1" summary="default cursor"/> | ||
| 74 | <entry name="context_menu" value="2" summary="a context menu is available for the object under the cursor"/> | ||
| 75 | <entry name="help" value="3" summary="help is available for the object under the cursor"/> | ||
| 76 | <entry name="pointer" value="4" summary="pointer that indicates a link or another interactive element"/> | ||
| 77 | <entry name="progress" value="5" summary="progress indicator"/> | ||
| 78 | <entry name="wait" value="6" summary="program is busy, user should wait"/> | ||
| 79 | <entry name="cell" value="7" summary="a cell or set of cells may be selected"/> | ||
| 80 | <entry name="crosshair" value="8" summary="simple crosshair"/> | ||
| 81 | <entry name="text" value="9" summary="text may be selected"/> | ||
| 82 | <entry name="vertical_text" value="10" summary="vertical text may be selected"/> | ||
| 83 | <entry name="alias" value="11" summary="drag-and-drop: alias of/shortcut to something is to be created"/> | ||
| 84 | <entry name="copy" value="12" summary="drag-and-drop: something is to be copied"/> | ||
| 85 | <entry name="move" value="13" summary="drag-and-drop: something is to be moved"/> | ||
| 86 | <entry name="no_drop" value="14" summary="drag-and-drop: the dragged item cannot be dropped at the current cursor location"/> | ||
| 87 | <entry name="not_allowed" value="15" summary="drag-and-drop: the requested action will not be carried out"/> | ||
| 88 | <entry name="grab" value="16" summary="drag-and-drop: something can be grabbed"/> | ||
| 89 | <entry name="grabbing" value="17" summary="drag-and-drop: something is being grabbed"/> | ||
| 90 | <entry name="e_resize" value="18" summary="resizing: the east border is to be moved"/> | ||
| 91 | <entry name="n_resize" value="19" summary="resizing: the north border is to be moved"/> | ||
| 92 | <entry name="ne_resize" value="20" summary="resizing: the north-east corner is to be moved"/> | ||
| 93 | <entry name="nw_resize" value="21" summary="resizing: the north-west corner is to be moved"/> | ||
| 94 | <entry name="s_resize" value="22" summary="resizing: the south border is to be moved"/> | ||
| 95 | <entry name="se_resize" value="23" summary="resizing: the south-east corner is to be moved"/> | ||
| 96 | <entry name="sw_resize" value="24" summary="resizing: the south-west corner is to be moved"/> | ||
| 97 | <entry name="w_resize" value="25" summary="resizing: the west border is to be moved"/> | ||
| 98 | <entry name="ew_resize" value="26" summary="resizing: the east and west borders are to be moved"/> | ||
| 99 | <entry name="ns_resize" value="27" summary="resizing: the north and south borders are to be moved"/> | ||
| 100 | <entry name="nesw_resize" value="28" summary="resizing: the north-east and south-west corners are to be moved"/> | ||
| 101 | <entry name="nwse_resize" value="29" summary="resizing: the north-west and south-east corners are to be moved"/> | ||
| 102 | <entry name="col_resize" value="30" summary="resizing: that the item/column can be resized horizontally"/> | ||
| 103 | <entry name="row_resize" value="31" summary="resizing: that the item/row can be resized vertically"/> | ||
| 104 | <entry name="all_scroll" value="32" summary="something can be scrolled in any direction"/> | ||
| 105 | <entry name="zoom_in" value="33" summary="something can be zoomed in"/> | ||
| 106 | <entry name="zoom_out" value="34" summary="something can be zoomed out"/> | ||
| 107 | </enum> | ||
| 108 | |||
| 109 | <enum name="error"> | ||
| 110 | <entry name="invalid_shape" value="1" | ||
| 111 | summary="the specified shape value is invalid"/> | ||
| 112 | </enum> | ||
| 113 | |||
| 114 | <request name="destroy" type="destructor"> | ||
| 115 | <description summary="destroy the cursor shape device"> | ||
| 116 | Destroy the cursor shape device. | ||
| 117 | |||
| 118 | The device cursor shape remains unchanged. | ||
| 119 | </description> | ||
| 120 | </request> | ||
| 121 | |||
| 122 | <request name="set_shape"> | ||
| 123 | <description summary="set device cursor to the shape"> | ||
| 124 | Sets the device cursor to the specified shape. The compositor will | ||
| 125 | change the cursor image based on the specified shape. | ||
| 126 | |||
| 127 | The cursor actually changes only if the input device focus is one of | ||
| 128 | the requesting client's surfaces. If any, the previous cursor image | ||
| 129 | (surface or shape) is replaced. | ||
| 130 | |||
| 131 | The "shape" argument must be a valid enum entry, otherwise the | ||
| 132 | invalid_shape protocol error is raised. | ||
| 133 | |||
| 134 | This is similar to the wl_pointer.set_cursor and | ||
| 135 | zwp_tablet_tool_v2.set_cursor requests, but this request accepts a | ||
| 136 | shape instead of contents in the form of a surface. Clients can mix | ||
| 137 | set_cursor and set_shape requests. | ||
| 138 | |||
| 139 | The serial parameter must match the latest wl_pointer.enter or | ||
| 140 | zwp_tablet_tool_v2.proximity_in serial number sent to the client. | ||
| 141 | Otherwise the request will be ignored. | ||
| 142 | </description> | ||
| 143 | <arg name="serial" type="uint" summary="serial number of the enter event"/> | ||
| 144 | <arg name="shape" type="uint" enum="shape"/> | ||
| 145 | </request> | ||
| 146 | </interface> | ||
| 147 | </protocol> | ||
