[PATCH weston 15/17] xdg-shell: Document the set_maximized and unsetmaximized requests
jadahl at gmail.com
Tue Apr 7 02:01:30 PDT 2015
Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
protocol/xdg-shell.xml | 41 +++++++++++++++++++++++++++++++++++++++--
1 file changed, 39 insertions(+), 2 deletions(-)
diff --git a/protocol/xdg-shell.xml b/protocol/xdg-shell.xml
index f07ba5e..13168b3 100644
@@ -440,8 +440,45 @@
<arg name="height" type="int"/>
- <request name="set_maximized" />
- <request name="unset_maximized" />
+ <request name="set_maximized">
+ <description summary="maximize the window">
+ Maximize the surface.
+ After requesting that the surface should be maximized, the compositor
+ will respond by emitting a configure event with the "maximized" state
+ and the required window geometry. The client should then update its
+ content, drawing it in a maximized state, i.e. without shadow or other
+ decoration outside of the window geometry. The client must also
+ acknowledge the configure when committing the new content (see
+ It is up to the compositor to decide how and where to maximize the
+ surface, for example what output and what region of the screen should
+ be used.
+ If the surface is already maximized, this request is a no-op.
+ <request name="unset_maximized">
+ <description summary="unmaximize the window">
+ Unmaximize the surface.
+ After requesting that the surface should be unmaximized, the compositor
+ will respond by emitting a configure event without the "maximized"
+ state. If available, the compositor will include the previous window
+ geometry dimensions in the configure request. The client must then
+ update its content, drawing it in a regular state, i.e. potentially
+ with shadow etc. The client must also acknowledge the configure when
+ committing the new content (see ack_configure),
+ It is up to the compositor to position the surface after it was
+ unmaximized; usually the position the surface had before maximizing, if
+ If the surface is not maximized, this request is a no-op.
<description summary="set the window as fullscreen on a monitor">
More information about the wayland-devel