1 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
2 <!-- Copyright (C) 2016, 2017 Mentor Graphics Development (Deutschland) GmbH
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
8 http://www.apache.org/licenses/LICENSE-2.0
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License. -->
17 org.agl.windowmanager:
18 @short_description: A Layout-based interface for the WindowManager.
20 A Layout defines a list of surfaces areas.
22 <interface name="org.agl.windowmanager">
25 @layoutId: A unique ID that represents this layout. If the ID is already in use WINDOWMANAGER_ERROR_ID_ALREADY_DEFINED will be returned.
26 @layoutName: A user readable string for the layout. If the string is already in use WINDOWMANAGER_ERROR_NAME_ALREADY_DEFINED will be returned.
27 @surfaceAreas: A list of surface areas.
28 @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
30 Add a layout definition to the WindowManayer layout database.
31 The layout database is temoprary and not stored persistently. It has to be recreated by the client after
32 a WindowManager restart.
34 <method name="addLayout">
35 <arg name="layoutId" type="i" direction="in"/>
36 <arg name="layoutName" type="s" direction="in"/>
37 <arg name="surfaceAreas" type="a(iiii)" direction="in"/>
38 <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QList<LayoutArea>"/>
39 <arg name="error" type="i" direction="out"/>
44 @layoutId: The ID of the layout to delete.
45 @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
47 Deletes the layout with the given ID. This cannot be the current active layout!
49 <method name="deleteLayoutById">
50 <arg name="layoutId" type="i" direction="in"/>
51 <arg name="error" type="i" direction="out"/>
56 @layoutId: The ID of the layout to activate.
57 @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
59 Switch to the layout with the given ID.
61 <method name="setLayoutById">
62 <arg name="layoutId" type="i" direction="in"/>
63 <arg name="error" type="i" direction="out"/>
67 @layoutName: The name of the layout to activate.
68 @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
70 Switch to the layout with the given name.
72 <method name="setLayoutByName">
73 <arg name="layoutName" type="s" direction="in"/>
74 <arg name="error" type="i" direction="out"/>
79 @layoutId: The ID of the requested layout name.
80 @layoutName: The name of the layout with the given ID.
82 Request the name of the layout with the given ID. This does not set or activate a layout.
83 It is just returning the name of the given layout.
85 <method name="getLayoutName">
86 <arg name="layoutId" type="i" direction="in"/>
87 <arg name="layoutName" type="s" direction="out"/>
92 The current active layout with all its information.
95 <arg name="layout" type="(isa(iiii))" access="read"/>
96 <annotation name="org.qtproject.QtDBus.QtTypeName" value="Layout"/>
100 The current active layout id. This property is redundant, since its info is already available
101 in the property layout. But this property is more lightweight.
103 <property name="layoutId" type="i" access="read"/>
106 The name of the current active layout. This property is redundant, since its info is already available
107 in the property layout. But this property is more lightweight.
109 <property name="layoutName" type="s" access="read"/>
113 @layouts: A list of all layouts.
115 Returns a list of all layouts that were added to the WindowManager.
117 <method name="getAllLayouts">
118 <arg name="layoutIds" type="a(isa(iiii))" direction="out"/>
119 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList<Layout>"/>
124 @numberOfAppSurfaces: The ID of the requested layout name.
125 @layoutIds: A list of layouts that offer the exact requested ammount of surface render areas.
127 Returns a list of layouts that offer the exact requested ammount of surface render areas.
128 If the list is empty, no layout fits the exact ammount.
131 <method name="getAvailableLayouts">
132 <arg name="numberOfAppSurfaces" type="i" direction="in"/>
133 <arg name="layoutIds" type="ai" direction="out"/>
134 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList<int>"/>
138 setSurfaceToLayoutArea:
139 @surfaceId: The ID of the surface that shall be positioned.
140 @layoutAreaId: The ID of the layout area where the surface shall be rendered.
141 @error: WINDOWMANAGER_NO_ERROR or the first error that occurred.
143 The surface will be scaled to the size of the layout area.
144 The surface will be made visible with this call.
146 <method name="setSurfaceToLayoutArea">
147 <arg name="surfaceId" type="i" direction="in"/>
148 <arg name="layoutAreaId" type="i" direction="in"/>
149 <arg name="error" type="i" direction="out"/>
153 getAvailableSurfaces:
154 @surfaceIds: A list of all known surfaceIds except for the surfaces created by the Home Screen app.
156 If no surfaces are available, the returned list is empty.
158 <method name="getAvailableSurfaces">
159 <arg name="surfaceIds" type="a(i)" direction="out"/>
160 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList<int>"/>
164 surfaceVisibilityChanged:
165 @surfaceId: The surface that changed.
166 @visible: True, if the surface is visible.
168 This is emitted when the visible property of the surfaces changes.
170 <signal name="surfaceVisibilityChanged">
171 <arg name="surfaceId" type="i"/>
172 <arg name="visible" type="b"/>
177 @layer: The ID of the layer to show. POPUP=0, HOMESCREEN_OVERLAY=1, APPS=2, HOMESCREEN=3
178 @pid: The PID of the app to show. (used only when layer is APPS=2)
180 Show complete layers.
181 By default, all layers are shown.
183 <method name="showLayer">
184 <arg name="layer" type="i" direction="in"/>
185 <arg name="pid" type="i" direction="in"/>
189 @pid: The PID of the app to show.
191 Show layer for application .
193 <method name="showAppLayer">
194 <arg name="pid" type="i" direction="in"/>
198 @layer: The ID of the layer to hide. POPUP=0, HOMESCREEN_OVERLAY=1, APPS=2, HOMESCREEN=3
200 Hide complete layers.
201 By default, all layers are shown.
203 <method name="hideLayer">
204 <arg name="layer" type="i" direction="in"/>