X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=interfaces%2Fhomescreen.xml;h=b317306959154cb4385cb68bff272349b6793edd;hb=ec688535558c31989e7da221b858328b2e0766c8;hp=3eb66d09080ff25255b9381b1cfd3f209128b088;hpb=cf8cd699e91df40c3f9070019f7c561432b4b4dd;p=staging%2FHomeScreen.git

diff --git a/interfaces/homescreen.xml b/interfaces/homescreen.xml
index 3eb66d0..b317306 100644
--- a/interfaces/homescreen.xml
+++ b/interfaces/homescreen.xml
@@ -13,12 +13,64 @@
  See the License for the specific language governing permissions and
  limitations under the License. -->
 <node>
+<!--
+  org.agl.homescreen:
+  @short_description: A generic interface for the HomeScreen app.
+
+  This interface is a collection of methods from different functional areas to control the HomeScreen app.
+-->
   <interface name="org.agl.homescreen">
+  <!--
+    hardKeyPressed:
+    @key: The key that was pressed using the inputevent.hpp InputEvent::HardKey type.
+
+    This is used to inject hard keys into the HomeScreen app.
+  -->
     <method name="hardKeyPressed">
-      <arg name="key" type="i" direction="in"/> <!-- using the inputevent.hpp InputEvent::HardKey type -->
+      <arg name="key" type="i" direction="in"/>
+    </method>
+  <!--
+    requestSurfaceIdToFullScreen:
+    @surfaceId: The surface that request to be shown fullscreen.
+
+    This allows an application to set a surface to full screen.
+  -->
+    <method name="requestSurfaceIdToFullScreen">
+      <arg name="surfaceId" type="i" direction="in"/>
     </method>
-    <method name="setToFullscreen">
-      <arg name="pid" type="i" direction="in"/>
+  <!--
+    getLayoutRenderAreaForSurfaceId:
+    @surfaceId: The surface that is requested.
+    @renderArea: The layout render area in which the given surface is located.
+
+    Before an application uses renderSurfaceToArea to render a surface into an area inside a layout area,
+    this method should be used to get the dimension of the layout area, in which the surface
+    currently is positioned.
+  -->
+    <method name="getLayoutRenderAreaForSurfaceId">
+      <arg name="surfaceId" type="i" direction="in"/>
+      <arg name="renderArea" type="(iiii)" direction="out"/>
+      <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QRect"/>
+    </method>
+  <!--
+    renderSurfaceToArea:
+    @surfaceId: The surface that is requested.
+    @renderArea: The render area inside the current layout area.
+
+    This is a special case. In the normal use case, one layout area is always filled completely
+    with one surface. By using this function, an app can request to position a surface in the
+    layout area.
+    Example:
+    If the layout area is 500x500 pixel in size, the normal use case qould be, that a surface
+    is positioned at x=0, y=0 with a width and a size of 500. With this function, an application can position surfaces
+    free in this area.
+    E.g.: Position surface 101 at x=10, y=30, width=300, height=100 and 
+    surface 104 at x=100, y=130, width=30, height=10
+  -->
+    <method name="renderSurfaceToArea">
+      <arg name="surfaceId" type="i" direction="in"/>
+      <arg name="renderArea" type="(iiii)" direction="in"/>
+      <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QRect"/>
     </method>
   </interface>
 </node>