protocol: Add agl-shell-desktop protocol
[src/agl-compositor.git] / protocol / agl-shell-desktop.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <protocol name="agl_shell_desktop">
3   <copyright>
4     Copyright © 2020 Collabora, Ltd.
5
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:
12
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
15     Software.
16
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.
24   </copyright>
25   <interface name="agl_shell_desktop" version="1">
26     <description summary="Private extension to allow other applications
27     to activate other apps">
28     </description>
29
30     <request name="activate_app">
31       <description summary="make client current window">
32         Ask the compositor to make a toplevel to become the current/focused
33         window for window management purposes.
34
35         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
36         description of app_id.
37       </description>
38       <arg name="app_id" type="string"/>
39       <arg name="output" type="object" interface="wl_output"/>
40     </request>
41   </interface>
42 </protocol>