Remove multimedia app from HomeScreen overview documentation
[staging/HomeScreen.git] / interfaces / windowmanager.xml
index c15ca2c..e3c6df3 100644 (file)
@@ -1,5 +1,5 @@
 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<!-- Copyright (C) 2016 Mentor Graphics Development (Deutschland) GmbH
+<!-- Copyright (C) 2016, 2017 Mentor Graphics Development (Deutschland) GmbH
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
                        <arg name="error" type="i" direction="out"/>
                </method>
 
+               <!--
+                 deleteLayoutById:
+                 @layoutId: The ID of the layout to delete.
+                 @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
+
+                 Deletes the layout with the given ID. This cannot be the current active layout!
+               -->
+               <method name="deleteLayoutById">
+                       <arg name="layoutId" type="i" direction="in"/>
+                       <arg name="error" type="i" direction="out"/>
+               </method>
+
                <!--
                  setLayoutById:
                  @layoutId: The ID of the layout to activate.
                  Returns a list of layouts that offer the exact requested ammount of surface render areas.
                  If the list is empty, no layout fits the exact ammount.
                -->
+
                <method name="getAvailableLayouts">
                        <arg name="numberOfAppSurfaces" type="i" direction="in"/>
                        <arg name="layoutIds" type="ai" direction="out"/>
                        <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList&lt;int&gt;"/>
                </method>
 
-               <!--
-                 getAllSurfacesOfProcess:
-                 @pid: The PID of the process.
-                 @surfaceIds: A list of surfaces that were created by the process.
-
-                 The surface IDs can be used to assign them to a layout render area.
-               -->
-               <method name="getAllSurfacesOfProcess">
-                       <arg name="pid" type="i" direction="in"/>
-                       <arg name="layoutIds" type="ai" direction="out"/>
-                       <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList&lt;int&gt;"/>
-               </method>
-
                <!--
                  setSurfaceToLayoutArea:
                  @surfaceId: The ID of the surface that shall be positioned.
                        <arg name="surfaceIds" type="a(i)" direction="out"/>
                        <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList&lt;int&gt;"/> 
                </method>
+
+               <!--
+                 surfaceVisibilityChanged:
+                 @surfaceId: The surface that changed.
+                 @visible: True, if the surface is visible.
+
+                 This is emitted when the visible property of the surfaces changes.
+               -->
+               <signal name="surfaceVisibilityChanged">
+                       <arg name="surfaceId" type="i"/>
+                       <arg name="visible" type="b"/>
+               </signal>
+
+               <!--
+                 showLayer:
+                 @layer: The ID of the layer to show. POPUP=0, HOMESCREEN_OVERLAY=1, APPS=2, HOMESCREEN=3
+                 @pid: The PID of the app to show. (used only when layer is APPS=2)
+
+                 Show complete layers.
+                 By default, all layers are shown.
+               -->
+               <method name="showLayer">
+                       <arg name="layer" type="i" direction="in"/>
+                       <arg name="pid" type="i" direction="in"/>
+               </method>
+               <!--
+                 showAppLayer:
+                 @pid: The PID of the app to show.
+
+                 Show layer for application .
+               -->
+               <method name="showAppLayer">
+                       <arg name="pid" type="i" direction="in"/>
+               </method>
+               <!--
+                 hideLayer:
+                 @layer: The ID of the layer to hide. POPUP=0, HOMESCREEN_OVERLAY=1, APPS=2, HOMESCREEN=3
+
+                 Hide complete layers.
+                 By default, all layers are shown.
+               -->
+               <method name="hideLayer">
+                       <arg name="layer" type="i" direction="in"/>
+               </method>
        </interface>
 </node>