[PATCH weston 15/17] xdg-shell: Document the set_maximized and unsetmaximized requests

[Bryce Harrington]

On Tue, Apr 07, 2015 at 05:01:30PM +0800, Jonas Ådahl wrote:
> Signed-off-by: Jonas Ådahl <jadahl at gmail.com>

Couple typos, but nothing major.  LGTM:

Reviewed-by: Bryce Harrington <bryce at osg.samsung.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
> --- a/protocol/xdg-shell.xml
> +++ b/protocol/xdg-shell.xml
> @@ -440,8 +440,45 @@
>        <arg name="height" type="int"/>
>      </request>
>  
> -    <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
> +        ack_configure),

Period rather than comma at end of sentence.

> +
> +        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

*which* output

> +        be used.
> +
> +        If the surface is already maximized, this request is a no-op.
> +      </description>
> +    </request>
> +
> +    <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

"with shadow, etc."

> +        committing the new content (see ack_configure),

Period rather than comma at end of sentence.

> +
> +        It is up to the compositor to position the surface after it was
> +        unmaximized; usually the position the surface had before maximizing, if
> +        applicable.
> +
> +        If the surface is not maximized, this request is a no-op.
> +      </description>
> +    </request>
>  
>      <request name="set_fullscreen">
>        <description summary="set the window as fullscreen on a monitor">
> -- 
> 2.1.4
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel