xdg-shell: Document error conditions when popup and surface getters

Document that a wl_surface can only be assigned either a xdg_popup or
xdg_surface once and that if the client still stries to do that an error
is raised.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
Pekka Paalanen <pekka.paalanen@collabora.co.uk>
dev
Jonas Ådahl 10 years ago committed by Bryce Harrington
parent ca13f7ed8f
commit 5b77199cc1
  1. 16
      protocol/xdg-shell.xml

@ -78,7 +78,13 @@
<request name="get_xdg_surface"> <request name="get_xdg_surface">
<description summary="create a shell surface from a surface"> <description summary="create a shell surface from a surface">
This creates an xdg_surface for the given surface and gives it the This creates an xdg_surface for the given surface and gives it the
xdg_surface role. See the documentation of xdg_surface for more details. xdg_surface role. A wl_surface can only be given an xdg_surface role
once. If get_xdg_surface is called with a wl_surface that already has
an active xdg_surface associated with it, or if it had any other role,
an error is raised.
See the documentation of xdg_surface for more details about what an
xdg_surface is and how it is used.
</description> </description>
<arg name="id" type="new_id" interface="xdg_surface"/> <arg name="id" type="new_id" interface="xdg_surface"/>
<arg name="surface" type="object" interface="wl_surface"/> <arg name="surface" type="object" interface="wl_surface"/>
@ -87,10 +93,16 @@
<request name="get_xdg_popup"> <request name="get_xdg_popup">
<description summary="create a popup for a surface"> <description summary="create a popup for a surface">
This creates an xdg_popup for the given surface and gives it the This creates an xdg_popup for the given surface and gives it the
xdg_popup role. See the documentation of xdg_popup for more details. xdg_popup role. A wl_surface can only be given an xdg_popup role
once. If get_xdg_popup is called with a wl_surface that already has
an active xdg_popup associated with it, or if it had any other role,
an error is raised.
This request must be used in response to some sort of user action This request must be used in response to some sort of user action
like a button press, key press, or touch down event. like a button press, key press, or touch down event.
See the documentation of xdg_popup for more details about what an
xdg_popup is and how it is used.
</description> </description>
<arg name="id" type="new_id" interface="xdg_popup"/> <arg name="id" type="new_id" interface="xdg_popup"/>
<arg name="surface" type="object" interface="wl_surface"/> <arg name="surface" type="object" interface="wl_surface"/>

Loading…
Cancel
Save