wp_cursor_shape_device_v1¤
Cursor shape for a device
This interface allows clients to set the cursor shape.
Methods:
Cursor shapes
This enum describes cursor shapes.
The names are taken from the CSS W3C specification: https://w3c.github.io/csswg-drafts/css-ui/#cursor with a few additions.
Note that there are some groups of cursor shapes that are related: The first group is drag-and-drop cursors which are used to indicate the selected action during dnd operations. The second group is resize cursors which are used to indicate resizing and moving possibilities on window borders. It is recommended that the shapes in these groups should use visually compatible images and metaphors.
-
default–Default cursor -
context_menu–A context menu is available for the object under the cursor -
help–Help is available for the object under the cursor -
pointer–Pointer that indicates a link or another interactive element -
progress–Progress indicator -
wait–Program is busy, user should wait -
cell–A cell or set of cells may be selected -
crosshair–Simple crosshair -
text–Text may be selected -
vertical_text–Vertical text may be selected -
alias–Drag-and-drop: alias of/shortcut to something is to be created -
copy–Drag-and-drop: something is to be copied -
move–Drag-and-drop: something is to be moved -
no_drop–Drag-and-drop: the dragged item cannot be dropped at the current cursor location -
not_allowed–Drag-and-drop: the requested action will not be carried out -
grab–Drag-and-drop: something can be grabbed -
grabbing–Drag-and-drop: something is being grabbed -
e_resize–Resizing: the east border is to be moved -
n_resize–Resizing: the north border is to be moved -
ne_resize–Resizing: the north-east corner is to be moved -
nw_resize–Resizing: the north-west corner is to be moved -
s_resize–Resizing: the south border is to be moved -
se_resize–Resizing: the south-east corner is to be moved -
sw_resize–Resizing: the south-west corner is to be moved -
w_resize–Resizing: the west border is to be moved -
ew_resize–Resizing: the east and west borders are to be moved -
ns_resize–Resizing: the north and south borders are to be moved -
nesw_resize–Resizing: the north-east and south-west corners are to be moved -
nwse_resize–Resizing: the north-west and south-east corners are to be moved -
col_resize–Resizing: that the item/column can be resized horizontally -
row_resize–Resizing: that the item/row can be resized vertically -
all_scroll–Something can be scrolled in any direction -
zoom_in–Something can be zoomed in -
zoom_out–Something can be zoomed out -
dnd_ask–Drag-and-drop: the user will select which action will be carried out (non-css value) -
all_resize–Resizing: something can be moved or resized in any direction (non-css value)
-
invalid_shape–The specified shape value is invalid
destroy() -> None
Destroy the cursor shape device
Destroy the cursor shape device.
The device cursor shape remains unchanged.
Set device cursor to the shape
Sets the device cursor to the specified shape. The compositor will change the cursor image based on the specified shape.
The cursor actually changes only if the input device focus is one of the requesting client's surfaces. If any, the previous cursor image (surface or shape) is replaced.
The "shape" argument must be a valid enum entry, otherwise the invalid_shape protocol error is raised.
This is similar to the wl_pointer.set_cursor and zwp_tablet_tool_v2.set_cursor requests, but this request accepts a shape instead of contents in the form of a surface. Clients can mix set_cursor and set_shape requests.
The serial parameter must match the latest wl_pointer.enter or zwp_tablet_tool_v2.proximity_in serial number sent to the client. Otherwise the request will be ignored.
Parameters: