diff options
| author | Jonas Ådahl <jadahl@gmail.com> | 2015-04-02 15:16:14 +0800 |
|---|---|---|
| committer | Jonas Ådahl <jadahl@gmail.com> | 2015-05-05 14:17:56 +0800 |
| commit | 6ce76f00de2ee0dafdcf97b8bcf75dcaa87af472 (patch) | |
| tree | fa26871c0aaa9ffcbdf1881f2c849343f3ce7aa1 /protocol | |
| parent | a46cf2862f74f424eb36f8fddbf0b48454a19550 (diff) | |
| download | weston-6ce76f00de2ee0dafdcf97b8bcf75dcaa87af472.tar.gz | |
xdg-shell: Some minor clarifications
Mention set_window_geometry in configure documentation.
Add a strategic "For instance" to clarify what is just an example.
Clarify that the arguments of set_window_geometry are in the surface
local coordinate space.
Point out that the client needs to destroy a dismissed popup.
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Diffstat (limited to 'protocol')
| -rw-r--r-- | protocol/xdg-shell.xml | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml index 0d8ebe35..9651f100 100644 --- a/protocol/xdg-shell.xml +++ b/protocol/xdg-shell.xml @@ -315,7 +315,7 @@ The width and height arguments specify a hint to the window about how its surface should be resized in window geometry - coordinates. + coordinates. See set_window_geometry. The states listed in the event specify how the width/height arguments should be interpreted, and possibly how it should be @@ -344,9 +344,9 @@ must make a ack_configure request before the commit request, passing along the serial of the configure event. - The compositor might use this information to move a surface - to the top left only when the client has drawn itself for - the maximized or fullscreen state. + For instance, the compositor might use this information to move + a surface to the top left only when the client has drawn itself + for the maximized or fullscreen state. If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event. @@ -377,6 +377,9 @@ must respect the sizing negotiations specified by the states in the configure event. + The arguments are given in the surface local coordinate space of + the wl_surface associated with this xdg_surface. + The width and height must be greater than zero. </description> <arg name="x" type="int"/> @@ -491,8 +494,9 @@ <event name="popup_done"> <description summary="popup interaction is done"> - The popup_done event is sent out when a popup is dismissed - by the compositor. + The popup_done event is sent out when a popup is dismissed by the + compositor. The client should destroy the xdg_popup object at this + point. </description> </event> |