protocol/agl-shell.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <protocol name="agl_shell">
   3   <copyright>
   4     Copyright © 2019 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" version="1">
  26     <description summary="user interface for weston-ivi">
  27     </description>
  28
  29     <enum name="error">
  30       <entry name="invalid_argument" value="0"/>
  31       <entry name="background_exists" value="1"/>
  32       <entry name="panel_exists" value="2"/>
  33     </enum>
  34
  35     <enum name="edge">
  36       <entry name="top" value="0"/>
  37       <entry name="bottom" value="1"/>
  38       <entry name="left" value="2"/>
  39       <entry name="right" value="3"/>
  40     </enum>
  41
  42     <request name="ready">
  43       <description summary="client is ready to be shown">
  44         Tell the server that this client is ready to be shown. The server
  45         will delay presentation during start-up until all shell clients are
  46         ready to be shown, and will display a black screen instead.
  47         This gives the client an oppurtunity to set up and configure several
  48         surfaces into a coherent interface.
  49
  50         The client that binds to this interface must send this request, otherwise
  51         they may stall the compositor unnecessarily.
  52
  53         If this request is called after the compositor has already finished
  54         start-up, no operation is performed.
  55       </description>
  56     </request>
  57
  58     <request name="set_background">
  59       <description summary="set surface as output's background">
  60         Set the surface to act as the background of an output. After this
  61         request, the server will immediately send a configure event with
  62         the dimensions the client should use to cover the entire output.
  63
  64         The surface must have a "desktop" surface role, as supported by
  65         libweston-desktop.
  66
  67         Only a single surface may be the background for any output. If a
  68         background surface already exists, a protocol error is raised.
  69       </description>
  70       <arg name="surface" type="object" interface="wl_surface"/>
  71       <arg name="output" type="object" interface="wl_output"/>
  72     </request>
  73
  74     <request name="set_panel">
  75       <description summary="set surface as panel">
  76         Set the surface to act as a panel of an output. The 'edge' argument
  77         says what edge of the output the surface will be anchored to.
  78         After this request, the server will send a configure event with the
  79         correponding width/height that the client should use, and 0 for the
  80         other dimension. E.g. if the edge is 'top', the width will be the
  81         output's width, and the height will be 0.
  82
  83         The surface must have a "desktop" surface role, as supported by
  84         libweston-desktop.
  85
  86         The compositor will take the panel's window geometry into account when
  87         positioning other windows, so the panels are not covered.
  88
  89         XXX: What happens if e.g. both top and left are used at the same time?
  90         Who gets to have the corner?
  91
  92         Only a single surface may be the panel for an output's edge. If a
  93         surface already exists on an edge, a protocol error is raised.
  94       </description>
  95       <arg name="surface" type="object" interface="wl_surface"/>
  96       <arg name="output" type="object" interface="wl_output"/>
  97       <arg name="edge" type="uint" enum="edge"/>
  98     </request>
  99
 100     <request name="activate_app">
 101       <description summary="make client current window">
 102         Ask the compositor to make a toplevel to become the current/focused
 103         window for window management purposes.
 104
 105         See xdg_toplevel.set_app_id from the xdg-shell protocol for a
 106         description of app_id.
 107
 108         If multiple toplevels have the same app_id, the result is unspecified.
 109
 110         XXX: Do we need feedback to say it didn't work? (e.g. client does
 111         not exist)
 112       </description>
 113       <arg name="app_id" type="string"/>
 114       <arg name="output" type="object" interface="wl_output"/>
 115     </request>
 116   </interface>
 117 </protocol>