mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-03 09:01:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Improve the wl_seat protocol docs

Browse source 
Expand the main description and tell if requests don't have
an effect.
This commit is contained in:
Matthias Clasen 2013-03-30 01:11:40 -04:00 • committed by Kristian Høgsberg
parent c63a59b802
commit 53b57a63ee
1 changed files with 22 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

33
protocol/wayland.xml
View file

@ -1105,11 +1105,12 @@
</interface> </interface>
<interface name="wl_seat" version="1"> <interface name="wl_seat" version="1">
<description summary="seat"> <description summary="group of input devices">
A group of keyboards, pointer (mice, for example) and touch A seat is a group of keyboards, pointer (mice, for example) and
devices . This object is published as a global during start up, touch devices. This object is published as a global during
or when such a device is hot plugged. A seat typically has a start up, or when such a device is hot plugged. A seat typically
pointer and maintains a keyboard_focus and a pointer_focus. has a pointer and maintains a keyboard focus, a pointer focus and
a touch focus.
</description> </description>
<enum name="capability"> <enum name="capability">
@ -1117,16 +1118,15 @@
This is a bitmask of capabilities this seat has; if a member is This is a bitmask of capabilities this seat has; if a member is
set, then it is present on the seat. set, then it is present on the seat.
</description> </description>
<entry name="pointer" value="1" summary="wl_pointer"/> <entry name="pointer" value="1" summary="The seat has pointer devices"/>
<entry name="keyboard" value="2" summary="wl_keyboard"/> <entry name="keyboard" value="2" summary="The seat has one or more keyboards"/>
<entry name="touch" value="4" summary="wl_touch"/> <entry name="touch" value="4" summary="The seat has touch devices"/>
</enum> </enum>
<event name="capabilities"> <event name="capabilities">
<description summary="seat capabilities changed"> <description summary="seat capabilities changed">
This is emitted whenever a seat gains or loses the pointer, This is emitted whenever a seat gains or loses the pointer,
keyboard or touch capabilities. The argument is a wl_seat_caps_mask keyboard or touch capabilities. The argument is a capability
enum containing the complete set of capabilities this seat has. enum containing the complete set of capabilities this seat has.
</description> </description>
<arg name="capabilities" type="uint"/> <arg name="capabilities" type="uint"/>
@ -1136,22 +1136,31 @@
<description summary="return pointer object"> <description summary="return pointer object">
The ID provided will be initialized to the wl_pointer interface The ID provided will be initialized to the wl_pointer interface
for this seat. for this seat.
This request only takes effect if the seat has the pointer
capability.
</description> </description>
<arg name="id" type="new_id" interface="wl_pointer"/> <arg name="id" type="new_id" interface="wl_pointer"/>
</request> </request>
<request name="get_keyboard"> <request name="get_keyboard">
<description summary="return pointer object"> <description summary="return keyboard object">
The ID provided will be initialized to the wl_keyboard interface The ID provided will be initialized to the wl_keyboard interface
for this seat. for this seat.
This request only takes effect if the seat has the keyboard
capability.
</description> </description>
<arg name="id" type="new_id" interface="wl_keyboard"/> <arg name="id" type="new_id" interface="wl_keyboard"/>
</request> </request>
<request name="get_touch"> <request name="get_touch">
<description summary="return pointer object"> <description summary="return touch object">
The ID provided will be initialized to the wl_touch interface The ID provided will be initialized to the wl_touch interface
for this seat. for this seat.
This request only takes effect if the seat has the touch
capability.
</description> </description>
<arg name="id" type="new_id" interface="wl_touch"/> <arg name="id" type="new_id" interface="wl_touch"/>
</request> </request>