sample/app/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 applications activate other apps">
  27       This extension can be used by regular application to instruct to compositor
  28       to activate or switch to other running (regular) applications. The client
  29       is responsbile for filtering their own app_id when receiving application id.
  30
  31       Note that other (regular) applications can bind to this interface and there is
  32       no mechanism to place to restrict or limit that.
  33     </description>
  34
  35     <enum name="app_role">
  36       <entry name="popup" value="0"/>
  37       <entry name="fullscreen" value="1"/>
  38     </enum>
  39
  40     <event name="application">
  41       <description summary="advertise application id">
  42         The compositor may choose to advertise one or more application ids which
  43         can be used to activate/switch to.
  44
  45         When this global is bound, the compositor will send all application ids
  46         available for activation, but may send additional application id at any
  47         time (when they've been mapped in the compositor).
  48       </description>
  49       <arg name="app_id" type="string"/>
  50     </event>
  51
  52     <request name="activate_app">
  53       <description summary="make client current window">
  54         Ask the compositor to make a toplevel to become the current/focused
  55         window for window management purposes.
  56
  57         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
  58         description of app_id.
  59       </description>
  60       <arg name="app_id" type="string"/>
  61       <arg name="output" type="object" interface="wl_output"/>
  62     </request>
  63
  64     <request name="set_app_property">
  65       <description summary="set properties for a client identified by app_id">
  66         Ask the compositor to make a toplevel obey the app_role and, depending
  67         on the role, to use the the x and y values as initial positional values.
  68         The x and y values would only make sense for certain roles.
  69
  70         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
  71         description of app_id.
  72       </description>
  73       <arg name="app_id" type="string"/>
  74       <arg name="role" type="uint" enum="app_role"/>
  75       <arg name="x" type="int"/>
  76       <arg name="y" type="int"/>
  77       <arg name="output" type="object" interface="wl_output"/>
  78     </request>
  79
  80     <request name="deactivate_app">
  81       <description summary="de-activate/hide window identified by app_id">
  82         Ask the compositor to hide the toplevel window for window
  83         management purposes. Depending on the window role, this request
  84         will either display the previously active window (or the background
  85         in case there's no previously activate surface) or temporarly (or
  86         until a 'activate_app' is called upon) hide the surface. All
  87         the surfaces are identifiable by using the app_id, and no actions are
  88         taken in case the app_id is not/was not present.
  89
  90         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
  91         description of app_id.
  92       </description>
  93       <arg name="app_id" type="string"/>
  94     </request>
  95   </interface>
  96 </protocol>