agl-shell-desktop: Add the ability to pass width and height as

area of the bounding box

The width and height will represent a rectangle which can be used to
define the maxium area to have the surface in. Any part of the surface
area that exceeds the area delimited by this bounding box will be
clipped away. The initial position of the bounding box is specified
using the bx and by values.

Bug-AGL: SPEC-3419

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
Change-Id: Ie24f469662dd686c49f658c415ccd2664d9a9b5b

diff --git a/protocol/agl-shell-desktop.xml b/protocol/agl-shell-desktop.xml
index 4f942f5..e7b9493 100644 (file)
--- a/protocol/agl-shell-desktop.xml
+++ b/protocol/agl-shell-desktop.xml
@@ -72,9 +72,31 @@
 
     <request name="set_app_property">
       <description summary="set properties for a client identified by app_id">
-        Ask the compositor to make a toplevel obey the app_role and, depending
-        on the role, to use the the x and y values as initial positional values.
-        The x and y values would only make sense for certain roles.
+        Ask the compositor to make a top-level window obey the 'app_role' enum
+        and, depending on that role, to use some of the arguments as initial
+        values to take into account.
+
+        Note that x, y, bx, by, width and height would only make sense for the
+        pop-up role, with the output argument being applicable to all the roles.
+        The width and height values define the maximum area which the
+        top-level window should be placed into. Note this doesn't correspond to
+        top-level surface size, but to a bounding box which will be used to
+        clip the surface to, in case the surface area extends that of this
+        bounding box. Both of these values need to be larger than 0 (zero) to be
+        taken into account by the compositor. Any negative values for the width
+        and height will be discarded.
+
+        The x and y values will serve as the (initial) position values.
+        The bx and by values are the top-left x and y value of the bounding box.
+        Any clipping happening to the bounding box will not affect the surface
+        size or the position of the underlying surface backing the top-level
+        window. The bx and by values, like the positional values, could be
+        both set to zero, or even negative values. The compositor will pass
+        those on without any further validation.
+
+        The initial position values and the bounding rectangle will still be
+        in effect on a subsequent activation request of the 'app_id', assuming
+        it was previously de-activated at some point in time.
 
         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
         description of app_id.
@@ -83,6 +105,10 @@
       <arg name="role" type="uint" enum="app_role"/>
       <arg name="x" type="int"/>
       <arg name="y" type="int"/>
+      <arg name="bx" type="int"/>
+      <arg name="by" type="int"/>
+      <arg name="width" type="int"/>
+      <arg name="height" type="int"/>
       <arg name="output" type="object" interface="wl_output"/>
     </request>