fdo-mirrors/wayland-protocols
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland-protocols.git synced 2025-12-20 12:50:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

xdg-shell: Add specific errors

Browse source 
This adds specific errors for all xdg_shell errors.

Signed-off-by: Demi Marie Obenour <demiobenour@gmail.com>
This commit is contained in:
Demi Marie Obenour 2021-10-05 09:55:13 -04:00 • committed by Jonas Ådahl
parent c79dbb7c11
commit cec292a653
1 changed files with 28 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
stable/xdg-shell/xdg-shell.xml
View file

@ -58,7 +58,7 @@
Destroying a bound xdg_wm_base object while there are surfaces Destroying a bound xdg_wm_base object while there are surfaces
still alive created by this xdg_wm_base object instance is illegal still alive created by this xdg_wm_base object instance is illegal
and will result in a protocol error. and will result in a defunct_surfaces error.
</description> </description>
</request> </request>
@ -77,7 +77,7 @@
itself is not a role, the corresponding surface may only be assigned itself is not a role, the corresponding surface may only be assigned
a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is
illegal to create an xdg_surface for a wl_surface which already has an illegal to create an xdg_surface for a wl_surface which already has an
assigned role and this will result in a protocol error. assigned role and this will result in a role error.
This creates an xdg_surface for the given surface. An xdg_surface is This creates an xdg_surface for the given surface. An xdg_surface is
used as basis to define a role to a given surface, such as xdg_toplevel used as basis to define a role to a given surface, such as xdg_toplevel
@ -137,7 +137,7 @@
For an xdg_positioner object to be considered complete, it must have a For an xdg_positioner object to be considered complete, it must have a
non-zero size set by set_size, and a non-zero anchor rectangle set by non-zero size set by set_size, and a non-zero anchor rectangle set by
set_anchor_rect. Passing an incomplete xdg_positioner object when set_anchor_rect. Passing an incomplete xdg_positioner object when
positioning a surface raises an error. positioning a surface raises an invalid_positioner error.
</description> </description>
<enum name="error"> <enum name="error">
@ -225,7 +225,8 @@
specified (e.g. 'bottom_right' or 'top_left'), then the child surface specified (e.g. 'bottom_right' or 'top_left'), then the child surface
will be placed towards the specified gravity; otherwise, the child will be placed towards the specified gravity; otherwise, the child
surface will be centered over the anchor point on any axis that had no surface will be centered over the anchor point on any axis that had no
gravity specified. gravity specified. If the gravity is not in the ‘gravity’ enum, an
invalid_input error is raised.
</description> </description>
<arg name="gravity" type="uint" enum="gravity" <arg name="gravity" type="uint" enum="gravity"
summary="gravity direction"/> summary="gravity direction"/>
@ -451,10 +452,16 @@
</description> </description>
<enum name="error"> <enum name="error">
<entry name="not_constructed" value="1"/> <entry name="not_constructed" value="1"
<entry name="already_constructed" value="2"/> summary="Surface was not fully constructed"/>
<entry name="unconfigured_buffer" value="3"/> <entry name="already_constructed" value="2"
<entry name="invalid_serial" value="4"/> summary="Surface was already constructed"/>
<entry name="unconfigured_buffer" value="3"
summary="Attaching a buffer to an unconfigured surface"/>
<entry name="invalid_serial" value="4"
summary="Invalid serial number when acking a configure event"/>
<entry name="invalid_size" value="5"
summary="Width or height was zero or negative"/>
</enum> </enum>
<request name="destroy" type="destructor"> <request name="destroy" type="destructor">
@ -518,10 +525,10 @@
the wl_surface associated with this xdg_surface. the wl_surface associated with this xdg_surface.
The width and height must be greater than zero. Setting an invalid size The width and height must be greater than zero. Setting an invalid size
will raise an error. When applied, the effective window geometry will be will raise an invalid_size error. When applied, the effective window
the set window geometry clamped to the bounding rectangle of the geometry will be the set window geometry clamped to the bounding
combined geometry of the surface of the xdg_surface and the associated rectangle of the combined geometry of the surface of the xdg_surface and
subsurfaces. the associated subsurfaces.
</description> </description>
<arg name="x" type="int"/> <arg name="x" type="int"/>
<arg name="y" type="int"/> <arg name="y" type="int"/>
@ -542,6 +549,8 @@
If the client receives multiple configure events before it If the client receives multiple configure events before it
can respond to one, it only has to ack the last configure event. can respond to one, it only has to ack the last configure event.
Acking a configure event that was never sent raises an invalid_serial
error.
A client is not required to commit immediately after sending A client is not required to commit immediately after sending
an ack_configure request - it may even ack_configure several times an ack_configure request - it may even ack_configure several times
@ -622,6 +631,8 @@
not a valid variant of the resize_edge enum"/> not a valid variant of the resize_edge enum"/>
<entry name="invalid_parent" value="1" <entry name="invalid_parent" value="1"
summary="invalid parent toplevel"/> summary="invalid parent toplevel"/>
<entry name="invalid_size" value="2"
summary="client provided an invalid min or max size"/>
</enum> </enum>
<request name="set_parent"> <request name="set_parent">
@ -891,11 +902,11 @@
request. request.
Requesting a maximum size to be smaller than the minimum size of Requesting a maximum size to be smaller than the minimum size of
a surface is illegal and will result in a protocol error. a surface is illegal and will result in an invalid_size error.
The width and height must be greater than or equal to zero. Using The width and height must be greater than or equal to zero. Using
strictly negative values for width and height will result in a strictly negative values for width or height will result in a
protocol error. invalid_size error.
</description> </description>
<arg name="width" type="int"/> <arg name="width" type="int"/>
<arg name="height" type="int"/> <arg name="height" type="int"/>
@ -932,11 +943,11 @@
request. request.
Requesting a minimum size to be larger than the maximum size of Requesting a minimum size to be larger than the maximum size of
a surface is illegal and will result in a protocol error. a surface is illegal and will result in an invalid_size error.
The width and height must be greater than or equal to zero. Using The width and height must be greater than or equal to zero. Using
strictly negative values for width and height will result in a strictly negative values for width and height will result in a
protocol error. invalid_size error.
</description> </description>
<arg name="width" type="int"/> <arg name="width" type="int"/>
<arg name="height" type="int"/> <arg name="height" type="int"/>