1 <?xml version="1.0" encoding="UTF-8"?>
2 <protocol name="agl_shell">
4 Copyright © 2019, 2022 Collabora, Ltd.
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
13 The above copyright notice and this permission notice (including the next
14 paragraph) shall be included in all copies or substantial portions of the
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 DEALINGS IN THE SOFTWARE.
25 <interface name="agl_shell" version="5">
26 <description summary="user interface for Automotive Grade Linux platform">
27 Starting with version 2 of the protocol, the client is required to wait
28 for the 'bound_ok' or 'bound_fail' events in order to proceed further.
30 In case the client gets a 'bound_fail' event then it should consider that
31 there's another client already bound to the agl_shell protocol.
32 A client that receives a 'bound_ok' event should consider that there's
33 no other client already bound to the interface and can proceed further.
35 If the client uses an older version of the protocol it will receive
36 automatically an error and the compositor will terminate the connection,
37 if there's another client already bound the interface.
39 If the client receives the 'bound_fail' event and attempts to use the
40 interface further it will receive an error and the compositor will
41 terminate the connection. After the 'bound_fail' event was received the
42 client should call the destructor, which has been added with version 2
43 of the protocol. The client is free to try at a later point in time to
44 see if it will receive the 'bound_ok' event, but there's no explicit way
45 of finding out when that event will delivered. It is assumed that it can
46 infer that information through other means/other channels.
49 <request name="destroy" type="destructor" since="2">
50 <description summary="destroys the factory object">
55 <entry name="invalid_argument" value="0"/>
56 <entry name="background_exists" value="1"/>
57 <entry name="panel_exists" value="2"/>
61 <entry name="top" value="0"/>
62 <entry name="bottom" value="1"/>
63 <entry name="left" value="2"/>
64 <entry name="right" value="3"/>
67 <enum name="app_state" since="4">
68 <entry name="started" value="0"/>
69 <entry name="activated" value="1"/>
70 <entry name="deactivated" value="2"/>
71 <entry name="destroyed" value="3"/>
74 <enum name="app_role" since="4">
75 <entry name="float" value="0"/>
76 <entry name="remote" value="1"/>
79 <request name="ready">
80 <description summary="client is ready to be shown">
81 Tell the server that this client is ready to be shown. The server
82 will delay presentation during start-up until all shell clients are
83 ready to be shown, and will display a black screen instead.
84 This gives the client an opportunity to set up and configure several
85 surfaces into a coherent interface.
87 The client that binds to this interface must send this request, otherwise
88 they may stall the compositor unnecessarily.
90 If this request is called after the compositor has already finished
91 start-up, no operation is performed.
95 <request name="set_background">
96 <description summary="set surface as output's background">
97 Set the surface to act as the background of an output. After this
98 request, the server will immediately send a configure event with
99 the dimensions the client should use to cover the entire output.
101 The surface must have a "desktop" surface role, as supported by
104 Only a single surface may be the background for any output. If a
105 background surface already exists, a protocol error is raised.
107 <arg name="surface" type="object" interface="wl_surface"/>
108 <arg name="output" type="object" interface="wl_output"/>
111 <request name="set_panel">
112 <description summary="set surface as panel">
113 Set the surface to act as a panel of an output. The 'edge' argument
114 says what edge of the output the surface will be anchored to.
115 After this request, the server will send a configure event with the
116 corresponding width/height that the client should use, and 0 for the
117 other dimension. E.g. if the edge is 'top', the width will be the
118 output's width, and the height will be 0.
120 The surface must have a "desktop" surface role, as supported by
123 The compositor will take the panel's window geometry into account when
124 positioning other windows, so the panels are not covered.
126 XXX: What happens if e.g. both top and left are used at the same time?
127 Who gets to have the corner?
129 Only a single surface may be the panel for an output's edge. If a
130 surface already exists on an edge, a protocol error is raised.
132 <arg name="surface" type="object" interface="wl_surface"/>
133 <arg name="output" type="object" interface="wl_output"/>
134 <arg name="edge" type="uint" enum="edge"/>
137 <request name="activate_app">
138 <description summary="make client current window">
139 Ask the compositor to make a toplevel to become the current/focused
140 window for window management purposes.
142 See xdg_toplevel.set_app_id from the xdg-shell protocol for a
143 description of app_id.
145 If multiple toplevels have the same app_id, the result is unspecified.
147 XXX: Do we need feedback to say it didn't work? (e.g. client does
150 <arg name="app_id" type="string"/>
151 <arg name="output" type="object" interface="wl_output"/>
154 <request name="deactivate_app" since="3">
155 <description summary="de-activate/hide window identified by app_id">
156 Ask the compositor to hide the toplevel window for window
157 management purposes. Depending on the window role, this request
158 will either display the previously active window (or the background
159 in case there's no previously active surface) or temporarily (or
160 until a 'activate_app' is called upon) hide the surface. All
161 the surfaces are identifiable by using the app_id, and no actions are
162 taken in case the app_id is not/was not present.
164 See xdg_toplevel.set_app_id from the xdg-shell protocol for a
165 description of app_id.
167 <arg name="app_id" type="string"/>
170 <event name="bound_ok" since="2">
172 Informs the client that it was able to bind the agl_shell
173 interface succesfully. Clients are required to wait for this
174 event before continuing further.
178 <event name="bound_fail" since="2">
180 Informs the client that binding to the agl_shell interface was
181 unsuccesfull. Clients are required to wait for this event for
186 <event name="app_state" since="4">
187 <description summary="event sent when application has suffered state modification">
188 Notifies application(s) when other application have suffered state modifications.
190 <arg name="app_id" type="string"/>
191 <arg name="state" type="uint" enum="app_state"/>
192 <arg name="role" type="uint" enum="app_role"/>
195 <request name="set_app_float" since="5">
196 <description summary="set the application floating">
197 The agl-shell protocol makes the windows by default maximized to the
198 output area, taking into consideration the panel sizes.
200 If certain client would want be behave like a pop-up type, always sticky
201 window, when switching between applications, it can use this request
204 If the application, specified with the app_id string,
205 is not currently running, it will be added it to a pending list.
207 If, at a later point in time, that application does come up it will
208 apply the floating state to it. Note that once that happens, and a later
209 point in time that application is stopped, these changes will not apply
210 anymore. To keep a permanent state see also set_app_property_mode().
212 Another use-case is for applications that want to be started from the
213 beginning as floating, so they the client must call this request before
214 doing the initial wl_surface.commit().
216 Application can also transit from float to maximized and vice-versa
217 using this request or the set_app_unfloat to go back to an
218 initial maximized state.
220 See xdg_toplevel.set_app_id from the xdg-shell protocol for a
221 description of app_id.
223 <arg name="app_id" type="string"/>
224 <arg name="x" type="int"/>
225 <arg name="y" type="int"/>
228 <request name="set_app_unfloat" since="5">
229 <description summary="set the application back to maximized mode">
230 This undoes the effect of the 'set_app_float' request
231 in case the client wants to go from floating back to the maximized
232 state. If there's no app_id present this request will obviously do
235 See xdg_toplevel.set_app_id from the xdg-shell protocol for a
236 description of app_id.
238 <arg name="app_id" type="string"/>
241 <request name="set_app_remote" since="5">
242 <description summary="set the application remoting on another output">
243 See xdg_toplevel.set_app_id from the xdg-shell protocol for a
244 description of app_id.
246 <arg name="app_id" type="string"/>
247 <arg name="output" type="object" interface="wl_output"/>
250 <request name="set_app_property_mode" since="5">
251 <description summary="Request to change the application properties lifetime">
252 Use this request to inform the compositor to maintain a pending state
253 for an app_id being set with set_app_float/set_app_remote request.
255 Any subsequent application matching that app_id would survive a
256 potential application destruction. Note that this request will
257 take effect globally on all applications.
259 To turn it on, or off, use the 'permanent' argument. Initially,
260 the compositor will have this option set to off. Note that it
261 doesn't matter the order of this request with respect to
262 set_app_property() request, as the changes will only take effect
263 when the application itself does the commit with an app_id set,
264 therefore the only requirement is to call this request before
265 the app_id client does its first commit.
267 <arg name="permanent" type="uint"/>