tablet-v2: clarify that name/id events are optional

libinput may not always have a descriptive name for a tablet
device, in which case it's better to let the Wayland client
pick a fallback (potentially localized) than send a fake string.

Not all tablet devices are USB, so make it clear that the id
event may be skipped.

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/issues/180
This commit is contained in:
Simon Ser 2024-02-29 11:49:29 +01:00
parent 4c8840ce04
commit 0819d97313

View file

@ -596,14 +596,23 @@
<event name="name">
<description summary="tablet device name">
A descriptive name for the tablet device.
If the device has no descriptive name, this event is not sent.
This event is sent in the initial burst of events before the
wp_tablet.done event.
wp_tablet.done event.
</description>
<arg name="name" type="string" summary="the device name"/>
</event>
<event name="id">
<description summary="tablet device USB vendor/product id">
The USB vendor and product IDs for the tablet device.
If the device has no USB vendor/product ID, this event is not sent.
This can happen for virtual devices or non-USB devices, for instance.
This event is sent in the initial burst of events before the
wp_tablet.done event.
</description>