xdg-foreign: add error enums

The protocol states that the client must provide xdg_toplevel surfaces,
but doesn't specify protocol error values that can be sent by the
compositor.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2020-12-23 11:37:56 +01:00
parent 17bef0eddd
commit b1670b4dda

View file

@ -69,6 +69,14 @@
</description> </description>
</request> </request>
<enum name="error">
<description summary="error values">
These errors can be emitted in response to invalid xdg_exporter
requests.
</description>
<entry name="invalid_surface" value="0" summary="surface is not an xdg_toplevel"/>
</enum>
<request name="export_toplevel"> <request name="export_toplevel">
<description summary="export a toplevel surface"> <description summary="export a toplevel surface">
The export_toplevel request exports the passed surface so that it can later be The export_toplevel request exports the passed surface so that it can later be
@ -78,7 +86,8 @@
A surface may be exported multiple times, and each exported handle may A surface may be exported multiple times, and each exported handle may
be used to create an xdg_imported multiple times. Only xdg_toplevel be used to create an xdg_imported multiple times. Only xdg_toplevel
equivalent surfaces may be exported. equivalent surfaces may be exported, otherwise an invalid_surface
protocol error is sent.
</description> </description>
<arg name="id" type="new_id" interface="zxdg_exported_v2" <arg name="id" type="new_id" interface="zxdg_exported_v2"
summary="the new xdg_exported object"/> summary="the new xdg_exported object"/>
@ -150,6 +159,14 @@
relationships between its own surfaces and the imported surface. relationships between its own surfaces and the imported surface.
</description> </description>
<enum name="error">
<description summary="error values">
These errors can be emitted in response to invalid xdg_imported
requests.
</description>
<entry name="invalid_surface" value="0" summary="surface is not an xdg_toplevel"/>
</enum>
<request name="destroy" type="destructor"> <request name="destroy" type="destructor">
<description summary="destroy the xdg_imported object"> <description summary="destroy the xdg_imported object">
Notify the compositor that it will no longer use the xdg_imported Notify the compositor that it will no longer use the xdg_imported
@ -161,9 +178,10 @@
<request name="set_parent_of"> <request name="set_parent_of">
<description summary="set as the parent of some surface"> <description summary="set as the parent of some surface">
Set the imported surface as the parent of some surface of the client. Set the imported surface as the parent of some surface of the client.
The passed surface must be an xdg_toplevel equivalent. Calling this The passed surface must be an xdg_toplevel equivalent, otherwise an
function sets up a surface to surface relation with the same stacking invalid_surface protocol error is sent. Calling this function sets up
and positioning semantics as xdg_toplevel.set_parent. a surface to surface relation with the same stacking and positioning
semantics as xdg_toplevel.set_parent.
</description> </description>
<arg name="surface" type="object" interface="wl_surface" <arg name="surface" type="object" interface="wl_surface"
summary="the child surface"/> summary="the child surface"/>