diff options
| author | Jonas Ådahl <jadahl@gmail.com> | 2015-05-05 15:35:15 +0800 |
|---|---|---|
| committer | Bryce Harrington <bryce@osg.samsung.com> | 2015-05-21 19:01:45 -0700 |
| commit | 5b77199cc1ad9d971d9ef51c9f21ef6149942193 (patch) | |
| tree | 0fd2a55512067bf9f76b022d2c12a59ee64353ac | |
| parent | ca13f7ed8f93cb3c5d227e77978dd78db16a1244 (diff) | |
| download | weston-5b77199cc1ad9d971d9ef51c9f21ef6149942193.tar.gz weston-5b77199cc1ad9d971d9ef51c9f21ef6149942193.tar.bz2 weston-5b77199cc1ad9d971d9ef51c9f21ef6149942193.zip | |
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>
| -rw-r--r-- | protocol/xdg-shell.xml | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml index 07206627..06a6cfd6 100644 --- a/protocol/xdg-shell.xml +++ b/protocol/xdg-shell.xml @@ -78,7 +78,13 @@ <request name="get_xdg_surface"> <description summary="create a shell surface from a surface"> 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> <arg name="id" type="new_id" interface="xdg_surface"/> <arg name="surface" type="object" interface="wl_surface"/> @@ -87,10 +93,16 @@ <request name="get_xdg_popup"> <description summary="create a popup for a surface"> 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 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> <arg name="id" type="new_id" interface="xdg_popup"/> <arg name="surface" type="object" interface="wl_surface"/> |