fdo-mirrors/libei
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libei.git synced 2025-12-20 05:40:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Extend summaries

Browse source 
Part-of: <https://gitlab.freedesktop.org/libinput/libei/-/merge_requests/344>
This commit is contained in:
Axel Karjalainen 2025-07-10 20:15:34 +03:00 • committed by Marge Bot
parent 4d999849ee
commit 70c3348dfe
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
proto/protocol.xml
View file

@ -183,7 +183,7 @@
</event> </event>
<event name="connection" type="destructor" since="1"> <event name="connection" type="destructor" since="1">
<description summary="the core connection object"> <description summary="initialization of the connection object">
Provides the client with the connection object that is the top-level Provides the client with the connection object that is the top-level
object for all future requests and events. object for all future requests and events.
@ -211,7 +211,7 @@
</interface> </interface>
<interface name="ei_connection" version="1"> <interface name="ei_connection" version="1">
<description summary="core global object"> <description summary="core connection object">
The core connection object. This is the top-level object for any communication The core connection object. This is the top-level object for any communication
with the EIS implementation. with the EIS implementation.
@ -420,7 +420,7 @@
</interface> </interface>
<interface name="ei_seat" version="1"> <interface name="ei_seat" version="1">
<description summary="seat object"> <description summary="set of input devices that logically belong together">
An ei_seat represents a set of input devices that logically belong together. In most An ei_seat represents a set of input devices that logically belong together. In most
cases only one seat is present and all input devices on that seat share the same cases only one seat is present and all input devices on that seat share the same
pointer and keyboard focus. pointer and keyboard focus.
@ -550,10 +550,10 @@
</interface> </interface>
<interface name="ei_device" version="2"> <interface name="ei_device" version="2">
<description summary="device object"> <description summary="logical input device">
An ei_device represents a single logical input devices. Like physical input devices An ei_device represents a single logical input device. Like physical input
an ei_device may have multiple capabilities and may e.g. function as pointer devices an ei_device may have multiple capabilities and may e.g. function
and keyboard. as pointer and keyboard.
Depending on the ei_handshake.context_type, an ei_device can Depending on the ei_handshake.context_type, an ei_device can
emulate events via client requests or receive events. It is a protocol violation emulate events via client requests or receive events. It is a protocol violation
@ -691,8 +691,8 @@
<description summary="device type notification"> <description summary="device type notification">
The device type, one of virtual or physical. The device type, one of virtual or physical.
Devices of type ei_device.device_type.physical are supported only clients of Devices of type ei_device.device_type.physical are only supported for
type ei_handshake.context_type.receiver. clients of type ei_handshake.context_type.receiver.
This event is sent once immediately after object creation. This event is sent once immediately after object creation.
It is a protocol violation to send this event after the ei_device.done event. It is a protocol violation to send this event after the ei_device.done event.
@ -714,7 +714,7 @@
</event> </event>
<event name="region" since="1"> <event name="region" since="1">
<description summary="device dimensions notification"> <description summary="device region notification">
Notifies the client of one region. The number of regions is constant for a device Notifies the client of one region. The number of regions is constant for a device
and all regions are announced immediately after object creation. and all regions are announced immediately after object creation.
@ -893,8 +893,9 @@
</interface> </interface>
<interface name="ei_pointer" version="1"> <interface name="ei_pointer" version="1">
<description summary="pointer object"> <description summary="device sub-interface for relative pointer motion">
Interface for pointer motion requests and events. Interface for relative pointer motion requests and events, originating
from physical devices like computer mice.
This interface is only provided once per device and where a client This interface is only provided once per device and where a client
requests ei_pointer.release the interface does not get re-initialized. An requests ei_pointer.release the interface does not get re-initialized. An
@ -908,7 +909,7 @@
<!-- ei_pointer client requests version 1 --> <!-- ei_pointer client requests version 1 -->
<request name="release" since="1"> <request name="release" since="1">
<description summary="Pointer removal request"> <description summary="pointer sub-interface removal request">
Notification that the client is no longer interested in this pointer. Notification that the client is no longer interested in this pointer.
The EIS implementation will release any resources related to this pointer and The EIS implementation will release any resources related to this pointer and
send the ei_pointer.destroyed event once complete. send the ei_pointer.destroyed event once complete.
@ -957,8 +958,8 @@
</interface> </interface>
<interface name="ei_pointer_absolute" version="1"> <interface name="ei_pointer_absolute" version="1">
<description summary="absolute pointer object"> <description summary="device sub-interface for absolute pointer motion">
Interface for absolute pointer requests and events. Interface for absolute pointer motion.
This interface is only provided once per device and where a client This interface is only provided once per device and where a client
requests ei_pointer_absolute.release the interface does not get requests ei_pointer_absolute.release the interface does not get
@ -972,7 +973,7 @@
<!-- ei_pointer_absolute client requests version 1 --> <!-- ei_pointer_absolute client requests version 1 -->
<request name="release" since="1"> <request name="release" since="1">
<description summary="Pointer absolute removal request"> <description summary="absolute pointer sub-interface removal request">
Notification that the client is no longer interested in this object. Notification that the client is no longer interested in this object.
The EIS implementation will release any resources related to this object and The EIS implementation will release any resources related to this object and
send the ei_pointer_absolute.destroyed event once complete. send the ei_pointer_absolute.destroyed event once complete.