X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=interfaces%2Fwindowmanager.xml;h=754c816667663ddb155e7f02548a64e028bb86f1;hb=2044d95f928fa42beaa00f9cb30816b1f6f63552;hp=c86c8e72dd445d5364ddefca056fad29f03284fb;hpb=824bfd42b0105b0aeffbc33a87285578abda2f3b;p=staging%2FHomeScreen.git

diff --git a/interfaces/windowmanager.xml b/interfaces/windowmanager.xml
index c86c8e7..754c816 100644
--- a/interfaces/windowmanager.xml
+++ b/interfaces/windowmanager.xml
@@ -13,40 +13,197 @@
  See the License for the specific language governing permissions and
  limitations under the License. -->
 <node>
-  <interface name="org.agl.windowmanager">
-      <method name="addLayout">
-        <arg name="layoutId" type="i" direction="in"/>
-        <arg name="layoutName" type="s" direction="in"/>
-        <arg name="surfaceAreas" type="a(iiii)" direction="in"/>
-        <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QList&lt;SimpleRect&gt;"/>
-        <arg name="error" type="i" direction="out"/>
-      </method>
-      <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>
-      <method name="setLayoutById">
-        <arg name="layoutId" type="i" direction="in"/>
-      </method>
-      <method name="setLayoutByName">
-        <arg name="layoutName" type="s" direction="in"/>
-      </method>
-      <method name="getLayout">
-        <arg name="layoutId" type="i" direction="out"/>
-      </method>
-      <method name="setPidToLayoutArea">
-        <arg name="pid" type="i" direction="in"/>
-        <arg name="layoutAreaId" type="i" direction="in"/>
-      </method>
-      <method name="getAvailableSurfaces">
-        <arg name="surfacesAndPids" type="a(ii)" direction="out"/>
-        <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList&lt;SimplePoint&gt;"/>
-      </method>
-      <method name="getLayoutName">
-        <arg name="layoutId" type="i" direction="in"/>
-        <arg name="layoutName" type="s" direction="out"/>
-      </method>
-  </interface>
+	<!--
+	  org.agl.windowmanager:
+	  @short_description: A Layout-based interface for the WindowManager.
+
+	  A Layout defines a list of surfaces areas.
+	-->
+	<interface name="org.agl.windowmanager">
+		<!--
+		  addLayout:
+		  @layoutId: A unique ID that represents this layout. If the ID is already in use WINDOWMANAGER_ERROR_ID_ALREADY_DEFINED will be returned.
+		  @layoutName: A user readable string for the layout. If the string is already in use WINDOWMANAGER_ERROR_NAME_ALREADY_DEFINED will be returned.
+		  @surfaceAreas: A list of surface areas.
+		  @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
+
+		  Add a layout definition to the WindowManayer layout database.
+		  The layout database is temoprary and not stored persistently. It has to be recreated by the client after
+		  a WindowManager restart.
+		-->
+		<method name="addLayout">
+			<arg name="layoutId" type="i" direction="in"/>
+			<arg name="layoutName" type="s" direction="in"/>
+			<arg name="surfaceAreas" type="a(iiii)" direction="in"/>
+			<annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QList&lt;LayoutArea&gt;"/>
+			<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.
+		  @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
+
+		  Switch to the layout with the given ID.
+		-->
+		<method name="setLayoutById">
+			<arg name="layoutId" type="i" direction="in"/>
+			<arg name="error" type="i" direction="out"/>
+		</method>
+		<!--
+		  setLayoutByName:
+		  @layoutName: The name of the layout to activate.
+		  @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
+
+		  Switch to the layout with the given name.
+		-->
+		<method name="setLayoutByName">
+			<arg name="layoutName" type="s" direction="in"/>
+			<arg name="error" type="i" direction="out"/>
+		</method>
+
+		<!--
+		  getLayoutName:
+		  @layoutId: The ID of the requested layout name.
+		  @layoutName: The name of the layout with the given ID.
+
+		  Request the name of the layout with the given ID. This does not set or activate a layout.
+		  It is just returning the name of the given layout.
+		-->
+		<method name="getLayoutName">
+			<arg name="layoutId" type="i" direction="in"/>
+			<arg name="layoutName" type="s" direction="out"/>
+		</method>
+
+		<!--
+		  layout:
+		  The current active layout with all its information.
+		-->
+		<property>
+			<arg name="layout" type="(isa(iiii))" access="read"/>
+			<annotation name="org.qtproject.QtDBus.QtTypeName" value="Layout"/>
+		</property>
+		<!--
+		  layoutId:
+		  The current active layout id. This property is redundant, since its info is already available
+		  in the property layout. But this property is more lightweight.
+		-->
+		<property name="layoutId" type="i" access="read"/>
+		<!--
+		  layoutName:
+		  The name of the current active layout. This property is redundant, since its info is already available
+		  in the property layout. But this property is more lightweight.
+		-->
+		<property name="layoutName" type="s" access="read"/>
+
+		<!--
+		  getAllLayouts:
+		  @layouts: A list of all layouts.
+
+		  Returns a list of all layouts that were added to the WindowManager.
+		-->
+		<method name="getAllLayouts">
+			<arg name="layoutIds" type="a(isa(iiii))" direction="out"/>
+			<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList&lt;Layout&gt;"/>
+		</method>
+
+		<!--
+		  getAvailableLayouts:
+		  @numberOfAppSurfaces: The ID of the requested layout name.
+		  @layoutIds: A list of layouts that offer the exact requested ammount of surface render areas.
+
+		  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.
+		  @layoutAreaId: The ID of the layout area where the surface shall be rendered.
+		  @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
+
+		  The surface will be scaled to the size of the layout area.
+		  The surface will be made visible with this call.
+		-->
+		<method name="setSurfaceToLayoutArea">
+			<arg name="surfaceId" type="i" direction="in"/>
+			<arg name="layoutAreaId" type="i" direction="in"/>
+			<arg name="error" type="i" direction="out"/>
+		</method>
+
+		<!--
+		  getAvailableSurfaces:
+		  @surfaceIds: A list of all known surfaceIds except for the surfaces created by the Home Screen app.
+
+		  If no surfaces are available, the returned list is empty.
+		-->
+		<method name="getAvailableSurfaces">
+			<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
+
+		  Show complete layers.
+		  By default, all layers are shown.
+		-->
+		<method name="showLayer">
+			<arg name="layer" 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>